TYPO3 CMS  TYPO3_7-6
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)
 

Protected Member Functions

 getObjectManager ()
 
 getSignalSlotDispatcher ()
 
 emitPostInitializeMailerSignal ()
 

Protected Attributes

 $transport
 
 $mailSettings = []
 

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

Constructor & Destructor Documentation

◆ __construct()

TYPO3\CMS\Core\Mail\Mailer::__construct ( \Swift_Transport  $transport = null)

When constructing, also initializes the like configured

Parameters
null | \Swift_Transport$transportoptionally pass a transport to the constructor.
Exceptions

Definition at line 45 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

Returns
void

Definition at line 178 of file Mailer.php.

References TYPO3\CMS\Core\Mail\Mailer\getSignalSlotDispatcher().

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

◆ getObjectManager()

TYPO3\CMS\Core\Mail\Mailer::getObjectManager ( )
protected

Get the object manager

Returns

Definition at line 158 of file Mailer.php.

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

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

◆ getSignalSlotDispatcher()

TYPO3\CMS\Core\Mail\Mailer::getSignalSlotDispatcher ( )
protected

Get the SignalSlot dispatcher

Returns

Definition at line 168 of file Mailer.php.

References TYPO3\CMS\Core\Mail\Mailer\getObjectManager().

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

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

References $host, and TYPO3\CMS\Core\Utility\GeneralUtility\makeInstance().

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$mailSettingsprivate

Definition at line 144 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

TYPO3\CMS\Core\Mail\Mailer::$mailSettings = []
protected

Definition at line 37 of file Mailer.php.

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

◆ $transport

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

Definition at line 32 of file Mailer.php.

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