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\AdminMessage Class Reference
Inheritance diagram for google\appengine\api\mail\AdminMessage:
google\appengine\api\mail\BaseMessage

Public Member Functions

 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 ()
 
- 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 to application admins using the App Engine mail APIs.

Member Function Documentation

google\appengine\api\mail\AdminMessage::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\AdminMessage::send ( )

Send the pre-formed email from the Message object to application admins.

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.

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