nextcloud / server

lib/private/Mail/Message.php

Indentation +247 added lines, -247 removed lines

@@ -37,251 +37,251 @@
  * @package OC\Mail
  */
 class Message implements IMessage {
-	/** @var Swift_Message */
-	private $swiftMessage;
-	/** @var bool */
-	private $plainTextOnly;
-
-	public function __construct(Swift_Message $swiftMessage, bool $plainTextOnly) {
-		$this->swiftMessage = $swiftMessage;
-		$this->plainTextOnly = $plainTextOnly;
-	}
-
-	/**
-	 * @param IAttachment $attachment
-	 * @return $this
-	 * @since 13.0.0
-	 */
-	public function attach(IAttachment $attachment): IMessage {
-		/** @var Attachment $attachment */
-		$this->swiftMessage->attach($attachment->getSwiftAttachment());
-		return $this;
-	}
-
-	/**
-	 * SwiftMailer does currently not work with IDN domains, this function therefore converts the domains
-	 * FIXME: Remove this once SwiftMailer supports IDN
-	 *
-	 * @param array $addresses Array of mail addresses, key will get converted
-	 * @return array Converted addresses if `idn_to_ascii` exists
-	 */
-	protected function convertAddresses(array $addresses): array {
-		if (!function_exists('idn_to_ascii') || !defined('INTL_IDNA_VARIANT_UTS46')) {
-			return $addresses;
-		}
-
-		$convertedAddresses = [];
-
-		foreach($addresses as $email => $readableName) {
-			if(!is_numeric($email)) {
-				list($name, $domain) = explode('@', $email, 2);
-				$domain = idn_to_ascii($domain, 0, INTL_IDNA_VARIANT_UTS46);
-				$convertedAddresses[$name.'@'.$domain] = $readableName;
-			} else {
-				list($name, $domain) = explode('@', $readableName, 2);
-				$domain = idn_to_ascii($domain, 0, INTL_IDNA_VARIANT_UTS46);
-				$convertedAddresses[$email] = $name.'@'.$domain;
-			}
-		}
-
-		return $convertedAddresses;
-	}
-
-	/**
-	 * Set the from address of this message.
-	 *
-	 * If no "From" address is used \OC\Mail\Mailer will use mail_from_address and mail_domain from config.php
-	 *
-	 * @param array $addresses Example: array('sender@domain.org', 'other@domain.org' => 'A name')
-	 * @return $this
-	 */
-	public function setFrom(array $addresses): IMessage {
-		$addresses = $this->convertAddresses($addresses);
-
-		$this->swiftMessage->setFrom($addresses);
-		return $this;
-	}
-
-	/**
-	 * Get the from address of this message.
-	 *
-	 * @return array
-	 */
-	public function getFrom(): array {
-		return $this->swiftMessage->getFrom();
-	}
-
-	/**
-	 * Set the Reply-To address of this message
-	 *
-	 * @param array $addresses
-	 * @return $this
-	 */
-	public function setReplyTo(array $addresses): IMessage {
-		$addresses = $this->convertAddresses($addresses);
-
-		$this->swiftMessage->setReplyTo($addresses);
-		return $this;
-	}
-
-	/**
-	 * Returns the Reply-To address of this message
-	 *
-	 * @return string
-	 */
-	public function getReplyTo(): string {
-		return $this->swiftMessage->getReplyTo();
-	}
-
-	/**
-	 * Set the to addresses of this message.
-	 *
-	 * @param array $recipients Example: array('recipient@domain.org', 'other@domain.org' => 'A name')
-	 * @return $this
-	 */
-	public function setTo(array $recipients): IMessage {
-		$recipients = $this->convertAddresses($recipients);
-
-		$this->swiftMessage->setTo($recipients);
-		return $this;
-	}
-
-	/**
-	 * Get the to address of this message.
-	 *
-	 * @return array
-	 */
-	public function getTo(): array {
-		return $this->swiftMessage->getTo();
-	}
-
-	/**
-	 * Set the CC recipients of this message.
-	 *
-	 * @param array $recipients Example: array('recipient@domain.org', 'other@domain.org' => 'A name')
-	 * @return $this
-	 */
-	public function setCc(array $recipients): IMessage {
-		$recipients = $this->convertAddresses($recipients);
-
-		$this->swiftMessage->setCc($recipients);
-		return $this;
-	}
-
-	/**
-	 * Get the cc address of this message.
-	 *
-	 * @return array
-	 */
-	public function getCc(): array {
-		return $this->swiftMessage->getCc();
-	}
-
-	/**
-	 * Set the BCC recipients of this message.
-	 *
-	 * @param array $recipients Example: array('recipient@domain.org', 'other@domain.org' => 'A name')
-	 * @return $this
-	 */
-	public function setBcc(array $recipients): IMessage {
-		$recipients = $this->convertAddresses($recipients);
-
-		$this->swiftMessage->setBcc($recipients);
-		return $this;
-	}
-
-	/**
-	 * Get the Bcc address of this message.
-	 *
-	 * @return array
-	 */
-	public function getBcc(): array {
-		return $this->swiftMessage->getBcc();
-	}
-
-	/**
-	 * Set the subject of this message.
-	 *
-	 * @param string $subject
-	 * @return IMessage
-	 */
-	public function setSubject(string $subject): IMessage {
-		$this->swiftMessage->setSubject($subject);
-		return $this;
-	}
-
-	/**
-	 * Get the from subject of this message.
-	 *
-	 * @return string
-	 */
-	public function getSubject(): string {
-		return $this->swiftMessage->getSubject();
-	}
-
-	/**
-	 * Set the plain-text body of this message.
-	 *
-	 * @param string $body
-	 * @return $this
-	 */
-	public function setPlainBody(string $body): IMessage {
-		$this->swiftMessage->setBody($body);
-		return $this;
-	}
-
-	/**
-	 * Get the plain body of this message.
-	 *
-	 * @return string
-	 */
-	public function getPlainBody(): string {
-		return $this->swiftMessage->getBody();
-	}
-
-	/**
-	 * Set the HTML body of this message. Consider also sending a plain-text body instead of only an HTML one.
-	 *
-	 * @param string $body
-	 * @return $this
-	 */
-	public function setHtmlBody($body) {
-		if (!$this->plainTextOnly) {
-			$this->swiftMessage->addPart($body, 'text/html');
-		}
-		return $this;
-	}
-
-	/**
-	 * Get's the underlying SwiftMessage
-	 * @return Swift_Message
-	 */
-	public function getSwiftMessage(): Swift_Message {
-		return $this->swiftMessage;
-	}
-
-	/**
-	 * @param string $body
-	 * @param string $contentType
-	 * @return $this
-	 */
-	public function setBody($body, $contentType) {
-		if (!$this->plainTextOnly || $contentType !== 'text/html') {
-			$this->swiftMessage->setBody($body, $contentType);
-		}
-		return $this;
-	}
-
-	/**
-	 * @param IEMailTemplate $emailTemplate
-	 * @return $this
-	 */
-	public function useTemplate(IEMailTemplate $emailTemplate): IMessage {
-		$this->setSubject($emailTemplate->renderSubject());
-		$this->setPlainBody($emailTemplate->renderText());
-		if (!$this->plainTextOnly) {
-			$this->setHtmlBody($emailTemplate->renderHtml());
-		}
-		return $this;
-	}
+    /** @var Swift_Message */
+    private $swiftMessage;
+    /** @var bool */
+    private $plainTextOnly;
+
+    public function __construct(Swift_Message $swiftMessage, bool $plainTextOnly) {
+        $this->swiftMessage = $swiftMessage;
+        $this->plainTextOnly = $plainTextOnly;
+    }
+
+    /**
+     * @param IAttachment $attachment
+     * @return $this
+     * @since 13.0.0
+     */
+    public function attach(IAttachment $attachment): IMessage {
+        /** @var Attachment $attachment */
+        $this->swiftMessage->attach($attachment->getSwiftAttachment());
+        return $this;
+    }
+
+    /**
+     * SwiftMailer does currently not work with IDN domains, this function therefore converts the domains
+     * FIXME: Remove this once SwiftMailer supports IDN
+     *
+     * @param array $addresses Array of mail addresses, key will get converted
+     * @return array Converted addresses if `idn_to_ascii` exists
+     */
+    protected function convertAddresses(array $addresses): array {
+        if (!function_exists('idn_to_ascii') || !defined('INTL_IDNA_VARIANT_UTS46')) {
+            return $addresses;
+        }
+
+        $convertedAddresses = [];
+
+        foreach($addresses as $email => $readableName) {
+            if(!is_numeric($email)) {
+                list($name, $domain) = explode('@', $email, 2);
+                $domain = idn_to_ascii($domain, 0, INTL_IDNA_VARIANT_UTS46);
+                $convertedAddresses[$name.'@'.$domain] = $readableName;
+            } else {
+                list($name, $domain) = explode('@', $readableName, 2);
+                $domain = idn_to_ascii($domain, 0, INTL_IDNA_VARIANT_UTS46);
+                $convertedAddresses[$email] = $name.'@'.$domain;
+            }
+        }
+
+        return $convertedAddresses;
+    }
+
+    /**
+     * Set the from address of this message.
+     *
+     * If no "From" address is used \OC\Mail\Mailer will use mail_from_address and mail_domain from config.php
+     *
+     * @param array $addresses Example: array('sender@domain.org', 'other@domain.org' => 'A name')
+     * @return $this
+     */
+    public function setFrom(array $addresses): IMessage {
+        $addresses = $this->convertAddresses($addresses);
+
+        $this->swiftMessage->setFrom($addresses);
+        return $this;
+    }
+
+    /**
+     * Get the from address of this message.
+     *
+     * @return array
+     */
+    public function getFrom(): array {
+        return $this->swiftMessage->getFrom();
+    }
+
+    /**
+     * Set the Reply-To address of this message
+     *
+     * @param array $addresses
+     * @return $this
+     */
+    public function setReplyTo(array $addresses): IMessage {
+        $addresses = $this->convertAddresses($addresses);
+
+        $this->swiftMessage->setReplyTo($addresses);
+        return $this;
+    }
+
+    /**
+     * Returns the Reply-To address of this message
+     *
+     * @return string
+     */
+    public function getReplyTo(): string {
+        return $this->swiftMessage->getReplyTo();
+    }
+
+    /**
+     * Set the to addresses of this message.
+     *
+     * @param array $recipients Example: array('recipient@domain.org', 'other@domain.org' => 'A name')
+     * @return $this
+     */
+    public function setTo(array $recipients): IMessage {
+        $recipients = $this->convertAddresses($recipients);
+
+        $this->swiftMessage->setTo($recipients);
+        return $this;
+    }
+
+    /**
+     * Get the to address of this message.
+     *
+     * @return array
+     */
+    public function getTo(): array {
+        return $this->swiftMessage->getTo();
+    }
+
+    /**
+     * Set the CC recipients of this message.
+     *
+     * @param array $recipients Example: array('recipient@domain.org', 'other@domain.org' => 'A name')
+     * @return $this
+     */
+    public function setCc(array $recipients): IMessage {
+        $recipients = $this->convertAddresses($recipients);
+
+        $this->swiftMessage->setCc($recipients);
+        return $this;
+    }
+
+    /**
+     * Get the cc address of this message.
+     *
+     * @return array
+     */
+    public function getCc(): array {
+        return $this->swiftMessage->getCc();
+    }
+
+    /**
+     * Set the BCC recipients of this message.
+     *
+     * @param array $recipients Example: array('recipient@domain.org', 'other@domain.org' => 'A name')
+     * @return $this
+     */
+    public function setBcc(array $recipients): IMessage {
+        $recipients = $this->convertAddresses($recipients);
+
+        $this->swiftMessage->setBcc($recipients);
+        return $this;
+    }
+
+    /**
+     * Get the Bcc address of this message.
+     *
+     * @return array
+     */
+    public function getBcc(): array {
+        return $this->swiftMessage->getBcc();
+    }
+
+    /**
+     * Set the subject of this message.
+     *
+     * @param string $subject
+     * @return IMessage
+     */
+    public function setSubject(string $subject): IMessage {
+        $this->swiftMessage->setSubject($subject);
+        return $this;
+    }
+
+    /**
+     * Get the from subject of this message.
+     *
+     * @return string
+     */
+    public function getSubject(): string {
+        return $this->swiftMessage->getSubject();
+    }
+
+    /**
+     * Set the plain-text body of this message.
+     *
+     * @param string $body
+     * @return $this
+     */
+    public function setPlainBody(string $body): IMessage {
+        $this->swiftMessage->setBody($body);
+        return $this;
+    }
+
+    /**
+     * Get the plain body of this message.
+     *
+     * @return string
+     */
+    public function getPlainBody(): string {
+        return $this->swiftMessage->getBody();
+    }
+
+    /**
+     * Set the HTML body of this message. Consider also sending a plain-text body instead of only an HTML one.
+     *
+     * @param string $body
+     * @return $this
+     */
+    public function setHtmlBody($body) {
+        if (!$this->plainTextOnly) {
+            $this->swiftMessage->addPart($body, 'text/html');
+        }
+        return $this;
+    }
+
+    /**
+     * Get's the underlying SwiftMessage
+     * @return Swift_Message
+     */
+    public function getSwiftMessage(): Swift_Message {
+        return $this->swiftMessage;
+    }
+
+    /**
+     * @param string $body
+     * @param string $contentType
+     * @return $this
+     */
+    public function setBody($body, $contentType) {
+        if (!$this->plainTextOnly || $contentType !== 'text/html') {
+            $this->swiftMessage->setBody($body, $contentType);
+        }
+        return $this;
+    }
+
+    /**
+     * @param IEMailTemplate $emailTemplate
+     * @return $this
+     */
+    public function useTemplate(IEMailTemplate $emailTemplate): IMessage {
+        $this->setSubject($emailTemplate->renderSubject());
+        $this->setPlainBody($emailTemplate->renderText());
+        if (!$this->plainTextOnly) {
+            $this->setHtmlBody($emailTemplate->renderHtml());
+        }
+        return $this;
+    }
 }

