Class SmtpTransport
Send mail using SMTP protocol
Property Summary
-
$_config protected
arrayRuntime config
-
$_configInitialized protected
boolWhether the config property has already been configured with defaults
-
$_content protected
arrayContent of email to return
-
$_defaultConfig protected
arrayDefault config for this class
-
$_lastResponse protected
arrayThe response of the last sent SMTP command.
-
$_socket protected
Cake\Network\SocketSocket to SMTP server
Method Summary
-
__construct() public
Constructor
-
__destruct() public
Destructor
-
_auth() protected
Send authentication
-
_bufferResponseLines() protected
Parses and stores the response lines in
'code' => 'message'format. -
_configDelete() protected
Deletes a single config key.
-
_configRead() protected
Reads a config key.
-
_configWrite() protected
Writes a config key.
-
_connect() protected
Connect to SMTP Server
-
_disconnect() protected
Disconnect
-
_generateSocket() protected
Helper method to generate socket
-
_headersToString() protected
Help to convert headers in string
-
_prepareFromAddress() protected
Prepares the
fromemail address. -
_prepareFromCmd() protected
Prepares the
MAIL FROMSMTP command. -
_prepareMessage() protected
Prepares the message body.
-
_prepareMessageHeaders() protected
Prepares the message headers.
-
_prepareRcptCmd() protected
Prepares the
RCPT 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
-
config() public deprecated
Gets/Sets the config.
-
configShallow() public
Merge provided config with existing config. Unlike
config()which does a recursive merge for nested keys, this method does a simple merge. -
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.
-
getConfig() public
Returns the config.
-
getLastResponse() public
Returns the response of the last sent SMTP command.
-
send() public
Send mail
-
setConfig() public
Sets the config.
Method Detail
__construct() ¶ public
__construct(array $config = [])Constructor
Parameters
-
array$config optional Configuration options.
__destruct() ¶ public
__destruct()Destructor
Tries to disconnect to ensure that the connection is being terminated properly before the socket gets closed.
_auth() ¶ protected
_auth(): voidSend authentication
Returns
voidThrows
Cake\Network\Exception\SocketException_bufferResponseLines() ¶ protected
_bufferResponseLines(array $responseLines): voidParses and stores the response lines in 'code' => 'message' format.
Parameters
-
array$responseLines Response lines to parse.
Returns
void_configDelete() ¶ protected
_configDelete(string $key): voidDeletes a single config key.
Parameters
-
string$key Key to delete.
Returns
voidThrows
Cake\Core\Exception\Exceptionif attempting to clobber existing config
_configRead() ¶ protected
_configRead(string|null $key): mixedReads a config key.
Parameters
-
string|null$key Key to read.
Returns
mixed_configWrite() ¶ protected
_configWrite(string|array $key, mixed $value, bool|string $merge = false): voidWrites a config key.
Parameters
-
string|array$key Key to write to.
-
mixed$value Value to write.
-
bool|string$merge optional True to merge recursively, 'shallow' for simple merge, false to overwrite, defaults to false.
Returns
voidThrows
Cake\Core\Exception\Exceptionif attempting to clobber existing config
_connect() ¶ protected
_connect(): voidConnect to SMTP Server
Returns
voidThrows
Cake\Network\Exception\SocketException_disconnect() ¶ protected
_disconnect(): voidDisconnect
Returns
voidThrows
Cake\Network\Exception\SocketException_generateSocket() ¶ protected
_generateSocket(): voidHelper method to generate socket
Returns
voidThrows
Cake\Network\Exception\SocketException_headersToString() ¶ protected
_headersToString(array $headers, string $eol = "\r\n"): stringHelp to convert headers in string
Parameters
-
array$headers Headers in format key => value
-
string$eol optional End of line string.
Returns
string_prepareFromAddress() ¶ protected
_prepareFromAddress(Cake\Mailer\Email $email): arrayPrepares the from email address.
Parameters
-
Cake\Mailer\Email$email Email instance
Returns
array_prepareFromCmd() ¶ protected
_prepareFromCmd(string $email): stringPrepares the MAIL FROM SMTP command.
Parameters
-
string$email The email address to send with the command.
Returns
string_prepareMessage() ¶ protected
_prepareMessage(Cake\Mailer\Email $email): stringPrepares the message body.
Parameters
-
Cake\Mailer\Email$email Email instance
Returns
string_prepareMessageHeaders() ¶ protected
_prepareMessageHeaders(Cake\Mailer\Email $email): arrayPrepares the message headers.
Parameters
-
Cake\Mailer\Email$email Email instance
Returns
array_prepareRcptCmd() ¶ protected
_prepareRcptCmd(string $email): stringPrepares the RCPT TO SMTP command.
Parameters
-
string$email The email address to send with the command.
Returns
string_prepareRecipientAddresses() ¶ protected
_prepareRecipientAddresses(Cake\Mailer\Email $email): arrayPrepares the recipient email addresses.
Parameters
-
Cake\Mailer\Email$email Email instance
Returns
array_sendData() ¶ protected
_sendData(Cake\Mailer\Email $email): voidSend Data
Parameters
-
Cake\Mailer\Email$email Email instance
Returns
voidThrows
Cake\Network\Exception\SocketException_sendRcpt() ¶ protected
_sendRcpt(Cake\Mailer\Email $email): voidSend emails
Parameters
-
Cake\Mailer\Email$email Cake Email
Returns
voidThrows
Cake\Network\Exception\SocketException_smtpSend() ¶ protected
_smtpSend(string|null $data, string|bool $checkCode = '250'): string|nullProtected method for sending data to SMTP connection
Parameters
-
string|null$data Data to be sent to SMTP server
-
string|bool$checkCode optional Code to check for in server response, false to skip
Returns
string|nullThe matched code, or null if nothing matched
Throws
Cake\Network\Exception\SocketExceptionconfig() ¶ public
config(string|array|null $key = null, mixed|null $value = null, bool $merge = true): mixedGets/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']);Parameters
-
string|array|null$key optional The key to get/set, or a complete array of configs.
-
mixed|null$value optional The value to set.
-
bool$merge optional Whether to recursively merge or overwrite existing config, defaults to true.
Returns
mixedConfig value being read, or the object itself on write operations.
Throws
Cake\Core\Exception\ExceptionWhen trying to set a key that is invalid.
configShallow() ¶ public
configShallow(string|array $key, mixed|null $value = null): $thisMerge 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 The value to set.
Returns
$thisconnect() ¶ public
connect(): voidConnect to the SMTP server.
This method tries to connect only in case there is no open connection available already.
Returns
voidconnected() ¶ public
connected(): boolCheck whether an open connection to the SMTP server is available.
Returns
booldisconnect() ¶ public
disconnect(): voidDisconnect from the SMTP server.
This method tries to disconnect only in case there is an open connection available.
Returns
voidgetConfig() ¶ public
getConfig(string|null $key = null): mixedReturns 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');Parameters
-
string|null$key optional The key to get or null for the whole config.
Returns
mixedConfig value being read.
getLastResponse() ¶ public
getLastResponse(): arrayReturns 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
arraysend() ¶ public
send(Cake\Mailer\Email $email): arraySend mail
Parameters
-
Cake\Mailer\Email$email Email instance
Returns
arrayThrows
Cake\Network\Exception\SocketExceptionsetConfig() ¶ public
setConfig(string|array $key, mixed|null $value = null, bool $merge = true): $thisSets 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 The value to set.
-
bool$merge optional Whether to recursively merge or overwrite existing config, defaults to true.
Returns
$thisThrows
Cake\Core\Exception\ExceptionWhen trying to set a key that is invalid.
Property Detail
$_configInitialized ¶ protected
Whether the config property has already been configured with defaults
Type
bool