Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/daniel-zahariev/php-aws-ses
PHP classes that interfaces Amazon Simple Email Service
https://github.com/daniel-zahariev/php-aws-ses
amazon aws-ses composer php
Last synced: 5 days ago
JSON representation
PHP classes that interfaces Amazon Simple Email Service
- Host: GitHub
- URL: https://github.com/daniel-zahariev/php-aws-ses
- Owner: daniel-zahariev
- Created: 2014-01-31T07:34:15.000Z (almost 11 years ago)
- Default Branch: master
- Last Pushed: 2022-10-06T19:52:15.000Z (over 2 years ago)
- Last Synced: 2025-01-11T21:05:18.169Z (12 days ago)
- Topics: amazon, aws-ses, composer, php
- Language: PHP
- Homepage:
- Size: 85 KB
- Stars: 308
- Watchers: 33
- Forks: 100
- Open Issues: 26
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
**Amazon Simple Email Service provides a simple way to send e-mails without having to maintain your own mail server. Those PHP classes use the REST-based interface to that service.**
[](https://travis-ci.org/daniel-zahariev/php-aws-ses)
[](https://circleci.com/gh/daniel-zahariev/php-aws-ses/tree/master)
---
> This repository is a fork from version 0.8.2 of the [original classes](http://www.orderingdisorder.com/aws/ses/) developed by **Dan Myers**
> Read the [old docs here](README_old.md)
---
## Table of Contents
* [Installation](#installation)
* [Basic Usage](#basic-usage)
* [Recipients](#recipients)
* [Message body](#message-body)
* [Attachments](#attachments)
* [Sending Bulk Messages](#sending-bulk-messages)
* [API Endpoints](#api-endpoints)
* [Helper Methods](#helper-methods)
### Installation
Install the latest version with
composer require daniel-zahariev/php-aws-ses
### Basic Usage
```php
addTo('Recipient Name ');
$m->setFrom('Sender ');
$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
//)
```
### Recipients
```php
addTo(array('[email protected]', '[email protected]'));
// You can either add one by one or pass an array to 'To' and 'CC'
$m->addCC('[email protected]');
$m->addCC(array('[email protected]', '[email protected]'));
// And 'BCC' and 'Reply-To' as well
$m->addBCC('[email protected]');
$m->addBCC(array('[email protected]', '[email protected]'));
$m->addReplyTo('[email protected]');
$m->addReplyTo(array('[email protected]', '[email protected]'));
// Also add names to any of the Recipients lists
$m->addTo('Jim Carrey ');
```
### Message body
```php
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');
```
The default is UTF-8 if you do not specify a charset, which is usually the right setting. You can read more information in the [SES API documentation](http://docs.amazonwebservices.com/ses/latest/APIReference/API_Content.html)
### Attachments
```php
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', '' , 'inline');
// and use it in the html version of the e-mail: ![]()
```
### Configuration Set and Message Tags
```php
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();
```
### Sending Bulk Messages
When hundreds of emails have to be sent in bulk it's best to use the Bulk mode which essentially reuses a CURL handler and reduces the number of SSL handshakes and this gives a better performance.
```php
setBulkMode(true);
// Send the messages
foreach($messages as $message) {
$ses->sendEmail($message);
}
// Disable bulk sending mode
$ses->setBulkMode(false);
```
### API Endpoints
Few [Regions and Amazon SES endpoints](http://docs.aws.amazon.com/ses/latest/DeveloperGuide/regions.html) are available and they can be used like this:
```php
listVerifiedEmailAddresses();
// Delete a verified address
$ses->deleteVerifiedEmailAddress('[email protected]');
// Send a confirmation email in order to verify a new email
$ses->verifyEmailAddress('[email protected]');
// Get Send Quota
$ses->getSendQuota();
// Get Send Statistics
$ses->getSendStatistics()
```
See the documentation on [GetSendQuota](http://docs.amazonwebservices.com/ses/latest/APIReference/API_GetSendQuota.html) and [GetSendStatistics](http://docs.amazonwebservices.com/ses/latest/APIReference/API_GetSendStatistics.html) for more information on these calls.
### Errors
By default when Amazon SES API returns an error it will be triggered with [`trigger_error`](http://php.net/manual/en/function.trigger-error.php):
```php
sendEmail($m, $use_raw_request, $trigger_error);
```
### Request Signature Version
You can configure which version of the request signature should be used. [Version 4](https://docs.aws.amazon.com/general/latest/gr/sigv4_signing.html) is now supported and used by default.
```php
` (#3)
* Most of the notices should be cleared now (#5)
v.0.8.3
* Made automatic use of `SendRawEmail` REST API call when there are attachments
v.0.8.2.
* Inital impport
### Todo List
* Fully document the class methods with phpdoc tags
* Build documentation with phpDocumentor
* Move examples to files
* Make a [Composer](https://packagist.org/) package
* Allow X-Headers usage
## Contributors
### Code Contributors
This project exists thanks to all the people who contribute. [[Contribute](CONTRIBUTING.md)].
### Financial Contributors
Become a financial contributor and help us sustain our community. [[Contribute](https://opencollective.com/php-aws-ses/contribute)]
#### Individuals
#### Organizations
Support this project with your organization. Your logo will show up here with a link to your website. [[Contribute](https://opencollective.com/php-aws-ses/contribute)]
### License
MIT License
Copyright (c) 2011 Dan Mayers
Copyright (c) 2014 Daniel Zahariev
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.