Class SmtpTransport
Send mail using SMTP protocol
- Cake\Mailer\AbstractTransport uses Cake\Core\InstanceConfigTrait
-
Cake\Mailer\Transport\SmtpTransport
Properties summary
-
$_contentprotectedarrayContent of email to return -
$_defaultConfigprotectedarrayDefault config for this class -
$_lastResponseprotectedarrayThe response of the last sent SMTP command. -
$_socketprotectedSocket to SMTP server
Inherited Properties
Method Summary
-
__destruct() public
Destructor -
__wakeup() public
Unserialize handler. -
_auth() protected
Send authentication -
_bufferResponseLines() protected
Parses and stores the response lines in'code' => 'message'format. -
_connect() protected
Connect to SMTP Server -
_disconnect() protected
Disconnect -
_generateSocket() protected
Helper method to generate socket -
_prepareFromAddress() protected
Prepares thefromemail address. -
_prepareFromCmd() protected
Prepares theMAIL FROMSMTP command. -
_prepareMessage() protected
Prepares the message body. -
_prepareMessageHeaders() protected
Prepares the message headers. -
_prepareRcptCmd() protected
Prepares theRCPT TOSMTP command. -
_prepareRecipientAddresses() protected
Prepares the recipient email addresses. -
_sendData() protected
Send Data -
_sendRcpt() protected
Send emails -
_smtpSend() protected
Protected method for sending data to SMTP connection -
connect() public
Connect to the SMTP server. -
connected() public
Check whether an open connection to the SMTP server is available. -
disconnect() public
Disconnect from the SMTP server. -
getLastResponse() public
Returns the response of the last sent SMTP command. -
send() public
Send mail
Method Detail
__destruct() public ¶
__destruct( )
Destructor
Tries to disconnect to ensure that the connection is being terminated properly before the socket gets closed.
__wakeup() public ¶
__wakeup( )
Unserialize handler.
Ensure that the socket property isn't reinitialized in a broken state.
_bufferResponseLines() protected ¶
_bufferResponseLines( array $responseLines )
Parses and stores the response lines in 'code' => 'message' format.
Parameters
- array $responseLines
- Response lines to parse.
_prepareFromCmd() protected ¶
_prepareFromCmd( string $email )
Prepares the MAIL FROM SMTP command.
Parameters
- string $email
- The email address to send with the command.
Returns
_prepareRcptCmd() protected ¶
_prepareRcptCmd( string $email )
Prepares the RCPT TO SMTP command.
Parameters
- string $email
- The email address to send with the command.
Returns
_prepareRecipientAddresses() protected ¶
_prepareRecipientAddresses( Cake\Mailer\Email $email )
Prepares the recipient email addresses.
Parameters
-
Cake\Mailer\Email$email - Email instance
Returns
_sendData() protected ¶
_sendData( Cake\Mailer\Email $email )
_sendRcpt() protected ¶
_sendRcpt( Cake\Mailer\Email $email )
_smtpSend() protected ¶
_smtpSend( string|null $data , string|boolean $checkCode '250' )
Protected method for sending data to SMTP connection
Parameters
- string|null $data
- Data to be sent to SMTP server
- string|boolean $checkCode optional '250'
- Code to check for in server response, false to skip
Returns
The matched code, or null if nothing matched
Throws
connect() public ¶
connect( )
Connect to the SMTP server.
This method tries to connect only in case there is no open connection available already.
connected() public ¶
connected( )
Check whether an open connection to the SMTP server is available.
Returns
disconnect() public ¶
disconnect( )
Disconnect from the SMTP server.
This method tries to disconnect only in case there is an open connection available.
getLastResponse() public ¶
getLastResponse( )
Returns the response of the last sent SMTP command.
A response consists of one or more lines containing a response code and an optional response message text:
[
[
'code' => '250',
'message' => 'mail.example.com'
],
[
'code' => '250',
'message' => 'PIPELINING'
],
[
'code' => '250',
'message' => '8BITMIME'
],
// etc...
]
Returns
send() public ¶
send( Cake\Mailer\Email $email )
Methods inherited from Cake\Mailer\AbstractTransport
__construct() public ¶
__construct( array $config [] )
Constructor
Parameters
- array $config optional []
- Configuration options.
_headersToString() protected ¶
_headersToString( array $headers , string $eol "\r\n" )
Help to convert headers in string
Parameters
- array $headers
- Headers in format key => value
- string $eol optional "\r\n"
- End of line string.
Returns
Methods used from Cake\Core\InstanceConfigTrait
_configDelete() protected ¶
_configDelete( string $key )
Deletes a single config key.
Parameters
- string $key
- Key to delete.
Throws
_configRead() protected ¶
_configRead( string|null $key )
Reads a config key.
Parameters
- string|null $key
- Key to read.
Returns
_configWrite() protected ¶
_configWrite( string|array $key , mixed $value , boolean|string $merge false )
Writes a config key.
Parameters
- string|array $key
- Key to write to.
- mixed $value
- Value to write.
- boolean|string $merge optional false
True to merge recursively, 'shallow' for simple merge, false to overwrite, defaults to false.
Throws
config() public ¶
config( string|array|null $key null , mixed|null $value null , boolean $merge true )
Gets/Sets the config.
Usage
Reading the whole config:
$this->config();
Reading a specific value:
$this->config('key');
Reading a nested value:
$this->config('some.nested.key');
Setting a specific value:
$this->config('key', $value);
Setting a nested value:
$this->config('some.nested.key', $value);
Updating multiple config settings at the same time:
$this->config(['one' => 'value', 'another' => 'value']);
Deprecated
Parameters
- string|array|null $key optional null
- The key to get/set, or a complete array of configs.
- mixed|null $value optional null
- The value to set.
- boolean $merge optional true
- Whether to recursively merge or overwrite existing config, defaults to true.
Returns
Config value being read, or the object itself on write operations.
Throws
configShallow() public ¶
configShallow( string|array $key , mixed|null $value null )
Merge provided config with existing config. Unlike config() which does
a recursive merge for nested keys, this method does a simple merge.
Setting a specific value:
$this->configShallow('key', $value);
Setting a nested value:
$this->configShallow('some.nested.key', $value);
Updating multiple config settings at the same time:
$this->configShallow(['one' => 'value', 'another' => 'value']);
Parameters
- string|array $key
- The key to set, or a complete array of configs.
- mixed|null $value optional null
- The value to set.
Returns
$this
getConfig() public ¶
getConfig( string|null $key null , mixed $default null )
Returns the config.
Usage
Reading the whole config:
$this->getConfig();
Reading a specific value:
$this->getConfig('key');
Reading a nested value:
$this->getConfig('some.nested.key');
Reading with default value:
$this->getConfig('some-key', 'default-value');
Parameters
- string|null $key optional null
- The key to get or null for the whole config.
- mixed $default optional null
- The return value when the key does not exist.
Returns
Config value being read.
setConfig() public ¶
setConfig( string|array $key , mixed|null $value null , boolean $merge true )
Sets the config.
Usage
Setting a specific value:
$this->setConfig('key', $value);
Setting a nested value:
$this->setConfig('some.nested.key', $value);
Updating multiple config settings at the same time:
$this->setConfig(['one' => 'value', 'another' => 'value']);
Parameters
- string|array $key
- The key to set, or a complete array of configs.
- mixed|null $value optional null
- The value to set.
- boolean $merge optional true
- Whether to recursively merge or overwrite existing config, defaults to true.
Returns
$this
Throws
Properties detail
$_defaultConfig ¶
Default config for this class
[
'host' => 'localhost',
'port' => 25,
'timeout' => 30,
'username' => null,
'password' => null,
'client' => null,
'tls' => false,
'keepAlive' => false
]