silverstripe-reports/code/Newsletter/NewsletterEmailProcess.php
Sam Minnee bfc448fa7f Added package tags and docblock info for API documentation
Fixed whitespace

git-svn-id: svn://svn.silverstripe.com/silverstripe/open/modules/cms/trunk@47726 467b73ca-7a2a-4603-9d3b-597d59a354a9
2008-01-08 06:41:55 +00:00

141 lines
4.0 KiB
PHP
Executable File

<?php
/**
* @package cms
* @subpackage newsletter
*/
/**
* Batch process for sending newsletters.
*/
class NewsletterEmailProcess extends BatchProcess {
protected $subject;
protected $body;
protected $from;
protected $newsletter;
protected $nlType;
protected $messageID;
/**
* Set up a Newsletter Email Process
*
* @recipients A DataObject containing the addresses of the recipients of this newsletter
*/
function __construct( $subject, $body, $from, $newsletter, $nlType, $messageID = null, $recipients) {
$this->subject = $subject;
$this->body = $body;
$this->from = $from;
$this->newsletter = $newsletter;
$this->nlType = $nlType;
$this->messageID = $messageID;
parent::__construct( $recipients );
}
function next( $count = 10 ) {
$max = $this->current + $count;
$max = $max < count( $this->objects ) ? $max : count( $this->objects );
while($this->current < $max) {
$index = $this->current++;
$member = $this->objects[$index];
// check to see if the user has unsubscribed from the mailing list
// TODO Join in the above query first
$unsubscribeRecord = DataObject::get_one('Member_UnsubscribeRecord', "`MemberID`='{$member->ID}' AND `NewsletterTypeID`='{$this->nlType->ID}'");
if( !$unsubscribeRecord ) {
$address = $member->Email;
/**
* Email Blacklisting Support
*/
if($member->BlacklistedEmail && Email_BlackList::isBlocked($address)){
$bounceRecord = new Email_BounceRecord();
$bounceRecord->BounceEmail = $member->Email;
$bounceRecord->BounceTime = date("Y-m-d H:i:s",time());
$bounceRecord->BounceMessage = "BlackListed Email";
$bounceRecord->MemberID = $member->ID;
$bounceRecord->write();
// Log the blacklist for this specific Newsletter
$newsletter = new Newsletter_SentRecipient();
$newsletter->Email = $address;
$newsletter->MemberID = $member->ID;
$newsletter->Result = 'BlackListed';
$newsletter->ParentID = $this->newsletter->ID;
$newsletter->write();
} else {
$e = new Newsletter_Email($this->nlType);
$e->setBody( $this->body );
$e->setSubject( $this->subject );
$e->setFrom( $this->from );
$e->setTemplate( $this->nlType->Template );
if(method_exists($member, "getNameForEmail"))
$nameForEmail = $member->getNameForEmail();
$e->populateTemplate( array( 'Member' => $member, 'FirstName' => $member->FirstName, 'NameForEmail'=>$nameForEmail ) );
$this->sendToAddress( $e, $address, $this->messageID, $member);
}
}
}
if( $this->current >= count( $this->objects ) )
return $this->complete();
else
return parent::next();
}
/*
* Sends a Newsletter email to the specified address
*
* @param $member The object containing information about the member being emailed
*/
private function sendToAddress( $email, $address, $messageID = null, $member) {
$email->setTo( $address );
$result = $email->send( $messageID );
// Log result of the send
$newsletter = new Newsletter_SentRecipient();
$newsletter->Email = $address;
$newsletter->MemberID = $member->ID;
// If Sending is successful
if ($result == true) {
$newsletter->Result = 'Sent';
} else {
$newsletter->Result = 'Failed';
}
$newsletter->ParentID = $this->newsletter->ID;
$newsletter->write();
// Adding a pause between email sending can be useful for debugging purposes
// sleep(10);
}
function complete() {
parent::complete();
if( $this->newsletter->SentDate ) {
$resent = true;
} else {
$resent = false;
}
$this->newsletter->SentDate = 'now';
$this->newsletter->Status = 'Send';
$this->newsletter->write();
// Call the success message JS function with the Newsletter information
if( $resent ) {
return "resent_ok( '{$this->nlType->ID}', '{$this->newsletter->ID}', '".count( $this->objects )."' )";
} else {
return "draft_sent_ok( '{$this->nlType->ID}', '{$this->newsletter->ID}', '".count( $this->objects )."' )";
}
}
}
?>