TYPO3\CMS\Core\Mail\MboxTransport Class Reference

Inheritance diagram for TYPO3\CMS\Core\Mail\MboxTransport:

Public Member Functions
	__construct ($debugFile)
	isStarted ()
	start ()
	stop ()
int	send (\Swift_Mime_Message $message, &$failedRecipients=null)
bool	registerPlugin (\Swift_Events_EventListener $plugin)

Private Member Functions
mixed null	getReversePath (\Swift_Mime_Message $message)

Private Attributes
string	$debugFile

Detailed Description

Adapter for Swift_Mailer to be used by TYPO3 extensions.

This will use the setting in TYPO3_CONF_VARS to choose the correct transport for it to work out-of-the-box.

Definition at line 26 of file MboxTransport.php.

Constructor & Destructor Documentation

__construct()

TYPO3\CMS\Core\Mail\MboxTransport::__construct

(

$debugFile

)

Create a new MailTransport

Parameters

string

$debugFile

Reimplemented in TYPO3\CMS\Core\Tests\Unit\Mail\Fixtures\FakeTransportFixture.

Definition at line 37 of file MboxTransport.php.

References TYPO3\CMS\Core\Mail\MboxTransport\$debugFile.

Member Function Documentation

getReversePath()

mixed null TYPO3\CMS\Core\Mail\MboxTransport::getReversePath ( \Swift_Mime_Message  $message )

private

Determine the best-use reverse path for this message

Parameters

\Swift_Mime_Message

$message

Returns

‪mixed|null

Definition at line 106 of file MboxTransport.php.

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

isStarted()

TYPO3\CMS\Core\Mail\MboxTransport::isStarted

(

)

Not used.

Definition at line 45 of file MboxTransport.php.

registerPlugin()

bool TYPO3\CMS\Core\Mail\MboxTransport::registerPlugin

(

\Swift_Events_EventListener

$plugin

)

Register a plugin in the Transport.

Parameters

\Swift_Events_EventListener

$plugin

Returns

‪bool

Definition at line 130 of file MboxTransport.php.

send()

int TYPO3\CMS\Core\Mail\MboxTransport::send	(	\Swift_Mime_Message	$message,
		&	$failedRecipients = null
	)

Outputs the mail to a text file according to RFC 4155.

Parameters

\Swift_Mime_Message	$message	‪The message to send
string[]	&$failedRecipients	‪To collect failures by-reference, nothing will fail in our debugging case

Returns

‪int

Exceptions

Definition at line 72 of file MboxTransport.php.

References TYPO3\CMS\Core\Mail\MboxTransport\getReversePath().

start()

TYPO3\CMS\Core\Mail\MboxTransport::start

(

)

Not used.

Definition at line 53 of file MboxTransport.php.

stop()

TYPO3\CMS\Core\Mail\MboxTransport::stop

(

)

Not used.

Definition at line 60 of file MboxTransport.php.

Member Data Documentation

$debugFile

string TYPO3\CMS\Core\Mail\MboxTransport::$debugFile

private

The file to write our mails into

Definition at line 30 of file MboxTransport.php.

Referenced by TYPO3\CMS\Core\Mail\MboxTransport\__construct().