humanmade / aws-ses-wp-mail
WordPress plugin to send mail via SES
Installs: 175 277
Dependents: 2
Suggesters: 1
Security: 0
Stars: 185
Watchers: 37
Forks: 51
Open Issues: 18
Type:wordpress-plugin
Requires
- php: >=5.3
- aws/aws-sdk-php: ~3.18
- composer/installers: ~1.0
This package is auto-updated.
Last update: 2024-10-21 12:07:54 UTC
README
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 clone
d 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!