Source for file Template.php

Documentation is available at Template.php

  1. <?php
  2.  
  3. /**
  4.  * This class wraps the Newsletter email sending functionality
  5.  * 
  6.  * If SMTPPro is enabled it will send emails using the given
  7.  * configuration.
  8.  *
  9.  *
  10.  * @author Ashley Schroder (aschroder.com)
  11.  * @copyright  Copyright (c) 2010 Ashley Schroder
  12.  * @license    http://opensource.org/licenses/osl-3.0.php  Open Software License (OSL 3.0)
  13.  */
  14.  
  15. class Aschroder_SMTPPro_Model_Newsletter_Template
  16.     extends Magentron_EmailImages_Model_Newsletter_Template {
  17.     
  18.     
  19.      /**
  20.      * Send mail to subscriber
  21.      *
  22.      * @param   Mage_Newsletter_Model_Subscriber|string  $subscriber   subscriber Model or E-mail
  23.      * @param   array                                     $variables    template variables
  24.      * @param   string|null                              $name         receiver name (if subscriber model not specified)
  25.      * @param   Mage_Newsletter_Model_Queue|null         $queue        queue model, used for problems reporting.
  26.      * @return boolean 
  27.      ***/
  28.     public function send($subscriber, array $variables = array(), $name=null, Mage_Newsletter_Model_Queue $queue=null)
  29.     {
  30.         if(!$this->isValidForSend()) {
  31.             return false;
  32.         }
  33.         
  34.         // If it's not enabled, just return the parent result.
  35.         if (!Mage::helper('smtppro')->isEnabled()) {
  36.              return parent::send($subscriber, $variables, $name, $queue);
  37.         } 
  38.  
  39.         Mage::log('SMTPPro is enabled, sending email in Aschroder_SMTPPro_Model_Newsletter_Template'); 
  40.         
  41.  
  42.         $email = '';
  43.         if ($subscriber instanceof Mage_Newsletter_Model_Subscriber) {
  44.             $email = $subscriber->getSubscriberEmail();
  45.             if (is_null($name) && ($subscriber->hasCustomerFirstname() || $subscriber->hasCustomerLastname()) ) {
  46.                 $name = $subscriber->getCustomerFirstname() . ' ' . $subscriber->getCustomerLastname();
  47.             }
  48.         } else {
  49.             $email = (string) $subscriber;
  50.         }
  51.  
  52.         $mail = $this->getMail();
  53.  
  54.         if (Mage::getStoreConfigFlag(Mage_Newsletter_Model_Subscriber::XML_PATH_SENDING_SET_RETURN_PATH)) {
  55.             // This is important for SPAM I think, what value should it be?
  56.             $mail->setReturnPath($this->getTemplateSenderEmail());
  57.         }
  58.  
  59.         $transport = Mage::helper('smtppro')->getTransport();
  60.         
  61.         $dev = Mage::helper('smtppro')->getDevelopmentMode();
  62.            
  63.         if ($dev == "contact") {
  64.             
  65.             $email = Mage::getStoreConfig('contacts/email/recipient_email');
  66.             Mage::log("Development mode set to send all emails to contact form recipient: " . $email);
  67.             
  68.         } elseif ($dev == "supress") {
  69.             
  70.             Mage::log("Development mode set to supress all emails.");
  71.             # we bail out, but report success
  72.             return true;
  73.         }
  74.  
  75.         $mail->addTo($email, $name);
  76.         $text = $this->getProcessedTemplate($variables, true);
  77.  
  78.         if($this->isPlain()) {
  79.             $mail->setBodyText($text);
  80.         } else {
  81.             $mail->setBodyHTML($text);
  82.         }
  83.  
  84.         $mail->setSubject($this->getProcessedTemplateSubject($variables));
  85.         $mail->setFrom($this->getTemplateSenderEmail(), $this->getTemplateSenderName());
  86.         
  87.          // If we are using store emails as reply-to's set the header
  88.         if (Mage::helper('smtppro')->isReplyToStoreEmail()) {
  89.             // Later versions of Zend have a method for this, and disallow direct header setting...
  90.             if (method_exists($mail, "setReplyTo")) {
  91.                 $mail->setReplyTo($this->getTemplateSenderEmail(), $this->getTemplateSenderName());
  92.             } else {
  93.                 $mail->addHeader('Reply-To', $this->getTemplateSenderEmail());
  94.             }
  95.             Mage::log('ReplyToStoreEmail is enabled, just set Reply-To header: ' . $this->getTemplateSenderEmail());
  96.         }
  97.  
  98.         try {
  99.             
  100.             Mage::log('About to send email');
  101.             $mail->send($transport);
  102.             Mage::log('Finished sending email');
  103.             
  104.              Mage::dispatchEvent('smtppro_email_after_send', 
  105.                  array('to' => $email,
  106.                          'template' => $this->getTemplateId(),
  107.                          'subject' => $mail->getSubject(),
  108.                          'html' => !$this->isPlain(),
  109.                          'email_body' => $text));
  110.                 
  111.             
  112.             $this->_mail = null;
  113.             if(!is_null($queue)) {
  114.                 $subscriber->received($queue);
  115.             }
  116.         }
  117.         catch (Exception $e) {
  118.             if($subscriber instanceof Mage_Newsletter_Model_Subscriber) {
  119.                 // If letter sent for subscriber, we create a problem report entry
  120.                 $problem = Mage::getModel('newsletter/problem');
  121.                 $problem->addSubscriberData($subscriber);
  122.                 if(!is_null($queue)) {
  123.                     $problem->addQueueData($queue);
  124.                 }
  125.                 $problem->addErrorData($e);
  126.                 $problem->save();
  127.  
  128.                 if(!is_null($queue)) {
  129.                     $subscriber->received($queue);
  130.                 }
  131.             } else {
  132.                 // Otherwise throw error to upper level
  133.                 throw $e;
  134.             }
  135.             return false;
  136.         }
  137.  
  138.         return true;
  139.     }
  140.     
  141. }

Documentation generated on Fri, 09 Oct 2015 03:37:11 +0200 by phpDocumentor 1.4.4