TYPO3\CMS\Core\Mail\Mailer Class Reference

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

Public Member Functions
	__construct (\Swift_Transport $transport=null)
	injectMailSettings (array $mailSettings=null)
Swift_Transport	getRealTransport ()

Protected Member Functions
TransportFactory	getTransportFactory ()
TYPO3 CMS Extbase Object ObjectManager	getObjectManager ()
TYPO3 CMS Extbase SignalSlot Dispatcher	getSignalSlotDispatcher ()
	emitPostInitializeMailerSignal ()

Protected Attributes
Swift_Transport	$transport
array	$mailSettings = array( )

Private Member Functions
	initializeTransport ()

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 28 of file Mailer.php.

Constructor & Destructor Documentation

__construct()

TYPO3\CMS\Core\Mail\Mailer::__construct

(

\Swift_Transport

$transport = null

)

When constructing, also initializes the \Swift_Transport like configured

Parameters

\Swift_Transport | null

$transport

‪optionally pass a transport to the constructor.

Exceptions

Definition at line 44 of file Mailer.php.

References TYPO3\CMS\Core\Mail\Mailer\$transport, TYPO3\CMS\Core\Mail\Mailer\emitPostInitializeMailerSignal(), TYPO3\CMS\Core\Mail\Mailer\initializeTransport(), and TYPO3\CMS\Core\Mail\Mailer\injectMailSettings().

Member Function Documentation

emitPostInitializeMailerSignal()

TYPO3\CMS\Core\Mail\Mailer::emitPostInitializeMailerSignal ( )

protected

Emits a signal after mailer initialization

Definition at line 143 of file Mailer.php.

References TYPO3\CMS\Extbase\SignalSlot\Dispatcher\dispatch(), and TYPO3\CMS\Core\Mail\Mailer\getSignalSlotDispatcher().

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

getObjectManager()

TYPO3 CMS Extbase Object ObjectManager TYPO3\CMS\Core\Mail\Mailer::getObjectManager ( )

protected

Get the object manager

Returns

‪\TYPO3\CMS\Extbase\Object\ObjectManager

Definition at line 125 of file Mailer.php.

Referenced by TYPO3\CMS\Core\Mail\Mailer\getSignalSlotDispatcher().

getRealTransport()

Swift_Transport TYPO3\CMS\Core\Mail\Mailer::getRealTransport

(

)

Returns the real transport (not a spool).

Returns

‪\Swift_Transport

Definition at line 105 of file Mailer.php.

References $GLOBALS, TYPO3\CMS\Core\Mail\Mailer\$mailSettings, TYPO3\CMS\Core\Mail\TransportFactory\get(), and TYPO3\CMS\Core\Mail\Mailer\getTransportFactory().

getSignalSlotDispatcher()

TYPO3 CMS Extbase SignalSlot Dispatcher TYPO3\CMS\Core\Mail\Mailer::getSignalSlotDispatcher ( )

protected

Get the SignalSlot dispatcher

Returns

‪\TYPO3\CMS\Extbase\SignalSlot\Dispatcher

Definition at line 135 of file Mailer.php.

References TYPO3\CMS\Extbase\Object\ObjectManager\get(), and TYPO3\CMS\Core\Mail\Mailer\getObjectManager().

Referenced by TYPO3\CMS\Core\Mail\Mailer\emitPostInitializeMailerSignal().

getTransportFactory()

TransportFactory TYPO3\CMS\Core\Mail\Mailer::getTransportFactory ( )

protected

Returns

‪TransportFactory

Definition at line 115 of file Mailer.php.

Referenced by TYPO3\CMS\Core\Mail\Mailer\getRealTransport(), and TYPO3\CMS\Core\Mail\Mailer\initializeTransport().

initializeTransport()

TYPO3\CMS\Core\Mail\Mailer::initializeTransport ( )

private

Prepares a transport using the TYPO3_CONF_VARS configuration

Used options: $TYPO3_CONF_VARS['MAIL']['transport'] = 'smtp' | 'sendmail' | 'mail' | 'mbox'

$TYPO3_CONF_VARS['MAIL']['transport_smtp_server'] = 'smtp.example.org'; $TYPO3_CONF_VARS['MAIL']['transport_smtp_port'] = '25'; $TYPO3_CONF_VARS['MAIL']['transport_smtp_encrypt'] = FALSE; # requires openssl in PHP $TYPO3_CONF_VARS['MAIL']['transport_smtp_username'] = 'username'; $TYPO3_CONF_VARS['MAIL']['transport_smtp_password'] = 'password';

$TYPO3_CONF_VARS['MAIL']['transport_sendmail_command'] = '/usr/sbin/sendmail -bs'

Exceptions

Definition at line 80 of file Mailer.php.

References TYPO3\CMS\Core\Mail\TransportFactory\get(), and TYPO3\CMS\Core\Mail\Mailer\getTransportFactory().

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

injectMailSettings()

TYPO3\CMS\Core\Mail\Mailer::injectMailSettings

(

array

$mailSettings = null

)

This method is only used in unit tests

Parameters

array

$mailSettings

Definition at line 91 of file Mailer.php.

References $GLOBALS, and TYPO3\CMS\Core\Mail\Mailer\$mailSettings.

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

Member Data Documentation

$mailSettings

array TYPO3\CMS\Core\Mail\Mailer::$mailSettings = array( )

protected

Definition at line 36 of file Mailer.php.

Referenced by TYPO3\CMS\Core\Mail\Mailer\getRealTransport(), and TYPO3\CMS\Core\Mail\Mailer\injectMailSettings().

$transport

Swift_Transport TYPO3\CMS\Core\Mail\Mailer::$transport

protected

Definition at line 32 of file Mailer.php.

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