Dolibarr / dolibarr

htdocs/includes/swiftmailer/lib/classes/Swift/Transport/AbstractSmtpTransport.php

Indentation +523 added lines, -523 removed lines

@@ -15,527 +15,527 @@
  */
 abstract class Swift_Transport_AbstractSmtpTransport implements Swift_Transport
 {
-    /** Input-Output buffer for sending/receiving SMTP commands and responses */
-    protected $buffer;
-
-    /** Connection status */
-    protected $started = false;
-
-    /** The domain name to use in HELO command */
-    protected $domain = '[127.0.0.1]';
-
-    /** The event dispatching layer */
-    protected $eventDispatcher;
-
-    protected $addressEncoder;
-
-    /** Whether the PIPELINING SMTP extension is enabled (RFC 2920) */
-    protected $pipelining = null;
-
-    /** The pipelined commands waiting for response */
-    protected $pipeline = [];
-
-    /** Source Ip */
-    protected $sourceIp;
-
-    /** Return an array of params for the Buffer */
-    abstract protected function getBufferParams();
-
-    /**
-     * Creates a new EsmtpTransport using the given I/O buffer.
-     *
-     * @param string $localDomain
-     */
-    public function __construct(Swift_Transport_IoBuffer $buf, Swift_Events_EventDispatcher $dispatcher, $localDomain = '127.0.0.1', Swift_AddressEncoder $addressEncoder = null)
-    {
-        $this->buffer = $buf;
-        $this->eventDispatcher = $dispatcher;
-        $this->addressEncoder = $addressEncoder ?? new Swift_AddressEncoder_IdnAddressEncoder();
-        $this->setLocalDomain($localDomain);
-    }
-
-    /**
-     * Set the name of the local domain which Swift will identify itself as.
-     *
-     * This should be a fully-qualified domain name and should be truly the domain
-     * you're using.
-     *
-     * If your server does not have a domain name, use the IP address. This will
-     * automatically be wrapped in square brackets as described in RFC 5321,
-     * section 4.1.3.
-     *
-     * @param string $domain
-     *
-     * @return $this
-     */
-    public function setLocalDomain($domain)
-    {
-        if ('[' !== substr($domain, 0, 1)) {
-            if (filter_var($domain, FILTER_VALIDATE_IP, FILTER_FLAG_IPV4)) {
-                $domain = '['.$domain.']';
-            } elseif (filter_var($domain, FILTER_VALIDATE_IP, FILTER_FLAG_IPV6)) {
-                $domain = '[IPv6:'.$domain.']';
-            }
-        }
-
-        $this->domain = $domain;
-
-        return $this;
-    }
-
-    /**
-     * Get the name of the domain Swift will identify as.
-     *
-     * If an IP address was specified, this will be returned wrapped in square
-     * brackets as described in RFC 5321, section 4.1.3.
-     *
-     * @return string
-     */
-    public function getLocalDomain()
-    {
-        return $this->domain;
-    }
-
-    /**
-     * Sets the source IP.
-     *
-     * @param string $source
-     */
-    public function setSourceIp($source)
-    {
-        $this->sourceIp = $source;
-    }
-
-    /**
-     * Returns the IP used to connect to the destination.
-     *
-     * @return string
-     */
-    public function getSourceIp()
-    {
-        return $this->sourceIp;
-    }
-
-    public function setAddressEncoder(Swift_AddressEncoder $addressEncoder)
-    {
-        $this->addressEncoder = $addressEncoder;
-    }
-
-    public function getAddressEncoder()
-    {
-        return $this->addressEncoder;
-    }
-
-    /**
-     * Start the SMTP connection.
-     */
-    public function start()
-    {
-        if (!$this->started) {
-            if ($evt = $this->eventDispatcher->createTransportChangeEvent($this)) {
-                $this->eventDispatcher->dispatchEvent($evt, 'beforeTransportStarted');
-                if ($evt->bubbleCancelled()) {
-                    return;
-                }
-            }
-
-            try {
-                $this->buffer->initialize($this->getBufferParams());
-            } catch (Swift_TransportException $e) {
-                $this->throwException($e);
-            }
-            $this->readGreeting();
-            $this->doHeloCommand();
-
-            if ($evt) {
-                $this->eventDispatcher->dispatchEvent($evt, 'transportStarted');
-            }
-
-            $this->started = true;
-        }
-    }
-
-    /**
-     * Test if an SMTP connection has been established.
-     *
-     * @return bool
-     */
-    public function isStarted()
-    {
-        return $this->started;
-    }
-
-    /**
-     * Send the given Message.
-     *
-     * Recipient/sender data will be retrieved from the Message API.
-     * The return value is the number of recipients who were accepted for delivery.
-     *
-     * @param string[] $failedRecipients An array of failures by-reference
-     *
-     * @return int
-     */
-    public function send(Swift_Mime_SimpleMessage $message, &$failedRecipients = null)
-    {
-        if (!$this->isStarted()) {
-            $this->start();
-        }
-
-        $sent = 0;
-        $failedRecipients = (array) $failedRecipients;
-
-        if ($evt = $this->eventDispatcher->createSendEvent($this, $message)) {
-            $this->eventDispatcher->dispatchEvent($evt, 'beforeSendPerformed');
-            if ($evt->bubbleCancelled()) {
-                return 0;
-            }
-        }
-
-        if (!$reversePath = $this->getReversePath($message)) {
-            $this->throwException(new Swift_TransportException('Cannot send message without a sender address'));
-        }
-
-        $to = (array) $message->getTo();
-        $cc = (array) $message->getCc();
-        $bcc = (array) $message->getBcc();
-        $tos = array_merge($to, $cc, $bcc);
-
-        $message->setBcc([]);
-
-        try {
-            $sent += $this->sendTo($message, $reversePath, $tos, $failedRecipients);
-        } finally {
-            $message->setBcc($bcc);
-        }
-
-        if ($evt) {
-            if ($sent == \count($to) + \count($cc) + \count($bcc)) {
-                $evt->setResult(Swift_Events_SendEvent::RESULT_SUCCESS);
-            } elseif ($sent > 0) {
-                $evt->setResult(Swift_Events_SendEvent::RESULT_TENTATIVE);
-            } else {
-                $evt->setResult(Swift_Events_SendEvent::RESULT_FAILED);
-            }
-            $evt->setFailedRecipients($failedRecipients);
-            $this->eventDispatcher->dispatchEvent($evt, 'sendPerformed');
-        }
-
-        $message->generateId(); //Make sure a new Message ID is used
-
-        return $sent;
-    }
-
-    /**
-     * Stop the SMTP connection.
-     */
-    public function stop()
-    {
-        if ($this->started) {
-            if ($evt = $this->eventDispatcher->createTransportChangeEvent($this)) {
-                $this->eventDispatcher->dispatchEvent($evt, 'beforeTransportStopped');
-                if ($evt->bubbleCancelled()) {
-                    return;
-                }
-            }
-
-            try {
-                $this->executeCommand("QUIT\r\n", [221]);
-            } catch (Swift_TransportException $e) {
-            }
-
-            try {
-                $this->buffer->terminate();
-
-                if ($evt) {
-                    $this->eventDispatcher->dispatchEvent($evt, 'transportStopped');
-                }
-            } catch (Swift_TransportException $e) {
-                $this->throwException($e);
-            }
-        }
-        $this->started = false;
-    }
-
-    /**
-     * {@inheritdoc}
-     */
-    public function ping()
-    {
-        try {
-            if (!$this->isStarted()) {
-                $this->start();
-            }
-
-            $this->executeCommand("NOOP\r\n", [250]);
-        } catch (Swift_TransportException $e) {
-            try {
-                $this->stop();
-            } catch (Swift_TransportException $e) {
-            }
-
-            return false;
-        }
-
-        return true;
-    }
-
-    /**
-     * Register a plugin.
-     */
-    public function registerPlugin(Swift_Events_EventListener $plugin)
-    {
-        $this->eventDispatcher->bindEventListener($plugin);
-    }
-
-    /**
-     * Reset the current mail transaction.
-     */
-    public function reset()
-    {
-        $this->executeCommand("RSET\r\n", [250], $failures, true);
-    }
-
-    /**
-     * Get the IoBuffer where read/writes are occurring.
-     *
-     * @return Swift_Transport_IoBuffer
-     */
-    public function getBuffer()
-    {
-        return $this->buffer;
-    }
-
-    /**
-     * Run a command against the buffer, expecting the given response codes.
-     *
-     * If no response codes are given, the response will not be validated.
-     * If codes are given, an exception will be thrown on an invalid response.
-     * If the command is RCPT TO, and the pipeline is non-empty, no exception
-     * will be thrown; instead the failing address is added to $failures.
-     *
-     * @param string   $command
-     * @param int[]    $codes
-     * @param string[] $failures An array of failures by-reference
-     * @param bool     $pipeline Do not wait for response
-     * @param string   $address  the address, if command is RCPT TO
-     *
-     * @return string|null The server response, or null if pipelining is enabled
-     */
-    public function executeCommand($command, $codes = [], &$failures = null, $pipeline = false, $address = null)
-    {
-        $failures = (array) $failures;
-        $seq = $this->buffer->write($command);
-        if ($evt = $this->eventDispatcher->createCommandEvent($this, $command, $codes)) {
-            $this->eventDispatcher->dispatchEvent($evt, 'commandSent');
-        }
-
-        $this->pipeline[] = [$command, $seq, $codes, $address];
-
-        if ($pipeline && $this->pipelining) {
-            return null;
-        }
-
-        $response = null;
-
-        while ($this->pipeline) {
-            list($command, $seq, $codes, $address) = array_shift($this->pipeline);
-            $response = $this->getFullResponse($seq);
-            try {
-                $this->assertResponseCode($response, $codes);
-            } catch (Swift_TransportException $e) {
-                if ($this->pipeline && $address) {
-                    $failures[] = $address;
-                } else {
-                    $this->throwException($e);
-                }
-            }
-        }
-
-        return $response;
-    }
-
-    /** Read the opening SMTP greeting */
-    protected function readGreeting()
-    {
-        $this->assertResponseCode($this->getFullResponse(0), [220]);
-    }
-
-    /** Send the HELO welcome */
-    protected function doHeloCommand()
-    {
-        $this->executeCommand(
-            sprintf("HELO %s\r\n", $this->domain), [250]
-            );
-    }
-
-    /** Send the MAIL FROM command */
-    protected function doMailFromCommand($address)
-    {
-        $address = $this->addressEncoder->encodeString($address);
-        $this->executeCommand(
-            sprintf("MAIL FROM:<%s>\r\n", $address), [250], $failures, true
-            );
-    }
-
-    /** Send the RCPT TO command */
-    protected function doRcptToCommand($address)
-    {
-        $address = $this->addressEncoder->encodeString($address);
-        $this->executeCommand(
-            sprintf("RCPT TO:<%s>\r\n", $address), [250, 251, 252], $failures, true, $address
-            );
-    }
-
-    /** Send the DATA command */
-    protected function doDataCommand(&$failedRecipients)
-    {
-        $this->executeCommand("DATA\r\n", [354], $failedRecipients);
-    }
-
-    /** Stream the contents of the message over the buffer */
-    protected function streamMessage(Swift_Mime_SimpleMessage $message)
-    {
-        $this->buffer->setWriteTranslations(["\r\n." => "\r\n.."]);
-        try {
-            $message->toByteStream($this->buffer);
-            $this->buffer->flushBuffers();
-        } catch (Swift_TransportException $e) {
-            $this->throwException($e);
-        }
-        $this->buffer->setWriteTranslations([]);
-        $this->executeCommand("\r\n.\r\n", [250]);
-    }
-
-    /** Determine the best-use reverse path for this message */
-    protected function getReversePath(Swift_Mime_SimpleMessage $message)
-    {
-        $return = $message->getReturnPath();
-        $sender = $message->getSender();
-        $from = $message->getFrom();
-        $path = null;
-        if (!empty($return)) {
-            $path = $return;
-        } elseif (!empty($sender)) {
-            // Don't use array_keys
-            reset($sender); // Reset Pointer to first pos
-            $path = key($sender); // Get key
-        } elseif (!empty($from)) {
-            reset($from); // Reset Pointer to first pos
-            $path = key($from); // Get key
-        }
-
-        return $path;
-    }
-
-    /** Throw a TransportException, first sending it to any listeners */
-    protected function throwException(Swift_TransportException $e)
-    {
-        if ($evt = $this->eventDispatcher->createTransportExceptionEvent($this, $e)) {
-            $this->eventDispatcher->dispatchEvent($evt, 'exceptionThrown');
-            if (!$evt->bubbleCancelled()) {
-                throw $e;
-            }
-        } else {
-            throw $e;
-        }
-    }
-
-    /** Throws an Exception if a response code is incorrect */
-    protected function assertResponseCode($response, $wanted)
-    {
-        if (!$response) {
-            $this->throwException(new Swift_TransportException('Expected response code '.implode('/', $wanted).' but got an empty response'));
-        }
-
-        list($code) = sscanf($response, '%3d');
-        $valid = (empty($wanted) || \in_array($code, $wanted));
-
-        if ($evt = $this->eventDispatcher->createResponseEvent($this, $response,
-            $valid)) {
-            $this->eventDispatcher->dispatchEvent($evt, 'responseReceived');
-        }
-
-        if (!$valid) {
-            $this->throwException(new Swift_TransportException('Expected response code '.implode('/', $wanted).' but got code "'.$code.'", with message "'.$response.'"', $code));
-        }
-    }
-
-    /** Get an entire multi-line response using its sequence number */
-    protected function getFullResponse($seq)
-    {
-        $response = '';
-        try {
-            do {
-                $line = $this->buffer->readLine($seq);
-                $response .= $line;
-            } while (null !== $line && false !== $line && ' ' != $line[3]);
-        } catch (Swift_TransportException $e) {
-            $this->throwException($e);
-        } catch (Swift_IoException $e) {
-            $this->throwException(new Swift_TransportException($e->getMessage(), 0, $e));
-        }
-
-        return $response;
-    }
-
-    /** Send an email to the given recipients from the given reverse path */
-    private function doMailTransaction($message, $reversePath, array $recipients, array &$failedRecipients)
-    {
-        $sent = 0;
-        $this->doMailFromCommand($reversePath);
-        foreach ($recipients as $forwardPath) {
-            try {
-                $this->doRcptToCommand($forwardPath);
-                ++$sent;
-            } catch (Swift_TransportException $e) {
-                $failedRecipients[] = $forwardPath;
-            } catch (Swift_AddressEncoderException $e) {
-                $failedRecipients[] = $forwardPath;
-            }
-        }
-
-        if (0 != $sent) {
-            $sent += \count($failedRecipients);
-            $this->doDataCommand($failedRecipients);
-            $sent -= \count($failedRecipients);
-
-            $this->streamMessage($message);
-        } else {
-            $this->reset();
-        }
-
-        return $sent;
-    }
-
-    /** Send a message to the given To: recipients */
-    private function sendTo(Swift_Mime_SimpleMessage $message, $reversePath, array $to, array &$failedRecipients)
-    {
-        if (empty($to)) {
-            return 0;
-        }
-
-        return $this->doMailTransaction($message, $reversePath, array_keys($to),
-            $failedRecipients);
-    }
-
-    /**
-     * Destructor.
-     */
-    public function __destruct()
-    {
-        try {
-            $this->stop();
-        } catch (Exception $e) {
-        }
-    }
-
-    public function __sleep()
-    {
-        throw new \BadMethodCallException('Cannot serialize '.__CLASS__);
-    }
-
-    public function __wakeup()
-    {
-        throw new \BadMethodCallException('Cannot unserialize '.__CLASS__);
-    }
+	/** Input-Output buffer for sending/receiving SMTP commands and responses */
+	protected $buffer;
+
+	/** Connection status */
+	protected $started = false;
+
+	/** The domain name to use in HELO command */
+	protected $domain = '[127.0.0.1]';
+
+	/** The event dispatching layer */
+	protected $eventDispatcher;
+
+	protected $addressEncoder;
+
+	/** Whether the PIPELINING SMTP extension is enabled (RFC 2920) */
+	protected $pipelining = null;
+
+	/** The pipelined commands waiting for response */
+	protected $pipeline = [];
+
+	/** Source Ip */
+	protected $sourceIp;
+
+	/** Return an array of params for the Buffer */
+	abstract protected function getBufferParams();
+
+	/**
+	 * Creates a new EsmtpTransport using the given I/O buffer.
+	 *
+	 * @param string $localDomain
+	 */
+	public function __construct(Swift_Transport_IoBuffer $buf, Swift_Events_EventDispatcher $dispatcher, $localDomain = '127.0.0.1', Swift_AddressEncoder $addressEncoder = null)
+	{
+		$this->buffer = $buf;
+		$this->eventDispatcher = $dispatcher;
+		$this->addressEncoder = $addressEncoder ?? new Swift_AddressEncoder_IdnAddressEncoder();
+		$this->setLocalDomain($localDomain);
+	}
+
+	/**
+	 * Set the name of the local domain which Swift will identify itself as.
+	 *
+	 * This should be a fully-qualified domain name and should be truly the domain
+	 * you're using.
+	 *
+	 * If your server does not have a domain name, use the IP address. This will
+	 * automatically be wrapped in square brackets as described in RFC 5321,
+	 * section 4.1.3.
+	 *
+	 * @param string $domain
+	 *
+	 * @return $this
+	 */
+	public function setLocalDomain($domain)
+	{
+		if ('[' !== substr($domain, 0, 1)) {
+			if (filter_var($domain, FILTER_VALIDATE_IP, FILTER_FLAG_IPV4)) {
+				$domain = '['.$domain.']';
+			} elseif (filter_var($domain, FILTER_VALIDATE_IP, FILTER_FLAG_IPV6)) {
+				$domain = '[IPv6:'.$domain.']';
+			}
+		}
+
+		$this->domain = $domain;
+
+		return $this;
+	}
+
+	/**
+	 * Get the name of the domain Swift will identify as.
+	 *
+	 * If an IP address was specified, this will be returned wrapped in square
+	 * brackets as described in RFC 5321, section 4.1.3.
+	 *
+	 * @return string
+	 */
+	public function getLocalDomain()
+	{
+		return $this->domain;
+	}
+
+	/**
+	 * Sets the source IP.
+	 *
+	 * @param string $source
+	 */
+	public function setSourceIp($source)
+	{
+		$this->sourceIp = $source;
+	}
+
+	/**
+	 * Returns the IP used to connect to the destination.
+	 *
+	 * @return string
+	 */
+	public function getSourceIp()
+	{
+		return $this->sourceIp;
+	}
+
+	public function setAddressEncoder(Swift_AddressEncoder $addressEncoder)
+	{
+		$this->addressEncoder = $addressEncoder;
+	}
+
+	public function getAddressEncoder()
+	{
+		return $this->addressEncoder;
+	}
+
+	/**
+	 * Start the SMTP connection.
+	 */
+	public function start()
+	{
+		if (!$this->started) {
+			if ($evt = $this->eventDispatcher->createTransportChangeEvent($this)) {
+				$this->eventDispatcher->dispatchEvent($evt, 'beforeTransportStarted');
+				if ($evt->bubbleCancelled()) {
+					return;
+				}
+			}
+
+			try {
+				$this->buffer->initialize($this->getBufferParams());
+			} catch (Swift_TransportException $e) {
+				$this->throwException($e);
+			}
+			$this->readGreeting();
+			$this->doHeloCommand();
+
+			if ($evt) {
+				$this->eventDispatcher->dispatchEvent($evt, 'transportStarted');
+			}
+
+			$this->started = true;
+		}
+	}
+
+	/**
+	 * Test if an SMTP connection has been established.
+	 *
+	 * @return bool
+	 */
+	public function isStarted()
+	{
+		return $this->started;
+	}
+
+	/**
+	 * Send the given Message.
+	 *
+	 * Recipient/sender data will be retrieved from the Message API.
+	 * The return value is the number of recipients who were accepted for delivery.
+	 *
+	 * @param string[] $failedRecipients An array of failures by-reference
+	 *
+	 * @return int
+	 */
+	public function send(Swift_Mime_SimpleMessage $message, &$failedRecipients = null)
+	{
+		if (!$this->isStarted()) {
+			$this->start();
+		}
+
+		$sent = 0;
+		$failedRecipients = (array) $failedRecipients;
+
+		if ($evt = $this->eventDispatcher->createSendEvent($this, $message)) {
+			$this->eventDispatcher->dispatchEvent($evt, 'beforeSendPerformed');
+			if ($evt->bubbleCancelled()) {
+				return 0;
+			}
+		}
+
+		if (!$reversePath = $this->getReversePath($message)) {
+			$this->throwException(new Swift_TransportException('Cannot send message without a sender address'));
+		}
+
+		$to = (array) $message->getTo();
+		$cc = (array) $message->getCc();
+		$bcc = (array) $message->getBcc();
+		$tos = array_merge($to, $cc, $bcc);
+
+		$message->setBcc([]);
+
+		try {
+			$sent += $this->sendTo($message, $reversePath, $tos, $failedRecipients);
+		} finally {
+			$message->setBcc($bcc);
+		}
+
+		if ($evt) {
+			if ($sent == \count($to) + \count($cc) + \count($bcc)) {
+				$evt->setResult(Swift_Events_SendEvent::RESULT_SUCCESS);
+			} elseif ($sent > 0) {
+				$evt->setResult(Swift_Events_SendEvent::RESULT_TENTATIVE);
+			} else {
+				$evt->setResult(Swift_Events_SendEvent::RESULT_FAILED);
+			}
+			$evt->setFailedRecipients($failedRecipients);
+			$this->eventDispatcher->dispatchEvent($evt, 'sendPerformed');
+		}
+
+		$message->generateId(); //Make sure a new Message ID is used
+
+		return $sent;
+	}
+
+	/**
+	 * Stop the SMTP connection.
+	 */
+	public function stop()
+	{
+		if ($this->started) {
+			if ($evt = $this->eventDispatcher->createTransportChangeEvent($this)) {
+				$this->eventDispatcher->dispatchEvent($evt, 'beforeTransportStopped');
+				if ($evt->bubbleCancelled()) {
+					return;
+				}
+			}
+
+			try {
+				$this->executeCommand("QUIT\r\n", [221]);
+			} catch (Swift_TransportException $e) {
+			}
+
+			try {
+				$this->buffer->terminate();
+
+				if ($evt) {
+					$this->eventDispatcher->dispatchEvent($evt, 'transportStopped');
+				}
+			} catch (Swift_TransportException $e) {
+				$this->throwException($e);
+			}
+		}
+		$this->started = false;
+	}
+
+	/**
+	 * {@inheritdoc}
+	 */
+	public function ping()
+	{
+		try {
+			if (!$this->isStarted()) {
+				$this->start();
+			}
+
+			$this->executeCommand("NOOP\r\n", [250]);
+		} catch (Swift_TransportException $e) {
+			try {
+				$this->stop();
+			} catch (Swift_TransportException $e) {
+			}
+
+			return false;
+		}
+
+		return true;
+	}
+
+	/**
+	 * Register a plugin.
+	 */
+	public function registerPlugin(Swift_Events_EventListener $plugin)
+	{
+		$this->eventDispatcher->bindEventListener($plugin);
+	}
+
+	/**
+	 * Reset the current mail transaction.
+	 */
+	public function reset()
+	{
+		$this->executeCommand("RSET\r\n", [250], $failures, true);
+	}
+
+	/**
+	 * Get the IoBuffer where read/writes are occurring.
+	 *
+	 * @return Swift_Transport_IoBuffer
+	 */
+	public function getBuffer()
+	{
+		return $this->buffer;
+	}
+
+	/**
+	 * Run a command against the buffer, expecting the given response codes.
+	 *
+	 * If no response codes are given, the response will not be validated.
+	 * If codes are given, an exception will be thrown on an invalid response.
+	 * If the command is RCPT TO, and the pipeline is non-empty, no exception
+	 * will be thrown; instead the failing address is added to $failures.
+	 *
+	 * @param string   $command
+	 * @param int[]    $codes
+	 * @param string[] $failures An array of failures by-reference
+	 * @param bool     $pipeline Do not wait for response
+	 * @param string   $address  the address, if command is RCPT TO
+	 *
+	 * @return string|null The server response, or null if pipelining is enabled
+	 */
+	public function executeCommand($command, $codes = [], &$failures = null, $pipeline = false, $address = null)
+	{
+		$failures = (array) $failures;
+		$seq = $this->buffer->write($command);
+		if ($evt = $this->eventDispatcher->createCommandEvent($this, $command, $codes)) {
+			$this->eventDispatcher->dispatchEvent($evt, 'commandSent');
+		}
+
+		$this->pipeline[] = [$command, $seq, $codes, $address];
+
+		if ($pipeline && $this->pipelining) {
+			return null;
+		}
+
+		$response = null;
+
+		while ($this->pipeline) {
+			list($command, $seq, $codes, $address) = array_shift($this->pipeline);
+			$response = $this->getFullResponse($seq);
+			try {
+				$this->assertResponseCode($response, $codes);
+			} catch (Swift_TransportException $e) {
+				if ($this->pipeline && $address) {
+					$failures[] = $address;
+				} else {
+					$this->throwException($e);
+				}
+			}
+		}
+
+		return $response;
+	}
+
+	/** Read the opening SMTP greeting */
+	protected function readGreeting()
+	{
+		$this->assertResponseCode($this->getFullResponse(0), [220]);
+	}
+
+	/** Send the HELO welcome */
+	protected function doHeloCommand()
+	{
+		$this->executeCommand(
+			sprintf("HELO %s\r\n", $this->domain), [250]
+			);
+	}
+
+	/** Send the MAIL FROM command */
+	protected function doMailFromCommand($address)
+	{
+		$address = $this->addressEncoder->encodeString($address);
+		$this->executeCommand(
+			sprintf("MAIL FROM:<%s>\r\n", $address), [250], $failures, true
+			);
+	}
+
+	/** Send the RCPT TO command */
+	protected function doRcptToCommand($address)
+	{
+		$address = $this->addressEncoder->encodeString($address);
+		$this->executeCommand(
+			sprintf("RCPT TO:<%s>\r\n", $address), [250, 251, 252], $failures, true, $address
+			);
+	}
+
+	/** Send the DATA command */
+	protected function doDataCommand(&$failedRecipients)
+	{
+		$this->executeCommand("DATA\r\n", [354], $failedRecipients);
+	}
+
+	/** Stream the contents of the message over the buffer */
+	protected function streamMessage(Swift_Mime_SimpleMessage $message)
+	{
+		$this->buffer->setWriteTranslations(["\r\n." => "\r\n.."]);
+		try {
+			$message->toByteStream($this->buffer);
+			$this->buffer->flushBuffers();
+		} catch (Swift_TransportException $e) {
+			$this->throwException($e);
+		}
+		$this->buffer->setWriteTranslations([]);
+		$this->executeCommand("\r\n.\r\n", [250]);
+	}
+
+	/** Determine the best-use reverse path for this message */
+	protected function getReversePath(Swift_Mime_SimpleMessage $message)
+	{
+		$return = $message->getReturnPath();
+		$sender = $message->getSender();
+		$from = $message->getFrom();
+		$path = null;
+		if (!empty($return)) {
+			$path = $return;
+		} elseif (!empty($sender)) {
+			// Don't use array_keys
+			reset($sender); // Reset Pointer to first pos
+			$path = key($sender); // Get key
+		} elseif (!empty($from)) {
+			reset($from); // Reset Pointer to first pos
+			$path = key($from); // Get key
+		}
+
+		return $path;
+	}
+
+	/** Throw a TransportException, first sending it to any listeners */
+	protected function throwException(Swift_TransportException $e)
+	{
+		if ($evt = $this->eventDispatcher->createTransportExceptionEvent($this, $e)) {
+			$this->eventDispatcher->dispatchEvent($evt, 'exceptionThrown');
+			if (!$evt->bubbleCancelled()) {
+				throw $e;
+			}
+		} else {
+			throw $e;
+		}
+	}
+
+	/** Throws an Exception if a response code is incorrect */
+	protected function assertResponseCode($response, $wanted)
+	{
+		if (!$response) {
+			$this->throwException(new Swift_TransportException('Expected response code '.implode('/', $wanted).' but got an empty response'));
+		}
+
+		list($code) = sscanf($response, '%3d');
+		$valid = (empty($wanted) || \in_array($code, $wanted));
+
+		if ($evt = $this->eventDispatcher->createResponseEvent($this, $response,
+			$valid)) {
+			$this->eventDispatcher->dispatchEvent($evt, 'responseReceived');
+		}
+
+		if (!$valid) {
+			$this->throwException(new Swift_TransportException('Expected response code '.implode('/', $wanted).' but got code "'.$code.'", with message "'.$response.'"', $code));
+		}
+	}
+
+	/** Get an entire multi-line response using its sequence number */
+	protected function getFullResponse($seq)
+	{
+		$response = '';
+		try {
+			do {
+				$line = $this->buffer->readLine($seq);
+				$response .= $line;
+			} while (null !== $line && false !== $line && ' ' != $line[3]);
+		} catch (Swift_TransportException $e) {
+			$this->throwException($e);
+		} catch (Swift_IoException $e) {
+			$this->throwException(new Swift_TransportException($e->getMessage(), 0, $e));
+		}
+
+		return $response;
+	}
+
+	/** Send an email to the given recipients from the given reverse path */
+	private function doMailTransaction($message, $reversePath, array $recipients, array &$failedRecipients)
+	{
+		$sent = 0;
+		$this->doMailFromCommand($reversePath);
+		foreach ($recipients as $forwardPath) {
+			try {
+				$this->doRcptToCommand($forwardPath);
+				++$sent;
+			} catch (Swift_TransportException $e) {
+				$failedRecipients[] = $forwardPath;
+			} catch (Swift_AddressEncoderException $e) {
+				$failedRecipients[] = $forwardPath;
+			}
+		}
+
+		if (0 != $sent) {
+			$sent += \count($failedRecipients);
+			$this->doDataCommand($failedRecipients);
+			$sent -= \count($failedRecipients);
+
+			$this->streamMessage($message);
+		} else {
+			$this->reset();
+		}
+
+		return $sent;
+	}
+
+	/** Send a message to the given To: recipients */
+	private function sendTo(Swift_Mime_SimpleMessage $message, $reversePath, array $to, array &$failedRecipients)
+	{
+		if (empty($to)) {
+			return 0;
+		}
+
+		return $this->doMailTransaction($message, $reversePath, array_keys($to),
+			$failedRecipients);
+	}
+
+	/**
+	 * Destructor.
+	 */
+	public function __destruct()
+	{
+		try {
+			$this->stop();
+		} catch (Exception $e) {
+		}
+	}
+
+	public function __sleep()
+	{
+		throw new \BadMethodCallException('Cannot serialize '.__CLASS__);
+	}
+
+	public function __wakeup()
+	{
+		throw new \BadMethodCallException('Cannot unserialize '.__CLASS__);
+	}
 }

