App Engine PHP SDK  v1 rev.445
The PHP runtime is available as an experimental Preview feature.
Public Member Functions | Protected Member Functions | List of all members
google\appengine\api\mail\Message Class Reference
Inheritance diagram for google\appengine\api\mail\Message:
google\appengine\api\mail\BaseMessage

Public Member Functions

 addBcc ($emails)
 
 addCc ($emails)
 
 addTo ($emails)
 
 clearBcc ()
 
 clearCc ()
 
 clearReplyTo ()
 
 clearTo ()
 
 send ()
 
- Public Member Functions inherited from google\appengine\api\mail\BaseMessage
 send ()
 
 __construct ($options=null)
 
 addAttachment ($filename, $data, $content_id=null)
 
 addAttachmentArray ($attach_array)
 
 addAttachmentsArray ($attach_array)
 
 addHeader ($key, $value)
 
 addHeaderArray ($header_array)
 
 clearAttachments ()
 
 clearHeaders ()
 
 setHtmlBody ($text)
 
 setReplyTo ($email)
 
 setSender ($email)
 
 setSubject ($subject)
 
 setTextBody ($text)
 

Protected Member Functions

 getFunctionArray ()
 
 validEmailsArray ($email_list, $err_str)
 
- Protected Member Functions inherited from google\appengine\api\mail\BaseMessage
 getFunctionArray ()
 
 checkValidAttachment ($filename, &$error)
 
 checkValidEmail ($email)
 
 checkValidHeader ($key, $value, &$error)
 
 handleApplicationError ($e)
 

Additional Inherited Members

- Protected Attributes inherited from google\appengine\api\mail\BaseMessage
 $message = null
 
- Static Protected Attributes inherited from google\appengine\api\mail\BaseMessage
static $allowed_headers
 
static $extension_blacklist
 
static $set_functions
 

Detailed Description

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

Member Function Documentation

google\appengine\api\mail\Message::addBcc (   $emails)

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

Parameters
mixed$emailsString email of individual recipient, or array of emails of recipients.
Exceptions
InvalidArgumentException If any of the input emails are not correctly formatted email addresses.
google\appengine\api\mail\Message::addCc (   $emails)

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

Parameters
mixed$emailsString email of individual recipient, or array of emails of recipients.
Exceptions
InvalidArgumentException If any of the input emails are not correctly formatted email addresses.
google\appengine\api\mail\Message::addTo (   $emails)

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

Parameters
mixed$emailsString email of individual recipient, or array of emails of recipients.
Exceptions
InvalidArgumentException If any of the input emails are not correctly formatted email addresses.
google\appengine\api\mail\Message::clearBcc ( )

Clears all "bcc" addresses from the mail object.

google\appengine\api\mail\Message::clearCc ( )

Clears all "cc" addresses from the mail object.

google\appengine\api\mail\Message::clearReplyTo ( )

Clear reply-to address from the mail object.

google\appengine\api\mail\Message::clearTo ( )

Clears all "to" addresses from the mail object.

google\appengine\api\mail\Message::getFunctionArray ( )
protected

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

Returns
mixed $set_functions array, or a string value from that array.
google\appengine\api\mail\Message::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.
ApplicationErrorIf there was an unknown error in the RPC call.
google\appengine\api\mail\Message::validEmailsArray (   $email_list,
  $err_str 
)
protected

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
mixed$emailsAn array of emails string, or a single email string
Returns
An array of emails.
Exceptions
InvalidArgumentException If any of the input emails are not correctly formatted email addresses.

The documentation for this class was generated from the following file: