@zcatalyst/mail

ZOHO CATALYST SDK for JavaScript Mail for Node.js and Browser.

Installing

To install this package, simply type add or install @zcatalyst/mail using your favorite package manager:

• npm install @zcatalyst/mail
• yarn add @zcatalyst/mail
• pnpm add @zcatalyst/mail

Getting Started

Import

The Catalyst SDK is modulized by Components. To send a request, you only need to import the Mail:

// ES5 example
const { Mail } = require('@zcatalyst/mail');

// ES6+ example
import { Mail } from '@zcatalyst/mail';

Usage

To send a request, you:

• Create a Mail Instance.
• Call the Mail operation with input parameters.

const mail = new Mail();

const data = await mail.sendMail({
	from_mail: '[email protected]',
	to_mail: ['[email protected]', '[email protected]', '[email protected]'],
	subject: 'Greetings from Zylker Corp!',
	content: "Hello,We're glad to welcome you at Zylker Corp."
});

Async/await

We recommend using await operator to wait for the promise returned by send operation as follows:

// async/await.
try {
	const data = await mail.sendMail({
		from_mail: '[email protected]',
		to_mail: ['[email protected]', '[email protected]', '[email protected]'],
		subject: 'Greetings from Zylker Corp!',
		content: "Hello,We're glad to welcome you at Zylker Corp."
	});
	// process data.
} catch (error) {
	// error handling.
} finally {
	// finally.
}

Async-await is clean, concise, intuitive, easy to debug and has better error handling as compared to using Promise chains or callbacks.

Promises

You can also use Promise chaining to execute send operation.

mail
	.sendMail({
		from_mail: '[email protected]',
		to_mail: ['[email protected]', '[email protected]', '[email protected]'],
		subject: 'Greetings from Zylker Corp!',
		content: "Hello,We're glad to welcome you at Zylker Corp."
	})
	.then(
		(data) => {
			// process data.
		},
		(error) => {
			// error handling.
		}
	);

Promises can also be called using .catch() and .finally() as follows:

mail
	.sendMail({
		from_mail: '[email protected]',
		to_mail: ['[email protected]', '[email protected]', '[email protected]'],
		subject: 'Greetings from Zylker Corp!',
		content: "Hello,We're glad to welcome you at Zylker Corp."
	})
	.then((data) => {
		// process data.
	})
	.catch((error) => {
		// error handling.
	})
	.finally(() => {
		// finally.
	});

Callbacks

We do not recommend using callbacks because of callback hell, but they are supported by the send operation.

// callbacks.
mail.sendMail(
	{
		from_mail: '[email protected]',
		to_mail: ['[email protected]', '[email protected]', '[email protected]'],
		subject: 'Greetings from Zylker Corp!',
		content: "Hello,We're glad to welcome you at Zylker Corp."
	},
	(err, data) => {
		// process err and data.
	}
);

Troubleshooting

When the service returns an exception, the error will include the exception information, as well as response metadata (e.g. request id).

try {
	const data = await mail.sendMail({
		from_mail: '[email protected]',
		to_mail: ['[email protected]', '[email protected]', '[email protected]'],
		subject: 'Greetings from Zylker Corp!',
		content: "Hello,We're glad to welcome you at Zylker Corp."
	});
	// process data.
} catch (error) {
	const message = error.message;
	const status = error.statusCode;
	console.log({ message, status });
}

Contributing

Contributions to this library are always welcome and highly encouraged.

See CONTRIBUTING for more information on how to get started.

License

This SDK is distributed under the Apache License 2.0. See LICENSE file for more information.

Mail operations