Source for file Template.php

Documentation is available at Template.php

  1. <?php
  2.  
  3. /**
  4.  * This class wraps the Template email sending functionality
  5.  * If SMTP Pro is enabled it will send emails using the given
  6.  * configuration.
  7.  *
  8.  * @author Ashley Schroder (aschroder.com)
  9.  */
  10.  
  11. class Aschroder_SMTPPro_Model_Email_Template extends Magentron_EmailImages_Model_Email_Template {
  12.     
  13.     public function send($email, $name=null, array $variables = array()) {
  14.         
  15.         // If it's not enabled, just return the parent result.
  16.         if (!Mage::helper('smtppro')->isEnabled()) {
  17.              return parent::send($email, $name, $variables);
  18.         } 
  19.  
  20.         Mage::log('SMTPPro is enabled, sending email in Aschroder_SMTPPro_Model_Email_Template');        
  21.        
  22.         
  23.         // The remainder of this function closely mirrors the parent
  24.         // method except for providing the SMTP auth details from the 
  25.         // configuration. This is not good OO, but the parent class 
  26.         // leaves little room for useful subclassing. This will probably 
  27.         // become redundant sooner or later anyway.         
  28.         
  29.         if(!$this->isValidForSend()) {
  30.             Mage::log('SMTPPro: Email not valid for sending - check template, and smtp enabled/disabled setting');        
  31.             Mage::logException(new Exception('This letter cannot be sent.')); // translation is intentionally omitted
  32.             return false;
  33.         }
  34.  
  35.         $emails = array_values((array)$email);
  36.         $names = is_array($name) ? $name : (array)$name;
  37.         $names = array_values($names);
  38.         foreach ($emails as $key => $email) {
  39.             if (!isset($names[$key])) {
  40.                 $names[$key] = substr($email, 0, strpos($email, '@'));
  41.             }
  42.         }
  43.  
  44.         $variables['email'] = reset($emails);
  45.         $variables['name'] = reset($names);
  46.         
  47.         $mail = $this->getMail();
  48.         
  49.            $dev = Mage::helper('smtppro')->getDevelopmentMode();
  50.            
  51.         if ($dev == "contact") {
  52.             
  53.             $email = Mage::getStoreConfig('contacts/email/recipient_email', $this->getDesignConfig()->getStore());
  54.             Mage::log("Development mode set to send all emails to contact form recipient: " . $email);
  55.             
  56.         } elseif ($dev == "supress") {
  57.             
  58.             Mage::log("Development mode set to supress all emails.");
  59.             # we bail out, but report success
  60.             return true;
  61.         }
  62.         
  63.         // In Magento core they set the Return-Path here, for the sendmail command.
  64.         // we assume our outbound SMTP server (or Gmail) will set that.
  65.         
  66.         foreach ($emails as $key => $email) {
  67.             $mail->addTo($email, '=?utf-8?B?' . base64_encode($names[$key]) . '?=');
  68.         }
  69.         
  70.  
  71.         $this->setUseAbsoluteLinks(true);
  72.         $text = $this->getProcessedTemplate($variables, true);
  73.  
  74.         if($this->isPlain()) {
  75.             $mail->setBodyText($text);
  76.         } else {
  77.             $mail->setBodyHTML($text);
  78.         }
  79.  
  80.         $mail->setSubject('=?utf-8?B?'.base64_encode($this->getProcessedTemplateSubject($variables)).'?=');
  81.         $mail->setFrom($this->getSenderEmail(), $this->getSenderName());
  82.  
  83.         // If we are using store emails as reply-to's set the header
  84.         // Check the header is not already set by the application.
  85.         // The contact form, for example, set's it to the sender of 
  86.         // the contact. Thanks i960 for pointing this out.
  87.  
  88.         if (Mage::helper('smtppro')->isReplyToStoreEmail()
  89.             && !array_key_exists('Reply-To', $mail->getHeaders())) {
  90.  
  91.             // Patch for Zend upgrade
  92.             // Later versions of Zend have a method for this, and disallow direct header setting...
  93.             if (method_exists($mail, "setReplyTo")) {
  94.                 $mail->setReplyTo($this->getSenderEmail(), $this->getSenderName());
  95.             } else {
  96.                 $mail->addHeader('Reply-To', $this->getSenderEmail());
  97.             }
  98.             Mage::log('ReplyToStoreEmail is enabled, just set Reply-To header: ' . $this->getSenderEmail());
  99.                 
  100.         }
  101.  
  102.         $transport = Mage::helper('smtppro')->getTransport($this->getDesignConfig()->getStore());
  103.         
  104.         try {
  105.             
  106.             Mage::log('About to send email');
  107.             $mail->send($transport); // Zend_Mail warning..
  108.             Mage::log('Finished sending email');
  109.             
  110.             // Record one email for each receipient
  111.              foreach ($emails as $key => $email) {
  112.                 Mage::dispatchEvent('smtppro_email_after_send', 
  113.                      array('to' => $email,
  114.                          'template' => $this->getTemplateId(),
  115.                          'subject' => $this->getProcessedTemplateSubject($variables),
  116.                          'html' => !$this->isPlain(),
  117.                          'email_body' => $text));
  118.                      
  119.             }
  120.             
  121.             $this->_mail = null;
  122.         }
  123.         catch (Exception $e) {
  124.             Mage::logException($e);
  125.             return false;
  126.         }
  127.  
  128.         return true;
  129.     }
  130. }

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