__destruct()source public

__destruct( )

Destructor

Tries to disconnect to ensure that the connection is being terminated properly before the socket gets closed.

__wakeup()source public

__wakeup( )

Unserialize handler.

Ensure that the socket property isn't reinitialized in a broken state.

_auth()source protected

_auth( )

Send authentication

Throws

Cake\Network\Exception\SocketException

_bufferResponseLines()source protected

_bufferResponseLines( array $responseLines )

Parses and stores the response lines in 'code' => 'message' format.

Parameters

array $responseLines

Response lines to parse.

_connect()source protected

_connect( )

Connect to SMTP Server

Throws

Cake\Network\Exception\SocketException

_disconnect()source protected

_disconnect( )

Disconnect

Throws

Cake\Network\Exception\SocketException

_generateSocket()source protected

_generateSocket( )

Helper method to generate socket

Throws

Cake\Network\Exception\SocketException

_prepareFromAddress()source protected

_prepareFromAddress( Cake\Mailer\Email $email )

Prepares the from email address.

Parameters

Cake\Mailer\Email $email

Email instance

Returns

array

_prepareFromCmd()source protected

_prepareFromCmd( string $email )

Prepares the MAIL FROM SMTP command.

Parameters

string $email

The email address to send with the command.

Returns

string

_prepareMessage()source protected

_prepareMessage( Cake\Mailer\Email $email )

Prepares the message body.

Parameters

Cake\Mailer\Email $email

Email instance

Returns

string

_prepareMessageHeaders()source protected

_prepareMessageHeaders( Cake\Mailer\Email $email )

Prepares the message headers.

Parameters

Cake\Mailer\Email $email

Email instance

Returns

array

_prepareRcptCmd()source protected

_prepareRcptCmd( string $email )

Prepares the RCPT TO SMTP command.

Parameters

string $email

The email address to send with the command.

Returns

string

_prepareRecipientAddresses()source protected

_prepareRecipientAddresses( Cake\Mailer\Email $email )

Prepares the recipient email addresses.

Parameters

Cake\Mailer\Email $email

Email instance

Returns

array

_sendData()source protected

_sendData( Cake\Mailer\Email $email )

Send Data

Parameters

Cake\Mailer\Email $email

Email instance

Throws

Cake\Network\Exception\SocketException

_sendRcpt()source protected

_sendRcpt( Cake\Mailer\Email $email )

Send emails

Parameters

Cake\Mailer\Email $email

Cake Email

Throws

Cake\Network\Exception\SocketException

_smtpSend()source 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

string|null
The matched code, or null if nothing matched

Throws

Cake\Network\Exception\SocketException

connect()source public

connect( )

Connect to the SMTP server.

This method tries to connect only in case there is no open connection available already.

connected()source public

connected( )

Check whether an open connection to the SMTP server is available.

Returns

boolean

disconnect()source public

disconnect( )

Disconnect from the SMTP server.

This method tries to disconnect only in case there is an open connection available.

getLastResponse()source 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

array

send()source public

send( Cake\Mailer\Email $email )

Send mail

Parameters

Cake\Mailer\Email $email

Email instance

Returns

array

Throws

Cake\Network\Exception\SocketException

__construct()source public

__construct( array $config = [] )

Constructor

Parameters

array $config optional []

Configuration options.

_headersToString()source 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

string

_configDelete()source protected

_configDelete( string $key )

Deletes a single config key.

Parameters

string $key

Key to delete.

Throws

Cake\Core\Exception\Exception
if attempting to clobber existing config

_configRead()source protected

_configRead( string|null $key )

Reads a config key.

Parameters

string|null $key

Key to read.

Returns

mixed

_configWrite()source 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

Cake\Core\Exception\Exception
if attempting to clobber existing config

config()source public deprecated

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

3.4.0 use setConfig()/getConfig() instead.

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

mixed
Config value being read, or the object itself on write operations.

Throws

Cake\Core\Exception\Exception
When trying to set a key that is invalid.

configShallow()source 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()source 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

mixed
Configuration data at the named key or null if the key does not exist.

setConfig()source 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

Cake\Core\Exception\Exception
When trying to set a key that is invalid.

[]

[
    'host' => 'localhost',
    'port' => 25,
    'timeout' => 30,
    'username' => null,
    'password' => null,
    'client' => null,
    'tls' => false,
    'keepAlive' => false
]

[]