htdocs/includes/swiftmailer/lib/classes/Swift/Transport/LoadBalancedTransport.php

Indentation +174 added lines, -174 removed lines

@@ -15,178 +15,178 @@
  */
 class Swift_Transport_LoadBalancedTransport implements Swift_Transport
 {
-    /**
-     * Transports which are deemed useless.
-     *
-     * @var Swift_Transport[]
-     */
-    private $deadTransports = [];
-
-    /**
-     * The Transports which are used in rotation.
-     *
-     * @var Swift_Transport[]
-     */
-    protected $transports = [];
-
-    /**
-     * The Transport used in the last successful send operation.
-     *
-     * @var Swift_Transport
-     */
-    protected $lastUsedTransport = null;
-
-    // needed as __construct is called from elsewhere explicitly
-    public function __construct()
-    {
-    }
-
-    /**
-     * Set $transports to delegate to.
-     *
-     * @param Swift_Transport[] $transports
-     */
-    public function setTransports(array $transports)
-    {
-        $this->transports = $transports;
-        $this->deadTransports = [];
-    }
-
-    /**
-     * Get $transports to delegate to.
-     *
-     * @return Swift_Transport[]
-     */
-    public function getTransports()
-    {
-        return array_merge($this->transports, $this->deadTransports);
-    }
-
-    /**
-     * Get the Transport used in the last successful send operation.
-     *
-     * @return Swift_Transport
-     */
-    public function getLastUsedTransport()
-    {
-        return $this->lastUsedTransport;
-    }
-
-    /**
-     * Test if this Transport mechanism has started.
-     *
-     * @return bool
-     */
-    public function isStarted()
-    {
-        return \count($this->transports) > 0;
-    }
-
-    /**
-     * Start this Transport mechanism.
-     */
-    public function start()
-    {
-        $this->transports = array_merge($this->transports, $this->deadTransports);
-    }
-
-    /**
-     * Stop this Transport mechanism.
-     */
-    public function stop()
-    {
-        foreach ($this->transports as $transport) {
-            $transport->stop();
-        }
-    }
-
-    /**
-     * {@inheritdoc}
-     */
-    public function ping()
-    {
-        foreach ($this->transports as $transport) {
-            if (!$transport->ping()) {
-                $this->killCurrentTransport();
-            }
-        }
-
-        return \count($this->transports) > 0;
-    }
-
-    /**
-     * Send the given Message.
-     *
-     * Recipient/sender data will be retrieved from the Message API.
-     * The return value is the number of recipients who were accepted for delivery.
-     *
-     * @param string[] $failedRecipients An array of failures by-reference
-     *
-     * @return int
-     */
-    public function send(Swift_Mime_SimpleMessage $message, &$failedRecipients = null)
-    {
-        $maxTransports = \count($this->transports);
-        $sent = 0;
-        $this->lastUsedTransport = null;
-
-        for ($i = 0; $i < $maxTransports
-            && $transport = $this->getNextTransport(); ++$i) {
-            try {
-                if (!$transport->isStarted()) {
-                    $transport->start();
-                }
-                if ($sent = $transport->send($message, $failedRecipients)) {
-                    $this->lastUsedTransport = $transport;
-                    break;
-                }
-            } catch (Swift_TransportException $e) {
-                $this->killCurrentTransport();
-            }
-        }
-
-        if (0 == \count($this->transports)) {
-            throw new Swift_TransportException('All Transports in LoadBalancedTransport failed, or no Transports available');
-        }
-
-        return $sent;
-    }
-
-    /**
-     * Register a plugin.
-     */
-    public function registerPlugin(Swift_Events_EventListener $plugin)
-    {
-        foreach ($this->transports as $transport) {
-            $transport->registerPlugin($plugin);
-        }
-    }
-
-    /**
-     * Rotates the transport list around and returns the first instance.
-     *
-     * @return Swift_Transport
-     */
-    protected function getNextTransport()
-    {
-        if ($next = array_shift($this->transports)) {
-            $this->transports[] = $next;
-        }
-
-        return $next;
-    }
-
-    /**
-     * Tag the currently used (top of stack) transport as dead/useless.
-     */
-    protected function killCurrentTransport()
-    {
-        if ($transport = array_pop($this->transports)) {
-            try {
-                $transport->stop();
-            } catch (Exception $e) {
-            }
-            $this->deadTransports[] = $transport;
-        }
-    }
+	/**
+	 * Transports which are deemed useless.
+	 *
+	 * @var Swift_Transport[]
+	 */
+	private $deadTransports = [];
+
+	/**
+	 * The Transports which are used in rotation.
+	 *
+	 * @var Swift_Transport[]
+	 */
+	protected $transports = [];
+
+	/**
+	 * The Transport used in the last successful send operation.
+	 *
+	 * @var Swift_Transport
+	 */
+	protected $lastUsedTransport = null;
+
+	// needed as __construct is called from elsewhere explicitly
+	public function __construct()
+	{
+	}
+
+	/**
+	 * Set $transports to delegate to.
+	 *
+	 * @param Swift_Transport[] $transports
+	 */
+	public function setTransports(array $transports)
+	{
+		$this->transports = $transports;
+		$this->deadTransports = [];
+	}
+
+	/**
+	 * Get $transports to delegate to.
+	 *
+	 * @return Swift_Transport[]
+	 */
+	public function getTransports()
+	{
+		return array_merge($this->transports, $this->deadTransports);
+	}
+
+	/**
+	 * Get the Transport used in the last successful send operation.
+	 *
+	 * @return Swift_Transport
+	 */
+	public function getLastUsedTransport()
+	{
+		return $this->lastUsedTransport;
+	}
+
+	/**
+	 * Test if this Transport mechanism has started.
+	 *
+	 * @return bool
+	 */
+	public function isStarted()
+	{
+		return \count($this->transports) > 0;
+	}
+
+	/**
+	 * Start this Transport mechanism.
+	 */
+	public function start()
+	{
+		$this->transports = array_merge($this->transports, $this->deadTransports);
+	}
+
+	/**
+	 * Stop this Transport mechanism.
+	 */
+	public function stop()
+	{
+		foreach ($this->transports as $transport) {
+			$transport->stop();
+		}
+	}
+
+	/**
+	 * {@inheritdoc}
+	 */
+	public function ping()
+	{
+		foreach ($this->transports as $transport) {
+			if (!$transport->ping()) {
+				$this->killCurrentTransport();
+			}
+		}
+
+		return \count($this->transports) > 0;
+	}
+
+	/**
+	 * Send the given Message.
+	 *
+	 * Recipient/sender data will be retrieved from the Message API.
+	 * The return value is the number of recipients who were accepted for delivery.
+	 *
+	 * @param string[] $failedRecipients An array of failures by-reference
+	 *
+	 * @return int
+	 */
+	public function send(Swift_Mime_SimpleMessage $message, &$failedRecipients = null)
+	{
+		$maxTransports = \count($this->transports);
+		$sent = 0;
+		$this->lastUsedTransport = null;
+
+		for ($i = 0; $i < $maxTransports
+			&& $transport = $this->getNextTransport(); ++$i) {
+			try {
+				if (!$transport->isStarted()) {
+					$transport->start();
+				}
+				if ($sent = $transport->send($message, $failedRecipients)) {
+					$this->lastUsedTransport = $transport;
+					break;
+				}
+			} catch (Swift_TransportException $e) {
+				$this->killCurrentTransport();
+			}
+		}
+
+		if (0 == \count($this->transports)) {
+			throw new Swift_TransportException('All Transports in LoadBalancedTransport failed, or no Transports available');
+		}
+
+		return $sent;
+	}
+
+	/**
+	 * Register a plugin.
+	 */
+	public function registerPlugin(Swift_Events_EventListener $plugin)
+	{
+		foreach ($this->transports as $transport) {
+			$transport->registerPlugin($plugin);
+		}
+	}
+
+	/**
+	 * Rotates the transport list around and returns the first instance.
+	 *
+	 * @return Swift_Transport
+	 */
+	protected function getNextTransport()
+	{
+		if ($next = array_shift($this->transports)) {
+			$this->transports[] = $next;
+		}
+
+		return $next;
+	}
+
+	/**
+	 * Tag the currently used (top of stack) transport as dead/useless.
+	 */
+	protected function killCurrentTransport()
+	{
+		if ($transport = array_pop($this->transports)) {
+			try {
+				$transport->stop();
+			} catch (Exception $e) {
+			}
+			$this->deadTransports[] = $transport;
+		}
+	}
 }

