ilMailMimeTransportBase Class Reference

Class ilMailMimeTransportBase. More...

Inheritance diagram for ilMailMimeTransportBase:

Collaboration diagram for ilMailMimeTransportBase:

Public Member Functions
	__construct (ilSetting $settings, ilAppEventHandler $eventHandler)
	send (ilMimeMail $mail)

Protected Member Functions
	getMailer ()
	setMailer (PHPMailer $mailer)
	resetMailer ()
	onBeforeSend ()

Protected Attributes
PHPMailer	$mailer
ilSetting	$settings

Private Attributes
ilAppEventHandler	$eventHandler

Detailed Description

Class ilMailMimeTransportBase.

Definition at line 26 of file class.ilMailMimeTransportBase.php.

Constructor & Destructor Documentation

__construct()

ilMailMimeTransportBase::__construct	(	ilSetting	$settings,
		ilAppEventHandler	$eventHandler
	)

Definition at line 32 of file class.ilMailMimeTransportBase.php.

References $eventHandler, $settings, setMailer(), and ILIAS\Repository\settings().

    {
        $this->settings = $settings;
        $this->eventHandler = $eventHandler;

        $mail = new PHPMailer();
        $this->setMailer($mail);
    }

Here is the call graph for this function:

Member Function Documentation

getMailer()

ilMailMimeTransportBase::getMailer ( )

protected

Definition at line 41 of file class.ilMailMimeTransportBase.php.

References $mailer.

Referenced by resetMailer(), and send().

                                  : PHPMailer
    {
        return $this->mailer;
    }

Here is the caller graph for this function:

onBeforeSend()

ilMailMimeTransportBase::onBeforeSend ( )

protected

Definition at line 59 of file class.ilMailMimeTransportBase.php.

Referenced by send().

                                     : void
    {
    }

Here is the caller graph for this function:

resetMailer()

ilMailMimeTransportBase::resetMailer ( )

protected

Definition at line 51 of file class.ilMailMimeTransportBase.php.

References getMailer().

Referenced by send().

                                    : void
    {
        $this->getMailer()->clearAllRecipients();
        $this->getMailer()->clearAttachments();
        $this->getMailer()->clearReplyTos();
        $this->getMailer()->ErrorInfo = '';
    }

Here is the call graph for this function:

Here is the caller graph for this function:

send()

ilMailMimeTransportBase::send ( ilMimeMail  $mail )

final

Implements ilMailMimeTransport.

Definition at line 63 of file class.ilMailMimeTransportBase.php.

