Common
1 year ago
ErrorMappers
1 year ago
AmazonSES.php
1 year ago
MailPoet.php
2 years ago
MailerMethod.php
3 years ago
PHPMail.php
4 years ago
PHPMailerMethod.php
1 year ago
SMTP.php
3 weeks ago
SendGrid.php
1 year ago
index.php
3 years ago
AmazonSES.php
250 lines
| 1 | <?php declare(strict_types = 1); |
| 2 | |
| 3 | namespace MailPoet\Mailer\Methods; |
| 4 | |
| 5 | if (!defined('ABSPATH')) exit; |
| 6 | |
| 7 | |
| 8 | use MailPoet\Mailer\Mailer; |
| 9 | use MailPoet\Mailer\Methods\Common\BlacklistCheck; |
| 10 | use MailPoet\Mailer\Methods\ErrorMappers\AmazonSESMapper; |
| 11 | use MailPoet\Util\Url; |
| 12 | use MailPoet\WP\Functions as WPFunctions; |
| 13 | use PHPMailer\PHPMailer\PHPMailer; |
| 14 | |
| 15 | class AmazonSES extends PHPMailerMethod { |
| 16 | /** @var string */ |
| 17 | public $awsAccessKey; |
| 18 | /** @var string */ |
| 19 | public $awsSecretKey; |
| 20 | /** @var string */ |
| 21 | public $awsRegion; |
| 22 | /** @var string */ |
| 23 | public $awsEndpoint; |
| 24 | /** @var string */ |
| 25 | public $awsSigningAlgorithm; |
| 26 | /** @var string */ |
| 27 | public $awsService; |
| 28 | /** @var string */ |
| 29 | public $awsTerminationString; |
| 30 | /** @var string */ |
| 31 | public $hashAlgorithm; |
| 32 | /** @var string */ |
| 33 | public $url; |
| 34 | /** @var string */ |
| 35 | public $rawMessage; |
| 36 | /** @var string */ |
| 37 | public $date; |
| 38 | /** @var string */ |
| 39 | public $dateWithoutTime; |
| 40 | /** @var string[] */ |
| 41 | private $availableRegions = [ |
| 42 | 'US East (N. Virginia)' => 'us-east-1', |
| 43 | 'US East (Ohio)' => 'us-east-2', |
| 44 | 'US West (N. California)' => 'us-west-1', |
| 45 | 'US West (Oregon)' => 'us-west-2', |
| 46 | 'EU (Ireland)' => 'eu-west-1', |
| 47 | 'EU (London)' => 'eu-west-2', |
| 48 | 'EU (Paris)' => 'eu-west-3', |
| 49 | 'EU (Milan)' => 'eu-south-1', |
| 50 | 'EU (Frankfurt)' => 'eu-central-1', |
| 51 | 'EU (Stockholm)' => 'eu-north-1', |
| 52 | 'Canada (Central)' => 'ca-central-1', |
| 53 | 'China (Beijing)' => 'cn-north-1', |
| 54 | 'China (Ningxia)' => 'cn-northwest-1', |
| 55 | 'Africa (Cape Town)' => 'af-south-1', |
| 56 | 'Asia Pacific (Hong Kong)' => 'ap-east-1', |
| 57 | 'Asia Pacific (Jakarta)' => 'ap-southeast-3', |
| 58 | 'Asia Pacific (Mumbai)' => 'ap-south-1', |
| 59 | 'Asia Pacific (Seoul)' => 'ap-northeast-2', |
| 60 | 'Asia Pacific (Osaka)' => 'ap-northeast-3', |
| 61 | 'Asia Pacific (Singapore)' => 'ap-southeast-1', |
| 62 | 'Asia Pacific (Sydney)' => 'ap-southeast-2', |
| 63 | 'Asia Pacific (Tokyo)' => 'ap-northeast-1', |
| 64 | 'Middle East (Bahrain)' => 'me-south-1', |
| 65 | 'South America (Sao Paulo)' => 'sa-east-1', |
| 66 | 'AWS GovCloud (US)' => 'us-gov-west-1', |
| 67 | ]; |
| 68 | /** @var AmazonSESMapper */ |
| 69 | protected $errorMapper; |
| 70 | /** @var WPFunctions */ |
| 71 | protected $wp; |
| 72 | |
| 73 | public function __construct( |
| 74 | $region, |
| 75 | $accessKey, |
| 76 | $secretKey, |
| 77 | $sender, |
| 78 | $replyTo, |
| 79 | $returnPath, |
| 80 | AmazonSESMapper $errorMapper, |
| 81 | WPFunctions $wp, |
| 82 | Url $urlUtils |
| 83 | ) { |
| 84 | $this->awsAccessKey = $accessKey; |
| 85 | $this->awsSecretKey = $secretKey; |
| 86 | $this->awsRegion = (in_array($region, $this->availableRegions)) ? $region : false; |
| 87 | if (!$this->awsRegion) { |
| 88 | throw new \Exception(__('Unsupported Amazon SES region', 'mailpoet')); |
| 89 | } |
| 90 | $this->awsEndpoint = sprintf('email.%s.amazonaws.com', $this->awsRegion); |
| 91 | $this->awsSigningAlgorithm = 'AWS4-HMAC-SHA256'; |
| 92 | $this->awsService = 'ses'; |
| 93 | $this->awsTerminationString = 'aws4_request'; |
| 94 | $this->hashAlgorithm = 'sha256'; |
| 95 | $this->url = 'https://' . $this->awsEndpoint; |
| 96 | $this->sender = $sender; |
| 97 | $this->replyTo = $replyTo; |
| 98 | $this->returnPath = $returnPath; |
| 99 | $this->date = gmdate('Ymd\THis\Z'); |
| 100 | $this->dateWithoutTime = gmdate('Ymd'); |
| 101 | $this->errorMapper = $errorMapper; |
| 102 | $this->wp = $wp; |
| 103 | $this->urlUtils = $urlUtils; |
| 104 | $this->blacklist = new BlacklistCheck(); |
| 105 | $this->mailer = $this->buildMailer(); |
| 106 | } |
| 107 | |
| 108 | public function send($newsletter, $subscriber, $extraParams = []): array { |
| 109 | if ($this->blacklist->isBlacklisted($subscriber)) { |
| 110 | $error = $this->errorMapper->getBlacklistError($subscriber); |
| 111 | return Mailer::formatMailerErrorResult($error); |
| 112 | } |
| 113 | try { |
| 114 | $result = $this->wp->wpRemotePost( |
| 115 | $this->url, |
| 116 | $this->request($newsletter, $subscriber, $extraParams) |
| 117 | ); |
| 118 | } catch (\Exception $e) { |
| 119 | $error = $this->errorMapper->getErrorFromException($e, $subscriber); |
| 120 | return Mailer::formatMailerErrorResult($error); |
| 121 | } |
| 122 | if (is_wp_error($result)) { |
| 123 | $error = $this->errorMapper->getConnectionError($result->get_error_message()); |
| 124 | return Mailer::formatMailerErrorResult($error); |
| 125 | } |
| 126 | if ($this->wp->wpRemoteRetrieveResponseCode($result) !== 200) { |
| 127 | $response = simplexml_load_string($this->wp->wpRemoteRetrieveBody($result)); |
| 128 | $error = $this->errorMapper->getErrorFromResponse($response, $subscriber); |
| 129 | return Mailer::formatMailerErrorResult($error); |
| 130 | } |
| 131 | return Mailer::formatMailerSendSuccessResult(); |
| 132 | } |
| 133 | |
| 134 | public function buildMailer(): PHPMailer { |
| 135 | return new PHPMailer(true); |
| 136 | } |
| 137 | |
| 138 | public function getBody($newsletter, $subscriber, $extraParams = []) { |
| 139 | /* Configure mailer and call preSend() method to prepare message */ |
| 140 | $mailer = $this->configureMailerWithMessage($newsletter, $subscriber, $extraParams); |
| 141 | $mailer->preSend(); |
| 142 | /* When message is prepared, we can get the raw message */ |
| 143 | $this->rawMessage = $mailer->getSentMIMEMessage(); |
| 144 | return [ |
| 145 | 'Action' => 'SendRawEmail', |
| 146 | 'Version' => '2010-12-01', |
| 147 | 'Source' => $this->sender['from_name_email'], |
| 148 | 'RawMessage.Data' => $this->encodeMessage($this->rawMessage), |
| 149 | ]; |
| 150 | } |
| 151 | |
| 152 | public function encodeMessage(string $message) { |
| 153 | return base64_encode($message); |
| 154 | } |
| 155 | |
| 156 | public function request($newsletter, $subscriber, $extraParams = []) { |
| 157 | $body = array_map('urlencode', $this->getBody($newsletter, $subscriber, $extraParams)); |
| 158 | return [ |
| 159 | 'timeout' => 10, |
| 160 | 'httpversion' => '1.1', |
| 161 | 'method' => 'POST', |
| 162 | 'headers' => [ |
| 163 | 'Host' => $this->awsEndpoint, |
| 164 | 'Authorization' => $this->signRequest($body), |
| 165 | 'X-Amz-Date' => $this->date, |
| 166 | ], |
| 167 | 'body' => urldecode(http_build_query($body, '', '&')), |
| 168 | ]; |
| 169 | } |
| 170 | |
| 171 | public function signRequest($body) { |
| 172 | $stringToSign = $this->createStringToSign( |
| 173 | $this->getCredentialScope(), |
| 174 | $this->getCanonicalRequest($body) |
| 175 | ); |
| 176 | $signature = hash_hmac( |
| 177 | $this->hashAlgorithm, |
| 178 | $stringToSign, |
| 179 | $this->getSigningKey() |
| 180 | ); |
| 181 | |
| 182 | return sprintf( |
| 183 | '%s Credential=%s/%s, SignedHeaders=host;x-amz-date, Signature=%s', |
| 184 | $this->awsSigningAlgorithm, |
| 185 | $this->awsAccessKey, |
| 186 | $this->getCredentialScope(), |
| 187 | $signature |
| 188 | ); |
| 189 | } |
| 190 | |
| 191 | public function getCredentialScope() { |
| 192 | return sprintf( |
| 193 | '%s/%s/%s/%s', |
| 194 | $this->dateWithoutTime, |
| 195 | $this->awsRegion, |
| 196 | $this->awsService, |
| 197 | $this->awsTerminationString |
| 198 | ); |
| 199 | } |
| 200 | |
| 201 | public function getCanonicalRequest($body) { |
| 202 | return implode("\n", [ |
| 203 | 'POST', |
| 204 | '/', |
| 205 | '', |
| 206 | 'host:' . $this->awsEndpoint, |
| 207 | 'x-amz-date:' . $this->date, |
| 208 | '', |
| 209 | 'host;x-amz-date', |
| 210 | hash($this->hashAlgorithm, urldecode(http_build_query($body, '', '&'))), |
| 211 | ]); |
| 212 | } |
| 213 | |
| 214 | public function createStringToSign($credentialScope, $canonicalRequest) { |
| 215 | return implode("\n", [ |
| 216 | $this->awsSigningAlgorithm, |
| 217 | $this->date, |
| 218 | $credentialScope, |
| 219 | hash($this->hashAlgorithm, $canonicalRequest), |
| 220 | ]); |
| 221 | } |
| 222 | |
| 223 | public function getSigningKey() { |
| 224 | $dateKey = hash_hmac( |
| 225 | $this->hashAlgorithm, |
| 226 | $this->dateWithoutTime, |
| 227 | 'AWS4' . $this->awsSecretKey, |
| 228 | true |
| 229 | ); |
| 230 | $regionKey = hash_hmac( |
| 231 | $this->hashAlgorithm, |
| 232 | $this->awsRegion, |
| 233 | $dateKey, |
| 234 | true |
| 235 | ); |
| 236 | $serviceKey = hash_hmac( |
| 237 | $this->hashAlgorithm, |
| 238 | $this->awsService, |
| 239 | $regionKey, |
| 240 | true |
| 241 | ); |
| 242 | return hash_hmac( |
| 243 | $this->hashAlgorithm, |
| 244 | $this->awsTerminationString, |
| 245 | $serviceKey, |
| 246 | true |
| 247 | ); |
| 248 | } |
| 249 | } |
| 250 |