vendor/symfony/swiftmailer-bundle/DependencyInjection/SwiftmailerTransportFactory.php line 28

Open in your IDE?
  1. <?php
  3. /*
  4. * This file is part of the Symfony package.
  5. *
  6. * (c) Fabien Potencier <fabien@symfony.com>
  7. *
  8. * For the full copyright and license information, please view the LICENSE
  9. * file that was distributed with this source code.
  10. */
  12. namespace Symfony\Bundle\SwiftmailerBundle\DependencyInjection;
  14. use Symfony\Component\Routing\RequestContext;
  16. /**
  17. * Factory to create a \Swift_Transport object.
  18. *
  19. * @author Romain Gautier <mail@romain.sh>
  20. */
  21. class SwiftmailerTransportFactory
  22. {
  23. /**
  24. * @return \Swift_Transport
  25. *
  26. * @throws \InvalidArgumentException if the scheme is not a built-in Swiftmailer transport
  27. */
  28. public static function createTransport(array $options, RequestContext $requestContext = null, \Swift_Events_EventDispatcher $eventDispatcher)
  29. {
  30. $options = static::resolveOptions($options);
  32. self::validateConfig($options);
  33. if ('smtp' === $options['transport']) {
  34. $smtpAuthHandler = new \Swift_Transport_Esmtp_AuthHandler([
  35. new \Swift_Transport_Esmtp_Auth_CramMd5Authenticator(),
  36. new \Swift_Transport_Esmtp_Auth_LoginAuthenticator(),
  37. new \Swift_Transport_Esmtp_Auth_PlainAuthenticator(),
  38. new \Swift_Transport_Esmtp_Auth_NTLMAuthenticator(),
  39. ]);
  40. $smtpAuthHandler->setUsername($options['username']);
  41. $smtpAuthHandler->setPassword($options['password']);
  42. $smtpAuthHandler->setAuthMode($options['auth_mode']);
  44. $transport = new \Swift_Transport_EsmtpTransport(
  45. new \Swift_Transport_StreamBuffer(new \Swift_StreamFilters_StringReplacementFilterFactory()),
  46. [$smtpAuthHandler],
  47. $eventDispatcher
  48. );
  49. $transport->setHost($options['host']);
  50. $transport->setPort($options['port']);
  51. $transport->setEncryption($options['encryption']);
  52. $transport->setTimeout($options['timeout']);
  53. $transport->setSourceIp($options['source_ip']);
  54. $transport->setStreamOptions($options['stream_options']);
  56. $smtpTransportConfigurator = new SmtpTransportConfigurator($options['local_domain'], $requestContext);
  57. $smtpTransportConfigurator->configure($transport);
  58. } elseif ('sendmail' === $options['transport']) {
  59. $transport = new \Swift_Transport_SendmailTransport(
  60. new \Swift_Transport_StreamBuffer(new \Swift_StreamFilters_StringReplacementFilterFactory()),
  61. $eventDispatcher
  62. );
  64. $transport->setCommand($options['command']);
  66. $smtpTransportConfigurator = new SmtpTransportConfigurator($options['local_domain'], $requestContext);
  67. $smtpTransportConfigurator->configure($transport);
  68. } elseif ('null' === $options['transport']) {
  69. $transport = new \Swift_Transport_NullTransport($eventDispatcher);
  70. } else {
  71. throw new \InvalidArgumentException(sprintf('Not a built-in Swiftmailer transport: %s.', $options['transport']));
  72. }
  74. return $transport;
  75. }
  77. /**
  78. * @return array options
  79. */
  80. public static function resolveOptions(array $options)
  81. {
  82. $options += [
  83. 'transport' => null,
  84. 'username' => null,
  85. 'password' => null,
  86. 'host' => null,
  87. 'port' => null,
  88. 'timeout' => null,
  89. 'source_ip' => null,
  90. 'local_domain' => null,
  91. 'encryption' => null,
  92. 'auth_mode' => null,
  93. 'command' => null,
  94. 'stream_options' => [],
  95. ];
  97. if (isset($options['url'])) {
  98. if (false === $parts = parse_url($options['url'])) {
  99. throw new \InvalidArgumentException(sprintf('The Swiftmailer URL "%s" is not valid.', $options['url']));
  100. }
  101. if (isset($parts['scheme'])) {
  102. $options['transport'] = $parts['scheme'];
  103. }
  104. if (isset($parts['user'])) {
  105. $options['username'] = rawurldecode($parts['user']);
  106. }
  107. if (isset($parts['pass'])) {
  108. $options['password'] = rawurldecode($parts['pass']);
  109. }
  110. if (isset($parts['host'])) {
  111. $options['host'] = rawurldecode($parts['host']);
  112. }
  113. if (isset($parts['port'])) {
  114. $options['port'] = $parts['port'];
  115. }
  116. if (isset($parts['query'])) {
  117. parse_str($parts['query'], $query);
  118. foreach ($options as $key => $value) {
  119. if (isset($query[$key]) && '' != $query[$key]) {
  120. $options[$key] = $query[$key];
  121. }
  122. }
  123. }
  124. }
  126. if (!isset($options['transport'])) {
  127. $options['transport'] = 'null';
  128. } elseif ('gmail' === $options['transport']) {
  129. $options['encryption'] = 'ssl';
  130. $options['auth_mode'] = 'login';
  131. $options['host'] = 'smtp.gmail.com';
  132. $options['transport'] = 'smtp';
  133. }
  135. if (!isset($options['port'])) {
  136. $options['port'] = 'ssl' === $options['encryption'] ? 465 : 25;
  137. }
  139. return $options;
  140. }
  142. /**
  143. * @throws \InvalidArgumentException if the encryption is not valid
  144. */
  145. public static function validateConfig($options)
  146. {
  147. if (!\in_array($options['encryption'], ['tcp', 'tls', 'ssl', null], true)) {
  148. throw new \InvalidArgumentException(sprintf('The %s encryption is not supported', $options['encryption']));
  149. }
  151. if (!\in_array($options['auth_mode'], ['plain', 'login', 'cram-md5', 'ntlm', null], true)) {
  152. throw new \InvalidArgumentException(sprintf('The %s authentication mode is not supported', $options['auth_mode']));
  153. }
  154. }
  155. }