@pubsweet/component-aws-ses
v0.1.0
Published
aws ses configured for pubsweet
Downloads
3
Keywords
Readme
AWS SES Configuration
In order to use this component, the following configuration needs to be added to a PubSweet application inside a section named pubsweet-component-aws-ses
:
secretAccessKey
: theAWS_SES_SECRET_KEY
value from the app's.env
fileaccessKeyId
: theAWS_SES_ACCESS_KEY
value from the app's.env
fileregion
: theAWS_SES_REGION
value from the app's.env
filesender
: theEMAIL_SENDER
value from the app's.env
file
For example:
"pubsweet-component-aws-ses": {
"secretAccessKey": "process.env.AWS_SES_SECRET_KEY",
"accessKeyId": "process.env.AWS_SES_ACCESS_KEY",
"region": "process.env.AWS_SES_REGION",
"sender": "process.env.EMAIL_SENDER",
},
In order to use component-aws-ses
you first need to have a .env
file containing AWS data in the root folder of the starting point of your application.
The .env
file contain the following data:
AWS_SES_SECRET_KEY = <secretKey>
AWS_SES_ACCESS_KEY = <accessKey>
EMAIL_SENDER = [email protected]
AWS_SES_REGION = region-name
Then, as soon as possible in your app you should add the dotenv
package:
require('dotenv').config()
component-aws-ses
API
A list of endpoints that help you upload, download and delete S3 files.
Send an email [POST]
Request
POST /api/email
Request body
All parameters are required
{
"email": "[email protected]",
"subject": "Example subject",
"textBody": "this is an email",
"htmlBody": "<p><b>This</b> is an <i>email</i>"
}
Response
HTTP/1.1 204