htdocs/includes/swiftmailer/lib/classes/Swift/Transport/SpoolTransport.php

Indentation +102 added lines, -102 removed lines

@@ -15,106 +15,106 @@
  */
 class Swift_Transport_SpoolTransport implements Swift_Transport
 {
-    /** The spool instance */
-    private $spool;
-
-    /** The event dispatcher from the plugin API */
-    private $eventDispatcher;
-
-    /**
-     * Constructor.
-     */
-    public function __construct(Swift_Events_EventDispatcher $eventDispatcher, Swift_Spool $spool = null)
-    {
-        $this->eventDispatcher = $eventDispatcher;
-        $this->spool = $spool;
-    }
-
-    /**
-     * Sets the spool object.
-     *
-     * @return $this
-     */
-    public function setSpool(Swift_Spool $spool)
-    {
-        $this->spool = $spool;
-
-        return $this;
-    }
-
-    /**
-     * Get the spool object.
-     *
-     * @return Swift_Spool
-     */
-    public function getSpool()
-    {
-        return $this->spool;
-    }
-
-    /**
-     * Tests if this Transport mechanism has started.
-     *
-     * @return bool
-     */
-    public function isStarted()
-    {
-        return true;
-    }
-
-    /**
-     * Starts this Transport mechanism.
-     */
-    public function start()
-    {
-    }
-
-    /**
-     * Stops this Transport mechanism.
-     */
-    public function stop()
-    {
-    }
-
-    /**
-     * {@inheritdoc}
-     */
-    public function ping()
-    {
-        return true;
-    }
-
-    /**
-     * Sends the given message.
-     *
-     * @param string[] $failedRecipients An array of failures by-reference
-     *
-     * @return int The number of sent e-mail's
-     */
-    public function send(Swift_Mime_SimpleMessage $message, &$failedRecipients = null)
-    {
-        if ($evt = $this->eventDispatcher->createSendEvent($this, $message)) {
-            $this->eventDispatcher->dispatchEvent($evt, 'beforeSendPerformed');
-            if ($evt->bubbleCancelled()) {
-                return 0;
-            }
-        }
-
-        $success = $this->spool->queueMessage($message);
-
-        if ($evt) {
-            $evt->setResult($success ? Swift_Events_SendEvent::RESULT_SPOOLED : Swift_Events_SendEvent::RESULT_FAILED);
-            $this->eventDispatcher->dispatchEvent($evt, 'sendPerformed');
-        }
-
-        return 1;
-    }
-
-    /**
-     * Register a plugin.
-     */
-    public function registerPlugin(Swift_Events_EventListener $plugin)
-    {
-        $this->eventDispatcher->bindEventListener($plugin);
-    }
+	/** The spool instance */
+	private $spool;
+
+	/** The event dispatcher from the plugin API */
+	private $eventDispatcher;
+
+	/**
+	 * Constructor.
+	 */
+	public function __construct(Swift_Events_EventDispatcher $eventDispatcher, Swift_Spool $spool = null)
+	{
+		$this->eventDispatcher = $eventDispatcher;
+		$this->spool = $spool;
+	}
+
+	/**
+	 * Sets the spool object.
+	 *
+	 * @return $this
+	 */
+	public function setSpool(Swift_Spool $spool)
+	{
+		$this->spool = $spool;
+
+		return $this;
+	}
+
+	/**
+	 * Get the spool object.
+	 *
+	 * @return Swift_Spool
+	 */
+	public function getSpool()
+	{
+		return $this->spool;
+	}
+
+	/**
+	 * Tests if this Transport mechanism has started.
+	 *
+	 * @return bool
+	 */
+	public function isStarted()
+	{
+		return true;
+	}
+
+	/**
+	 * Starts this Transport mechanism.
+	 */
+	public function start()
+	{
+	}
+
+	/**
+	 * Stops this Transport mechanism.
+	 */
+	public function stop()
+	{
+	}
+
+	/**
+	 * {@inheritdoc}
+	 */
+	public function ping()
+	{
+		return true;
+	}
+
+	/**
+	 * Sends the given message.
+	 *
+	 * @param string[] $failedRecipients An array of failures by-reference
+	 *
+	 * @return int The number of sent e-mail's
+	 */
+	public function send(Swift_Mime_SimpleMessage $message, &$failedRecipients = null)
+	{
+		if ($evt = $this->eventDispatcher->createSendEvent($this, $message)) {
+			$this->eventDispatcher->dispatchEvent($evt, 'beforeSendPerformed');
+			if ($evt->bubbleCancelled()) {
+				return 0;
+			}
+		}
+
+		$success = $this->spool->queueMessage($message);
+
+		if ($evt) {
+			$evt->setResult($success ? Swift_Events_SendEvent::RESULT_SPOOLED : Swift_Events_SendEvent::RESULT_FAILED);
+			$this->eventDispatcher->dispatchEvent($evt, 'sendPerformed');
+		}
+
+		return 1;
+	}
+
+	/**
+	 * Register a plugin.
+	 */
+	public function registerPlugin(Swift_Events_EventListener $plugin)
+	{
+		$this->eventDispatcher->bindEventListener($plugin);
+	}
 }

