TYPO3  7.6
Public Member Functions | Protected Member Functions | Protected Attributes | Private Member Functions | List of all members
Mailer Class Reference
Inheritance diagram for Mailer:
Swift_Mailer

Public Member Functions

 __construct (\Swift_Transport $transport=null)
 
 injectMailSettings (array $mailSettings=null)
 
- Public Member Functions inherited from Swift_Mailer
 __construct (Swift_Transport $transport)
 
 createMessage ($service= 'message')
 
 send (Swift_Mime_Message $message, &$failedRecipients=null)
 
 registerPlugin (Swift_Events_EventListener $plugin)
 
 getTransport ()
 

Protected Member Functions

 getObjectManager ()
 
 getSignalSlotDispatcher ()
 
 emitPostInitializeMailerSignal ()
 

Protected Attributes

 $transport
 
 $mailSettings = array()
 

Private Member Functions

 initializeTransport ()
 

Additional Inherited Members

- Static Public Member Functions inherited from Swift_Mailer
static newInstance (Swift_Transport $transport)
 

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 typo3/sysext/core/Classes/Mail/Mailer.php.

Constructor & Destructor Documentation

__construct ( \Swift_Transport  $transport = null)

When constructing, also initializes the like configured

Parameters
null | \Swift_Transport$transportoptionally pass a transport to the constructor.
Exceptions
\TYPO3\CMS\Core\Exception

Definition at line 45 of file typo3/sysext/core/Classes/Mail/Mailer.php.

References Mailer\$transport, Mailer\emitPostInitializeMailerSignal(), Mailer\initializeTransport(), and Mailer\injectMailSettings().

Member Function Documentation

emitPostInitializeMailerSignal ( )
protected

Emits a signal after mailer initialization

Returns
void

Definition at line 178 of file typo3/sysext/core/Classes/Mail/Mailer.php.

References Mailer\getSignalSlotDispatcher().

Referenced by Mailer\__construct().

getObjectManager ( )
protected

Get the object manager

Returns

Definition at line 158 of file typo3/sysext/core/Classes/Mail/Mailer.php.

References GeneralUtility\makeInstance().

Referenced by Mailer\getSignalSlotDispatcher().

getSignalSlotDispatcher ( )
protected

Get the SignalSlot dispatcher

Returns

Definition at line 168 of file typo3/sysext/core/Classes/Mail/Mailer.php.

References Mailer\getObjectManager().

Referenced by Mailer\emitPostInitializeMailerSignal().

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
\TYPO3\CMS\Core\Exception
\RuntimeException

Definition at line 81 of file typo3/sysext/core/Classes/Mail/Mailer.php.

Referenced by Mailer\__construct().

injectMailSettings ( array  $mailSettings = null)

This method is only used in unit tests

Parameters
array$mailSettingsprivate

Definition at line 144 of file typo3/sysext/core/Classes/Mail/Mailer.php.

References $GLOBALS, and Mailer\$mailSettings.

Referenced by Mailer\__construct().

Member Data Documentation

$mailSettings = array()
protected

Definition at line 37 of file typo3/sysext/core/Classes/Mail/Mailer.php.

Referenced by Mailer\injectMailSettings().

$transport
protected

Definition at line 32 of file typo3/sysext/core/Classes/Mail/Mailer.php.

Referenced by Mailer\__construct().