README

Amazon Simple Email Service提供了一种简单的方式来发送电子邮件，无需维护自己的邮件服务器。这些PHP类使用基于REST的服务接口。

此存储库是从由Dan Myers开发的原始类的0.8.2版本分支的。阅读旧文档在这里

<?php

require_once 'vendor/autoload.php';

$m = new SimpleEmailServiceMessage();
$m->addTo('recipient@example.com');
$m->setFrom('user@example.com');
$m->setSubject('Hello, world!');
$m->setMessageFromString('This is the message body.');

$ses = new SimpleEmailService('AccessKey', 'SecretKey');
print_r($ses->sendEmail($m));

// Successful response should print something similar to:
//Array(
//     [MessageId] => 0000012dc5e4b4c0-b2c566ad-dcd0-4d23-bea5-f40da774033c-000000
//     [RequestId] => 4953a96e-29d4-11e0-8907-21df9ed6ffe3
//)

收件人

<?php

$m = new SimpleEmailServiceMessage();
// Add many Recipients
$m->addTo(array('dwight@example.com', 'angela@example.com'));

// You can either add one by one or pass an array to 'To' and 'CC'
$m->addCC('holly@example.com');
$m->addCC(array('kelly@example.com', 'ryan@example.com'));

// And 'BCC' and 'Reply-To' as well
$m->addBCC('michael@example.com');
$m->addBCC(array('kevin@example.com', 'oscar@example.com'));
$m->addReplyTo('andy@example.com');
$m->addReplyTo(array('stanley@example.com', 'erin@example.com'));


// Also add names to any of the Recipients lists
$m->addTo('Jim Carrey <jim@example.com>');

消息正文

<?php

// Additionally you can set the content of the email via:
$m->setMessageFromFile('/path/to/some/file.txt');
$m->setMessageFromURL('http://example.com/somefile.txt');

// And have both Text and HTML version with:
$m->setMessageFromString($text, $html);
$m->setMessageFromFile($textfilepath, $htmlfilepath);
$m->setMessageFromURL($texturl, $htmlurl);

// Remember that setMessageFromString, setMessageFromFile, and setMessageFromURL are mutually exclusive.
// If you call more than one, then whichever call you make last will be the message used.

// You can also set the encoding of the Subject and the Message Body
$m->setSubjectCharset('ISO-8859-1');
$m->setMessageCharset('ISO-8859-1');

如果没有指定字符集，则默认为UTF-8，这通常是正确的设置。您可以在SES API文档中了解更多信息

附件

<?php

$m->addAttachmentFromData('my_text_file.txt', 'Simple content', 'text/plain');
$m->addAttachmentFromFile('my_PFD_file.pdf', '/path/to/pdf/file', 'application/pdf');

// SendRawEmail is explicitly used when there are attachments:
$ses->sendEmail($m);
// Sending raw email can be enforsed with:
$ses->sendEmail($m, $use_raw_request = true);

// Now you can add an inline file in the message
$m->addAttachmentFromFile('logo.png','path/to/logo.png','application/octet-stream', '<logo.png>' , 'inline');
// and use it in the html version of the e-mail: <img src='cid:logo.png' />

配置集和消息标签

<?php

// Set the configuration set
$m->setConfigurationSet('myConfigurationSet');

// Reset the configuration set
$m->setConfigurationSet(null);


// Set message tag
$m->setMessageTag('key', 'value');

// Get message tag
$tag = $m->getMessageTag('key');

// Remove message tag
$m->removeMessageTag('key');

// Set message tags in bulk - performs merge with current tags
$m->setMessageTags(array('key1' => 'value1', 'key2' => 'value2'));

// Get message tags
$tags = $m->getMessageTags();

// Remove all message tags
$m->removeMessageTags();

发送大量消息

当需要批量发送数百封电子邮件时，最好使用批量模式，该模式本质上重用CURL处理器，减少了SSL握手次数，从而提高了性能。

<?php

// Enable bulk sending mode (reuse of CURL handler)
$ses->setBulkMode(true);

