1. class
  2. Google
  3. \
  4. AppEngine
  5. \
  6. Api
  7. \
  8. Mail
  9. \
  10. Message

Message

class Message extends BaseMessage (View source)

Allows users to send mail using the App Engine mail APIs.

Properties

protected $message from BaseMessage
static protected $allowed_headers from BaseMessage
static protected $extension_denylist from BaseMessage
static protected $set_functions from BaseMessage

Methods

send()

Send the pre-formed email from the Message object.

getFunctionArray()

Returns the class variable $set_functions array, or the corresponding value in that array if a key is provided.

__construct(array $options = null)

Construct an instance of Message.

from BaseMessage
addAttachment(string $filename, mixed $data, string $content_id = null)

Adds an attachment to the Message object.

from BaseMessage
addAttachmentArray() deprecated

Adds an array of attachments to the Message object.

from BaseMessage
addAttachmentsArray()

Adds an array of attachments to the Message object.

from BaseMessage
addHeader(string $key, string $value)

Adds a header pair to the mail object.

from BaseMessage
addHeaderArray()

Adds an array of headers to the mail object.

from BaseMessage
bool
checkValidAttachment(string $filename)

Checks that an attachment is valid.

from BaseMessage
bool
checkValidEmail(string $email)

Checks that an email is valid using the mailparse extension if available.

from BaseMessage
bool
checkValidHeader(string $key, string $value)

Check validity of a header pair.

from BaseMessage
clearAttachments()

Clear all attachments from the mail object.

from BaseMessage
clearHeaders()

Clear all headers from the mail object.

from BaseMessage
handleApplicationError()

Handles application errors generated by the RPC call.

from BaseMessage
setHtmlBody(string $text)

Sets HTML content for the email body.

from BaseMessage
setAmpHtmlBody(string $text)

Sets AMP HTML content for the email body. This field is optional. Setting AMP HTML body makes the email an AMP Email. Plain text or HTML may become fallback content depending on the email client used.

from BaseMessage
setReplyTo(string $email)

Sets a reply-to address for the mail object.

from BaseMessage
setSender(string $email)

Sets the sender for the mail object.

from BaseMessage
setSubject(string $subject)

Sets the subject for the mail object.

from BaseMessage
bool
setTextBody(string $text)

Sets plain text for the email body.

from BaseMessage
addBcc(mixed $emails)

Adds a "bcc" address, or array of addresses, to the mail object.

addCc(mixed $emails)

Adds a "cc" address, or array of addresses, to the mail object.

addTo(mixed $emails)

Adds a "to" address, or array of addresses, to the mail object.

clearBcc()

Clears all "bcc" addresses from the mail object.

clearCc()

Clears all "cc" addresses from the mail object.

clearReplyTo()

Clear reply-to address from the mail object.

clearTo()

Clears all "to" addresses from the mail object.

An
validEmailsArray($email_list, $err_str)

Checks that an email input is either: - An array, and each array member is a valid email - A single valid email string And subsequently returns an array of the valid emails.

Details

at line 124
send()

Send the pre-formed email from the Message object.

Exceptions

InvalidArgumentException If a required field (sender, recipient [to, cc or bcc], subject, body [plain or html]) is missing, or if an ApplicationError was thrown by the RPC call due to an unauthorized sender, an invalid attachment type, or an invalid header name.
RuntimeException If an ApplicationError was thrown by the RPC call due to an internal error or bad request.
ApplicationError If there was an unknown error in the RPC call.

at line 109
protected getFunctionArray()

Returns the class variable $set_functions array, or the corresponding value in that array if a key is provided.

in BaseMessage at line 77
__construct(array $options = null)

Construct an instance of Message.

Parameters

array $options Options for message content, key as per set_functions shown above, value to be set.

Exceptions

InvalidArgumentException If the options variable passed was not an array, if an invalid option was set in the options array, or if a value to be set by the options array was invalid.

in BaseMessage at line 113
addAttachment(string $filename, mixed $data, string $content_id = null)

Adds an attachment to the Message object.

Parameters

string $filename Filename of the attachment.
mixed $data File data of the attachment.
string $content_id Optional Content-ID header value of the attachment. Must be enclosed by angle brackets (<>).

Exceptions

InvalidArgumentException If the input is not an array or if the attachment type is invalid (i.e. the filename is not a string, or the file extension is denied).

in BaseMessage at line 129
addAttachmentArray() deprecated

deprecated

Adds an array of attachments to the Message object.

Exceptions

InvalidArgumentException If the input is not an array or if the attachment type is invalid (i.e. the filename is not a string, or the file extension is denied).

in BaseMessage at line 163
addAttachmentsArray()

