LINE_LENGTH_SHOULD
LINE_LENGTH_SHOULD = 78 : integer
Line length - no should more - RFC 2822 - 2.1.1
CakePHP Email class.
This class is used for sending Internet Message Format based on the standard outlined in https://www.rfc-editor.org/rfc/rfc2822.txt
Configuration for Email is managed by Email::config() and Email::configTransport(). Email::config() can be used to add or read a configuration profile for Email instances. Once made configuration profiles can be used to re-use across various email messages your application sends.
$_viewBuilder : \Cake\View\ViewBuilder
The view builder instance being used.
$_transport : \Cake\Mailer\AbstractTransport|null
The transport instance to use for sending mail.
setConfig(string|array $key, array $config = null) : void
This method can be used to define configuration adapters for an application.
To change an adapter's configuration at runtime, first drop the adapter and then reconfigure it.
Adapters will not be constructed until the first operation is done.
Assuming that the class' name is Cache the following scenarios
are supported:
Setting a cache engine up.
Cache::setConfig('default', $settings);Injecting a constructed adapter in:
Cache::setConfig('default', $instance);Configure multiple adapters at once:
Cache::setConfig($arrayOfConfig);| string|array | $key | The name of the configuration, or an array of multiple configs. |
| array | $config | An array of name => configuration data for adapter. |
When trying to modify an existing config.
When trying to store an invalid structured config array.
config(string|array $key, array|null $config = null) : array|null
This method can be used to define configuration adapters for an application or read existing configuration.
To change an adapter's configuration at runtime, first drop the adapter and then reconfigure it.
Adapters will not be constructed until the first operation is done.
Assuming that the class' name is Cache the following scenarios
are supported:
Reading config data back:
Cache::config('default');Setting a cache engine up.
Cache::config('default', $settings);Injecting a constructed adapter in:
Cache::config('default', $instance);Configure multiple adapters at once:
Cache::config($arrayOfConfig);| string|array | $key | The name of the configuration, or an array of multiple configs. |
| array|null | $config | An array of name => configuration data for adapter. |
When trying to modify an existing config.
Null when adding configuration or an array of configuration data when reading.
drop(string $config) : boolean
Drops a constructed adapter.
If you wish to modify an existing configuration, you should drop it, change configuration and then re-add it.
If the implementing objects supports a $_registry object the named configuration
will also be unloaded from the registry.
| string | $config | An existing configuration you wish to remove. |
Success of the removal, returns false when the config does not exist.
parseDsn(string $dsn) : array
Parses a DSN into a valid connection configuration
This method allows setting a DSN using formatting similar to that used by PEAR::DB. The following is an example of its usage:
$dsn = 'mysql://user:pass@localhost/database?';
$config = ConnectionManager::parseDsn($dsn);
$dsn = 'Cake\Log\Engine\FileLog://?types=notice,info,debug&file=debug&path=LOGS';
$config = Log::parseDsn($dsn);
$dsn = 'smtp://user:secret@localhost:25?timeout=30&client=null&tls=null';
$config = Email::parseDsn($dsn);
$dsn = 'file:///?className=\My\Cache\Engine\FileEngine';
$config = Cache::parseDsn($dsn);
$dsn = 'File://?prefix=myapp_cake_core_&serialize=true&duration=+2 minutes&path=/tmp/persistent/';
$config = Cache::parseDsn($dsn);For all classes, the value of scheme is set as the value of both the className
unless they have been otherwise specified.
Note that querystring arguments are also parsed and set as values in the returned configuration.
| string | $dsn | The DSN string to convert to a configuration array |
If not passed a string, or passed an invalid string
The configuration array to be stored after parsing the DSN
viewBuilder() : \Cake\View\ViewBuilder
Get the view builder being used.
createView(string|null $viewClass = null) : \Cake\View\View
Constructs the view class instance based on the current configuration.
| string|null | $viewClass | Optional namespaced class name of the View class to instantiate. |
If view class was not found.
set(string|array $name, mixed $value = null) : $this
Saves a variable or an associative array of variables for use inside a template.
| string|array | $name | A string or an array of data. |
| mixed | $value | Value in case $name is a string (which then works as the key). Unused if $name is an associative array, otherwise serves as the values to $name's keys. |
viewOptions(string|array|null $options = null, boolean $merge = true) : array
Get/Set valid view options in the object's _validViewOptions property. The property is created as an empty array if it is not set. If called without any parameters it will return the current list of valid view options. See `createView()`.
| string|array|null | $options | string or array of string to be appended to _validViewOptions. |
| boolean | $merge | Whether to merge with or override existing valid View options.
Defaults to |
The updated view options as an array.
from(string|array|null $email = null, string|null $name = null) : array|$this
From
| string|array|null | Null to get, String with email, Array with email as key, name as value or email as value (without name) |
|
| string|null | $name | Name |
sender(string|array|null $email = null, string|null $name = null) : array|$this
Sender
| string|array|null | Null to get, String with email, Array with email as key, name as value or email as value (without name) |
|
| string|null | $name | Name |
replyTo(string|array|null $email = null, string|null $name = null) : array|$this
Reply-To
| string|array|null | Null to get, String with email, Array with email as key, name as value or email as value (without name) |
|
| string|null | $name | Name |
setReadReceipt(string|array $email, string|null $name = null) : $this
Sets Read Receipt (Disposition-Notification-To header).
| string|array | String with email, Array with email as key, name as value or email as value (without name) |
|
| string|null | $name | Name |
readReceipt(string|array|null $email = null, string|null $name = null) : array|$this
Read Receipt (Disposition-Notification-To header)
| string|array|null | Null to get, String with email, Array with email as key, name as value or email as value (without name) |
|
| string|null | $name | Name |
returnPath(string|array|null $email = null, string|null $name = null) : array|$this
Return Path
| string|array|null | Null to get, String with email, Array with email as key, name as value or email as value (without name) |
|
| string|null | $name | Name |
emailPattern(string|boolean|null $regex = false) : string|$this
EmailPattern setter/getter
| string|boolean|null | $regex | The pattern to use for email address validation, null to unset the pattern and make use of filter_var() instead, false or nothing to return the current value |
setTransport(string|\Cake\Mailer\AbstractTransport $name) : $this
Sets the transport.
When setting the transport you can either use the name of a configured transport or supply a constructed transport.
| string|\Cake\Mailer\AbstractTransport | $name | Either the name of a configured transport, or a transport instance. |
When the chosen transport lacks a send method.
When $name is neither a string nor an object.
getTransport() : \Cake\Mailer\AbstractTransport
Gets the transport.
transport(string|\Cake\Mailer\AbstractTransport|null $name = null) : \Cake\Mailer\AbstractTransport|$this
Get/set the transport.
When setting the transport you can either use the name of a configured transport or supply a constructed transport.
| string|\Cake\Mailer\AbstractTransport|null | $name | Either the name of a configured transport, or a transport instance. |
When the chosen transport lacks a send method.
When $name is neither a string nor an object.
setAttachments(string|array $attachments) : $this
Add attachments to the email message
Attachments can be defined in a few forms depending on how much control you need:
Attach a single file:
$email->setAttachments('path/to/file');Attach a file with a different filename:
$email->setAttachments(['custom_name.txt' => 'path/to/file.txt']);Attach a file and specify additional properties:
$email->setAttachments(['custom_name.png' => [
'file' => 'path/to/file',
'mimetype' => 'image/png',
'contentId' => 'abc123',
'contentDisposition' => false
]
]);Attach a file from string and specify additional properties:
$email->setAttachments(['custom_name.png' => [
'data' => file_get_contents('path/to/file'),
'mimetype' => 'image/png'
]
]);The contentId key allows you to specify an inline attachment. In your email text, you
can use <img src="cid:abc123" /> to display the image inline.
The contentDisposition key allows you to disable the Content-Disposition header, this can improve
attachment compatibility with outlook email clients.
| string|array | $attachments | String with the filename or array with filenames |
attachments(string|array|null $attachments = null) : array|$this
Add attachments to the email message
Attachments can be defined in a few forms depending on how much control you need:
Attach a single file:
$email->setAttachments('path/to/file');Attach a file with a different filename:
$email->setAttachments(['custom_name.txt' => 'path/to/file.txt']);Attach a file and specify additional properties:
$email->setAttachments(['custom_name.png' => [
'file' => 'path/to/file',
'mimetype' => 'image/png',
'contentId' => 'abc123',
'contentDisposition' => false
]
]);Attach a file from string and specify additional properties:
$email->setAttachments(['custom_name.png' => [
'data' => file_get_contents('path/to/file'),
'mimetype' => 'image/png'
]
]);The contentId key allows you to specify an inline attachment. In your email text, you
can use <img src="cid:abc123" /> to display the image inline.
The contentDisposition key allows you to disable the Content-Disposition header, this can improve
attachment compatibility with outlook email clients.
| string|array|null | $attachments | String with the filename or array with filenames |
Either the array of attachments when getting or $this when setting.
setConfigTransport(string|array $key, array|\Cake\Mailer\AbstractTransport|null $config = null) : void
Sets transport configuration.
Use this method to define transports to use in delivery profiles. Once defined you cannot edit the configurations, and must use Email::dropTransport() to flush the configuration first.
When using an array of configuration data a new transport will be constructed for each message sent. When using a Closure, the closure will be evaluated for each message.
The className is used to define the class to use for a transport.
It can either be a short name, or a fully qualified class name
| string|array | $key | The configuration name to write. Or an array of multiple transports to set. |
| array|\Cake\Mailer\AbstractTransport|null | $config | Either an array of configuration data, or a transport instance. Null when using key as array. |
configTransport(string|array $key, array|\Cake\Mailer\AbstractTransport|null $config = null) : array|null
Add or read transport configuration.
Use this method to define transports to use in delivery profiles. Once defined you cannot edit the configurations, and must use Email::dropTransport() to flush the configuration first.
When using an array of configuration data a new transport will be constructed for each message sent. When using a Closure, the closure will be evaluated for each message.
The className is used to define the class to use for a transport.
It can either be a short name, or a fully qualified classname
| string|array | $key | The configuration name to read/write. Or an array of multiple transports to set. |
| array|\Cake\Mailer\AbstractTransport|null | $config | Either an array of configuration data, or a transport instance. |
When modifying an existing configuration.
Either null when setting or an array of data when reading.
deliver(string|array|null $to = null, string|null $subject = null, string|array|null $message = null, string|array $config = 'default', boolean $send = true) : static
Static method to fast create an instance of \Cake\Mailer\Email
| string|array|null | $to | Address to send (see Cake\Mailer\Email::to()). If null, will try to use 'to' from transport config |
| string|null | $subject | String of subject or null to use 'subject' from transport config |
| string|array|null | $message | String with message or array with variables to be used in render |
| string|array | $config | String to use Email delivery profile from app.php or array with configs |
| boolean | $send | Send the email or just return the instance pre-configured |
Instance of Cake\Mailer\Email
jsonSerialize() : array
Serializes the email object to a value that can be natively serialized and re-used to clone this email instance.
It has certain limitations for viewVars that are good to know:
When a view var object can not be properly serialized.
Serializable array of configuration properties.
_setEmail(string $varName, string|array $email, string $name) : $this
Set email
| string | $varName | Property name |
| string|array | String with email, Array with email as key, name as value or email as value (without name) |
|
| string | $name | Name |
_setEmailSingle(string $varName, string|array $email, string $name, string $throwMessage) : $this
Set only 1 email
| string | $varName | Property name |
| string|array | String with email, Array with email as key, name as value or email as value (without name) |
|
| string | $name | Name |
| string | $throwMessage | Exception message |
_addEmail(string $varName, string|array $email, string $name) : $this
Add email
| string | $varName | Property name |
| string|array | String with email, Array with email as key, name as value or email as value (without name) |
|
| string | $name | Name |
_renderTemplates(string $content) : array
Build and set all the view properties needed to render the templated emails.
If there is no template set, the $content will be returned in a hash of the text content types for the email.
| string | $content | The content passed in from send() in most cases. |
The rendered content with html and text keys.