$_defaultConfig
$_defaultConfig : array
Default config for this class
Send mail using SMTP protocol
$_socket : \Cake\Network\Socket
Socket to SMTP server
send(\Cake\Mailer\Email $email) : array
Send mail
| \Cake\Mailer\Email | Email instance |
setConfig(string|array $key, mixed|null $value = null, boolean $merge = true) : $this
Sets the config.
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']);| string|array | $key | The key to set, or a complete array of configs. |
| mixed|null | $value | The value to set. |
| boolean | $merge | Whether to recursively merge or overwrite existing config, defaults to true. |
When trying to set a key that is invalid.
getConfig(string|null $key = null, mixed $default = null) : mixed
Returns the config.
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');| string|null | $key | The key to get or null for the whole config. |
| mixed | $default | The return value when the key does not exist. |
Config value being read.
config(string|array|null $key = null, mixed|null $value = null, boolean $merge = true) : mixed
Gets/Sets the config.
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']);| string|array|null | $key | The key to get/set, or a complete array of configs. |
| mixed|null | $value | The value to set. |
| boolean | $merge | Whether to recursively merge or overwrite existing config, defaults to true. |
When trying to set a key that is invalid.
Config value being read, or the object itself on write operations.
configShallow(string|array $key, mixed|null $value = null) : $this
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']);| string|array | $key | The key to set, or a complete array of configs. |
| mixed|null | $value | The value to set. |
getLastResponse() : array
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...
]_configWrite(string|array $key, mixed $value, boolean|string $merge = false) : void
Writes a config key.
| string|array | $key | Key to write to. |
| mixed | $value | Value to write. |
| boolean|string | $merge | True to merge recursively, 'shallow' for simple merge, false to overwrite, defaults to false. |
if attempting to clobber existing config
_prepareFromAddress(\Cake\Mailer\Email $email) : array
Prepares the `from` email address.
| \Cake\Mailer\Email | Email instance |
_prepareRecipientAddresses(\Cake\Mailer\Email $email) : array
Prepares the recipient email addresses.
| \Cake\Mailer\Email | Email instance |
_prepareMessageHeaders(\Cake\Mailer\Email $email) : array
Prepares the message headers.
| \Cake\Mailer\Email | Email instance |
_prepareMessage(\Cake\Mailer\Email $email) : string
Prepares the message body.
| \Cake\Mailer\Email | Email instance |
_sendRcpt(\Cake\Mailer\Email $email) : void
Send emails
| \Cake\Mailer\Email | Cake Email |
_sendData(\Cake\Mailer\Email $email) : void
Send Data
| \Cake\Mailer\Email | Email instance |
_smtpSend(string|null $data, string|boolean $checkCode = '250') : string|null
Protected method for sending data to SMTP connection
| string|null | $data | Data to be sent to SMTP server |
| string|boolean | $checkCode | Code to check for in server response, false to skip |
The matched code, or null if nothing matched