// Send the messages
foreach($messages as $message) {
	$ses->sendEmail($message);
}

// Disable bulk sending mode
$ses->setBulkMode(false);

API端点

有一些区域和Amazon SES端点可用，可以像这样使用

<?php

$region_endpoint = SimpleEmailService::AWS_US_EAST_1;
$ses = new SimpleEmailService('AccessKey', 'SecretKey', $region_endpoint);

辅助方法

<?php

// Get the addresses that have been verified in your AWS SES account
$ses->listVerifiedEmailAddresses();
// Delete a verified address
$ses->deleteVerifiedEmailAddress('user@example.com');
// Send a confirmation email in order to verify a new email
$ses->verifyEmailAddress('user@example.com');

// Get Send Quota
$ses->getSendQuota();
// Get Send Statistics
$ses->getSendStatistics()

有关这些调用的更多信息，请参阅GetSendQuota和GetSendStatistics的文档

错误

默认情况下，当Amazon SES API返回错误时，它将触发trigger_error

<?php

// Set the default behaviour for handling errors
$trigger_error = true;
$ses = new SimpleEmailService('AccessKey', 'SecretKey', $region_endpoint, $trigger_error);

// Or overwrite the main setting on a single call
$use_raw_request = false;
$trigger_error = false;
$ses->sendEmail($m, $use_raw_request, $trigger_error);

变更日志

v.0.9.2

增加了对HTML消息的支持

v.0.9.1

增加了对AWS SES配置集和消息标签的支持
在SimpleEmailServiceMessage中增加了缓存机制，以加快批量发送模式

v.0.9.0

添加了原始消息编码参数

v.0.8.9

合并了来自hlev的pull request 32：从requirement中删除

v.0.8.8

修复了问题：#24, #25, #30, #31
在SimpleEmailService中添加了一个方法setBulkMode，可以启用重用SimpleEmailServiceRequest对象来对AWS SES进行批量发送请求
SimpleEmailService中的新方法：getVerifyPeer、setVerifyPeer、getVerifyHost、setVerifyHost、getBulkMode、setBulkMode、getRequestHandler（受保护）
SimpleEmailService中标记为过时的方法：enableVerifyHost、enableVerifyPeer、verifyHost、verifyPeer
SimpleEmailServiceMessage中的新方法：clearTo、clearCC、clearBCC、clearReplyTo、clearRecipients
SimpleEmailServiceRequest中的新方法：setVerb、clearParameters、getCurlHandler（受保护）
更新了SimpleEmailServiceMessage中的validate方法
添加了一些phpDocumentor代码块

v.0.8.7

一些小的更新

v.0.8.6

删除了示例代码
从源文件中删除了版本号

v.0.8.5

修复了一些问题 #9, #10, #10
合并了添加内联文件的pull request
合并了修复“From: ”字段错误的pull request
已添加Composer文件并提交到Packagist.org
触发错误现在是可选的（默认开启）
在SimpleEmailService中添加了类常量，以便于选择区域API端点

v.0.8.4

为SimpleEmailServiceMessage类添加了新方法addCustomHeader，用于在调用SendRawEmail时添加自定义头（#7）
可以使用sendEmail函数的新参数强制执行SendRawEmail方法
当格式为Name <Email>时，收件人现在默认使用base64编码（#3）
现在应该已经清除了大部分通知（#5）

v.0.8.3

当有附件时，自动使用SendRawEmail REST API调用

v.0.8.2.

初始导入

待办事项列表

使用phpdoc标签完全记录类方法
使用phpDocumentor构建文档
将示例移动到文件中
创建一个Composer包
允许使用X-Headers

许可

MIT许可

在此特此授予任何获得本软件及其相关文档副本（以下简称“软件”）的人士，无需支付任何费用，有权在不受限制的情况下处理该软件，包括但不限于使用、复制、修改、合并、发布、分发、再许可和/或出售软件的副本，并允许提供软件的人士按以下条件这样做：

lubuzzo / php-aws-ses

维护者

详细信息