/externals/amazon-ses/ses.php
PHP | 722 lines | 426 code | 105 blank | 191 comment | 76 complexity | 44c77681b090640f7b754df0be0f400a MD5 | raw file
Possible License(s): JSON, MPL-2.0-no-copyleft-exception, Apache-2.0, BSD-3-Clause, LGPL-2.0, MIT, LGPL-2.1, LGPL-3.0
- <?php
- /**
- *
- * 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:
- *
- * - Redistributions of source code must retain the above copyright notice,
- * this list of conditions and the following disclaimer.
- * - Redistributions in binary form must reproduce the above copyright
- * notice, this list of conditions and the following disclaimer in the
- * documentation and/or other materials provided with the distribution.
- *
- * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
- * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
- * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
- * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
- * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
- * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
- * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
- * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
- * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
- * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
- * POSSIBILITY OF SUCH DAMAGE.
- *
- * This is a modified BSD license (the third clause has been removed).
- * The BSD license may be found here:
- * http://www.opensource.org/licenses/bsd-license.php
- *
- * Amazon Simple Email Service is a trademark of Amazon.com, Inc. or its affiliates.
- *
- * SimpleEmailService is based on Donovan Schonknecht's Amazon S3 PHP class, found here:
- * http://undesigned.org.za/2007/10/22/amazon-s3-php-class
- *
- */
- /**
- * Amazon SimpleEmailService PHP class
- *
- * @link http://sourceforge.net/projects/php-aws-ses/
- * version 0.8.1
- *
- */
- class SimpleEmailService
- {
- protected $__accessKey; // AWS Access key
- protected $__secretKey; // AWS Secret key
- protected $__host;
- public function getAccessKey() { return $this->__accessKey; }
- public function getSecretKey() { return $this->__secretKey; }
- public function getHost() { return $this->__host; }
- protected $__verifyHost = 1;
- protected $__verifyPeer = 1;
- // verifyHost and verifyPeer determine whether curl verifies ssl certificates.
- // It may be necessary to disable these checks on certain systems.
- // These only have an effect if SSL is enabled.
- public function verifyHost() { return $this->__verifyHost; }
- public function enableVerifyHost($enable = true) { $this->__verifyHost = $enable; }
- public function verifyPeer() { return $this->__verifyPeer; }
- public function enableVerifyPeer($enable = true) { $this->__verifyPeer = $enable; }
- // If you use exceptions, errors will be communicated by throwing a
- // SimpleEmailServiceException. By default, they will be trigger_error()'d.
- protected $__useExceptions = 0;
- public function useExceptions() { return $this->__useExceptions; }
- public function enableUseExceptions($enable = true) { $this->__useExceptions = $enable; }
- /**
- * Constructor
- *
- * @param string $accessKey Access key
- * @param string $secretKey Secret key
- * @return void
- */
- public function __construct($accessKey = null, $secretKey = null, $host = 'email.us-east-1.amazonaws.com') {
- if (!function_exists('simplexml_load_string')) {
- throw new Exception(
- pht(
- 'The PHP SimpleXML extension is not available, but this '.
- 'extension is required to send mail via Amazon SES, because '.
- 'Amazon SES returns API responses in XML format. Install or '.
- 'enable the SimpleXML extension.'));
- }
- // Catch mistakes with reading the wrong column out of the SES
- // documentation. See T10728.
- if (preg_match('(-smtp)', $host)) {
- throw new Exception(
- pht(
- 'Amazon SES is not configured correctly: the configured SES '.
- 'endpoint ("%s") is an SMTP endpoint. Instead, use an API (HTTPS) '.
- 'endpoint.',
- $host));
- }
- if ($accessKey !== null && $secretKey !== null) {
- $this->setAuth($accessKey, $secretKey);
- }
- $this->__host = $host;
- }
- /**
- * Set AWS access key and secret key
- *
- * @param string $accessKey Access key
- * @param string $secretKey Secret key
- * @return void
- */
- public function setAuth($accessKey, $secretKey) {
- $this->__accessKey = $accessKey;
- $this->__secretKey = $secretKey;
- }
- /**
- * 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.
- */
- public function listVerifiedEmailAddresses() {
- $rest = new SimpleEmailServiceRequest($this, 'GET');
- $rest->setParameter('Action', 'ListVerifiedEmailAddresses');
- $rest = $rest->getResponse();
- $response = array();
- if(!isset($rest->body)) {
- return $response;
- }
- $addresses = array();
- foreach($rest->body->ListVerifiedEmailAddressesResult->VerifiedEmailAddresses->member as $address) {
- $addresses[] = (string)$address;
- }
- $response['Addresses'] = $addresses;
- $response['RequestId'] = (string)$rest->body->ResponseMetadata->RequestId;
- return $response;
- }
- /**
- * 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.
- */
- public function verifyEmailAddress($email) {
- $rest = new SimpleEmailServiceRequest($this, 'POST');
- $rest->setParameter('Action', 'VerifyEmailAddress');
- $rest->setParameter('EmailAddress', $email);
- $rest = $rest->getResponse();
- $response['RequestId'] = (string)$rest->body->ResponseMetadata->RequestId;
- return $response;
- }
- /**
- * 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.
- */
- public function deleteVerifiedEmailAddress($email) {
- $rest = new SimpleEmailServiceRequest($this, 'DELETE');
- $rest->setParameter('Action', 'DeleteVerifiedEmailAddress');
- $rest->setParameter('EmailAddress', $email);
- $rest = $rest->getResponse();
- $response['RequestId'] = (string)$rest->body->ResponseMetadata->RequestId;
- return $response;
- }
- /**
- * 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.
- */
- public function getSendQuota() {
- $rest = new SimpleEmailServiceRequest($this, 'GET');
- $rest->setParameter('Action', 'GetSendQuota');
- $rest = $rest->getResponse();
- $response = array();
- if(!isset($rest->body)) {
- return $response;
- }
- $response['Max24HourSend'] = (string)$rest->body->GetSendQuotaResult->Max24HourSend;
- $response['MaxSendRate'] = (string)$rest->body->GetSendQuotaResult->MaxSendRate;
- $response['SentLast24Hours'] = (string)$rest->body->GetSendQuotaResult->SentLast24Hours;
- $response['RequestId'] = (string)$rest->body->ResponseMetadata->RequestId;
- return $response;
- }
- /**
- * 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.
- */
- public function getSendStatistics() {
- $rest = new SimpleEmailServiceRequest($this, 'GET');
- $rest->setParameter('Action', 'GetSendStatistics');
- $rest = $rest->getResponse();
- $response = array();
- if(!isset($rest->body)) {
- return $response;
- }
- $datapoints = array();
- foreach($rest->body->GetSendStatisticsResult->SendDataPoints->member as $datapoint) {
- $p = array();
- $p['Bounces'] = (string)$datapoint->Bounces;
- $p['Complaints'] = (string)$datapoint->Complaints;
- $p['DeliveryAttempts'] = (string)$datapoint->DeliveryAttempts;
- $p['Rejects'] = (string)$datapoint->Rejects;
- $p['Timestamp'] = (string)$datapoint->Timestamp;
- $datapoints[] = $p;
- }
- $response['SendDataPoints'] = $datapoints;
- $response['RequestId'] = (string)$rest->body->ResponseMetadata->RequestId;
- return $response;
- }
- public function sendRawEmail($raw) {
- $rest = new SimpleEmailServiceRequest($this, 'POST');
- $rest->setParameter('Action', 'SendRawEmail');
- $rest->setParameter('RawMessage.Data', base64_encode($raw));
- $rest = $rest->getResponse();
- $response['MessageId'] = (string)$rest->body->SendEmailResult->MessageId;
- $response['RequestId'] = (string)$rest->body->ResponseMetadata->RequestId;
- return $response;
- }
- /**
- * 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.
- * Returns false if the provided message is missing any required fields.
- */
- public function sendEmail($sesMessage) {
- if(!$sesMessage->validate()) {
- return false;
- }
- $rest = new SimpleEmailServiceRequest($this, 'POST');
- $rest->setParameter('Action', 'SendEmail');
- $i = 1;
- foreach($sesMessage->to as $to) {
- $rest->setParameter('Destination.ToAddresses.member.'.$i, $to);
- $i++;
- }
- if(is_array($sesMessage->cc)) {
- $i = 1;
- foreach($sesMessage->cc as $cc) {
- $rest->setParameter('Destination.CcAddresses.member.'.$i, $cc);
- $i++;
- }
- }
- if(is_array($sesMessage->bcc)) {
- $i = 1;
- foreach($sesMessage->bcc as $bcc) {
- $rest->setParameter('Destination.BccAddresses.member.'.$i, $bcc);
- $i++;
- }
- }
- if(is_array($sesMessage->replyto)) {
- $i = 1;
- foreach($sesMessage->replyto as $replyto) {
- $rest->setParameter('ReplyToAddresses.member.'.$i, $replyto);
- $i++;
- }
- }
- $rest->setParameter('Source', $sesMessage->from);
- if($sesMessage->returnpath != null) {
- $rest->setParameter('ReturnPath', $sesMessage->returnpath);
- }
- if($sesMessage->subject != null && strlen($sesMessage->subject) > 0) {
- $rest->setParameter('Message.Subject.Data', $sesMessage->subject);
- if($sesMessage->subjectCharset != null && strlen($sesMessage->subjectCharset) > 0) {
- $rest->setParameter('Message.Subject.Charset', $sesMessage->subjectCharset);
- }
- }
- if($sesMessage->messagetext != null && strlen($sesMessage->messagetext) > 0) {
- $rest->setParameter('Message.Body.Text.Data', $sesMessage->messagetext);
- if($sesMessage->messageTextCharset != null && strlen($sesMessage->messageTextCharset) > 0) {
- $rest->setParameter('Message.Body.Text.Charset', $sesMessage->messageTextCharset);
- }
- }
- if($sesMessage->messagehtml != null && strlen($sesMessage->messagehtml) > 0) {
- $rest->setParameter('Message.Body.Html.Data', $sesMessage->messagehtml);
- if($sesMessage->messageHtmlCharset != null && strlen($sesMessage->messageHtmlCharset) > 0) {
- $rest->setParameter('Message.Body.Html.Charset', $sesMessage->messageHtmlCharset);
- }
- }
- $rest = $rest->getResponse();
- $response['MessageId'] = (string)$rest->body->SendEmailResult->MessageId;
- $response['RequestId'] = (string)$rest->body->ResponseMetadata->RequestId;
- return $response;
- }
- /**
- * Trigger an error message
- *
- * @internal Used by member functions to output errors
- * @param array $error Array containing error information
- * @return string
- */
- public function __triggerError($functionname, $error)
- {
- if($error == false) {
- $message = sprintf("SimpleEmailService::%s(): Encountered an error, but no description given", $functionname);
- }
- else if(isset($error['curl']) && $error['curl'])
- {
- $message = sprintf("SimpleEmailService::%s(): %s %s", $functionname, $error['code'], $error['message']);
- }
- else if(isset($error['Error']))
- {
- $e = $error['Error'];
- $message = sprintf("SimpleEmailService::%s(): %s - %s: %s\nRequest Id: %s\n", $functionname, $e['Type'], $e['Code'], $e['Message'], $error['RequestId']);
- }
- if ($this->useExceptions()) {
- throw new SimpleEmailServiceException($message);
- } else {
- trigger_error($message, E_USER_WARNING);
- }
- }
- /**
- * Callback handler for 503 retries.
- *
- * @internal Used by SimpleDBRequest to call the user-specified callback, if set
- * @param $attempt The number of failed attempts so far
- * @return The retry delay in microseconds, or 0 to stop retrying.
- */
- public function __executeServiceTemporarilyUnavailableRetryDelay($attempt)
- {
- if(is_callable($this->__serviceUnavailableRetryDelayCallback)) {
- $callback = $this->__serviceUnavailableRetryDelayCallback;
- return $callback($attempt);
- }
- return 0;
- }
- }
- final class SimpleEmailServiceRequest
- {
- private $ses, $verb, $parameters = array();
- public $response;
- /**
- * Constructor
- *
- * @param string $ses The SimpleEmailService object making this request
- * @param string $action action
- * @param string $verb HTTP verb
- * @return mixed
- */
- function __construct($ses, $verb) {
- $this->ses = $ses;
- $this->verb = $verb;
- $this->response = new STDClass;
- $this->response->error = false;
- }
- /**
- * 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
- */
- public function setParameter($key, $value, $replace = true) {
- if(!$replace && isset($this->parameters[$key]))
- {
- $temp = (array)($this->parameters[$key]);
- $temp[] = $value;
- $this->parameters[$key] = $temp;
- }
- else
- {
- $this->parameters[$key] = $value;
- }
- }
- /**
- * Get the response
- *
- * @return object | false
- */
- public function getResponse() {
- $params = array();
- foreach ($this->parameters as $var => $value)
- {
- if(is_array($value))
- {
- foreach($value as $v)
- {
- $params[] = $var.'='.$this->__customUrlEncode($v);
- }
- }
- else
- {
- $params[] = $var.'='.$this->__customUrlEncode($value);
- }
- }
- sort($params, SORT_STRING);
- // must be in format 'Sun, 06 Nov 1994 08:49:37 GMT'
- $date = gmdate('D, d M Y H:i:s e');
- $query = implode('&', $params);
- $headers = array();
- $headers[] = 'Date: '.$date;
- $headers[] = 'Host: '.$this->ses->getHost();
- $auth = 'AWS3-HTTPS AWSAccessKeyId='.$this->ses->getAccessKey();
- $auth .= ',Algorithm=HmacSHA256,Signature='.$this->__getSignature($date);
- $headers[] = 'X-Amzn-Authorization: '.$auth;
- $url = 'https://'.$this->ses->getHost().'/';
- // Basic setup
- $curl = curl_init();
- curl_setopt($curl, CURLOPT_USERAGENT, 'SimpleEmailService/php');
- curl_setopt($curl, CURLOPT_SSL_VERIFYHOST, ($this->ses->verifyHost() ? 2 : 0));
- curl_setopt($curl, CURLOPT_SSL_VERIFYPEER, ($this->ses->verifyPeer() ? 1 : 0));
- // Request types
- switch ($this->verb) {
- case 'GET':
- $url .= '?'.$query;
- break;
- case 'POST':
- curl_setopt($curl, CURLOPT_CUSTOMREQUEST, $this->verb);
- curl_setopt($curl, CURLOPT_POSTFIELDS, $query);
- $headers[] = 'Content-Type: application/x-www-form-urlencoded';
- break;
- case 'DELETE':
- $url .= '?'.$query;
- curl_setopt($curl, CURLOPT_CUSTOMREQUEST, 'DELETE');
- break;
- default: break;
- }
- curl_setopt($curl, CURLOPT_HTTPHEADER, $headers);
- curl_setopt($curl, CURLOPT_HEADER, false);
- curl_setopt($curl, CURLOPT_URL, $url);
- curl_setopt($curl, CURLOPT_RETURNTRANSFER, false);
- curl_setopt($curl, CURLOPT_WRITEFUNCTION, array(&$this, '__responseWriteCallback'));
- curl_setopt($curl, CURLOPT_FOLLOWLOCATION, true);
- // Execute, grab errors
- if (!curl_exec($curl)) {
- throw new SimpleEmailServiceException(
- pht(
- 'Encountered an error while making an HTTP request to Amazon SES '.
- '(cURL Error #%d): %s',
- curl_errno($curl),
- curl_error($curl)));
- }
- $this->response->code = curl_getinfo($curl, CURLINFO_HTTP_CODE);
- if ($this->response->code != 200) {
- throw new SimpleEmailServiceException(
- pht(
- 'Unexpected HTTP status while making request to Amazon SES: '.
- 'expected 200, got %s.',
- $this->response->code));
- }
- @curl_close($curl);
- // Parse body into XML
- if ($this->response->error === false && isset($this->response->body)) {
- $this->response->body = simplexml_load_string($this->response->body);
- // Grab SES errors
- if (!in_array($this->response->code, array(200, 201, 202, 204))
- && isset($this->response->body->Error)) {
- $error = $this->response->body->Error;
- $output = array();
- $output['curl'] = false;
- $output['Error'] = array();
- $output['Error']['Type'] = (string)$error->Type;
- $output['Error']['Code'] = (string)$error->Code;
- $output['Error']['Message'] = (string)$error->Message;
- $output['RequestId'] = (string)$this->response->body->RequestId;
- $this->response->error = $output;
- unset($this->response->body);
- }
- }
- return $this->response;
- }
- /**
- * CURL write callback
- *
- * @param resource &$curl CURL resource
- * @param string &$data Data
- * @return integer
- */
- private function __responseWriteCallback(&$curl, &$data) {
- if(!isset($this->response->body)) $this->response->body = '';
- $this->response->body .= $data;
- return strlen($data);
- }
- /**
- * 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
- */
- private function __customUrlEncode($var) {
- return str_replace('%7E', '~', rawurlencode($var));
- }
- /**
- * Generate the auth string using Hmac-SHA256
- *
- * @internal Used by SimpleDBRequest::getResponse()
- * @param string $string String to sign
- * @return string
- */
- private function __getSignature($string) {
- return base64_encode(hash_hmac('sha256', $string, $this->ses->getSecretKey(), true));
- }
- }
- final class SimpleEmailServiceMessage {
- // these are public for convenience only
- // these are not to be used outside of the SimpleEmailService class!
- public $to, $cc, $bcc, $replyto;
- public $from, $returnpath;
- public $subject, $messagetext, $messagehtml;
- public $subjectCharset, $messageTextCharset, $messageHtmlCharset;
- function __construct() {
- $to = array();
- $cc = array();
- $bcc = array();
- $replyto = array();
- $from = null;
- $returnpath = null;
- $subject = null;
- $messagetext = null;
- $messagehtml = null;
- $subjectCharset = null;
- $messageTextCharset = null;
- $messageHtmlCharset = null;
- }
- /**
- * 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.
- */
- function addTo($to) {
- if(!is_array($to)) {
- $this->to[] = $to;
- }
- else {
- $this->to = array_merge($this->to, $to);
- }
- }
- function addCC($cc) {
- if(!is_array($cc)) {
- $this->cc[] = $cc;
- }
- else {
- $this->cc = array_merge($this->cc, $cc);
- }
- }
- function addBCC($bcc) {
- if(!is_array($bcc)) {
- $this->bcc[] = $bcc;
- }
- else {
- $this->bcc = array_merge($this->bcc, $bcc);
- }
- }
- function addReplyTo($replyto) {
- if(!is_array($replyto)) {
- $this->replyto[] = $replyto;
- }
- else {
- $this->replyto = array_merge($this->replyto, $replyto);
- }
- }
- function setFrom($from) {
- $this->from = $from;
- }
- function setReturnPath($returnpath) {
- $this->returnpath = $returnpath;
- }
- function setSubject($subject) {
- $this->subject = $subject;
- }
- function setSubjectCharset($charset) {
- $this->subjectCharset = $charset;
- }
- function setMessageFromString($text, $html = null) {
- $this->messagetext = $text;
- $this->messagehtml = $html;
- }
- function setMessageFromFile($textfile, $htmlfile = null) {
- if(file_exists($textfile) && is_file($textfile) && is_readable($textfile)) {
- $this->messagetext = file_get_contents($textfile);
- }
- if(file_exists($htmlfile) && is_file($htmlfile) && is_readable($htmlfile)) {
- $this->messagehtml = file_get_contents($htmlfile);
- }
- }
- function setMessageFromURL($texturl, $htmlurl = null) {
- $this->messagetext = file_get_contents($texturl);
- if($htmlurl !== null) {
- $this->messagehtml = file_get_contents($htmlurl);
- }
- }
- function setMessageCharset($textCharset, $htmlCharset = null) {
- $this->messageTextCharset = $textCharset;
- $this->messageHtmlCharset = $htmlCharset;
- }
- /**
- * 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
- */
- public function validate() {
- if(count($this->to) == 0)
- return false;
- if($this->from == null || strlen($this->from) == 0)
- return false;
- if($this->messagetext == null)
- return false;
- return true;
- }
- }
- /**
- * Thrown by SimpleEmailService when errors occur if you call
- * enableUseExceptions(true).
- */
- final class SimpleEmailServiceException extends Exception {
- }