humanmade/aws-ses-wp-mail

WordPress plugin to send mail via SES

Installs: 145 033

Dependents: 2

Suggesters: 1

Security: 0

Stars: 182

Watchers: 36

Forks: 50

Open Issues: 16

Type:wordpress-plugin

2.0.0-alpha 2021-09-14 10:31 UTC

README

AWS SES wp_mail() drop-in
Use AWS SES to send your WordPress emails. Easily.
A Human Made project. Maintained by @joehoyle. 68747470733a2f2f686d6e2e6d642f636f6e74656e742f7468656d65732f686d6e6d642f6173736574732f696d616765732f686d2d6c6f676f2e737667

AWS SES is a very simple UI-less plugin for sending wp_mail()s email via AWS SES.

Getting Set Up

Once you have git cloned the repo, or added it as a Git Submodule, add the following constants to your wp-config.php:

define( 'AWS_SES_WP_MAIL_REGION', 'us-east-1' );
define( 'AWS_SES_WP_MAIL_KEY', '' );
define( 'AWS_SES_WP_MAIL_SECRET', '' );
define( 'AWS_SES_WP_MAIL_CONFIG_SET', '' );

If you plan to use IAM instance profiles to protect your AWS credentials on disk you'll need the following configuration instead:

define('AWS_SES_WP_MAIL_REGION', 'us-east-1');
define('AWS_SES_WP_MAIL_USE_INSTANCE_PROFILE', true);

The next thing that you should do is to verify your sending domain for SES. You can do this via the AWS Console, which will allow you to automatically set headers if your DNS is hosted on Route 53. Alternatively, you can get the required DNS records by running:

wp aws-ses verify-sending-domain

Once you have verified your sending domain, you are all good to go!

Note: If you have not used SES in production previously, you need to apply to move out of the Amazon SES sandbox.

Configuration Sets

To better track your mail activity for monitoring or statistics you can use the configuration sets. To enable it you will first need to create your Configuration Set on AWS SES Console and add the configuration set name as the value to the AWS_SES_WP_MAIL_CONFIG_SET constant.

Detailed information on the setup and usage you find here: https://docs.aws.amazon.com/ses/latest/DeveloperGuide/using-configuration-sets.html

Other Commands

wp aws-ses send <to> <subject> <message> [--from-email=<email>]

Send a test email via the command line. Good for testing!

Credits

Created by Human Made for high volume and large-scale sites. We run AWS SES wp_mail() on sites with millions of monthly page views, and thousands of sites.

Written and maintained by Joe Hoyle. Thanks to all our contributors.

Interested in joining in on the fun? Join us, and become human!