htdocs/includes/swiftmailer/lib/classes/Swift/Transport/StreamBuffer.php

Indentation +301 added lines, -301 removed lines

@@ -15,305 +15,305 @@
  */
 class Swift_Transport_StreamBuffer extends Swift_ByteStream_AbstractFilterableInputStream implements Swift_Transport_IoBuffer
 {
-    /** A primary socket */
-    private $stream;
-
-    /** The input stream */
-    private $in;
-
-    /** The output stream */
-    private $out;
-
-    /** Buffer initialization parameters */
-    private $params = [];
-
-    /** The ReplacementFilterFactory */
-    private $replacementFactory;
-
-    /** Translations performed on data being streamed into the buffer */
-    private $translations = [];
-
-    /**
-     * Create a new StreamBuffer using $replacementFactory for transformations.
-     */
-    public function __construct(Swift_ReplacementFilterFactory $replacementFactory)
-    {
-        $this->replacementFactory = $replacementFactory;
-    }
-
-    /**
-     * Perform any initialization needed, using the given $params.
-     *
-     * Parameters will vary depending upon the type of IoBuffer used.
-     */
-    public function initialize(array $params)
-    {
-        $this->params = $params;
-        switch ($params['type']) {
-            case self::TYPE_PROCESS:
-                $this->establishProcessConnection();
-                break;
-            case self::TYPE_SOCKET:
-            default:
-                $this->establishSocketConnection();
-                break;
-        }
-    }
-
-    /**
-     * Set an individual param on the buffer (e.g. switching to SSL).
-     *
-     * @param string $param
-     * @param mixed  $value
-     */
-    public function setParam($param, $value)
-    {
-        if (isset($this->stream)) {
-            switch ($param) {
-                case 'timeout':
-                    if ($this->stream) {
-                        stream_set_timeout($this->stream, $value);
-                    }
-                    break;
-
-                case 'blocking':
-                    if ($this->stream) {
-                        stream_set_blocking($this->stream, 1);
-                    }
-            }
-        }
-        $this->params[$param] = $value;
-    }
-
-    public function startTLS()
-    {
-        // STREAM_CRYPTO_METHOD_TLS_CLIENT only allow tls1.0 connections (some php versions)
-        // To support modern tls we allow explicit tls1.0, tls1.1, tls1.2
-        // Ssl3 and older are not allowed because they are vulnerable
-        // @TODO make tls arguments configurable
-        return stream_socket_enable_crypto($this->stream, true, STREAM_CRYPTO_METHOD_TLSv1_0_CLIENT | STREAM_CRYPTO_METHOD_TLSv1_1_CLIENT | STREAM_CRYPTO_METHOD_TLSv1_2_CLIENT);
-    }
-
-    /**
-     * Perform any shutdown logic needed.
-     */
-    public function terminate()
-    {
-        if (isset($this->stream)) {
-            switch ($this->params['type']) {
-                case self::TYPE_PROCESS:
-                    fclose($this->in);
-                    fclose($this->out);
-                    proc_close($this->stream);
-                    break;
-                case self::TYPE_SOCKET:
-                default:
-                    fclose($this->stream);
-                    break;
-            }
-        }
-        $this->stream = null;
-        $this->out = null;
-        $this->in = null;
-    }
-
-    /**
-     * Set an array of string replacements which should be made on data written
-     * to the buffer.
-     *
-     * This could replace LF with CRLF for example.
-     *
-     * @param string[] $replacements
-     */
-    public function setWriteTranslations(array $replacements)
-    {
-        foreach ($this->translations as $search => $replace) {
-            if (!isset($replacements[$search])) {
-                $this->removeFilter($search);
-                unset($this->translations[$search]);
-            }
-        }
-
-        foreach ($replacements as $search => $replace) {
-            if (!isset($this->translations[$search])) {
-                $this->addFilter(
-                    $this->replacementFactory->createFilter($search, $replace), $search
-                    );
-                $this->translations[$search] = true;
-            }
-        }
-    }
-
-    /**
-     * Get a line of output (including any CRLF).
-     *
-     * The $sequence number comes from any writes and may or may not be used
-     * depending upon the implementation.
-     *
-     * @param int $sequence of last write to scan from
-     *
-     * @return string
-     *
-     * @throws Swift_IoException
-     */
-    public function readLine($sequence)
-    {
-        if (isset($this->out) && !feof($this->out)) {
-            $line = fgets($this->out);
-            if (0 == \strlen($line)) {
-                $metas = stream_get_meta_data($this->out);
-                if ($metas['timed_out']) {
-                    throw new Swift_IoException('Connection to '.$this->getReadConnectionDescription().' Timed Out');
-                }
-            }
-
-            return $line;
-        }
-    }
-
-    /**
-     * Reads $length bytes from the stream into a string and moves the pointer
-     * through the stream by $length.
-     *
-     * If less bytes exist than are requested the remaining bytes are given instead.
-     * If no bytes are remaining at all, boolean false is returned.
-     *
-     * @param int $length
-     *
-     * @return string|bool
-     *
-     * @throws Swift_IoException
-     */
-    public function read($length)
-    {
-        if (isset($this->out) && !feof($this->out)) {
-            $ret = fread($this->out, $length);
-            if (0 == \strlen($ret)) {
-                $metas = stream_get_meta_data($this->out);
-                if ($metas['timed_out']) {
-                    throw new Swift_IoException('Connection to '.$this->getReadConnectionDescription().' Timed Out');
-                }
-            }
-
-            return $ret;
-        }
-    }
-
-    /** Not implemented */
-    public function setReadPointer($byteOffset)
-    {
-    }
-
-    /** Flush the stream contents */
-    protected function flush()
-    {
-        if (isset($this->in)) {
-            fflush($this->in);
-        }
-    }
-
-    /** Write this bytes to the stream */
-    protected function doCommit($bytes)
-    {
-        if (isset($this->in)) {
-            $bytesToWrite = \strlen($bytes);
-            $totalBytesWritten = 0;
-
-            while ($totalBytesWritten < $bytesToWrite) {
-                $bytesWritten = fwrite($this->in, substr($bytes, $totalBytesWritten));
-                if (false === $bytesWritten || 0 === $bytesWritten) {
-                    break;
-                }
-
-                $totalBytesWritten += $bytesWritten;
-            }
-
-            if ($totalBytesWritten > 0) {
-                return ++$this->sequence;
-            }
-        }
-    }
-
-    /**
-     * Establishes a connection to a remote server.
-     */
-    private function establishSocketConnection()
-    {
-        $host = $this->params['host'];
-        if (!empty($this->params['protocol'])) {
-            $host = $this->params['protocol'].'://'.$host;
-        }
-        $timeout = 15;
-        if (!empty($this->params['timeout'])) {
-            $timeout = $this->params['timeout'];
-        }
-        $options = [];
-        if (!empty($this->params['sourceIp'])) {
-            $options['socket']['bindto'] = $this->params['sourceIp'].':0';
-        }
-
-        if (isset($this->params['stream_context_options'])) {
-            $options = array_merge($options, $this->params['stream_context_options']);
-        }
-        $streamContext = stream_context_create($options);
-
-        set_error_handler(function ($type, $msg) {
-            throw new Swift_TransportException('Connection could not be established with host '.$this->params['host'].' :'.$msg);
-        });
-        try {
-            $this->stream = stream_socket_client($host.':'.$this->params['port'], $errno, $errstr, $timeout, STREAM_CLIENT_CONNECT, $streamContext);
-        } finally {
-            restore_error_handler();
-        }
-
-        if (!empty($this->params['blocking'])) {
-            stream_set_blocking($this->stream, 1);
-        } else {
-            stream_set_blocking($this->stream, 0);
-        }
-        stream_set_timeout($this->stream, $timeout);
-        $this->in = &$this->stream;
-        $this->out = &$this->stream;
-    }
-
-    /**
-     * Opens a process for input/output.
-     */
-    private function establishProcessConnection()
-    {
-        $command = $this->params['command'];
-        $descriptorSpec = [
-            0 => ['pipe', 'r'],
-            1 => ['pipe', 'w'],
-            2 => ['pipe', 'w'],
-            ];
-        $pipes = [];
-        $this->stream = proc_open($command, $descriptorSpec, $pipes);
-        stream_set_blocking($pipes[2], 0);
-        if ($err = stream_get_contents($pipes[2])) {
-            throw new Swift_TransportException('Process could not be started ['.$err.']');
-        }
-        $this->in = &$pipes[0];
-        $this->out = &$pipes[1];
-    }
-
-    private function getReadConnectionDescription()
-    {
-        switch ($this->params['type']) {
-            case self::TYPE_PROCESS:
-                return 'Process '.$this->params['command'];
-                break;
-
-            case self::TYPE_SOCKET:
-            default:
-                $host = $this->params['host'];
-                if (!empty($this->params['protocol'])) {
-                    $host = $this->params['protocol'].'://'.$host;
-                }
-                $host .= ':'.$this->params['port'];
-
-                return $host;
-                break;
-        }
-    }
+	/** A primary socket */
+	private $stream;
+
+	/** The input stream */
+	private $in;
+
+	/** The output stream */
+	private $out;
+
+	/** Buffer initialization parameters */
+	private $params = [];
+
+	/** The ReplacementFilterFactory */
+	private $replacementFactory;
+
+	/** Translations performed on data being streamed into the buffer */
+	private $translations = [];
+
+	/**
+	 * Create a new StreamBuffer using $replacementFactory for transformations.
+	 */
+	public function __construct(Swift_ReplacementFilterFactory $replacementFactory)
+	{
+		$this->replacementFactory = $replacementFactory;
+	}
+
+	/**
+	 * Perform any initialization needed, using the given $params.
+	 *
+	 * Parameters will vary depending upon the type of IoBuffer used.
+	 */
+	public function initialize(array $params)
+	{
+		$this->params = $params;
+		switch ($params['type']) {
+			case self::TYPE_PROCESS:
+				$this->establishProcessConnection();
+				break;
+			case self::TYPE_SOCKET:
+			default:
+				$this->establishSocketConnection();
+				break;
+		}
+	}
+
+	/**
+	 * Set an individual param on the buffer (e.g. switching to SSL).
+	 *
+	 * @param string $param
+	 * @param mixed  $value
+	 */
+	public function setParam($param, $value)
+	{
+		if (isset($this->stream)) {
+			switch ($param) {
+				case 'timeout':
+					if ($this->stream) {
+						stream_set_timeout($this->stream, $value);
+					}
+					break;
+
+				case 'blocking':
+					if ($this->stream) {
+						stream_set_blocking($this->stream, 1);
+					}
+			}
+		}
+		$this->params[$param] = $value;
+	}
+
+	public function startTLS()
+	{
+		// STREAM_CRYPTO_METHOD_TLS_CLIENT only allow tls1.0 connections (some php versions)
+		// To support modern tls we allow explicit tls1.0, tls1.1, tls1.2
+		// Ssl3 and older are not allowed because they are vulnerable
+		// @TODO make tls arguments configurable
+		return stream_socket_enable_crypto($this->stream, true, STREAM_CRYPTO_METHOD_TLSv1_0_CLIENT | STREAM_CRYPTO_METHOD_TLSv1_1_CLIENT | STREAM_CRYPTO_METHOD_TLSv1_2_CLIENT);
+	}
+
+	/**
+	 * Perform any shutdown logic needed.
+	 */
+	public function terminate()
+	{
+		if (isset($this->stream)) {
+			switch ($this->params['type']) {
+				case self::TYPE_PROCESS:
+					fclose($this->in);
+					fclose($this->out);
+					proc_close($this->stream);
+					break;
+				case self::TYPE_SOCKET:
+				default:
+					fclose($this->stream);
+					break;
+			}
+		}
+		$this->stream = null;
+		$this->out = null;
+		$this->in = null;
+	}
+
+	/**
+	 * Set an array of string replacements which should be made on data written
+	 * to the buffer.
+	 *
+	 * This could replace LF with CRLF for example.
+	 *
+	 * @param string[] $replacements
+	 */
+	public function setWriteTranslations(array $replacements)
+	{
+		foreach ($this->translations as $search => $replace) {
+			if (!isset($replacements[$search])) {
+				$this->removeFilter($search);
+				unset($this->translations[$search]);
+			}
+		}
+
+		foreach ($replacements as $search => $replace) {
+			if (!isset($this->translations[$search])) {
+				$this->addFilter(
+					$this->replacementFactory->createFilter($search, $replace), $search
+					);
+				$this->translations[$search] = true;
+			}
+		}
+	}
+
+	/**
+	 * Get a line of output (including any CRLF).
+	 *
+	 * The $sequence number comes from any writes and may or may not be used
+	 * depending upon the implementation.
+	 *
+	 * @param int $sequence of last write to scan from
+	 *
+	 * @return string
+	 *
+	 * @throws Swift_IoException
+	 */
+	public function readLine($sequence)
+	{
+		if (isset($this->out) && !feof($this->out)) {
+			$line = fgets($this->out);
+			if (0 == \strlen($line)) {
+				$metas = stream_get_meta_data($this->out);
+				if ($metas['timed_out']) {
+					throw new Swift_IoException('Connection to '.$this->getReadConnectionDescription().' Timed Out');
+				}
+			}
+
+			return $line;
+		}
+	}
+
+	/**
+	 * Reads $length bytes from the stream into a string and moves the pointer
+	 * through the stream by $length.
+	 *
+	 * If less bytes exist than are requested the remaining bytes are given instead.
+	 * If no bytes are remaining at all, boolean false is returned.
+	 *
+	 * @param int $length
+	 *
+	 * @return string|bool
+	 *
+	 * @throws Swift_IoException
+	 */
+	public function read($length)
+	{
+		if (isset($this->out) && !feof($this->out)) {
+			$ret = fread($this->out, $length);
+			if (0 == \strlen($ret)) {
+				$metas = stream_get_meta_data($this->out);
+				if ($metas['timed_out']) {
+					throw new Swift_IoException('Connection to '.$this->getReadConnectionDescription().' Timed Out');
+				}
+			}
+
+			return $ret;
+		}
+	}
+
+	/** Not implemented */
+	public function setReadPointer($byteOffset)
+	{
+	}
+
+	/** Flush the stream contents */
+	protected function flush()
+	{
+		if (isset($this->in)) {
+			fflush($this->in);
+		}
+	}
+
+	/** Write this bytes to the stream */
+	protected function doCommit($bytes)
+	{
+		if (isset($this->in)) {
+			$bytesToWrite = \strlen($bytes);
+			$totalBytesWritten = 0;
+
+			while ($totalBytesWritten < $bytesToWrite) {
+				$bytesWritten = fwrite($this->in, substr($bytes, $totalBytesWritten));
+				if (false === $bytesWritten || 0 === $bytesWritten) {
+					break;
+				}
+
+				$totalBytesWritten += $bytesWritten;
+			}
+
+			if ($totalBytesWritten > 0) {
+				return ++$this->sequence;
+			}
+		}
+	}
+
+	/**
+	 * Establishes a connection to a remote server.
+	 */
+	private function establishSocketConnection()
+	{
+		$host = $this->params['host'];
+		if (!empty($this->params['protocol'])) {
+			$host = $this->params['protocol'].'://'.$host;
+		}
+		$timeout = 15;
+		if (!empty($this->params['timeout'])) {
+			$timeout = $this->params['timeout'];
+		}
+		$options = [];
+		if (!empty($this->params['sourceIp'])) {
+			$options['socket']['bindto'] = $this->params['sourceIp'].':0';
+		}
+
+		if (isset($this->params['stream_context_options'])) {
+			$options = array_merge($options, $this->params['stream_context_options']);
+		}
+		$streamContext = stream_context_create($options);
+
+		set_error_handler(function ($type, $msg) {
+			throw new Swift_TransportException('Connection could not be established with host '.$this->params['host'].' :'.$msg);
+		});
+		try {
+			$this->stream = stream_socket_client($host.':'.$this->params['port'], $errno, $errstr, $timeout, STREAM_CLIENT_CONNECT, $streamContext);
+		} finally {
+			restore_error_handler();
+		}
+
+		if (!empty($this->params['blocking'])) {
+			stream_set_blocking($this->stream, 1);
+		} else {
+			stream_set_blocking($this->stream, 0);
+		}
+		stream_set_timeout($this->stream, $timeout);
+		$this->in = &$this->stream;
+		$this->out = &$this->stream;
+	}
+
+	/**
+	 * Opens a process for input/output.
+	 */
+	private function establishProcessConnection()
+	{
+		$command = $this->params['command'];
+		$descriptorSpec = [
+			0 => ['pipe', 'r'],
+			1 => ['pipe', 'w'],
+			2 => ['pipe', 'w'],
+			];
+		$pipes = [];
+		$this->stream = proc_open($command, $descriptorSpec, $pipes);
+		stream_set_blocking($pipes[2], 0);
+		if ($err = stream_get_contents($pipes[2])) {
+			throw new Swift_TransportException('Process could not be started ['.$err.']');
+		}
+		$this->in = &$pipes[0];
+		$this->out = &$pipes[1];
+	}
+
+	private function getReadConnectionDescription()
+	{
+		switch ($this->params['type']) {
+			case self::TYPE_PROCESS:
+				return 'Process '.$this->params['command'];
+				break;
+
+			case self::TYPE_SOCKET:
+			default:
+				$host = $this->params['host'];
+				if (!empty($this->params['protocol'])) {
+					$host = $this->params['protocol'].'://'.$host;
+				}
+				$host .= ':'.$this->params['port'];
+
+				return $host;
+				break;
+		}
+	}
 }