lib/private/Mail/Mailer.php

Indentation +212 added lines, -212 removed lines

@@ -55,242 +55,242 @@
  * @package OC\Mail
  */
 class Mailer implements IMailer {
-	/** @var \Swift_SmtpTransport|\Swift_SendmailTransport|\Swift_MailTransport Cached transport */
-	private $instance = null;
-	/** @var IConfig */
-	private $config;
-	/** @var ILogger */
-	private $logger;
-	/** @var Defaults */
-	private $defaults;
-	/** @var IURLGenerator */
-	private $urlGenerator;
-	/** @var IL10N */
-	private $l10n;
+    /** @var \Swift_SmtpTransport|\Swift_SendmailTransport|\Swift_MailTransport Cached transport */
+    private $instance = null;
+    /** @var IConfig */
+    private $config;
+    /** @var ILogger */
+    private $logger;
+    /** @var Defaults */
+    private $defaults;
+    /** @var IURLGenerator */
+    private $urlGenerator;
+    /** @var IL10N */
+    private $l10n;
 
-	/**
-	 * @param IConfig $config
-	 * @param ILogger $logger
-	 * @param Defaults $defaults
-	 * @param IURLGenerator $urlGenerator
-	 * @param IL10N $l10n
-	 */
-	public function __construct(IConfig $config,
-						 ILogger $logger,
-						 Defaults $defaults,
-						 IURLGenerator $urlGenerator,
-						 IL10N $l10n) {
-		$this->config = $config;
-		$this->logger = $logger;
-		$this->defaults = $defaults;
-		$this->urlGenerator = $urlGenerator;
-		$this->l10n = $l10n;
-	}
+    /**
+     * @param IConfig $config
+     * @param ILogger $logger
+     * @param Defaults $defaults
+     * @param IURLGenerator $urlGenerator
+     * @param IL10N $l10n
+     */
+    public function __construct(IConfig $config,
+                            ILogger $logger,
+                            Defaults $defaults,
+                            IURLGenerator $urlGenerator,
+                            IL10N $l10n) {
+        $this->config = $config;
+        $this->logger = $logger;
+        $this->defaults = $defaults;
+        $this->urlGenerator = $urlGenerator;
+        $this->l10n = $l10n;
+    }
 
-	/**
-	 * Creates a new message object that can be passed to send()
-	 *
-	 * @return IMessage
-	 */
-	public function createMessage(): IMessage {
-		$plainTextOnly = $this->config->getSystemValue('mail_send_plaintext_only', false);
-		return new Message(new \Swift_Message(), $plainTextOnly);
-	}
+    /**
+     * Creates a new message object that can be passed to send()
+     *
+     * @return IMessage
+     */
+    public function createMessage(): IMessage {
+        $plainTextOnly = $this->config->getSystemValue('mail_send_plaintext_only', false);
+        return new Message(new \Swift_Message(), $plainTextOnly);
+    }
 
-	/**
-	 * @param string|null $data
-	 * @param string|null $filename
-	 * @param string|null $contentType
-	 * @return IAttachment
-	 * @since 13.0.0
-	 */
-	public function createAttachment($data = null, $filename = null, $contentType = null): IAttachment {
-		return new Attachment(\Swift_Attachment::newInstance($data, $filename, $contentType));
-	}
+    /**
+     * @param string|null $data
+     * @param string|null $filename
+     * @param string|null $contentType
+     * @return IAttachment
+     * @since 13.0.0
+     */
+    public function createAttachment($data = null, $filename = null, $contentType = null): IAttachment {
+        return new Attachment(\Swift_Attachment::newInstance($data, $filename, $contentType));
+    }
 
-	/**
-	 * @param string $path
-	 * @param string|null $contentType
-	 * @return IAttachment
-	 * @since 13.0.0
-	 */
-	public function createAttachmentFromPath(string $path, $contentType = null): IAttachment {
-		return new Attachment(\Swift_Attachment::fromPath($path, $contentType));
-	}
+    /**
+     * @param string $path
+     * @param string|null $contentType
+     * @return IAttachment
+     * @since 13.0.0
+     */
+    public function createAttachmentFromPath(string $path, $contentType = null): IAttachment {
+        return new Attachment(\Swift_Attachment::fromPath($path, $contentType));
+    }
 
-	/**
-	 * Creates a new email template object
-	 *
-	 * @param string $emailId
-	 * @param array $data
-	 * @return IEMailTemplate
-	 * @since 12.0.0
-	 */
-	public function createEMailTemplate(string $emailId, array $data = []): IEMailTemplate {
-		$class = $this->config->getSystemValue('mail_template_class', '');
+    /**
+     * Creates a new email template object
+     *
+     * @param string $emailId
+     * @param array $data
+     * @return IEMailTemplate
+     * @since 12.0.0
+     */
+    public function createEMailTemplate(string $emailId, array $data = []): IEMailTemplate {
+        $class = $this->config->getSystemValue('mail_template_class', '');
 
-		if ($class !== '' && class_exists($class) && is_a($class, EMailTemplate::class, true)) {
-			return new $class(
-				$this->defaults,
-				$this->urlGenerator,
-				$this->l10n,
-				$emailId,
-				$data
-			);
-		}
+        if ($class !== '' && class_exists($class) && is_a($class, EMailTemplate::class, true)) {
+            return new $class(
+                $this->defaults,
+                $this->urlGenerator,
+                $this->l10n,
+                $emailId,
+                $data
+            );
+        }
 
-		return new EMailTemplate(
-			$this->defaults,
-			$this->urlGenerator,
-			$this->l10n,
-			$emailId,
-			$data
-		);
-	}
+        return new EMailTemplate(
+            $this->defaults,
+            $this->urlGenerator,
+            $this->l10n,
+            $emailId,
+            $data
+        );
+    }
 
-	/**
-	 * Send the specified message. Also sets the from address to the value defined in config.php
-	 * if no-one has been passed.
-	 *
-	 * @param IMessage|Message $message Message to send
-	 * @return string[] Array with failed recipients. Be aware that this depends on the used mail backend and
-	 * therefore should be considered
-	 * @throws \Exception In case it was not possible to send the message. (for example if an invalid mail address
-	 * has been supplied.)
-	 */
-	public function send(IMessage $message): array {
-		$debugMode = $this->config->getSystemValue('mail_smtpdebug', false);
+    /**
+     * Send the specified message. Also sets the from address to the value defined in config.php
+     * if no-one has been passed.
+     *
+     * @param IMessage|Message $message Message to send
+     * @return string[] Array with failed recipients. Be aware that this depends on the used mail backend and
+     * therefore should be considered
+     * @throws \Exception In case it was not possible to send the message. (for example if an invalid mail address
+     * has been supplied.)
+     */
+    public function send(IMessage $message): array {
+        $debugMode = $this->config->getSystemValue('mail_smtpdebug', false);
 
-		if (empty($message->getFrom())) {
-			$message->setFrom([\OCP\Util::getDefaultEmailAddress($this->defaults->getName()) => $this->defaults->getName()]);
-		}
+        if (empty($message->getFrom())) {
+            $message->setFrom([\OCP\Util::getDefaultEmailAddress($this->defaults->getName()) => $this->defaults->getName()]);
+        }
 
-		$failedRecipients = [];
+        $failedRecipients = [];
 
-		$mailer = $this->getInstance();
+        $mailer = $this->getInstance();
 
-		// Enable logger if debug mode is enabled
-		if($debugMode) {
-			$mailLogger = new \Swift_Plugins_Loggers_ArrayLogger();
-			$mailer->registerPlugin(new \Swift_Plugins_LoggerPlugin($mailLogger));
-		}
+        // Enable logger if debug mode is enabled
+        if($debugMode) {
+            $mailLogger = new \Swift_Plugins_Loggers_ArrayLogger();
+            $mailer->registerPlugin(new \Swift_Plugins_LoggerPlugin($mailLogger));
+        }
 
-		$mailer->send($message->getSwiftMessage(), $failedRecipients);
+        $mailer->send($message->getSwiftMessage(), $failedRecipients);
 
-		// Debugging logging
-		$logMessage = sprintf('Sent mail to "%s" with subject "%s"', print_r($message->getTo(), true), $message->getSubject());
-		$this->logger->debug($logMessage, ['app' => 'core']);
-		if($debugMode && isset($mailLogger)) {
-			$this->logger->debug($mailLogger->dump(), ['app' => 'core']);
-		}
+        // Debugging logging
+        $logMessage = sprintf('Sent mail to "%s" with subject "%s"', print_r($message->getTo(), true), $message->getSubject());
+        $this->logger->debug($logMessage, ['app' => 'core']);
+        if($debugMode && isset($mailLogger)) {
+            $this->logger->debug($mailLogger->dump(), ['app' => 'core']);
+        }
 
-		return $failedRecipients;
-	}
+        return $failedRecipients;
+    }
 
-	/**
-	 * Checks if an e-mail address is valid
-	 *
-	 * @param string $email Email address to be validated
-	 * @return bool True if the mail address is valid, false otherwise
-	 */
-	public function validateMailAddress(string $email): bool {
-		return \Swift_Validate::email($this->convertEmail($email));
-	}
+    /**
+     * Checks if an e-mail address is valid
+     *
+     * @param string $email Email address to be validated
+     * @return bool True if the mail address is valid, false otherwise
+     */
+    public function validateMailAddress(string $email): bool {
+        return \Swift_Validate::email($this->convertEmail($email));
+    }
 
-	/**
-	 * SwiftMailer does currently not work with IDN domains, this function therefore converts the domains
-	 *
-	 * FIXME: Remove this once SwiftMailer supports IDN
-	 *
-	 * @param string $email
-	 * @return string Converted mail address if `idn_to_ascii` exists
-	 */
-	protected function convertEmail(string $email): string {
-		if (!function_exists('idn_to_ascii') || !defined('INTL_IDNA_VARIANT_UTS46') || strpos($email, '@') === false) {
-			return $email;
-		}
+    /**
+     * SwiftMailer does currently not work with IDN domains, this function therefore converts the domains
+     *
+     * FIXME: Remove this once SwiftMailer supports IDN
+     *
+     * @param string $email
+     * @return string Converted mail address if `idn_to_ascii` exists
+     */
+    protected function convertEmail(string $email): string {
+        if (!function_exists('idn_to_ascii') || !defined('INTL_IDNA_VARIANT_UTS46') || strpos($email, '@') === false) {
+            return $email;
+        }
 
-		list($name, $domain) = explode('@', $email, 2);
-		$domain = idn_to_ascii($domain, 0,INTL_IDNA_VARIANT_UTS46);
-		return $name.'@'.$domain;
-	}
+        list($name, $domain) = explode('@', $email, 2);
+        $domain = idn_to_ascii($domain, 0,INTL_IDNA_VARIANT_UTS46);
+        return $name.'@'.$domain;
+    }
 
-	/**
-	 * Returns whatever transport is configured within the config
-	 *
-	 * @return \Swift_SmtpTransport|\Swift_SendmailTransport|\Swift_MailTransport
-	 */
-	protected function getInstance() {
-		if (!is_null($this->instance)) {
-			return $this->instance;
-		}
+    /**
+     * Returns whatever transport is configured within the config
+     *
+     * @return \Swift_SmtpTransport|\Swift_SendmailTransport|\Swift_MailTransport
+     */
+    protected function getInstance() {
+        if (!is_null($this->instance)) {
+            return $this->instance;
+        }
 
-		switch ($this->config->getSystemValue('mail_smtpmode', 'php')) {
-			case 'smtp':
-				$this->instance = $this->getSmtpInstance();
-				break;
-			case 'sendmail':
-				// FIXME: Move into the return statement but requires proper testing
-				//       for SMTP and mail as well. Thus not really doable for a
-				//       minor release.
-				$this->instance = \Swift_Mailer::newInstance($this->getSendMailInstance());
-				break;
-			default:
-				$this->instance = $this->getMailInstance();
-				break;
-		}
+        switch ($this->config->getSystemValue('mail_smtpmode', 'php')) {
+            case 'smtp':
+                $this->instance = $this->getSmtpInstance();
+                break;
+            case 'sendmail':
+                // FIXME: Move into the return statement but requires proper testing
+                //       for SMTP and mail as well. Thus not really doable for a
+                //       minor release.
+                $this->instance = \Swift_Mailer::newInstance($this->getSendMailInstance());
+                break;
+            default:
+                $this->instance = $this->getMailInstance();
+                break;
+        }
 
-		return $this->instance;
-	}
+        return $this->instance;
+    }
 
-	/**
-	 * Returns the SMTP transport
-	 *
-	 * @return \Swift_SmtpTransport
-	 */
-	protected function getSmtpInstance(): \Swift_SmtpTransport {
-		$transport = \Swift_SmtpTransport::newInstance();
-		$transport->setTimeout($this->config->getSystemValue('mail_smtptimeout', 10));
-		$transport->setHost($this->config->getSystemValue('mail_smtphost', '127.0.0.1'));
-		$transport->setPort($this->config->getSystemValue('mail_smtpport', 25));
-		if ($this->config->getSystemValue('mail_smtpauth', false)) {
-			$transport->setUsername($this->config->getSystemValue('mail_smtpname', ''));
-			$transport->setPassword($this->config->getSystemValue('mail_smtppassword', ''));
-			$transport->setAuthMode($this->config->getSystemValue('mail_smtpauthtype', 'LOGIN'));
-		}
-		$smtpSecurity = $this->config->getSystemValue('mail_smtpsecure', '');
-		if (!empty($smtpSecurity)) {
-			$transport->setEncryption($smtpSecurity);
-		}
-		$transport->start();
-		return $transport;
-	}
+    /**
+     * Returns the SMTP transport
+     *
+     * @return \Swift_SmtpTransport
+     */
+    protected function getSmtpInstance(): \Swift_SmtpTransport {
+        $transport = \Swift_SmtpTransport::newInstance();
+        $transport->setTimeout($this->config->getSystemValue('mail_smtptimeout', 10));
+        $transport->setHost($this->config->getSystemValue('mail_smtphost', '127.0.0.1'));
+        $transport->setPort($this->config->getSystemValue('mail_smtpport', 25));
+        if ($this->config->getSystemValue('mail_smtpauth', false)) {
+            $transport->setUsername($this->config->getSystemValue('mail_smtpname', ''));
+            $transport->setPassword($this->config->getSystemValue('mail_smtppassword', ''));
+            $transport->setAuthMode($this->config->getSystemValue('mail_smtpauthtype', 'LOGIN'));
+        }
+        $smtpSecurity = $this->config->getSystemValue('mail_smtpsecure', '');
+        if (!empty($smtpSecurity)) {
+            $transport->setEncryption($smtpSecurity);
+        }
+        $transport->start();
+        return $transport;
+    }
 
-	/**
-	 * Returns the sendmail transport
-	 *
-	 * @return \Swift_SendmailTransport
-	 */
-	protected function getSendMailInstance(): \Swift_SendmailTransport {
-		switch ($this->config->getSystemValue('mail_smtpmode', 'php')) {
-			case 'qmail':
-				$binaryPath = '/var/qmail/bin/sendmail';
-				break;
-			default:
-				$binaryPath = '/usr/sbin/sendmail';
-				break;
-		}
+    /**
+     * Returns the sendmail transport
+     *
+     * @return \Swift_SendmailTransport
+     */
+    protected function getSendMailInstance(): \Swift_SendmailTransport {
+        switch ($this->config->getSystemValue('mail_smtpmode', 'php')) {
+            case 'qmail':
+                $binaryPath = '/var/qmail/bin/sendmail';
+                break;
+            default:
+                $binaryPath = '/usr/sbin/sendmail';
+                break;
+        }
 
-		return \Swift_SendmailTransport::newInstance($binaryPath . ' -bs');
-	}
+        return \Swift_SendmailTransport::newInstance($binaryPath . ' -bs');
+    }
 
-	/**
-	 * Returns the mail transport
-	 *
-	 * @return \Swift_MailTransport
-	 */
-	protected function getMailInstance(): \Swift_MailTransport {
-		return \Swift_MailTransport::newInstance();
-	}
+    /**
+     * Returns the mail transport
+     *
+     * @return \Swift_MailTransport
+     */
+    protected function getMailInstance(): \Swift_MailTransport {
+        return \Swift_MailTransport::newInstance();
+    }
 
 }