Class Message

Constants summary

• string
  EMAIL_PATTERN
  '/^((?:[\\p{L}0-9.!#$%&\'*+\\/=?^_`{|}~-]+)*@[\\p{L}0-9-._]+)$/ui'
• int
  LINE_LENGTH_MUST
  998
• int
  LINE_LENGTH_SHOULD
  78
• string
  MESSAGE_BOTH
  'both'
• 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

• $charset protected
  string

  Charset the email body is sent in

• $charset8bit protected
  array

  8Bit character sets

• $contentTypeCharset protected
  array

  Define Content-Type charset name

• $domain protected
  string

  Domain for messageId generation.

• $emailFormat protected
  string

  What format should the email be sent in

• $emailFormatAvailable protected
  array

  Available formats to be sent.

• $emailPattern protected
  string|null

  Regex for email validation

• $from protected
  array

  The mail which the email is sent from

• $headerCharset protected
  string|null

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

• $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
  bool|string

  Message ID

• $priority protected
  int|null

  Contains the optional priority of the email.

• $readReceipt protected
  array

  The read receipt email

• $replyTo protected
  array

  List of email(s) that 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

• $transferEncoding protected
  string|null

  The email transfer encoding used.

• $transferEncodingAvailable protected
  array

  Available encoding to be set for transfer.

Method Summary

• __construct() public

  Constructor

• addAttachments() public

  Add attachments

• addBcc() public

  Add "bcc" address.

• addCc() public

  Add "cc" address.

• addEmail() protected

  Add email

• addHeaders() public

  Add header for the message

• addTo() public

  Add "To" address.

• 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

• createFromArray() public

  Configures an email instance object from serialized config.

• decodeForHeader() protected

  Decode the specified string

• encodeForHeader() 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

• generateMessage() protected

  Generate full message.

• getAttachments() public

  Gets attachments to the email message.

• getBcc() public

  Gets "bcc" address.

• getBody() public

  Get generated message body as array.

• getBodyHtml() public

  Get HTML body of message.

• getBodyString() public

  Get generated body as string.

• getBodyText() public

  Get text body of message.

• getBodyTypes() public

  Gets the body types that are in this email message

• getCc() public

  Gets "cc" address.

• getCharset() public

  Charset getter.

• getContentTransferEncoding() public

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

• getContentTypeCharset() public

  Return charset value for Content-Type.

• 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

• getHeadersString() public

  Get headers as string.

• getMessageId() public

  Gets message ID.

• getOriginalSubject() public

  Get original subject without encoding

• getPriority() public

  Gets priority.

• getReadReceipt() public

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

• getReplyTo() public

  Gets "Reply-To" address.

• getReturnPath() public

  Gets return path.

• getSender() public

  Gets the "sender" address. See RFC link below for full explanation.

• getSubject() public

  Gets subject.

• getTo() public

  Gets "to" address

• getTransferEncoding() public

  TransferEncoding getter.

• jsonSerialize() public

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

• readFile() protected

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

• reset() public

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

• serialize() public

  Serializes the Email object.

• setAttachments() public

  Add attachments to the email message

• setBcc() public

  Sets "bcc" address.

• setBody() public

  Set message body.

• setBodyHtml() public

  Set HTML body for message.

• setBodyText() public

  Set text body for message.

• setCc() public

  Sets "cc" address.

• setCharset() public

  Charset setter.

• setConfig() public

  Sets the configuration for this instance.

• setDomain() public

  Sets domain.

• setEmail() protected

  Set email

• setEmailFormat() public

  Sets email format.

• setEmailPattern() public

  EmailPattern setter/getter

• setEmailSingle() protected

  Set only 1 email

• setFrom() public

  Sets "from" address.

• setHeaderCharset() public

  HeaderCharset setter.

• setHeaders() public

  Sets headers for the message

• setMessageId() public

  Sets message ID.

• setPriority() public

  Sets priority.

• setReadReceipt() public

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

• setReplyTo() public

  Sets "Reply-To" address.

• setReturnPath() public

  Sets return path.

• setSender() public

  Sets the "sender" address. See RFC link below for full explanation.

• setSubject() public

  Sets subject.

• setTo() public

  Sets "to" address.

• setTransferEncoding() public

  TransferEncoding setter.

• unserialize() public

  Unserializes the Email object.

• validateEmail() protected

  Validate email address

• wrap() protected

  Wrap the message to follow the RFC 2822 - 2.1.1

Method Detail

__construct(?array $config)

addAttachments(array $attachments)

addBcc(mixed $email, ?string $name)

addCc(mixed $email, ?string $name)

addEmail(string $varName, mixed $email, ?string $name)

addHeaders(array $headers)

addTo(mixed $email, ?string $name)

attachFiles(?string $boundary)

attachInlineFiles(?string $boundary)

createBoundary()

createFromArray(array $config)

decodeForHeader(string $text)

encodeForHeader(string $text)

encodeString(string $text, string $charset)

formatAddress(array $address)

generateMessage()

getAttachments()

getBcc()

getBody()

getBodyHtml()

getBodyString(string $eol)

getBodyText()

getBodyTypes()

getCc()

getCharset()

getContentTransferEncoding()

getContentTypeCharset()

getDomain()

getEmailFormat()

getEmailPattern()

getFrom()

getHeaderCharset()

getHeaders(array $include)

getHeadersString(array $include, string $eol, ?\Closure $callback)

getMessageId()

getOriginalSubject()

getPriority()

getReadReceipt()

getReplyTo()

getReturnPath()

getSender()

getSubject()

getTo()

getTransferEncoding()

jsonSerialize()

readFile(mixed $file)

reset()

serialize()

setAttachments(array $attachments)

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

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

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

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

setBcc(mixed $email, ?string $name)

setBody(array $content)

setBodyHtml(string $content)

setBodyText(string $content)

setCc(mixed $email, ?string $name)

setCharset(string $charset)

setConfig(array $config)

setDomain(string $domain)

setEmail(string $varName, mixed $email, ?string $name)

setEmailFormat(string $format)

setEmailPattern(?string $regex)

setEmailSingle(string $varName, mixed $email, ?string $name, string $throwMessage)

setFrom(mixed $email, ?string $name)

setHeaderCharset(?string $charset)

setHeaders(array $headers)

setMessageId(mixed $message)

setPriority(?int $priority)

setReadReceipt(mixed $email, ?string $name)

setReplyTo(mixed $email, ?string $name)

setReturnPath(mixed $email, ?string $name)

setSender(mixed $email, ?string $name)

setSubject(string $subject)

setTo(mixed $email, ?string $name)

setTransferEncoding(?string $encoding)

unserialize(mixed $data)

validateEmail(string $email, string $context)

wrap(?string $message, int $wrapLength)

Property Detail