Mailer.php 5.91 KB
Newer Older
1 2 3 4 5 6 7
<?php
/**
 * @link http://www.yiiframework.com/
 * @copyright Copyright (c) 2008 Yii Software LLC
 * @license http://www.yiiframework.com/license/
 */

Paul Klimov committed
8
namespace yii\swiftmailer;
9

10
use Yii;
11
use yii\base\InvalidConfigException;
12
use yii\mail\BaseMailer;
13 14

/**
Qiang Xue committed
15 16 17
 * Mailer implements a mailer based on SwiftMailer.
 *
 * To use Mailer, you should configure it in the application configuration like the following,
18 19
 *
 * ~~~
Qiang Xue committed
20
 * 'components' => [
21
 *     ...
Qiang Xue committed
22
 *     'email' => [
23
 *         'class' => 'yii\swiftmailer\Mailer',
24 25 26 27 28 29 30 31
 *         'transport' => [
 *             'class' => 'Swift_SmtpTransport',
 *             'host' => 'localhost',
 *             'username' => 'username',
 *             'password' => 'password',
 *             'port' => '587',
 *             'encryption' => 'tls',
 *         ],
Qiang Xue committed
32
 *     ],
33
 *     ...
Qiang Xue committed
34
 * ],
35 36
 * ~~~
 *
Qiang Xue committed
37 38 39
 * You may also skip the configuration of the [[transport]] property. In that case, the default
 * PHP `mail()` function will be used to send emails.
 *
40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56
 * You specify the transport constructor arguments using 'constructArgs' key in the config.
 * You can also specify the list of plugins, which should be registered to the transport using
 * 'plugins' key. For example:
 *
 * ~~~
 * 'transport' => [
 *     'class' => 'Swift_SmtpTransport',
 *     'constructArgs' => ['localhost', 25]
 *     'plugins' => [
 *         [
 *             'class' => 'Swift_Plugins_ThrottlerPlugin',
 *             'constructArgs' => [20],
 *         ],
 *     ],
 * ],
 * ~~~
 *
Qiang Xue committed
57 58 59 60 61 62 63 64 65
 * To send an email, you may use the following code:
 *
 * ~~~
 * Yii::$app->mail->compose('contact/html', ['contactForm' => $form])
 *     ->setFrom('from@domain.com')
 *     ->setTo($form->email)
 *     ->setSubject($form->subject)
 *     ->send();
 * ~~~
66
 *
Qiang Xue committed
67
 * @see http://swiftmailer.org
68
 *
69 70 71 72
 * @property array|\Swift_Mailer $swiftMailer Swift mailer instance or array configuration. This property is
 * read-only.
 * @property array|\Swift_Transport $transport This property is read-only.
 *
73 74 75 76 77
 * @author Paul Klimov <klimov.paul@gmail.com>
 * @since 2.0
 */
class Mailer extends BaseMailer
{
78 79 80 81
	/**
	 * @var string message default class name.
	 */
	public $messageClass = 'yii\swiftmailer\Message';
82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103
	/**
	 * @var \Swift_Mailer Swift mailer instance.
	 */
	private $_swiftMailer;
	/**
	 * @var \Swift_Transport|array Swift transport instance or its array configuration.
	 */
	private $_transport = [];

	/**
	 * @return array|\Swift_Mailer Swift mailer instance or array configuration.
	 */
	public function getSwiftMailer()
	{
		if (!is_object($this->_swiftMailer)) {
			$this->_swiftMailer = $this->createSwiftMailer();
		}
		return $this->_swiftMailer;
	}

	/**
	 * @param array|\Swift_Transport $transport
Qiang Xue committed
104
	 * @throws InvalidConfigException on invalid argument.
105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125
	 */
	public function setTransport($transport)
	{
		if (!is_array($transport) && !is_object($transport)) {
			throw new InvalidConfigException('"' . get_class($this) . '::transport" should be either object or array, "' . gettype($transport) . '" given.');
		}
		$this->_transport = $transport;
	}

	/**
	 * @return array|\Swift_Transport
	 */
	public function getTransport()
	{
		if (!is_object($this->_transport)) {
			$this->_transport = $this->createTransport($this->_transport);
		}
		return $this->_transport;
	}

	/**
Qiang Xue committed
126
	 * @inheritdoc
127
	 */
128
	protected function sendMessage($message)
129
	{
Qiang Xue committed
130 131
		$address = $message->getTo();
		if (is_array($address)) {
132
			$address = implode(', ', array_keys($address));
Qiang Xue committed
133
		}
134
		Yii::info('Sending email "' . $message->getSubject() . '" to "' . $address . '"', __METHOD__);
Qiang Xue committed
135
		return $this->getSwiftMailer()->send($message->getSwiftMessage()) > 0;
136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153
	}

	/**
	 * Creates Swift mailer instance.
	 * @return \Swift_Mailer mailer instance.
	 */
	protected function createSwiftMailer()
	{
		return \Swift_Mailer::newInstance($this->getTransport());
	}

	/**
	 * Creates email transport instance by its array configuration.
	 * @param array $config transport configuration.
	 * @throws \yii\base\InvalidConfigException on invalid transport configuration.
	 * @return \Swift_Transport transport instance.
	 */
	protected function createTransport(array $config)
154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181
	{
		if (!isset($config['class'])) {
			$config['class'] = 'Swift_MailTransport';
		}
		if (isset($config['plugins'])) {
			$plugins = $config['plugins'];
			unset($config['plugins']);
		}
		/** @var \Swift_MailTransport $transport */
		$transport = $this->createSwiftObject($config);
		if (isset($plugins)) {
			foreach ($plugins as $plugin) {
				if (is_array($plugin) && isset($plugin['class'])) {
					$plugin = $this->createSwiftObject($plugin);
				}
				$transport->registerPlugin($plugin);
			}
		}
		return $transport;
	}

	/**
	 * Creates Swift library object, from given array configuration.
	 * @param array $config object configuration
	 * @return Object created object
	 * @throws \yii\base\InvalidConfigException on invalid configuration.
	 */
	protected function createSwiftObject(array $config)
182
	{
183
		if (isset($config['class'])) {
184 185 186
			$className = $config['class'];
			unset($config['class']);
		} else {
187 188 189 190 191 192 193 194 195 196 197 198
			throw new InvalidConfigException('Object configuration must be an array containing a "class" element.');
		}
		if (isset($config['constructArgs'])) {
			$args = [];
			foreach ($config['constructArgs'] as $arg) {
				if (is_array($arg) && isset($arg['class'])) {
					$args[] = $this->createSwiftObject($arg);
				} else {
					$args[] = $arg;
				}
			}
			unset($config['constructArgs']);
199
			array_unshift($args, $className);
200 201 202
			$object = call_user_func_array(['Yii', 'createObject'], $args);
		} else {
			$object = new $className;
203 204 205
		}
		if (!empty($config)) {
			foreach ($config as $name => $value) {
206 207
				if (property_exists($object, $name)) {
					$object->$name = $value;
208 209
				} else {
					$setter = 'set' . $name;
210 211
					if (method_exists($object, $setter) || method_exists($object, '__call')) {
						$object->$setter($value);
212
					} else {
213
						throw new InvalidConfigException('Setting unknown property: ' . $className . '::' . $name);
214 215 216 217
					}
				}
			}
		}
218
		return $object;
219
	}
220
}