References $GLOBALS, $message, ilMimeMail\getAttachments(), ilMimeMail\getBcc(), ilMimeMail\getCc(), ilMimeMail\getFinalBody(), ilMimeMail\getFinalBodyAlt(), ilMimeMail\getFrom(), ILIAS\Survey\Mode\getId(), ilMimeMail\getImages(), ilLoggerFactory\getLogger(), getMailer(), ilMimeMail\getSubject(), ilMimeMail\getTo(), onBeforeSend(), resetMailer(), and ILIAS\Repository\user().

                                                : bool
    {
        $this->resetMailer();

        $this->getMailer()->XMailer = ' ';

        foreach ($mail->getTo() as $recipients) {
            $recipient_pieces = array_filter(array_map('trim', explode(',', $recipients)));
            foreach ($recipient_pieces as $recipient) {
                if (!$this->getMailer()->addAddress($recipient)) {
                    ilLoggerFactory::getLogger('mail')->warning($this->getMailer()->ErrorInfo);
                }
            }
        }

        foreach ($mail->getCc() as $carbon_copies) {
            $cc_pieces = array_filter(array_map('trim', explode(',', $carbon_copies)));
            foreach ($cc_pieces as $carbon_copy) {
                if (!$this->getMailer()->addCC($carbon_copy)) {
                    ilLoggerFactory::getLogger('mail')->warning($this->getMailer()->ErrorInfo);
                }
            }
        }

        foreach ($mail->getBcc() as $blind_carbon_copies) {
            $bcc_pieces = array_filter(array_map('trim', explode(',', $blind_carbon_copies)));
            foreach ($bcc_pieces as $blind_carbon_copy) {
                if (!$this->getMailer()->addBCC($blind_carbon_copy)) {
                    ilLoggerFactory::getLogger('mail')->warning($this->getMailer()->ErrorInfo);
                }
            }
        }

        $this->getMailer()->Subject = $mail->getSubject();

        if ($mail->getFrom()->hasReplyToAddress()) {
            if (!$this->getMailer()->addReplyTo($mail->getFrom()->getReplyToAddress(), $mail->getFrom()->getReplyToName())) {
                ilLoggerFactory::getLogger('mail')->warning($this->getMailer()->ErrorInfo);
            }
        }
        if ($mail->getFrom()->hasEnvelopFromAddress()) {
            $this->getMailer()->Sender = $mail->getFrom()->getEnvelopFromAddress();
        }

        if (!$this->getMailer()->setFrom($mail->getFrom()->getFromAddress(), $mail->getFrom()->getFromName(), false)) {
            ilLoggerFactory::getLogger('mail')->warning($this->getMailer()->ErrorInfo);
        }

        foreach ($mail->getAttachments() as $attachment) {
            if (!$this->getMailer()->addAttachment($attachment['path'], $attachment['name'])) {
                ilLoggerFactory::getLogger('mail')->warning($this->getMailer()->ErrorInfo);
            }
        }

        foreach ($mail->getImages() as $image) {
            if (!$this->getMailer()->addEmbeddedImage($image['path'], $image['cid'], $image['name'])) {
                ilLoggerFactory::getLogger('mail')->warning($this->getMailer()->ErrorInfo);
            }
        }

        if ($mail->getFinalBodyAlt()) {
            $this->getMailer()->isHTML(true);
            $this->getMailer()->AltBody = $mail->getFinalBodyAlt();
        } else {
            $this->getMailer()->isHTML(false);
            $this->getMailer()->AltBody = '';
        }
        $this->getMailer()->Body = $mail->getFinalBody();

        ilLoggerFactory::getLogger('mail')->info(sprintf(
            "Trying to delegate external email delivery:" .
            " Initiated by: %s (%s) " .
            "| To: %s | CC: %s | BCC: %s | Subject: %s " .
            "| From: %s / %s " .
            "| ReplyTo: %s / %s " .
            "| EnvelopeFrom: %s",
            $GLOBALS['DIC']->user()->getLogin(),
            $GLOBALS['DIC']->user()->getId(),
            implode(', ', $mail->getTo()),
            implode(', ', $mail->getCc()),
            implode(', ', $mail->getBcc()),
            $mail->getSubject(),
            $mail->getFrom()->getFromAddress(),
            $mail->getFrom()->getFromName(),
            $mail->getFrom()->getReplyToAddress(),
            $mail->getFrom()->getReplyToName(),
            $mail->getFrom()->getEnvelopFromAddress()
        ));

        ilLoggerFactory::getLogger('mail')
                       ->debug(sprintf("Mail Alternative Body: %s", $this->getMailer()->AltBody));
        ilLoggerFactory::getLogger('mail')
                       ->debug(sprintf("Mail Body: %s", $this->getMailer()->Body));

        $this->getMailer()->CharSet = 'utf-8';

        $this->mailer->Debugoutput = static function (string $message, $level): void {
            if (
                strpos($message, 'Invalid address') ||
                strpos($message, 'Message body empty')
            ) {
                ilLoggerFactory::getLogger('mail')->warning($message);
            } else {
                ilLoggerFactory::getLogger('mail')->debug($message);
            }
        };

        $this->onBeforeSend();
        $result = $this->getMailer()->send();
        if ($result) {
            ilLoggerFactory::getLogger('mail')
                           ->info('Successfully delegated external mail delivery');

            if ($this->getMailer()->ErrorInfo !== '') {
                ilLoggerFactory::getLogger('mail')->warning(sprintf(
                    '... with most recent errors: %s',
                    $this->getMailer()->ErrorInfo
                ));
            }
        } else {
            ilLoggerFactory::getLogger('mail')->warning(sprintf(
                'Could not deliver external email: %s',
                $this->getMailer()->ErrorInfo
            ));
        }

        $this->eventHandler->raise('Services/Mail', 'externalEmailDelegated', [
            'mail' => $mail,
            'result' => $result,
        ]);

        return $result;
    }

Here is the call graph for this function:

setMailer()

ilMailMimeTransportBase::setMailer ( PHPMailer  $mailer )

protected

Definition at line 46 of file class.ilMailMimeTransportBase.php.

References $mailer.

Referenced by __construct().

                                                   : void
    {
        $this->mailer = $mailer;
    }

Here is the caller graph for this function:

Field Documentation

$eventHandler

ilAppEventHandler ilMailMimeTransportBase::$eventHandler

private

Definition at line 30 of file class.ilMailMimeTransportBase.php.

Referenced by __construct().

$mailer

PHPMailer ilMailMimeTransportBase::$mailer

protected

Definition at line 28 of file class.ilMailMimeTransportBase.php.

Referenced by getMailer(), and setMailer().

$settings

ilSetting ilMailMimeTransportBase::$settings

protected

Definition at line 29 of file class.ilMailMimeTransportBase.php.

Referenced by __construct().

---

The documentation for this class was generated from the following file:

• Services/Mail/classes/Mime/Transport/class.ilMailMimeTransportBase.php