Class Email

Constants summary

• string
  EMAIL_PATTERN ¶
  '/^((?:[\p{L}0-9.!#$%&\'*+\/=?^_`{|}~-]+)*@[\p{L}0-9-._]+)$/ui'
• integer
  LINE_LENGTH_MUST ¶
  998
• integer
  LINE_LENGTH_SHOULD ¶
  78
• string
  MESSAGE_HTML ¶
  'html'
• string
  MESSAGE_TEXT ¶
  'text'

Properties summary

• $_appCharset protected
  string|null
  The application wide charset, used to encode headers and body
• $_attachments protected
  array
  List of files that should be attached to the email.
• $_bcc protected
  array
  Blind Carbon Copy
• $_boundary protected
  string|null
  If set, boundary to use for multipart mime messages
• $_cc protected
  array
  Carbon Copy
• $_charset8bit protected
  array
  8Bit character sets
• $_contentTypeCharset protected
  array
  Define Content-Type charset name
• $_domain protected
  string

  Domain for messageId generation. Needs to be manually set for CLI mailing as env('HTTP_HOST') is empty

• $_dsnClassMap protected static
  array

  An array mapping url schemes to fully qualified Transport class names. Unused.

• $_emailFormat protected
  string
  What format should the email be sent in
• $_emailFormatAvailable protected
  array
  Available formats to be sent.
• $_emailPattern protected
  string
  Regex for email validation
• $_from protected
  array
  The mail which the email is sent from
• $_headers protected
  array

  Associative array of a user defined headers Keys will be prefixed 'X-' as per RFC2822 Section 4.7.5

• $_htmlMessage protected
  string
  Html message
• $_message protected
  array
  Final message to send
• $_messageId protected
  boolean|string
  Message ID
• $_priority protected
  integer|null
  Contains the optional priority of the email.
• $_profile protected
  array

  A copy of the configuration profile for this instance. This copy can be modified with Email::profile().

• $_readReceipt protected
  array
  The read receipt email
• $_replyTo protected
  array
  The email the recipient will reply to
• $_returnPath protected
  array

  The mail that will be used in case of any errors like - Remote mailserver down - Remote user has exceeded his quota - Unknown user

• $_sender protected
  array
  The sender email
• $_subject protected
  string
  The subject of the email
• $_textMessage protected
  string
  Text message
• $_to protected
  array
  Recipient of the email
• $_transferEncodingAvailable protected
  array
  Available encoding to be set for transfer.
• $_transport protected
  Cake\Mailer\AbstractTransport|null
  The transport instance to use for sending mail.
• $charset public
  string
  Charset the email body is sent in
• $headerCharset public
  string|null

  Charset the email header is sent in If null, the $charset property will be used as default

• $transferEncoding protected
  string|null

  The email transfer encoding used. If null, the $charset property is used for determined the transfer encoding.

Inherited Magic Properties

• _validViewOptions

Inherited Properties

• _config _viewBuilder, viewClass, viewVars

Method Summary

• __clone() public

  Clone ViewBuilder instance when email object is cloned.

• __construct() public

  Constructor

• _addEmail() protected

  Add email

• _applyConfig() protected

  Apply the config to an instance

• _attachFiles() protected

  Attach non-embedded files by adding file contents inside boundaries.

• _attachInlineFiles() protected

  Attach inline/embedded files to the message.

• _checkViewVars() protected

  Iterates through hash to clean up and normalize.

• _createBoundary() protected

  Create unique boundary identifier

• _decode() protected

  Decode the specified string

• _encode() protected

  Encode the specified string using the current charset

• _encodeString() protected

  Translates a string for one charset to another if the App.encoding value differs and the mb_convert_encoding function exists

• _formatAddress() protected

  Format addresses

• _getContentTransferEncoding() protected

  Return the Content-Transfer Encoding value based on the set transferEncoding or set charset.

• _getContentTypeCharset() protected

  Return charset value for Content-Type.

• _getTypes() protected

  Gets the text body types that are in this email message

• _logDelivery() protected

  Log the email message delivery.

• _readFile() protected

  Read the file contents and return a base64 version of the file contents.

• _render() protected

  Render the body of the email.

• _renderTemplates() protected

  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.

• _setEmail() protected

  Set email

• _setEmailSingle() protected

  Set only 1 email

• _validateEmail() protected

  Validate email address

• _wrap() protected

  Wrap the message to follow the RFC 2822 - 2.1.1

• addAttachments() public

  Add attachments

• addBcc() public

  Add Bcc

• addCc() public

  Add Cc

• addHeaders() public

  Add header for the message

• addTo() public

  Add To

• attachments() public deprecated

  Add attachments to the email message

• bcc() public deprecated

  Bcc

• cc() public deprecated

  Cc

• charset() public deprecated

  Charset setter/getter

• configTransport() public static deprecated

  Add or read transport configuration.

• configuredTransport() public static deprecated

  Returns an array containing the named transport configurations

• createFromArray() public

  Configures an email instance object from serialized config.

• deliver() public static

  Static method to fast create an instance of \Cake\Mailer\Email

• domain() public deprecated

  Domain as top level (the part after @)

• dropTransport() public static deprecated

  Delete transport configuration.

• emailFormat() public deprecated

  Email format

• emailPattern() public deprecated

  EmailPattern setter/getter

• flatten() protected

  Converts given value to string

• from() public deprecated

  From

• getAttachments() public

  Gets attachments to the email message.

• getBcc() public

  Gets "bcc" address.

• getCc() public

  Gets "cc" address.

• getCharset() public

  Charset getter.

• getConfigTransport() public static deprecated

  Gets current transport configuration.

• getDomain() public

  Gets domain.

