From f84a140ee5a729b651508764c875e3a7a251554f Mon Sep 17 00:00:00 2001 From: MujiGMJ Date: Wed, 8 Jan 2020 13:47:02 +0800 Subject: [PATCH] Modified amazon ses integration --- docs/administrator/integrations.md | 75 ++++++++++++++++++++++++------ docs/developer/amazon-ses.md | 71 ---------------------------- website/sidebars.json | 3 +- 3 files changed, 63 insertions(+), 86 deletions(-) delete mode 100644 docs/developer/amazon-ses.md diff --git a/docs/administrator/integrations.md b/docs/administrator/integrations.md index 5b19877..cb61f6a 100644 --- a/docs/administrator/integrations.md +++ b/docs/administrator/integrations.md @@ -183,20 +183,69 @@ AWS_PREFIX='' ## AWS SES Integration -1. Configure AWS account settings in `erxes-api/.env` like below +Amazon Simple Email Service enables you to send and receive email using a reliable and scalable email platform. Set up your custom amazon simple email service account. -```Shell -AWS_SES_ACCESS_KEY_ID='aws account access key id' -AWS_SES_SECRET_ACCESS_KEY='aws account secret access key' -AWS_REGION='aws account region' -AWS_SES_CONFIG_SET='could be anything that you wanted to name your config' -AWS_ENDPOINT='your erxes-api domain' -``` +### Configure Amazon SES and Amazon SNS to track each email responses. -- You can get your aws access key id and region from [here](https://console.aws.amazon.com/console/home) - , You can not get your current aws secret access key, however you can always create new one and claim newly created aws secret access key -- Make sure your IAM user has proper access to SNS and SES services. +1. [ Log in to your AWS Management Console. ](https://console.aws.amazon.com) +2. Click on your user name at the top right of the page. +3. Click on the My Security Credentials link from the drop-down menu. +4. Click on the Users menu from left Sidebar. +5. Click on the Add user. +6. Then create your username and check Programmatic access type and click next. +7. Click on the Create group then write group name and check amazonSesFullAccess and amazonSNSFullAccess. +8. Then check your created group and click on the Next button. +9. Finally click on the create user and copy the Access Key Id and Secret Access Key. + + +### To find your Region. + +1. [ Log in to your AWS Management Console.](https://console.aws.amazon.com) +2. Click on services menu at the top left of the page. +3. Find Simple Email Service and Copy region code from url. + +**If you choose not available region** +1. Click on your region at the top right of the menu. +2. Select any active region from list. +3. Copy the selected Region code. +_(example: us-east-1, us-west-2, ap-south-1, ap-southeast-2, eu-central-1, eu-west-1)_ + + +### To determine if your account is in the sandbox. +1. [Open the Amazon SES console at https://console.aws.amazon.com/ses/](https://console.aws.amazon.com/ses/) +2. Use the Region selector to choose an AWS Region. +3. If your account is in the sandbox in the AWS Region that you selected, you see a banner at the top of the page that resembles the example in the following figure. + + + +4. If the banner doesn't appear on this page, then your account is no longer in the sandbox in the current Region. + + + + +5. **If you move out of the Sandbox,** follow the instructions described [here](https://docs.aws.amazon.com/ses/latest/DeveloperGuide/request-production-access.html) to move out of the Amazon SES Sandbox. + + +### Paste Amazon-Ses Access Keys to Erxes AWS-SES engage. + +1. Login Erxes, go to Settings menu => Appstore. +2. Click on the “Appstore” menu +3. Click manage to AWS-SES engage configuration + + + +4. Paste the AWS-SES access key ID, AWS-SES secret access key and AWS-SES region which you have created user in AWS Management console. + + + +### Test configuration. + +Amazon places all new accounts in the Amazon SES sandbox. While your account is in the sandbox, you can use all of the features of Amazon SES. However, when your account is in the sandbox, Amazon have applied the following restrictions to your account: + ++ You can only send mail to verified email addresses and domains, or to the Amazon SES mailbox simulator. -2. Run `yarn engageSubscriptions` command to automatically create all the necessary configs for you ++ You can only send mail from verified email addresses and domains. -3. Before start sending email you should verify sender's email address through [here](https://console.aws.amazon.com/ses/home?#verified-senders-email:) + \ No newline at end of file diff --git a/docs/developer/amazon-ses.md b/docs/developer/amazon-ses.md deleted file mode 100644 index 23299d5..0000000 --- a/docs/developer/amazon-ses.md +++ /dev/null @@ -1,71 +0,0 @@ ---- -id: amazon-ses -title: AWS SES engage configuration -sidebar_label: AWS SES engage ---- -Amazon Simple Email Service enables you to send and receive email using a reliable and scalable email platform. Set up your custom amazon simple email service account. - -## Configure Amazon SES and Amazon SNS to track each email responses. - -1. [ Log in to your AWS Management Console. ](https://console.aws.amazon.com) -2. Click on your user name at the top right of the page. -3. Click on the My Security Credentials link from the drop-down menu. -4. Click on the Users menu from left Sidebar. -5. Click on the Add user. -6. Then create your username and check Programmatic access type and click next. -7. Click on the Create group then write group name and check amazonSesFullAccess and amazonSNSFullAccess. -8. Then check your created group and click on the Next button. -9. Finally click on the create user and copy the Access Key Id and Secret Access Key. - - -## To find your Region. - -1. [ Log in to your AWS Management Console.](https://console.aws.amazon.com) -2. Click on services menu at the top left of the page. -3. Find Simple Email Service and Copy region code from url. - -**If you choose not available region** -1. Click on your region at the top right of the menu. -2. Select any active region from list. -3. Copy the selected Region code. -_(example: us-east-1, us-west-2, ap-south-1, ap-southeast-2, eu-central-1, eu-west-1)_ - - -## To determine if your account is in the sandbox. -1. [Open the Amazon SES console at https://console.aws.amazon.com/ses/](https://console.aws.amazon.com/ses/) -2. Use the Region selector to choose an AWS Region. -3. If your account is in the sandbox in the AWS Region that you selected, you see a banner at the top of the page that resembles the example in the following figure. - - - -4. If the banner doesn't appear on this page, then your account is no longer in the sandbox in the current Region. - - - - -5. **If you move out of the Sandbox,** follow the instructions described [here](https://docs.aws.amazon.com/ses/latest/DeveloperGuide/request-production-access.html) to move out of the Amazon SES Sandbox. - - -## Paste Amazon-Ses Access Keys to Erxes AWS-SES engage. - -1. Login Erxes, go to Settings menu => Appstore. -2. Click on the “Appstore” menu -3. Click manage to AWS-SES engage configuration - - - -4. Paste the AWS-SES access key ID, AWS-SES secret access key and AWS-SES region which you have created user in AWS Management console. - - - -## Test configuration. - -Amazon places all new accounts in the Amazon SES sandbox. While your account is in the sandbox, you can use all of the features of Amazon SES. However, when your account is in the sandbox, Amazon have applied the following restrictions to your account: - -+ You can only send mail to verified email addresses and domains, or to the Amazon SES mailbox simulator. - -+ You can only send mail from verified email addresses and domains. - - \ No newline at end of file diff --git a/website/sidebars.json b/website/sidebars.json index ec9d959..2f9ed21 100644 --- a/website/sidebars.json +++ b/website/sidebars.json @@ -46,8 +46,7 @@ "developer/graphql-api", "developer/push-notifications", "developer/android-sdk", - "developer/ios-sdk", - "developer/amazon-ses" + "developer/ios-sdk" ] } }