---
title: "Overview"
url: https://docs.catalyst.zoho.com/en/sdk/javascript/v1/cloudscale/mail/overview/
description: "This page describes the method to perform operations using the Mail component."
last_updated: 2026-09-09T10:45:38Z
service: CloudScale
type: general
related_links:
  - name: "Catalyst CloudScale"
    url: /en/cloud-scale/
  - name: "Mail Help Documentation"
    url: /en/cloud-scale/help/mail/introduction/
  - name: "Java SDK Documentation"
    url: /en/sdk/java/v1/cloud-scale/mail/send-email/
  - name: "Python SDK Documentation"
    url: /en/sdk/python/v1/cloud-scale/mail/get-component-instance/
  - name: "REST API Documentation"
    url: /en/api/code-reference/cloud-scale/mail/send-email/#SendEmail
repository:
  name: "Repository"
  url: https://github.com/catalystbyzoho/zcatalyst-sdk-js
---

# Mail JavaScript SDK

# Overview

[Mail](https://docs.catalyst.zoho.com/en/cloud-scale/help/mail/introduction/) 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.

```sh
npm install @zcatalyst/mail
```

> **Info:** Ensure that you have applied the [required authentication configuration](https://docs.catalyst.zoho.com/en/sdk/javascript/v1/auth-config/node-consideration/) to use the SDK methods of this component.

### Import Requirement

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

```javascript
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.

<table border="1" cellpadding="8" cellspacing="0">
  <thead>
    <tr>
      <th>Category</th>
      <th>SDK Method</th>
      <th>Required Scope</th>
    </tr>
  </thead>
  <tbody>
    <tr>
      <td>General Operations</td>
      <td>[Get Mail Instance](https://docs.catalyst.zoho.com/en/sdk/javascript/v1/cloudscale/mail/get-mail-instance/)</td>
      <td>Not required</td>
    </tr>
    <tr>
      <td>Mail Operations</td>
      <td>[Send Email](https://docs.catalyst.zoho.com/en/sdk/javascript/v1/cloudscale/mail/send-email/)</td>
      <td>**Admin**</td>
    </tr>
  </tbody>
</table>