htdocs/includes/swiftmailer/lib/classes/Swift/Transport/Esmtp/Authenticator.php

Indentation +17 added lines, -17 removed lines

@@ -15,22 +15,22 @@
  */
 interface Swift_Transport_Esmtp_Authenticator
 {
-    /**
-     * Get the name of the AUTH mechanism this Authenticator handles.
-     *
-     * @return string
-     */
-    public function getAuthKeyword();
+	/**
+	 * Get the name of the AUTH mechanism this Authenticator handles.
+	 *
+	 * @return string
+	 */
+	public function getAuthKeyword();
 
-    /**
-     * Try to authenticate the user with $username and $password.
-     *
-     * @param string $username
-     * @param string $password
-     *
-     * @return bool true if authentication worked (returning false is deprecated, throw a Swift_TransportException instead)
-     *
-     * @throws Swift_TransportException Allows the message to bubble up when authentication was not successful
-     */
-    public function authenticate(Swift_Transport_SmtpAgent $agent, $username, $password);
+	/**
+	 * Try to authenticate the user with $username and $password.
+	 *
+	 * @param string $username
+	 * @param string $password
+	 *
+	 * @return bool true if authentication worked (returning false is deprecated, throw a Swift_TransportException instead)
+	 *
+	 * @throws Swift_TransportException Allows the message to bubble up when authentication was not successful
+	 */
+	public function authenticate(Swift_Transport_SmtpAgent $agent, $username, $password);
 }

