Skip to content

Allow for plugin to use Amazon SDK directly. Clarify installation instructions. #50

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open

Allow for plugin to use Amazon SDK directly. Clarify installation instructions. #50

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
64c4334
Conditionally add composer autoload.
SteveRyan-ASU Dec 2, 2021
3536bde
Update readme with better install instructions
SteveRyan-ASU Dec 2, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 13 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,10 +17,21 @@

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

Getting Set Up
Installation
==========

Once you have `git clone`d the repo, or added it as a Git Submodule, add the following constants to your `wp-config.php`:
The ideal approach for using this plugin is to install it via composer at the root of your project. This can prevent multiple versions of the Amazon SDK from being installed within your codebase.

```
composer require humanmade/aws-ses-wp-mail
```

Otherwise, clone the plugin to `/wp-content/plugins` and then run `composer install` within the resulting directory.

Configuration
==========

Once installed, add the following constants to your `wp-config.php`:

```PHP
define( 'AWS_SES_WP_MAIL_REGION', 'us-east-1' );
Expand Down
6 changes: 6 additions & 0 deletions aws-ses-wp-mail.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,12 @@
return;
}

// Access to the Amazon SDK is required for this plugin to send mail.
// It can be provided directly via composer install within this plugin, or as a dependency of your project.
if ( is_readable( dirname( __FILE__ ) . '/vendor/autoload.php' ) ) {
require_once dirname( __FILE__ ) . '/vendor/autoload.php';
}

require_once dirname( __FILE__ ) . '/inc/class-ses.php';

if ( defined( 'WP_CLI' ) && WP_CLI ) {
Expand Down