Product
Introducing License Enforcement in Socket
Ensure open-source compliance with Socket’s License Enforcement Beta. Set up your License Policy and secure your software!
org.webjars.npm:nodemailer-smtp-transport
Advanced tools
Applies for Nodemailer v1.x and not for v0.x where transports are built-in.
Install with npm
npm install nodemailer-smtp-transport
Require to your script
var nodemailer = require('nodemailer');
var smtpTransport = require('nodemailer-smtp-transport');
Create a Nodemailer transport object
var transporter = nodemailer.createTransport(smtpTransport(options))
or (by using smtpTransport as default)
var transporter = nodemailer.createTransport(options)
Where
true
) or not (if false
)true
then logs to console. If value is not set or is false
then nothing is loggedAlternatively you can use connection url with protocol 'smtp:' or 'smtps:'. Use query arguments for additional configuration values.
Example
var transporter = nodemailer.createTransport(smtpTransport({
host: 'localhost',
port: 25,
auth: {
user: 'username',
pass: 'password'
}
}));
Or with connection url (gmail)
var transporter = nodemailer.createTransport(
smtpTransport('smtps://username%40gmail.com:password@smtp.gmail.com')
);
If authentication data is not present, the connection is considered authenticated from the start.
Set authentcation data with options.auth
Where
pass
and xoauth2
values are set) or an XOAuth2 token generator object.If a XOAuth2 token generator is used as the value for auth.xoauth2
then you do not need to set the value for auth.user
. XOAuth2 generator generates required accessToken
itself if it is missing or expired. In this case if the authentication fails, a new token is requested and the authentication is retried once. If it still fails, an error is returned.
Install xoauth2 module to use XOauth2 token generators (not included by default)
npm install xoauth2 --save
XOAuth2 Example
NB! The correct OAuth2 scope for Gmail is
https://mail.google.com/
var nodemailer = require('nodemailer');
var generator = require('xoauth2').createXOAuth2Generator({
user: '{username}',
clientId: '{Client ID}',
clientSecret: '{Client Secret}',
refreshToken: '{refresh-token}',
accessToken: '{cached access token}' // optional
});
// listen for token updates
// you probably want to store these to a db
generator.on('token', function(token){
console.log('New token for %s: %s', token.user, token.accessToken);
});
// login
var transporter = nodemailer.createTransport(({
service: 'gmail',
auth: {
xoauth2: generator
}
}));
// send mail
transporter.sendMail({
from: 'sender@example.com',
to: 'receiver@example.com',
subject: 'hello world!',
text: 'Authenticated with OAuth2'
}, function(error, response) {
if (error) {
console.log(error);
} else {
console.log('Message sent');
}
});
If you do not want to specify the hostname, port and security settings for a well known service, you can use it by its name (case insensitive)
smtpTransport({
service: 'gmail',
auth: ..
});
See the list of all supported services here.
You can verify your configuration with verify(callback)
call. If it returns an error, then something is not correct, otherwise the server is ready to accept messages.
// verify connection configuration
transporter.verify(function(error, success) {
if (error) {
console.log(error);
} else {
console.log('Server is ready to take our messages');
}
});
MIT
FAQs
WebJar for nodemailer-smtp-transport
We found that org.webjars.npm:nodemailer-smtp-transport demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 0 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Product
Ensure open-source compliance with Socket’s License Enforcement Beta. Set up your License Policy and secure your software!
Product
We're launching a new set of license analysis and compliance features for analyzing, managing, and complying with licenses across a range of supported languages and ecosystems.
Product
We're excited to introduce Socket Optimize, a powerful CLI command to secure open source dependencies with tested, optimized package overrides.