htdocs/includes/swiftmailer/lib/classes/Swift/Transport/Esmtp/SmtpUtf8Handler.php

Indentation +72 added lines, -72 removed lines

@@ -23,85 +23,85 @@
  */
 class Swift_Transport_Esmtp_SmtpUtf8Handler implements Swift_Transport_EsmtpHandler
 {
-    public function __construct()
-    {
-    }
+	public function __construct()
+	{
+	}
 
-    /**
-     * Get the name of the ESMTP extension this handles.
-     *
-     * @return string
-     */
-    public function getHandledKeyword()
-    {
-        return 'SMTPUTF8';
-    }
+	/**
+	 * Get the name of the ESMTP extension this handles.
+	 *
+	 * @return string
+	 */
+	public function getHandledKeyword()
+	{
+		return 'SMTPUTF8';
+	}
 
-    /**
-     * Not used.
-     */
-    public function setKeywordParams(array $parameters)
-    {
-    }
+	/**
+	 * Not used.
+	 */
+	public function setKeywordParams(array $parameters)
+	{
+	}
 
-    /**
-     * Not used.
-     */
-    public function afterEhlo(Swift_Transport_SmtpAgent $agent)
-    {
-    }
+	/**
+	 * Not used.
+	 */
+	public function afterEhlo(Swift_Transport_SmtpAgent $agent)
+	{
+	}
 
-    /**
-     * Get params which are appended to MAIL FROM:<>.
-     *
-     * @return string[]
-     */
-    public function getMailParams()
-    {
-        return ['SMTPUTF8'];
-    }
+	/**
+	 * Get params which are appended to MAIL FROM:<>.
+	 *
+	 * @return string[]
+	 */
+	public function getMailParams()
+	{
+		return ['SMTPUTF8'];
+	}
 
-    /**
-     * Not used.
-     */
-    public function getRcptParams()
-    {
-        return [];
-    }
+	/**
+	 * Not used.
+	 */
+	public function getRcptParams()
+	{
+		return [];
+	}
 
-    /**
-     * Not used.
-     */
-    public function onCommand(Swift_Transport_SmtpAgent $agent, $command, $codes = [], &$failedRecipients = null, &$stop = false)
-    {
-    }
+	/**
+	 * Not used.
+	 */
+	public function onCommand(Swift_Transport_SmtpAgent $agent, $command, $codes = [], &$failedRecipients = null, &$stop = false)
+	{
+	}
 
-    /**
-     * Returns +1, -1 or 0 according to the rules for usort().
-     *
-     * This method is called to ensure extensions can be execute in an appropriate order.
-     *
-     * @param string $esmtpKeyword to compare with
-     *
-     * @return int
-     */
-    public function getPriorityOver($esmtpKeyword)
-    {
-        return 0;
-    }
+	/**
+	 * Returns +1, -1 or 0 according to the rules for usort().
+	 *
+	 * This method is called to ensure extensions can be execute in an appropriate order.
+	 *
+	 * @param string $esmtpKeyword to compare with
+	 *
+	 * @return int
+	 */
+	public function getPriorityOver($esmtpKeyword)
+	{
+		return 0;
+	}
 
-    /**
-     * Not used.
-     */
-    public function exposeMixinMethods()
-    {
-        return [];
-    }
+	/**
+	 * Not used.
+	 */
+	public function exposeMixinMethods()
+	{
+		return [];
+	}
 
-    /**
-     * Not used.
-     */
-    public function resetState()
-    {
-    }
+	/**
+	 * Not used.
+	 */
+	public function resetState()
+	{
+	}
 }

