-
Notifications
You must be signed in to change notification settings - Fork 5
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Pablo J. Veintimilla Vargas
committed
Mar 30, 2024
1 parent
eec511c
commit 78482a5
Showing
1 changed file
with
29 additions
and
15 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,44 +1,58 @@ | ||
# Mautic Amazon SES | ||
# Mautic 5 Amazon SES | ||
|
||
![Amazons SES](Assets/img/icon.png "Amazons SES") | ||
|
||
This plugin enable Mautic 5 to run AWS SES as a email transport and provide a callback to process bounces | ||
This plugin enable Mautic 5 to run AWS SES as a email transport and provide a callback to process bounces. | ||
|
||
## INSTALLATION | ||
|
||
1. Get the plugin using `composer pablo.veintimilla/amazon-ses-bundle` | ||
2. Install it using `php bin\console mautic:plugins:reload`. | ||
3. The plugin will start listing on plugin page. ![Plugins Page](Docs/imgs/01%20-%20Plugins%20Page.png) | ||
1. Get the plugin using | ||
|
||
## CONFIGURATION | ||
``` | ||
composer require pabloveintimilla/mautic-amazon-ses | ||
``` | ||
|
||
2. Install plugin | ||
|
||
``` | ||
php bin\console mautic:plugins:reload | ||
``` | ||
|
||
## CONFIGURATION MAUTIC | ||
|
||
Be sure to use the `ses+api` as Data Source Name, or DSN. | ||
The following is the example for the DSN. | ||
`ses+api://ACCESS_KEY:SECRET_KEY@default?region=REGION&session_token=SESSION_TOKEN` | ||
`ses+api://ACCESS_KEY:SECRET_KEY@default?region=REGION` | ||
|
||
Follow the steps tp setup Mailjet SMTP DSN, | ||
Follow the steps tp setup Mailjet SMTP DSN: | ||
|
||
1. Navigate to Configuration (/s/config/edit>) | ||
2. Scroll to Email Settings | ||
3. Update the following fields leaving rest default or empty, | ||
1. Navigate to Configuration > Mail Send Settings | ||
2. Update the following fields leaving rest default or empty, | ||
|
||
| Field | Value | | ||
| -------- | ------------- | | ||
| Scheme | `ses+api` | | ||
| Host | `default` | | ||
| Port | `465` | | ||
| User | `<apiKey>` | | ||
| User | `<aws-user>` | | ||
| Password | `<secretKey>` | | ||
| Region | `<region>` | | ||
|
||
The `<apiKey>` and `<secretKey>` will be a credential access from a user AWS. | ||
The `<region>` is AWS region were run AWS SES in your account | ||
|
||
## CONFIGURATION AWS | ||
|
||
The `<apiKey>` and `<secretKey>` will be used for authentication purposes. Please visit the [Amazon SES Guide](https://aws.amazon.com/es/blogs/messaging-and-targeting/credentials-and-ses/) | ||
Process bounces you need to configure an AWS SNS to send a callback to Mautic. | ||
|
||
On the Configuration page **Email DSN** should look like ![Email DSN](Assets/img/02%20-%20Email%20DSN.png "Email DSN") | ||
- Configure a HTTP SNS topic to request to: `URL_MAUTIC`/mailer/callback | ||
- Confirm SNS, this plugin automatic activate. | ||
|
||
## AUTHOR | ||
|
||
👤 **Pablo Veintimilla** | ||
|
||
- Twitter: [@\pabloveintimilla](https://twitter.com/pabloveintimilla) | ||
- Twitter: [@pabloveintimilla](https://twitter.com/pabloveintimilla) | ||
- Github: [@pabloveintimilla](https://github.com/pabloveintimilla) | ||
|
||
[MailjetGuidePage]: https://dev.mailjet.com/email/guides/getting-started/ |