Class CakeEmail

Constants summary

• string
  EMAIL_CLIENT ¶
  'CakePHP Email'
• 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
  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
  If set, boundary to use for multipart mime messages
• $_cc protected
  array
  Carbon Copy
• $_charset8bit protected
  array
  8Bit character sets
• $_config protected
  string|array
  Configuration to transport
• $_configClass protected
  string
  The class name used for email configuration.
• $_configInstance protected
  EmailConfig
  An instance of the EmailConfig class can be set here
• $_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

• $_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

• $_helpers protected
  array
  Helpers to be used in the render
• $_htmlMessage protected
  string
  Html message
• $_layout protected
  string
  Layout for the View
• $_message protected
  array
  Final message to send
• $_messageId protected
  boolean|string
  Message ID
• $_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
• $_template protected
  string
  Template for the view
• $_textMessage protected
  string
  Text message
• $_theme protected
  array
  Theme for the View
• $_to protected
  array
  Recipient of the email
• $_transportClass protected
  AbstractTransport
  Instance of transport class
• $_transportName protected
  string
  What method should the email be sent
• $_viewRender protected
  string
  View for render
• $_viewVars protected
  array
  Vars to sent to render
• $charset public
  string
  Charset the email body is sent in
• $headerCharset public
  string

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

Method Summary

• __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.

• _createBoundary() protected

  Create unique boundary identifier

• _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 charset

• _getContentTypeCharset() protected

  Return charset value for Content-Type.

• _getTypes() protected

  Gets the text body types that are in this email message

• _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

  Add attachments to the email message

• bcc() public

  Bcc

• cc() public

  Cc

• charset() public

  Charset setter/getter

• config() public

  Configuration to use when send email

• deliver() public static

  Static method to fast create an instance of CakeEmail

• domain() public

  Domain as top level (the part after @)

• emailFormat() public

  Email format

• emailPattern() public

  EmailPattern setter/getter

• from() public

  From

• getHeaders() public

  Get list of headers

• headerCharset() public

  HeaderCharset setter/getter

• helpers() public

  Helpers to be used in render

• message() public

  Get generated message (used by transport classes)

• messageId() public

  Message-ID

• readReceipt() public

  Read Receipt (Disposition-Notification-To header)

• replyTo() public

  Reply-To

• reset() public

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

• returnPath() public

  Return Path

• send() public

  Send an email using the specified content, template and layout

• sender() public

  Sender

• setHeaders() public

  Sets headers for the message

• subject() public

  Get/Set Subject.

• template() public

  Template and layout

• theme() public

  Theme to use when rendering

• to() public

  To

• transport() public

  Transport name

• transportClass() public

  Return the transport class

• viewRender() public

  View class for render

• viewVars() public

  Variables to be set on render

Method Detail

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

$email->attachments(array('custom_name.txt' => 'path/to/file.txt'));

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

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

Properties detail

null

array()

array()

null

array()

array('UTF-8', 'SHIFT_JIS')

array()

'EmailConfig'

array(
    'ISO-2022-JP-MS' => 'ISO-2022-JP'
)

null

'text'

array('text', 'html', 'both')

self::EMAIL_PATTERN

array()

array()

array('Html')

''

'default'

array()

true

array()

array()

array()

array()

''

''

''

null

array()

null

'Mail'

'View'

array()

'utf-8'

null