TYPO3 CMS  TYPO3_6-2
TYPO3\CMS\Core\Mail\MailMessage Class Reference
Inheritance diagram for TYPO3\CMS\Core\Mail\MailMessage:
t3lib_mail_Message

Public Member Functions

 send ()
 
 isSent ()
 
 getFailedRecipients ()
 

Protected Attributes

 $mailer
 
 $mailerHeader = 'TYPO3'
 
 $sent = FALSE
 
 $failedRecipients = array()
 

Private Member Functions

 initializeMailer ()
 

Detailed Description

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! Adapter for Swift_Mailer to be used by TYPO3 extensions

Author
Ernesto Baschny ernst.nosp@m.@cro.nosp@m.n-it..nosp@m.de

Definition at line 25 of file MailMessage.php.

Member Function Documentation

◆ getFailedRecipients()

TYPO3\CMS\Core\Mail\MailMessage::getFailedRecipients ( )

Returns the recipients for which the mail was not accepted for delivery.

Returns
array the recipients who were not accepted for delivery
Author
Karsten Dambekalns karst.nosp@m.en@t.nosp@m.ypo3..nosp@m.org

Definition at line 87 of file MailMessage.php.

References TYPO3\CMS\Core\Mail\MailMessage\$failedRecipients.

◆ initializeMailer()

TYPO3\CMS\Core\Mail\MailMessage::initializeMailer ( )
private
Returns
void

Definition at line 54 of file MailMessage.php.

References TYPO3\CMS\Core\Utility\GeneralUtility\makeInstance().

Referenced by TYPO3\CMS\Core\Mail\MailMessage\send().

◆ isSent()

TYPO3\CMS\Core\Mail\MailMessage::isSent ( )

Checks whether the message has been sent.

Returns
boolean
Author
Karsten Dambekalns karst.nosp@m.en@t.nosp@m.ypo3..nosp@m.org

Definition at line 77 of file MailMessage.php.

References TYPO3\CMS\Core\Mail\MailMessage\$sent.

◆ send()

TYPO3\CMS\Core\Mail\MailMessage::send ( )

Sends the message.

Returns
integer the number of recipients who were accepted for delivery
Author
Karsten Dambekalns karst.nosp@m.en@t.nosp@m.ypo3..nosp@m.org

Definition at line 64 of file MailMessage.php.

References TYPO3\CMS\Core\Mail\MailMessage\initializeMailer().

Member Data Documentation

◆ $failedRecipients

TYPO3\CMS\Core\Mail\MailMessage::$failedRecipients = array()
protected

Definition at line 49 of file MailMessage.php.

Referenced by TYPO3\CMS\Core\Mail\MailMessage\getFailedRecipients().

◆ $mailer

TYPO3\CMS\Core\Mail\MailMessage::$mailer
protected

Definition at line 30 of file MailMessage.php.

◆ $mailerHeader

TYPO3\CMS\Core\Mail\MailMessage::$mailerHeader = 'TYPO3'
protected

Definition at line 35 of file MailMessage.php.

◆ $sent

TYPO3\CMS\Core\Mail\MailMessage::$sent = FALSE
protected

Definition at line 42 of file MailMessage.php.

Referenced by TYPO3\CMS\Core\Mail\MailMessage\isSent().