Mail JavaScript SDK

Mail is a CloudScale component that allows you to send emails to your end-users from within your application. You can configure email addresses of public domains or of your organization’s own domains. You can also use an external email client of your choice and configure its SMTP settings with Catalyst, instead of using the built-in Catalyst email client.

The Mail JavaScript SDK package enables you to send emails to registered users of your application through code.

Prerequisites

You will need to install the following package to be able to use the Mail SDK methods.

copy
$
npm install @zcatalyst/mail
Info: Ensure that you have applied the required authentication configuration to use the SDK methods of this component.

Import Requirement

You will need to import the following modules to use the Mail SDK methods.

copy
const { Email } = require('@zcatalyst/mail');

List of SDK Methods

The following table contains the list of SDK methods that can be used to perform operations in the ZCQL component through code.

Category SDK Method Required Scope
General Operations Get Mail Instance Not required
Mail Operations Send Email Admin

Last Updated 2026-07-02 14:51:41 +0530 IST