How to Send Email using Node.js ?
Sending emails is a common task in many applications, whether it be for sending notifications, account verification, password resets, or other communication needs. Node.js, with its event-driven and non-blocking architecture, is well-suited for performing such tasks. In this article, we’ll explore how to send emails using Node.js. We will cover setting up a mail transport, composing the email, and sending it.
Why Use Node.js for Sending Emails?
Node.js provides a powerful and flexible environment for sending emails. It supports various email protocols, can handle asynchronous tasks efficiently, and integrates well with popular email services like Gmail, SendGrid, and Mailgun. By using Node.js for sending emails, you can:
- Leverage Asynchronous Operations: Send emails without blocking other operations in your application.
- Integrate Seamlessly: Use libraries that integrate with various email services and protocols.
- Handle Large Volumes: Efficiently send large volumes of emails with appropriate configuration.
Nodemailer
There are various modules available for sending emails but the nodemailer is the most popular one and it provides us simple procedure and functionality to send mail.
Features of Nodemailer
- It supports various features like adding HTML in the mail, Unicode characters, sending attachments with the text, etc.
- It uses the simple mail transfer protocol (SMTP). Below is the step-by-step approach to be followed to integrate this module into our application.
Step 1: Module Installation
Write the command in the terminal to install nodemailer and then import at the top of your nodejs application.
npm install nodemailer
Now we are ready to import this into our application.
const nodemailer = require('nodemailer');
Step 2: Create Transporter Object
There exists a createTransport method in nodemailer which accepts an object with some configurations and finally returns a transporter object. This object will be required later to send emails.
const transporter = nodemailer.createTransport(transport[, defaults]);
Here we are using Gmail as a service just for sample purposes, Although nodemailer can be easily integrated with any other mail service. In Gmail, we can either make our account less secure or we can use the Oauth2 security authentication unless normally google will not allow sending any mail via node.js.
Less Secure Account
Visit this link to make your account less secure, after doing this we can create our working transporter object just with the username and password of your Gmail account.
// app.js
const nodemailer = require('nodemailer');
const transporter = nodemailer.createTransport({
service: 'gmail',
auth: {
user: secure_configuration.EMAIL_USERNAME,
pass: secure_configuration.PASSWORD
}
});
Using Oauth2
According to official docs here we need to provide client id, client secret, refresh token, and an access token along with the username and password. Follow the step-by-step approach to get these configurations from the google cloud console.
Step 1: Open Google Cloud Console
In this step, we will get our client id and client secret. Visit the google cloud console website and register/sign in yourself. Then proceed to API & Services section from the leftmost navigation bar. Now check out the dashboard and create a project. After this, visit the Oauth consent screen to register about your application in this step make sure to select user type external and add some/one Test Users. After this step, go to the credentials section and click on Create credentials and then choose Oauth2 ClientID and choose application type as a web application, also make sure to add redirect URI as OAuth playground (copy link from here). Finally, you’ll be successful to get your client_id and client_secret.
Step 2: Open the Oauth2 Playground
Here we will get our refresh token and access token. Visit the OAuth2 playground, Click on the oauth2.0 configuration icon from the right and then check the use your own credentials checkbox and provide the same client id and secret you’ve got from the cloud console. Now select the Gmail API for authorization. Click on Authorize API and then authorize it by the same Gmail id you have been filled as a test user in the credentials section of the last step. Finally, click on the exchange authorization code for tokens and this will provide a refresh token and access token.
Note: We suggest you open these gifs in a separate tab and follow both approaches separately and don’t skip at any span this would save you from a lot of confusion, Also don’t try to copy this client id and client secret, etc. it will not going to work.
// app.js
const nodemailer = require('nodemailer');
const transporter = nodemailer.createTransport({
service: 'gmail',
auth: {
type: 'OAuth2',
user: secure_configuration.EMAIL_USERNAME,
pass: secure_configuration.PASSWORD,
clientId: secure_configuration.CLIENT_ID,
clientSecret: secure_configuration.CLIENT_SECRET,
refreshToken: secure_configuration.REFRESH_TOKEN
}
});
With this our transporter object is ready and now we can send our emails.
Step 3: Configure eMail
Before sending the mail we have to create some message configurations like what to send where to send etc. It is super easy to create these configurations there are several key-value pairs, from which you can provide the required ones along with some other values to the predefined key.
Sending a simple text to one email
// app.js
const mailConfigurations = {
// It should be a string of sender email
from: 'mrtwinklesharma@gmail.com',
// Comma Separated list of mails
to: 'smtwinkle451@gmail.com',
// Subject of Email
subject: 'Sending Email using Node.js',
// This would be the text of email body
text: 'Hi! There, You know I am using the'
+ ' NodeJS Code along with NodeMailer '
+ 'to send this email.'
};
Output: If we send the email with these configurations, something like this will be sent to the receiver. Although our code is currently incomplete, here we are just showing you how this message configuration will look like when the code will be completed.
Sending to Multiple emails:
We can concatenate more emails with a comma as a separator.
const mailConfigurations = {
from: 'mrtwinklesharma@gmail.com',
to: 'smtwinkle451@gmail.com, anyothergmailid@gmail.com',
subject: 'Sending Email using Node.js',
text: 'Hi! There, You know I am using the NodeJS Code'
+ ' along with NodeMailer to send this email.'
};
Sending some HTML content
Just replace the Plain text with HTML and provide it to HTML key.
const mailConfigurations = {
from: 'mrtwinklesharma@gmail.com',
to: 'smtwinkle451@gmail.com',
subject: 'Sending Email using Node.js',
html: "<h2>Hi! There</h2> <h5> This HTML content is
being send by NodeJS along with NodeMailer.</h5>"
};
Output:
Sending some Attachments, Nodemailer is so flexible while sending attachments, you can send any type of file which is being accepted by email service.
const mailConfigurations = {
from: 'mrtwinklesharma@gmail.com',
to: 'smtwinkle451@gmail.com',
subject: 'Sending Email using Node.js',
text:'Attachments can also be sent using nodemailer',
attachments: [
{
// utf-8 string as an attachment
filename: 'text.txt',
content: 'Hello, w3wiki Learner!'
},
{
// filename and content type is derived from path
path: '/home/mrtwinklesharma/Programming/document.docx'
},
{
path: '/home/mrtwinklesharma/Videos/Sample.mp4'
},
{
// use URL as an attachment
filename: 'license.txt',
path: 'https://raw.github.com/nodemailer/nodemailer/master/LICENSE'
}
]
};
Output:
Not only these but nodemailer have a lot of possibilities for message configurations you can check them all from here.
Step 4: Send eMail
Use any one of the above approaches to proceed with the transporter object, and then choose any one email configurations to send mail.
There exists a sendMail method in the transporter object which accepts email configurations and a callback function that will be executed either when mail has been sent or due to an error.
transporter.sendMail(mailConfigurations[, callback]);
transporter.sendMail(mailConfigurations, function(error, info){
if (error) throw Error(error);
console.log('Email Sent Successfully');
console.log(info);
});
Step 5: Combine them All
You can pick any options from the step 2 and 3. After providing it to the sendMail method you will be successfully able to send an email with node.js.
Explanation
Here we have imported the nodemailer module in the beginning and then used the Oauth2 type of authentication, later there is the most basic message configuration which is being used. Finally, the sendMail method is sending the mail to receivers provided in message configuration.
Note:- The secure module being imported has nothing to do with this nodemailer, I have just used it to secure my credentials.
const nodemailer = require('nodemailer');
const secure_configuration = require('./secure');
const transporter = nodemailer.createTransport({
service: 'gmail',
auth: {
type: 'OAuth2',
user: secure_configuration.EMAIL_USERNAME,
pass: secure_configuration.PASSWORD,
clientId: secure_configuration.CLIENT_ID,
clientSecret: secure_configuration.CLIENT_SECRET,
refreshToken: secure_configuration.REFRESH_TOKEN
}
});
const mailConfigurations = {
from: 'mrtwinklesharma@gmail.com',
to: 'smtwinkle451@gmail.com',
subject: 'Sending Email using Node.js',
text: 'Hi! There, You know I am using the NodeJS '
+ 'Code along with NodeMailer to send this email.'
};
transporter.sendMail(mailConfigurations, function(error, info){
if (error) throw Error(error);
console.log('Email Sent Successfully');
console.log(info);
});
Output: Run this code snippet with node command and this will be the output in the console and Gmail inbox.