• getEmailFormat() public

  Gets email format.

• getEmailPattern() public

  EmailPattern setter/getter

• getFrom() public

  Gets "from" address.

• getHeaderCharset() public

  HeaderCharset getter.

• getHeaders() public

  Get list of headers

• getHelpers() public deprecated

  Gets helpers to be used when rendering.

• getLayout() public deprecated

  Gets layout.

• getMessageId() public

  Gets message ID.

• getOriginalSubject() public

  Get original subject without encoding

• getPriority() public

  Gets priority.

• getProfile() public

  Gets the configuration profile to use for this instance.

• getReadReceipt() public

  Gets Read Receipt (Disposition-Notification-To header).

• getReplyTo() public

  Gets "Reply-To" address.

• getReturnPath() public

  Gets return path.

• getSender() public

  Gets "sender" address.

• getSubject() public

  Gets subject.

• getTemplate() public deprecated

  Gets template.

• getTheme() public deprecated

  Gets theme to use when rendering.

• getTo() public

  Gets "to" address

• getTransferEncoding() public

  TransferEncoding getter.

• getTransport() public

  Gets the transport.

• getViewRenderer() public

  Gets view class for render.

• getViewVars() public

  Gets variables to be set on render.

• headerCharset() public deprecated

  HeaderCharset setter/getter

• helpers() public deprecated

  Helpers to be used in render

• jsonSerialize() public

  Serializes the email object to a value that can be natively serialized and re-used to clone this email instance.

• message() public

  Get generated message (used by transport classes)

• messageId() public deprecated

  Message-ID

• profile() public deprecated

  Get/Set the configuration profile to use for this instance.

• readReceipt() public deprecated

  Read Receipt (Disposition-Notification-To header)

• replyTo() public deprecated

  Reply-To

• reset() public

  Reset all the internal variables to be able to send out a new email.

• returnPath() public deprecated

  Return Path

• send() public

  Send an email using the specified content, template and layout

• sender() public deprecated

  Sender

• serialize() public

  Serializes the Email object.

• setAttachments() public

  Add attachments to the email message

• setBcc() public

  Sets "bcc" address.

• setCc() public

  Sets "cc" address.

• setCharset() public

  Charset setter.

• setConfigTransport() public static deprecated

  Sets transport configuration.

• setDomain() public

  Sets domain.

• setEmailFormat() public

  Sets email format.

• setEmailPattern() public

  EmailPattern setter/getter

• setFrom() public

  Sets "from" address.

• setHeaderCharset() public

  HeaderCharset setter.

• setHeaders() public

  Sets headers for the message

• setHelpers() public deprecated

  Sets helpers to be used when rendering.

• setLayout() public deprecated

  Sets layout.

• setMessageId() public

  Sets message ID.

• setPriority() public

  Sets priority.

• setProfile() public

  Sets the configuration profile to use for this instance.

• setReadReceipt() public

  Sets Read Receipt (Disposition-Notification-To header).

• setReplyTo() public

  Sets "Reply-To" address.

• setReturnPath() public

  Return Path

• setSender() public

  Sets "sender" address.

• setSubject() public

  Sets subject.

• setTemplate() public deprecated

  Sets template.

• setTheme() public deprecated

  Sets theme to use when rendering.

• setTo() public

  Sets "to" address.

• setTransferEncoding() public

  TransferEncoding setter.

• setTransport() public

  Sets the transport.

• setViewRenderer() public

  Sets view class for render.

• setViewVars() public

  Sets variables to be set on render.

• subject() public deprecated

  Get/Set Subject.

• template() public deprecated

  Template and layout

• theme() public deprecated

  Theme to use when rendering

• to() public deprecated

  To

• transport() public deprecated

  Get/set the transport.

• unserialize() public

  Unserializes the Email object.

• viewRender() public deprecated

  View class for render

• viewVars() public deprecated

  Variables to be set on render

Method Detail

$email->setAttachments('path/to/file');

$email->setAttachments(['custom_name.txt' => 'path/to/file.txt']);

$email->setAttachments(['custom_name.png' => [
     'file' => 'path/to/file',
     'mimetype' => 'image/png',
     'contentId' => 'abc123',
     'contentDisposition' => false
   ]
]);

$email->setAttachments(['custom_name.png' => [
     'data' => file_get_contents('path/to/file'),
     'mimetype' => 'image/png'
   ]
]);

$email->setAttachments('path/to/file');

$email->setAttachments(['custom_name.txt' => 'path/to/file.txt']);

$email->setAttachments(['custom_name.png' => [
     'file' => 'path/to/file',
     'mimetype' => 'image/png',
     'contentId' => 'abc123',
     'contentDisposition' => false
   ]
]);

$email->setAttachments(['custom_name.png' => [
     'data' => file_get_contents('path/to/file'),
     'mimetype' => 'image/png'
   ]
]);

Methods used from Cake\Core\StaticConfigTrait

Cache::config('default');

Cache::config('default', $settings);

Cache::config('default', $instance);

Cache::config($arrayOfConfig);

$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);

Cache::setConfig('default', $settings);

Cache::setConfig('default', $instance);

Cache::setConfig($arrayOfConfig);

Methods used from Cake\View\ViewVarsTrait

Properties detail

[]

[]

[]

['UTF-8', 'SHIFT_JIS']

[
    'ISO-2022-JP-MS' => 'ISO-2022-JP'
]

[]

'text'

['text', 'html', 'both']

self::EMAIL_PATTERN

[]

[]

''

[]

true

[]

[]

[]

[]

[]

''

''

[]

[
    '7bit',
    '8bit',
    'base64',
    'binary',
    'quoted-printable'
]

'utf-8'