htdocs/includes/swiftmailer/lib/classes/Swift/Transport/Esmtp/EightBitMimeHandler.php

Indentation +78 added lines, -78 removed lines

@@ -22,92 +22,92 @@
  */
 class Swift_Transport_Esmtp_EightBitMimeHandler implements Swift_Transport_EsmtpHandler
 {
-    protected $encoding;
+	protected $encoding;
 
-    /**
-     * @param string $encoding The parameter so send with the MAIL FROM command;
-     *                         either "8BITMIME" or "7BIT"
-     */
-    public function __construct(string $encoding = '8BITMIME')
-    {
-        $this->encoding = $encoding;
-    }
+	/**
+	 * @param string $encoding The parameter so send with the MAIL FROM command;
+	 *                         either "8BITMIME" or "7BIT"
+	 */
+	public function __construct(string $encoding = '8BITMIME')
+	{
+		$this->encoding = $encoding;
+	}
 
-    /**
-     * Get the name of the ESMTP extension this handles.
-     *
-     * @return string
-     */
-    public function getHandledKeyword()
-    {
-        return '8BITMIME';
-    }
+	/**
+	 * Get the name of the ESMTP extension this handles.
+	 *
+	 * @return string
+	 */
+	public function getHandledKeyword()
+	{
+		return '8BITMIME';
+	}
 
-    /**
-     * Not used.
-     */
-    public function setKeywordParams(array $parameters)
-    {
-    }
+	/**
+	 * Not used.
+	 */
+	public function setKeywordParams(array $parameters)
+	{
+	}
 
-    /**
-     * Not used.
-     */
-    public function afterEhlo(Swift_Transport_SmtpAgent $agent)
-    {
-    }
+	/**
+	 * Not used.
+	 */
+	public function afterEhlo(Swift_Transport_SmtpAgent $agent)
+	{
+	}
 
-    /**
-     * Get params which are appended to MAIL FROM:<>.
-     *
-     * @return string[]
-     */
-    public function getMailParams()
-    {
-        return ['BODY='.$this->encoding];
-    }
+	/**
+	 * Get params which are appended to MAIL FROM:<>.
+	 *
+	 * @return string[]
+	 */
+	public function getMailParams()
+	{
+		return ['BODY='.$this->encoding];
+	}
 
-    /**
-     * Not used.
-     */
-    public function getRcptParams()
-    {
-        return [];
-    }
+	/**
+	 * Not used.
+	 */
+	public function getRcptParams()
+	{
+		return [];
+	}
 
-    /**
-     * Not used.
-     */
-    public function onCommand(Swift_Transport_SmtpAgent $agent, $command, $codes = [], &$failedRecipients = null, &$stop = false)
-    {
-    }
+	/**
+	 * Not used.
+	 */
+	public function onCommand(Swift_Transport_SmtpAgent $agent, $command, $codes = [], &$failedRecipients = null, &$stop = false)
+	{
+	}
 
-    /**
-     * Returns +1, -1 or 0 according to the rules for usort().
-     *
-     * This method is called to ensure extensions can be execute in an appropriate order.
-     *
-     * @param string $esmtpKeyword to compare with
-     *
-     * @return int
-     */
-    public function getPriorityOver($esmtpKeyword)
-    {
-        return 0;
-    }
+	/**
+	 * Returns +1, -1 or 0 according to the rules for usort().
+	 *
+	 * This method is called to ensure extensions can be execute in an appropriate order.
+	 *
+	 * @param string $esmtpKeyword to compare with
+	 *
+	 * @return int
+	 */
+	public function getPriorityOver($esmtpKeyword)
+	{
+		return 0;
+	}
 
-    /**
-     * Not used.
-     */
-    public function exposeMixinMethods()
-    {
-        return [];
-    }
+	/**
+	 * Not used.
+	 */
+	public function exposeMixinMethods()
+	{
+		return [];
+	}
 
-    /**
-     * Not used.
-     */
-    public function resetState()
-    {
-    }
+	/**
+	 * Not used.
+	 */
+	public function resetState()
+	{
+	}
 }

