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' />

发送批量邮件

当需要批量发送数百封电子邮件时，最好使用批量模式，该模式本质上会重用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.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
合并了添加内联文件的拉取请求
合并了修复原始消息中'From: '字段错误的拉取请求
添加了Composer文件并提交到Packagist.org
触发错误现在是可选的（默认开启）
在SimpleEmailService中添加了类常量，以便轻松选择区域API端点

v.0.8.4

在SimpleEmailServiceMessage类中添加了addCustomHeader方法，以便在调用SendRawEmail时添加自定义标题（#7）
SendRawEmail 方法可以通过在 sendEmail 函数中添加一个新参数来强制执行
当格式为 Name <Email> 时，接收者现在默认使用 base64 编码 (#3)
现在应该已经清除了大多数通知 (#5)

版本 v.0.8.3

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

版本 v.0.8.2.

初始导入

待办事项列表

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

hisune / php-aws-ses

维护者

详细信息