1. sfMailer.class.php
  2. /**
 * sfMailer is the main entry point for the mailer system.
 *
 * This class is instanciated by sfContext on demand.
 *
 * @package    symfony
 * @subpackage mailer
 * @author     Fabien Potencier 
 * @version    SVN: $Id: sfMailer.class.php 23810 2009-11-12 11:07:44Z Kris.Wallsmith $
 */
  3. class sfMailer extends Swift_Mailer
  4. {
  5.   const
  6.     REALTIME       = 'realtime',
  7.     SPOOL          = 'spool',
  8.     SINGLE_ADDRESS = 'single_address',
  9.     NONE           = 'none';
  11.   protected
  12.     $spool             = null,
  13.     $logger            = null,
  14.     $strategy          = 'realtime',
  15.     $address           = '',
  16.     $realtimeTransport = null,
  17.     $force             = false;
  19.   /**
  20.    * Constructor.
  21.    *
  22.    * Available options:
  23.    *
  24.    *  * charset: The default charset to use for messages
  25.    *  * logging: Whether to enable logging or not
  26.    *  * delivery_strategy: The delivery strategy to use
  27.    *  * spool_class: The spool class (for the spool strategy)
  28.    *  * spool_arguments: The arguments to pass to the spool constructor
  29.    *  * delivery_address: The email address to use for the single_address strategy
  30.    *  * transport: The main transport configuration
  31.    *  *   * class: The main transport class
  32.    *  *   * param: The main transport parameters
  33.    *
  34.    * @param sfEventDispatcher $dispatcher An event dispatcher instance
  35.    * @param array             $options    An array of options
  36.    */
  37.   public function __construct(sfEventDispatcher $dispatcher, $options)
  38.   {
  39.     // options
  40.     $options = array_merge(array(
  41.       'charset' => 'UTF-8',
  42.       'logging' => false,
  43.       'delivery_strategy' => 'realtime',
  44.       'transport' => array(
  45.         'class' => 'Swift_MailTransport',
  46.         'param' => array(),
  47.        ),
  48.     ), $options);
  50.     $constantName = 'sfMailer::'.strtoupper($options['delivery_strategy']);
  51.     $this->strategy = defined($constantName) ? constant($constantName) : false;
  52.     if (!$this->strategy)
  53.     {
  54.       throw new InvalidArgumentException(sprintf('Unknown mail delivery strategy "%s" (should be one of realtime, spool, single_address, or none)', $options['delivery_strategy']));
  55.     }
  57.     // transport
  58.     $class = $options['transport']['class'];
  59.     $transport = new $class();
  60.     if (isset($options['transport']['param']))
  61.     {
  62.       foreach ($options['transport']['param'] as $key => $value)
  63.       {
  64.         $method = 'set'.ucfirst($key);
  65.         if (method_exists($transport, $method))
  66.         {
  67.           $transport->$method($value);
  68.         }
  69.         elseif (method_exists($transport, 'getExtensionHandlers'))
  70.         {
  71.           foreach ($transport->getExtensionHandlers() as $handler)
  72.           {
  73.             if (in_array(strtolower($method), array_map('strtolower', (array) $handler->exposeMixinMethods())))
  74.             {
  75.               $transport->$method($value);
  76.             }
  77.           }
  78.         }
  79.       }
  80.     }
  81.     $this->realtimeTransport = $transport;
  83.     if (sfMailer::SPOOL == $this->strategy)
  84.     {
  85.       if (!isset($options['spool_class']))
  86.       {
  87.         throw new InvalidArgumentException('For the spool mail delivery strategy, you must also define a spool_class option');
  88.       }
  89.       $arguments = isset($options['spool_arguments']) ? $options['spool_arguments'] : array();
  91.       if ($arguments)
  92.       {
  93.         $r = new ReflectionClass($options['spool_class']);
  94.         $this->spool = $r->newInstanceArgs($arguments);
  95.       }
  96.       else
  97.       {
  98.         $this->spool = new $options['spool_class'];
  99.       }
  101.       $transport = new Swift_SpoolTransport($this->spool);
  102.     }
  103.     elseif (sfMailer::SINGLE_ADDRESS == $this->strategy)
  104.     {
  105.       if (!isset($options['delivery_address']))
  106.       {
  107.         throw new InvalidArgumentException('For the single_address mail delivery strategy, you must also define a delivery_address option');
  108.       }
  110.       $this->address = $options['delivery_address'];
  112.       $transport->registerPlugin(new Swift_Plugins_RedirectingPlugin($this->address));
  113.     }
  115.     parent::__construct($transport);
  117.     // logger
  118.     if ($options['logging'])
  119.     {
  120.       $this->logger = new sfMailerMessageLoggerPlugin($dispatcher);
  122.       $transport->registerPlugin($this->logger);
  123.     }
  125.     if (sfMailer::NONE == $this->strategy)
  126.     {
  127.       // must be registered after logging
  128.       $transport->registerPlugin(new Swift_Plugins_BlackholePlugin());
  129.     }
  131.     // preferences
  132.     Swift_Preferences::getInstance()->setCharset($options['charset']);
  134.     $dispatcher->notify(new sfEvent($this, 'mailer.configure'));
  135.   }
  137.   /**
  138.    * Gets the realtime transport instance.
  139.    *
  140.    * @return Swift_Transport The realtime transport instance.
  141.    */
  142.   public function getRealtimeTransport()
  143.   {
  144.     return $this->realtimeTransport;
  145.   }
  147.   /**
  148.    * Sets the realtime transport instance.
  149.    *
  150.    * @param Swift_Transport $transport The realtime transport instance.
  151.    */
  152.   public function setRealtimeTransport(Swift_Transport $transport)
  153.   {
  154.     $this->realtimeTransport = $transport;
  155.   }
  157.   /**
  158.    * Gets the logger instance.
  159.    *
  160.    * @return sfMailerMessageLoggerPlugin The logger instance.
  161.    */
  162.   public function getLogger()
  163.   {
  164.     return $this->logger;
  165.   }
  167.   /**
  168.    * Sets the logger instance.
  169.    *
  170.    * @param sfMailerMessageLoggerPlugin $logger The logger instance.
  171.    */
  172.   public function setLogger($logger)
  173.   {
  174.     $this->logger = $logger;
  175.   }
  177.   /**
  178.    * Gets the delivery strategy.
  179.    *
  180.    * @return string The delivery strategy
  181.    */
  182.   public function getDeliveryStrategy()
  183.   {
  184.     return $this->strategy;
  185.   }
  187.   /**
  188.    * Gets the delivery address.
  189.    *
  190.    * @return string The delivery address
  191.    */
  192.   public function getDeliveryAddress()
  193.   {
  194.     return $this->address;
  195.   }
  197.   /**
  198.    * Sets the delivery address.
  199.    *
  200.    * @param string $address The delivery address
  201.    */
  202.   public function setDeliveryAddress($address)
  203.   {
  204.     $this->address = $address;
  205.   }
  207.   /**
  208.    * Creates a new message.
  209.    *
  210.    * @param string|array $from    The from address
  211.    * @param string|array $to      The recipient(s)
  212.    * @param string       $subject The subject
  213.    * @param string       $body    The body
  214.    *
  215.    * @return Swift_Message A Swift_Message instance
  216.    */
  217.   public function compose($from = null, $to = null, $subject = null, $body = null)
  218.   {
  219.     return Swift_Message::newInstance()
  220.       ->setFrom($from)
  221.       ->setTo($to)
  222.       ->setSubject($subject)
  223.       ->setBody($body)
  224.     ;
  225.   }
  227.   /**
  228.    * Sends a message.
  229.    *
  230.    * @param string|array $from    The from address
  231.    * @param string|array $to      The recipient(s)
  232.    * @param string       $subject The subject
  233.    * @param string       $body    The body
  234.    *
  235.    * @return int The number of sent emails
  236.    */
  237.   public function composeAndSend($from, $to, $subject, $body)
  238.   {
  239.     return $this->send($this->compose($from, $to, $subject, $body));
  240.   }
  242.   /**
  243.    * Forces the next call to send() to use the realtime strategy.
  244.    *
  245.    * @return sfMailer The current sfMailer instance
  246.    */
  247.   public function sendNextImmediately()
  248.   {
  249.     $this->force = true;
  251.     return $this;
  252.   }
  254.   /**
  255.    * Sends the given message.
  256.    *
  257.    * @param Swift_Transport $transport         A transport instance
  258.    * @param string[]        &$failedRecipients An array of failures by-reference
  259.    *
  260.    * @return int|false The number of sent emails
  261.    */
  262.   public function send(Swift_Mime_Message $message, &$failedRecipients = null)
  263.   {
  264.     if ($this->force)
  265.     {
  266.       $this->force = false;
  268.       if (!$this->realtimeTransport->isStarted())
  269.       {
  270.         $this->realtimeTransport->start();
  271.       }
  273.       return $this->realtimeTransport->send($message, $failedRecipients);
  274.     }
  276.     return parent::send($message, $failedRecipients);
  277.   }
  279.   /**
  280.    * Sends the current messages in the spool.
  281.    *
  282.    * The return value is the number of recipients who were accepted for delivery.
  283.    *
  284.    * @param string[] &$failedRecipients An array of failures by-reference
  285.    *
  286.    * @return int The number of sent emails
  287.    */
  288.   public function flushQueue(&$failedRecipients = null)
  289.   {
  290.     return $this->getSpool()->flushQueue($this->realtimeTransport, $failedRecipients);
  291.   }
  293.   public function getSpool()
  294.   {
  295.     if (self::SPOOL != $this->strategy)
  296.     {
  297.       throw new LogicException(sprintf('You can only send messages in the spool if the delivery strategy is "spool" (%s is the current strategy).', $this->strategy));
  298.     }
  300.     return $this->spool;
  301.   }
  303.   static public function initialize()
  304.   {
  305.     require_once sfConfig::get('sf_symfony_lib_dir').'/vendor/swiftmailer/swift_init.php';
  306.   }
  307. }
Debug toolbar