htdocs/includes/swiftmailer/lib/classes/Swift/Transport/Esmtp/Auth/CramMd5Authenticator.php

Indentation +49 added lines, -49 removed lines

@@ -15,61 +15,61 @@
  */
 class Swift_Transport_Esmtp_Auth_CramMd5Authenticator implements Swift_Transport_Esmtp_Authenticator
 {
-    /**
-     * Get the name of the AUTH mechanism this Authenticator handles.
-     *
-     * @return string
-     */
-    public function getAuthKeyword()
-    {
-        return 'CRAM-MD5';
-    }
+	/**
+	 * Get the name of the AUTH mechanism this Authenticator handles.
+	 *
+	 * @return string
+	 */
+	public function getAuthKeyword()
+	{
+		return 'CRAM-MD5';
+	}
 
-    /**
-     * {@inheritdoc}
-     */
-    public function authenticate(Swift_Transport_SmtpAgent $agent, $username, $password)
-    {
-        try {
-            $challenge = $agent->executeCommand("AUTH CRAM-MD5\r\n", [334]);
-            $challenge = base64_decode(substr($challenge, 4));
-            $message = base64_encode(
-                $username.' '.$this->getResponse($password, $challenge)
-            );
-            $agent->executeCommand(sprintf("%s\r\n", $message), [235]);
+	/**
+	 * {@inheritdoc}
+	 */
+	public function authenticate(Swift_Transport_SmtpAgent $agent, $username, $password)
+	{
+		try {
+			$challenge = $agent->executeCommand("AUTH CRAM-MD5\r\n", [334]);
+			$challenge = base64_decode(substr($challenge, 4));
+			$message = base64_encode(
+				$username.' '.$this->getResponse($password, $challenge)
+			);
+			$agent->executeCommand(sprintf("%s\r\n", $message), [235]);
 
-            return true;
-        } catch (Swift_TransportException $e) {
-            $agent->executeCommand("RSET\r\n", [250]);
+			return true;
+		} catch (Swift_TransportException $e) {
+			$agent->executeCommand("RSET\r\n", [250]);
 
-            throw $e;
-        }
-    }
+			throw $e;
+		}
+	}
 
-    /**
-     * Generate a CRAM-MD5 response from a server challenge.
-     *
-     * @param string $secret
-     * @param string $challenge
-     *
-     * @return string
-     */
-    private function getResponse($secret, $challenge)
-    {
-        if (\strlen($secret) > 64) {
-            $secret = pack('H32', md5($secret));
-        }
+	/**
+	 * Generate a CRAM-MD5 response from a server challenge.
+	 *
+	 * @param string $secret
+	 * @param string $challenge
+	 *
+	 * @return string
+	 */
+	private function getResponse($secret, $challenge)
+	{
+		if (\strlen($secret) > 64) {
+			$secret = pack('H32', md5($secret));
+		}
 
-        if (\strlen($secret) < 64) {
-            $secret = str_pad($secret, 64, \chr(0));
-        }
+		if (\strlen($secret) < 64) {
+			$secret = str_pad($secret, 64, \chr(0));
+		}
 
-        $k_ipad = substr($secret, 0, 64) ^ str_repeat(\chr(0x36), 64);
-        $k_opad = substr($secret, 0, 64) ^ str_repeat(\chr(0x5C), 64);
+		$k_ipad = substr($secret, 0, 64) ^ str_repeat(\chr(0x36), 64);
+		$k_opad = substr($secret, 0, 64) ^ str_repeat(\chr(0x5C), 64);
 
-        $inner = pack('H32', md5($k_ipad.$challenge));
-        $digest = md5($k_opad.$inner);
+		$inner = pack('H32', md5($k_ipad.$challenge));
+		$digest = md5($k_opad.$inner);
 
-        return $digest;
-    }
+		return $digest;
+	}
 }

htdocs/includes/swiftmailer/lib/classes/Swift/Transport/Esmtp/Auth/LoginAuthenticator.php

Indentation +24 added lines, -24 removed lines

@@ -15,31 +15,31 @@
  */
 class Swift_Transport_Esmtp_Auth_LoginAuthenticator implements Swift_Transport_Esmtp_Authenticator
 {
-    /**
-     * Get the name of the AUTH mechanism this Authenticator handles.
-     *
-     * @return string
-     */
-    public function getAuthKeyword()
-    {
-        return 'LOGIN';
-    }
+	/**
+	 * Get the name of the AUTH mechanism this Authenticator handles.
+	 *
+	 * @return string
+	 */
+	public function getAuthKeyword()
+	{
+		return 'LOGIN';
+	}
 
-    /**
-     * {@inheritdoc}
-     */
-    public function authenticate(Swift_Transport_SmtpAgent $agent, $username, $password)
-    {
-        try {
-            $agent->executeCommand("AUTH LOGIN\r\n", [334]);
-            $agent->executeCommand(sprintf("%s\r\n", base64_encode($username ?? '')), [334]);
-            $agent->executeCommand(sprintf("%s\r\n", base64_encode($password ?? '')), [235]);
+	/**
+	 * {@inheritdoc}
+	 */
+	public function authenticate(Swift_Transport_SmtpAgent $agent, $username, $password)
+	{
+		try {
+			$agent->executeCommand("AUTH LOGIN\r\n", [334]);
+			$agent->executeCommand(sprintf("%s\r\n", base64_encode($username ?? '')), [334]);
+			$agent->executeCommand(sprintf("%s\r\n", base64_encode($password ?? '')), [235]);
 
-            return true;
-        } catch (Swift_TransportException $e) {
-            $agent->executeCommand("RSET\r\n", [250]);
+			return true;
+		} catch (Swift_TransportException $e) {
+			$agent->executeCommand("RSET\r\n", [250]);
 
-            throw $e;
-        }
-    }
+			throw $e;
+		}
+	}
 }