| [ Index ] |
PHP Cross Reference of Phabricator |
[Source view] [Print] [Project Stats]
Copyright (c) 2011, Dan Myers. Parts copyright (c) 2008, Donovan Schonknecht. All rights reserved. Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
| File Size: | 743 lines (24 kb) |
| Included or required: | 0 times |
| Referenced: | 1 time |
| Includes or requires: | 0 files |
SimpleEmailService:: (40 methods):
getAccessKey()
getSecretKey()
getHost()
verifyHost()
enableVerifyHost()
verifyPeer()
enableVerifyPeer()
useExceptions()
enableUseExceptions()
__construct()
setAuth()
listVerifiedEmailAddresses()
verifyEmailAddress()
deleteVerifiedEmailAddress()
getSendQuota()
getSendStatistics()
sendRawEmail()
sendEmail()
__triggerError()
__executeServiceTemporarilyUnavailableRetryDelay()
__construct()
setParameter()
getResponse()
__responseWriteCallback()
__customUrlEncode()
__getSignature()
__construct()
addTo()
addCC()
addBCC()
addReplyTo()
setFrom()
setReturnPath()
setSubject()
setSubjectCharset()
setMessageFromString()
setMessageFromFile()
setMessageFromURL()
setMessageCharset()
validate()
Class: SimpleEmailService - X-Ref
Amazon SimpleEmailService PHP class| getAccessKey() X-Ref |
| No description |
| getSecretKey() X-Ref |
| No description |
| getHost() X-Ref |
| No description |
| verifyHost() X-Ref |
| No description |
| enableVerifyHost($enable = true) X-Ref |
| No description |
| verifyPeer() X-Ref |
| No description |
| enableVerifyPeer($enable = true) X-Ref |
| No description |
| useExceptions() X-Ref |
| No description |
| enableUseExceptions($enable = true) X-Ref |
| No description |
| __construct($accessKey = null, $secretKey = null, $host = 'email.us-east-1.amazonaws.com') X-Ref |
| Constructor param: string $accessKey Access key param: string $secretKey Secret key return: void |
| setAuth($accessKey, $secretKey) X-Ref |
| Set AWS access key and secret key param: string $accessKey Access key param: string $secretKey Secret key return: void |
| listVerifiedEmailAddresses() X-Ref |
| Lists the email addresses that have been verified and can be used as the 'From' address return: An array containing two items: a list of verified email addresses, and the request id. |
| verifyEmailAddress($email) X-Ref |
| Requests verification of the provided email address, so it can be used as the 'From' address when sending emails through SimpleEmailService. After submitting this request, you should receive a verification email from Amazon at the specified address containing instructions to follow. param: string email The email address to get verified return: The request id for this request. |
| deleteVerifiedEmailAddress($email) X-Ref |
| Removes the specified email address from the list of verified addresses. param: string email The email address to remove return: The request id for this request. |
| getSendQuota() X-Ref |
| Retrieves information on the current activity limits for this account. See http://docs.amazonwebservices.com/ses/latest/APIReference/API_GetSendQuota.html return: An array containing information on this account's activity limits. |
| getSendStatistics() X-Ref |
| Retrieves statistics for the last two weeks of activity on this account. See http://docs.amazonwebservices.com/ses/latest/APIReference/API_GetSendStatistics.html return: An array of activity statistics. Each array item covers a 15-minute period. |
| sendRawEmail($raw) X-Ref |
| No description |
| sendEmail($sesMessage) X-Ref |
| Given a SimpleEmailServiceMessage object, submits the message to the service for sending. return: An array containing the unique identifier for this message and a separate request id. |
| __triggerError($functionname, $error) X-Ref |
| Trigger an error message param: array $error Array containing error information return: string |
| __executeServiceTemporarilyUnavailableRetryDelay($attempt) X-Ref |
| Callback handler for 503 retries. param: $attempt The number of failed attempts so far return: The retry delay in microseconds, or 0 to stop retrying. |
| __construct($ses, $verb) X-Ref |
| Constructor param: string $ses The SimpleEmailService object making this request param: string $action action param: string $verb HTTP verb return: mixed |
| setParameter($key, $value, $replace = true) X-Ref |
| Set request parameter param: string $key Key param: string $value Value param: boolean $replace Whether to replace the key if it already exists (default true) return: void |
| getResponse() X-Ref |
| Get the response return: object | false |
| __responseWriteCallback(&$curl, &$data) X-Ref |
| CURL write callback param: resource &$curl CURL resource param: string &$data Data return: integer |
| __customUrlEncode($var) X-Ref |
| Contributed by afx114 URL encode the parameters as per http://docs.amazonwebservices.com/AWSECommerceService/latest/DG/index.html?Query_QueryAuth.html PHP's rawurlencode() follows RFC 1738, not RFC 3986 as required by Amazon. The only difference is the tilde (~), so convert it back after rawurlencode See: http://www.morganney.com/blog/API/AWS-Product-Advertising-API-Requires-a-Signed-Request.php param: string $var String to encode return: string |
| __getSignature($string) X-Ref |
| Generate the auth string using Hmac-SHA256 param: string $string String to sign return: string |
| __construct() X-Ref |
| No description |
| addTo($to) X-Ref |
| addTo, addCC, addBCC, and addReplyTo have the following behavior: If a single address is passed, it is appended to the current list of addresses. If an array of addresses is passed, that array is merged into the current list. |
| addCC($cc) X-Ref |
| No description |
| addBCC($bcc) X-Ref |
| No description |
| addReplyTo($replyto) X-Ref |
| No description |
| setFrom($from) X-Ref |
| No description |
| setReturnPath($returnpath) X-Ref |
| No description |
| setSubject($subject) X-Ref |
| No description |
| setSubjectCharset($charset) X-Ref |
| No description |
| setMessageFromString($text, $html = null) X-Ref |
| No description |
| setMessageFromFile($textfile, $htmlfile = null) X-Ref |
| No description |
| setMessageFromURL($texturl, $htmlurl = null) X-Ref |
| No description |
| setMessageCharset($textCharset, $htmlCharset = null) X-Ref |
| No description |
| validate() X-Ref |
| Validates whether the message object has sufficient information to submit a request to SES. This does not guarantee the message will arrive, nor that the request will succeed; instead, it makes sure that no required fields are missing. This is used internally before attempting a SendEmail or SendRawEmail request, but it can be used outside of this file if verification is desired. May be useful if e.g. the data is being populated from a form; developers can generally use this function to verify completeness instead of writing custom logic. return: boolean |
| Generated: Sun Nov 30 09:20:46 2014 | Cross-referenced by PHPXref 0.7.1 |