MailMessage.php

Go to the documentation of this file.

<?php
 
/*
 * This file is part of the TYPO3 CMS project.
 *
 * It is free software; you can redistribute it and/or modify it under
 * the terms of the GNU General Public License, either version 2
 * of the License, or any later version.
 *
 * For the full copyright and license information, please read the
 * LICENSE.txt file that was distributed with this source code.
 *
 * The TYPO3 project - inspiring people to share!
 */
 
namespace ‪TYPO3\CMS\Core\Mail;
 
use Symfony\Component\Mime\Address;
use Symfony\Component\Mime\Email;
use ‪TYPO3\CMS\Core\Utility\GeneralUtility;
 
class ‪MailMessage extends Email
{
    protected ‪MailerInterface ‪$mailer;
 
    protected bool ‪$sent = false;
 
    private function ‪initializeMailer(): void
    {
        // TODO: DI should be used to inject the MailerInterface
        $this->mailer ??= GeneralUtility::makeInstance(MailerInterface::class);
    }
 
    public function ‪send(): bool
    {
        $this->‪initializeMailer();
        $this->sent = false;
        $this->mailer->send($this);
        $sentMessage = $this->mailer->getSentMessage();
        if ($sentMessage) {
            $this->sent = true;
        }
        return ‪$this->sent;
    }
 
    public function ‪isSent(): bool
    {
        return ‪$this->sent;
    }
 
    public function ‪setSubject($subject): self
    {
        return $this->subject($subject);
    }
 
    public function ‪setDate($date): self
    {
        return $this->date((new \DateTime())->setTimestamp($date));
    }
 
    public function ‪setReturnPath($address): self
    {
        return $this->returnPath($address);
    }
 
    public function ‪setSender($address, $name = null): self
    {
        return $this->sender(...$this->‪convertNamedAddress($address, $name));
    }
 
    public function ‪setFrom($addresses, $name = null): self
    {
        $this->‪checkArguments($addresses, $name);
        return $this->from(...$this->‪convertNamedAddress($addresses, $name));
    }
 
    public function ‪setReplyTo($addresses, $name = null): self
    {
        $this->‪checkArguments($addresses, $name);
        return $this->replyTo(...$this->‪convertNamedAddress($addresses, $name));
    }
 
    public function ‪setTo($addresses, $name = null): self
    {
        $this->‪checkArguments($addresses, $name);
        return $this->to(...$this->‪convertNamedAddress($addresses, $name));
    }
 
    public function ‪setCc($addresses, $name = null): self
    {
        $this->‪checkArguments($addresses, $name);
        return $this->cc(...$this->‪convertNamedAddress($addresses, $name));
    }
 
    public function ‪setBcc($addresses, $name = null): self
    {
        $this->‪checkArguments($addresses, $name);
        return $this->bcc(...$this->‪convertNamedAddress($addresses, $name));
    }
 
    public function ‪setReadReceiptTo(string $address): self
    {
        $this->getHeaders()->addMailboxHeader('Disposition-Notification-To', $address);
        return $this;
    }
 
    protected function ‪convertNamedAddress(...‪$args): array
    {
        if (isset(‪$args[1])) {
            return [Address::create(sprintf('%s <%s>', ‪$args[1], ‪$args[0]))];
        }
        if (is_string(‪$args[0]) || is_array(‪$args[0])) {
            return $this->‪convertAddresses(‪$args[0]);
        }
        return $this->‪convertAddresses(‪$args);
    }
 
    protected function ‪convertAddresses($addresses): array
    {
        if (!is_array($addresses)) {
            return [Address::create($addresses)];
        }
        $newAddresses = [];
        foreach ($addresses as $email => $name) {
            if (is_numeric($email) || ctype_digit($email)) {
                $newAddresses[] = Address::create($name);
            } else {
                $newAddresses[] = Address::create(sprintf('%s <%s>', $name, $email));
            }
        }
 
        return $newAddresses;
    }
 
    //
    // Compatibility methods, as it was possible in TYPO3 v9 / SwiftMailer.
    //
 
    public function ‪addFrom(Address|string|null|array ...$addresses): static
    {
        return parent::addFrom(...$this->‪convertNamedAddress(...$addresses));
    }
 
    public function ‪addReplyTo(Address|string|null|array ...$addresses): static
    {
        return parent::addReplyTo(...$this->‪convertNamedAddress(...$addresses));
    }
 
    public function ‪addTo(Address|string|null|array ...$addresses): static
    {
        return parent::addTo(...$this->‪convertNamedAddress(...$addresses));
    }
 
    public function ‪addCc(Address|string|null|array ...$addresses): static
    {
        return parent::addCc(...$this->‪convertNamedAddress(...$addresses));
    }
 
    public function ‪addBcc(Address|string|null|array ...$addresses): static
    {
        return parent::addBcc(...$this->‪convertNamedAddress(...$addresses));
    }
 
    protected function ‪checkArguments($addresses, string $name = null): void
    {
        if ($name !== null && !is_string($addresses)) {
            throw new \InvalidArgumentException('The combination of a name and an array of addresses is invalid.', 1570543657);
        }
    }
}