Adds an array of attachments to the Message object.

Exceptions

InvalidArgumentException If the input is not an array or if the attachment type is invalid (i.e. the filename is not a string, or the file extension is denied).

in BaseMessage at line 198
addHeader(string $key, string $value)

Adds a header pair to the mail object.

Parameters

string $key Header name (from the allowlist) to be added.
string $value Header value to be added.

Exceptions

InvalidArgumentException If the header is not on the allowlist, or if the header is invalid (i.e. not a string).

in BaseMessage at line 215
addHeaderArray()

Adds an array of headers to the mail object.

Exceptions

InvalidArgumentException If the input is not an array, or if headers are not on the allowlist, or if a header is invalid (i.e. not a string).

in BaseMessage at line 243
protected bool checkValidAttachment(string $filename)

Checks that an attachment is valid.

Parameters

string $filename Filename of the attachment.

Return Value

bool True if successful, false otherwise.

in BaseMessage at line 268
protected bool checkValidEmail(string $email)

Checks that an email is valid using the mailparse extension if available.

Parameters

string $email The email to be validated.

Return Value

bool True if valid, false otherwise.

in BaseMessage at line 288
protected bool checkValidHeader(string $key, string $value)

Check validity of a header pair.

Parameters

string $key Header key.
string $value Header value.

Return Value

bool True if successful, false otherwise.

in BaseMessage at line 307
clearAttachments()

Clear all attachments from the mail object.

in BaseMessage at line 314
clearHeaders()

Clear all headers from the mail object.

in BaseMessage at line 327
protected handleApplicationError()

Handles application errors generated by the RPC call.

Exceptions

RuntimeException If there was an internal error or bad request.
InvalidArgumentException If there was an unauthorized sender, an invalid attachment type, or an invalid header name.
ApplicationError If the error is not one of the above.

in BaseMessage at line 355
setHtmlBody(string $text)

Sets HTML content for the email body.

Parameters

string $text HTML to add.

Exceptions

InvalidArgumentException If text is not a string.

in BaseMessage at line 372
setAmpHtmlBody(string $text)

Sets AMP HTML content for the email body. This field is optional. Setting AMP HTML body makes the email an AMP Email. Plain text or HTML may become fallback content depending on the email client used.

Parameters

string $text AMP HTML to add.

Exceptions

InvalidArgumentException If text is not a string.

in BaseMessage at line 388
setReplyTo(string $email)

Sets a reply-to address for the mail object.

Parameters

string $email Reply-to address.

Exceptions

InvalidArgumentException If the input reply-to address is an invalid email address.

in BaseMessage at line 403
setSender(string $email)

Sets the sender for the mail object.

Parameters

string $email Email of the sender.

Exceptions

InvalidArgumentException If the input sender is an invalid email address.

in BaseMessage at line 417
setSubject(string $subject)

Sets the subject for the mail object.

Parameters

string $subject Subject line.

Exceptions

InvalidArgumentException If subject line is not a string.

in BaseMessage at line 433
bool setTextBody(string $text)

Sets plain text for the email body.

Parameters

string $text Plain text to add.

Return Value

bool True if successful, false otherwise.

Exceptions

InvalidArgumentException If text is not a string.

at line 38
addBcc(mixed $emails)

Adds a "bcc" address, or array of addresses, to the mail object.

Parameters

mixed $emails String email of individual recipient, or array of emails of recipients.

Exceptions

InvalidArgumentException If any of the input emails are not correctly formatted email addresses.

at line 53
addCc(mixed $emails)

Adds a "cc" address, or array of addresses, to the mail object.

Parameters

mixed $emails String email of individual recipient, or array of emails of recipients.

Exceptions

InvalidArgumentException If any of the input emails are not correctly formatted email addresses.

at line 68
addTo(mixed $emails)

Adds a "to" address, or array of addresses, to the mail object.

Parameters

mixed $emails String email of individual recipient, or array of emails of recipients.

Exceptions

InvalidArgumentException If any of the input emails are not correctly formatted email addresses.

at line 78
clearBcc()

Clears all "bcc" addresses from the mail object.

at line 85
clearCc()

Clears all "cc" addresses from the mail object.

at line 92
clearReplyTo()

Clear reply-to address from the mail object.

at line 99
clearTo()

Clears all "to" addresses from the mail object.

at line 163
protected An validEmailsArray($email_list, $err_str)

Checks that an email input is either: - An array, and each array member is a valid email - A single valid email string And subsequently returns an array of the valid emails.

Parameters

$email_list
$err_str

Return Value

An array of emails.

Exceptions

InvalidArgumentException If any of the input emails are not correctly formatted email addresses.