Send Emails using Node, Express and SendGrid
- node and node package manager
- Postman
- Save your API Key in your local environment
export API_KEY="Your custom API KEY from Sendgrid"- Install all dependencies listed in package.json
npm install- To start the endpoint use
npm startor
node index.js- In the console check Port number
Example
server started on PORT: 5000
- Open Postman and make a get request on http://localhost:5000 If You get a callback as "Hello World", your server has started successfully on localhost
Endpont to send mail is in the format https://localhost:5000/test
To send an email to a person copy-paste this JSON Tree. This is the simplest payload. Every field is mandatory. Replace emailMessage with your HTML Body and email with an email id you want to send an email.
{
"userData": [
{
"email": "[email protected]",
"name": "Ram",
"status": "PASS",
"cc":[],
"bcc":[]
}
],
"emailMessage": "<html><head><title></title></head><body>Hello {{name}} ,<br /><br/>Results are out<br /><br/><br /><br/>You are designated as {{status}}<br /><br/></body></html>"
}{
"status": 200,
"message": "Successfully added mails to queue",
"data": {
"success": [
"[email protected]"
],
"failure": [],
"note": "Check your Dashboard or set up a Webhook to get live values of failures. Emails are put in a queue, they may take some time to arrive or decide to fail"
}
}Check your mailbox to see the email you have sent. Emails are put in a queue by SendGrid, they may take some time to arrive or decide to fail.
{
"userData": [
{
"email": "[email protected]",
"name": "Ram",
"status": "PASS",
"cc":["[email protected]"],
"bcc":[]
},
{
"email": "[email protected]",
"name": "Ram",
"status": "PASS",
"cc":["[email protected]","[email protected]"],
"bcc":["[email protected]","[email protected]"]
}
],
"emailMessage": "<html><head><title></title></head><body>Hello {{name}} ,<br /><br/>Results are out<br /><br/><br /><br/>You are designated as {{status}} This is the raw body<br /><br/></body></html>"
}Attachments can se sent in an API using form-data and binary data. In binary data method one attachment can be sent with no json body. Here form-data is used.
The easiest way to test the API with attachment
- Open Postman
- Select POST as a request
- Add URL http://localhost:5000
- Click on Body Tab
- Click
form-data - Add key as
binaryFileIn the same horizontal line click on dropdown selectFileand choose the file you want to send - Now fill all other options in the sample image
| Key | Value |
|---|---|
| binaryFile | [CHOOSE FILE]] |
| emailMessage | Sample HTML Body |
| userData[0][email] | [email protected] |
| userData[0][name] | Ram |
| userData[0][status] | PASS |
| Key | Value |
|---|---|
| binaryFile | [CHOOSE FILE]] |
| emailMessage | Sample HTML Body |
| userData[0][email] | [email protected] |
| userData[0][name] | Ram |
| userData[0][status] | PASS |
| userData[0][cc] | [email protected] |
| userData[1][email] | [email protected] |
| userData[1][name] | Shyam |
| userData[1][status] | FAIL |
| userData[1][cc] | [email protected] |
| userData[1][cc] | [email protected] |
| userData[1][cc] | [email protected] |
| userData[1][bcc] | [email protected] |
| userData[1][bcc] | [email protected] |
To compile your typescript file to javascript you must have typescript installed. To install TypeScript
sudo npm install -g typescriptCompile TypeScript > JavaScript
tsc index.tsNow Run the index.js using node
node index.ts
React
Typescript
Django
Laravel
Facebook
Microsoft
Google
Alibaba
D3
Tencent