nodemailer-smtp-transport - npm Package Compare versions

Comparing version 2.7.2 to 2.7.3

package.json

		{
		"name": "nodemailer-smtp-transport",
		"version": "2.7.2",
		"version": "2.7.3",
		"description": "SMTP transport for Nodemailer",
		@@ -5,0 +5,0 @@ "main": "lib/smtp-transport.js",

170

README.md

		@@ -1,169 +0,7 @@
		# SMTP transport module for Nodemailer
		# nodemailer-smtp-transport

		[![Build Status](https://travis-ci.org/andris9/nodemailer-smtp-transport.svg)](https://travis-ci.org/andris9/nodemailer-smtp-transport)
		[![NPM version](https://badge.fury.io/js/nodemailer-smtp-transport.png)](http://badge.fury.io/js/nodemailer-smtp-transport)
		![Nodemailer](https://raw.githubusercontent.com/nodemailer/nodemailer/master/assets/nm_logo_200x136.png)

		Applies for Nodemailer v1.x and not for v0.x where transports are built-in.
		SMTP module with for Nodemailer.

		## Setup

		Install with npm

		npm install nodemailer-smtp-transport

		Require to your script

		```javascript
		var nodemailer = require('nodemailer');
		var smtpTransport = require('nodemailer-smtp-transport');
		```

		## Usage

		Create a Nodemailer transport object

		```javascript
		var transporter = nodemailer.createTransport(smtpTransport(options))
		```

		or (by using smtpTransport as default)

		```javascript
		var transporter = nodemailer.createTransport(options)
		```

		Where

		* options defines connection data
		* options.port is the port to connect to (defaults to 25 or 465)
		* options.host is the hostname or IP address to connect to (defaults to 'localhost')
		* options.secure defines if the connection should use SSL (if `true`) or not (if `false`)
		* options.auth defines authentication data (see [authentication](#authentication) section below)
		* options.ignoreTLS turns off STARTTLS support if true
		* options.name optional hostname of the client, used for identifying to the server
		* options.localAddress is the local interface to bind to for network connections
		* options.connectionTimeout how many milliseconds to wait for the connection to establish
		* options.greetingTimeout how many milliseconds to wait for the greeting after connection is established
		* options.socketTimeout how many milliseconds of inactivity to allow
		* options.logger optional [bunyan](https://github.com/trentm/node-bunyan) compatible logger instance. If set to `true` then logs to console. If value is not set or is `false` then nothing is logged
		* options.debug if set to true, then logs SMTP traffic, otherwise logs only transaction events
		* options.authMethod defines preferred authentication method, eg. 'PLAIN'
		* options.tls defines additional options to be passed to the socket constructor, eg. {rejectUnauthorized: true}
		* getSocket optional method that is called every time a new connection is made against the SMTP server. This method can provide an existing socket to be used instead of creating a new one

		Alternatively you can use connection url with protocol 'smtp:' or 'smtps:'. Use query arguments for additional configuration values.

		Example

		```javascript
		var transporter = nodemailer.createTransport(smtpTransport({
		host: 'localhost',
		port: 25,
		auth: {
		user: 'username',
		pass: 'password'
		}
		}));
		```

		Or with connection url (gmail)

		```javascript
		var transporter = nodemailer.createTransport(
		smtpTransport('smtps://username%40gmail.com:password@smtp.gmail.com')
		);
		```

		## Authentication

		If authentication data is not present, the connection is considered authenticated from the start.

		Set authentcation data with `options.auth`

		Where

		* auth is the authentication object
		* auth.user is the username
		* auth.pass is the password for the user
		* auth.xoauth2 is the OAuth2 access token (preferred if both `pass` and `xoauth2` values are set) or an [XOAuth2](https://github.com/andris9/xoauth2) token generator object.

		If a [XOAuth2](https://github.com/andris9/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/`

		```javascript
		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');
		}
		});
		```

		## Using well-known services

		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)

		```javascript
		smtpTransport({
		service: 'gmail',
		auth: ..
		});
		```

		See the list of all supported services [here](https://github.com/andris9/nodemailer-wellknown#supported-services).

		## Verify connection configuration

		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.

		```javascript
		// verify connection configuration
		transporter.verify(function(error, success) {
		if (error) {
		console.log(error);
		} else {
		console.log('Server is ready to take our messages');
		}
		});
		```

		## License

		MIT
		See [Nodemailer homepage](https://nodemailer.com/smtp/) for documentation and terms of using SMTP.

lib/smtp-transport.js

nodemailer-smtp-transport - npm Package Compare versions

New alerts

Worsened metrics