Zoho ZeptoMail

https://www.zoho.com/zeptomail/help/
Admin
Zoho ZeptoMail is a secure and reliable transactional email sending service designed for businesses.
Tokens:155,092
Snippets:2,028
Trust Score:10
Update:2 months ago
Show doc for...
Tokens:
Raw
### Install ZeptoMail Plugin via Composer

Source: https://www.zoho.com/zeptomail/help/craftcms-integration.html

Run this command in the application root folder to download and install the plugin.

```bash
composer require "zoho-mail/craft-zoho-zepto-mail:^1.0" -w && php craft plugin/install zoho-zepto-mail
```

--------------------------------

### Install ZeptoMail Library

Source: https://www.zoho.com/zeptomail/help/django-integration.html

Use this command in your terminal to install the required package for Django integration.

```bash
pip install django-zoho-zeptomail
```

--------------------------------

### Install and Enable ZeptoMail Module in Magento

Source: https://www.zoho.com/zeptomail/help/magento-integration.html

Execute these commands in the Magento root directory to install the ZeptoMail module and update the Magento environment.

```bash
composer require zohomail/magento2-zeptomail:^1.0
php bin/magento module:enable Zoho_ZeptoMail.
php bin/magento setup:upgrade
php bin/magento setup:static-content:deploy
php bin/magento cache:clean
```

--------------------------------

### Install ZeptoMail Package

Source: https://www.zoho.com/zeptomail/help/laravel-integration.html

Use Composer to add the ZeptoMail Laravel package to your project.

```bash
composer require zohomail/laravel-zeptomail:dev-main
```

--------------------------------

### Sample API response

Source: https://www.zoho.com/zeptomail/help/api/get-specific-domain.html

Example JSON response structure returned when successfully fetching domain details.

```json
     {
         "data":
         [
             {
                 "associated_mailagents":
                 [
                     "5a57413991a0a232"
                 ],
                 "domain_name": "mail.zylker.com",
                 "domain_key": "2e625d9d42a1",
                 "dkim":
                 {
                     "public_key": "k=rsa; p=MI**",
                     "host": "15131721._domainkey.mail.zylker.com",
                     "verified_time": "29 May 2024 07:30 PM",
                     "selector": 15131721,
                     "status": "verified"
                 },
                 "cname":
                 {
                     "host": "bounce.mail.zylker.com",
                     "cname_record": "cluster90.zeptomail.com",
                     "status": "unverified"
                 },
                 "is_restricted_senders": false,
                 "status": "unverified"
             }
         ],
         "status": "success"
     }
```

--------------------------------

### Execute Custom Command

Source: https://www.zoho.com/zeptomail/help/laravel-integration.html

Run the registered artisan command to send the welcome email.

```bash
php artisan send-zepto-welcome-mail
```

--------------------------------

### Launch Tinker Environment

Source: https://www.zoho.com/zeptomail/help/laravel-integration.html

Open the Laravel tinker shell to test email functionality.

```bash
php artisan tinker
```

--------------------------------

### Failure response example

Source: https://www.zoho.com/zeptomail/help/api/delete-suppression-list.html

JSON structure returned when the suppression data is not found.

```json
{
    "error": {
        "code": "DND_102",
        "field": "values",
        "message": "Suppression data not found",
        "value": "[rebecca@zilker.com]"
    },
    "status": "failure"
}
```

--------------------------------

### GET https://api.zeptomail.com/v1.1/domains

Source: https://www.zoho.com/zeptomail/help/api/list-all-domains.html

Retrieves a list of all domains added to the ZeptoMail account.

```APIDOC
## GET https://api.zeptomail.com/v1.1/domains

### Description
This API lists all the domains added to your ZeptoMail account. The domain_key obtained in this API is used for subsequent domain-related operations.

### Method
GET

### Endpoint
https://api.zeptomail.com/v1.1/domains

### OAuth Scopes
- Zeptomail.Domains.All
- Zeptomail.Domains.READ

### Response
#### Success Response (200)
- **data** (array) - List of domain objects
- **status** (string) - The status of the request

#### Response Example
{
  "data": [
    {
      "associated_mailagents": ["5a57413991a0a232"],
      "domain_name": "zylker.com",
      "domain_key": "2e625d9d42a1",
      "is_restricted_senders": false,
      "status": "unverified"
    }
  ],
  "status": "success"
}
```

--------------------------------

### Register Console Command

Source: https://www.zoho.com/zeptomail/help/laravel-integration.html

Add a custom Artisan command to trigger the welcome email in routes/console.php.

```php
<?php
use App\Mail\ZeptoWelcomeMail;
use Illuminate\Support\Facades\Mail;

Artisan::command('send-zepto-welcome-mail', function () {
    Mail::to('rebecca@zylker.com')->send(new ZeptoWelcomeMail("Jon"));
    
})->purpose('Send welcome mail');
```

--------------------------------

### GET /v1.1/domains/{domain_key}

Source: https://www.zoho.com/zeptomail/help/api/get-specific-domain.html

Retrieves the details of a specific domain using its domain_key.

```APIDOC
## GET /v1.1/domains/{domain_key}

### Description
Returns the details of a specific domain identified by the provided domain_key.

### Method
GET

### Endpoint
https://api.zeptomail.com/v1.1/domains/{domain_key}

### Parameters
#### Path Parameters
- **domain_key** (String) - Required - Identification key of the domain to be fetched.

### Response
#### Success Response (200)
- **data** (Array) - List containing the domain details.
- **status** (String) - The status of the request (e.g., "success").

#### Response Example
{
  "data": [
    {
      "associated_mailagents": ["5a57413991a0a232"],
      "domain_name": "mail.zylker.com",
      "domain_key": "2e625d9d42a1",
      "dkim": {
        "public_key": "k=rsa; p=MI**",
        "host": "15131721._domainkey.mail.zylker.com",
        "verified_time": "29 May 2024 07:30 PM",
        "selector": 15131721,
        "status": "verified"
      },
      "cname": {
        "host": "bounce.mail.zylker.com",
        "cname_record": "cluster90.zeptomail.com",
        "status": "unverified"
      },
      "is_restricted_senders": false,
      "status": "unverified"
    }
  ],
  "status": "success"
}
```

--------------------------------

### List Agent API Keys Request

Source: https://www.zoho.com/zeptomail/help/api/list-api-keys.html

Example cURL request to retrieve API keys for a specified agent.

```bash
curl "https://api.zeptomail.in/v1.1/agents/{agentkey}/apikeys
-X GET
-H "Authorization : Zoho-oauthtoken ***"\
-H "Content-Type : application/json" \
```

--------------------------------

### API Success Response

Source: https://www.zoho.com/zeptomail/help/api/list-api-keys.html

Example JSON response returned upon a successful request.

```json
{
    "data": [
        {
            "created_time": "06 Jun 2023 07:15 PM",
            "apikey": "OlyO55***",
            "id": "4b960e532bb95634",
            "username": "emailapikey"
        }
    ],
    "status": "success"
}
```

--------------------------------

### Send Batch Email Template via API

Source: https://www.zoho.com/zeptomail/help/code-examples.html

Examples for sending batch emails using templates across different programming environments.

```curl
curl "https://api.zeptomail.com/v1.1/email/template/batch" \
        -X POST \
        -H "Accept: application/json" \
        -H "Content-Type: application/json" \
        -H "Authorization:Zoho-enczapikey ***" \
        -d '{
        "from": {"address": "notifications@zylker.com"},
        "to": [
        	{
        	"email_address": {"address": "michael.s@zohomail.com","name": "Michael"},
        	"merge_info": {"header": "header", "footer" : "footer"}
        	},
        	{
        	"email_address": {"address": "anderson97@zohomail.com","name": "Anderson"},
        	"merge_info": {"header": "header1", "footer" : "footer1"}
        	}
        ],
	"template_key": "ea36f19a.1033669632ce7549.k1.2b3eeef0-198a-11ee-910a-8a90785fcf47.1891b3da35f",
	}'
```

```php
<?php

$curl = curl_init();

curl_setopt_array($curl, array(
    CURLOPT_URL => "https://api.zeptomail.com/v1.1/email/template/batch",
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_ENCODING => "",
    CURLOPT_MAXREDIRS => 10,
    CURLOPT_TIMEOUT => 30,
    CURLOPT_SSLVERSION => CURL_SSLVERSION_TLSv1_2,
    CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
    CURLOPT_CUSTOMREQUEST => "POST",
    CURLOPT_POSTFIELDS => '{
"from": { "address": "notifications@zylker.com"},
"to": [
        	{
        	"email_address": {"address": "michael.s@zohomail.com","name": "Michael"},
        	"merge_info": {"header": "header", "footer" : "footer"}
        	},
        	{
        	"email_address": {"address": "anderson97@zohomail.com","name": "Anderson"},
        	"merge_info": {"header": "header1", "footer" : "footer1"}
        	}
        ],"subject":"Test Email",
"htmlbody":"<div><b> Test email sent successfully. </b></div>",
"template_key": "2d6f.2b020fa1.k1.0bf691e0-de72-11ed-882e-52540064429e.18797f5f9fe",
}',
    CURLOPT_HTTPHEADER => array(
        "accept: application/json",
        "authorization: Zoho-enczapikey ***",
        "cache-control: no-cache",
        "content-type: application/json",
    ),
));

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
    echo "cURL Error #:" . $err;
} else {
    echo $response;
}
?>
```

```python
import requests
import json

url = "https://api.zeptomail.com/v1.1/email/template/batch"

payload = "{ \"from\": {\"address\": \"notifications@zylker.com\"}, \"to\": [ { \"email_address\": {\"address\": \"michael.s@zohomail.com\",\"name\": \"Michael\"}, \"merge_info\": {\"header\": \"header\", \"footer\" : \"footer\"} }, { \"email_address\": {\"address\": \"anderson97@zohomail.com\",\"name\": \"Anderson\"}, \"merge_info\": {\"header\": \"header1\", \"footer\" : \"footer1\"} } ], \"template_key\": \"ea36f19a.1033669632ce7549.k1.2b3eeef0-198a-11ee-910a-8a90785fcf47.1891b3da35f\", }"
json_str = json.dumps(payload)
headers = {
'accept': "application/json",
'content-type': "application/json",
'authorization': "Zoho-enczapikey ***",
}

response = requests.request("POST", url, data=json_str, headers=headers)

print(response.text)
```

```javascript
// For ES6, set type: "module" in package.json.
import { SendMailClient } from "zeptomail";

// For CommonJS
var { SendMailClient } = require("zeptomail");

const url = "https://api.zeptomail.com/v1.1/email/template/batch";
const token = "Zoho-enczapikey ****";

let client = new SendMailClient({url, token});

client.sendMail({
    "from": {
        "address": "notifications@zylker.com"
    },
    "to": [
        {
            "email_address": {
                "address": "michael.s@zohomail.com",
                "name": "Michael"
            },
            "merge_info": {
                "header": "header",
                "footer": "footer"
            }
        },
        {
            "email_address": {
                "address": "anderson97@zohomail.com",
                "name": "Anderson"
            },
            "merge_info": {
                "header": "header1",
                "footer": "footer1"
            }
        }
    ],
    "template_key": "ea36f19a.1033669632ce7549.k1.2b3eeef0-198a-11ee-910a-8a90785fcf47.1891b3da35f"
}).then((resp) => console.log("success")).catch((error) => console.log("error"));
```

--------------------------------

### Edit suppression list request

Source: https://www.zoho.com/zeptomail/help/api/edit-suppression-list.html

Example of a cURL request to update a suppression entry.

```bash
curl "https://api.zeptomail.com/v1.1/suppressions/{email}"
-X PUT
-H "Authorization : Zoho-oauthtoken ***"\
-H "Content-Type : application/json" \
{
    "suppression_type":"email",
    "action":"reject",
    "values":["rebecca@zilker.com"],
    "description":"Modifying the suppression action"
    "mailagent_keys":["4e29626b34b4a653"]
}
```

--------------------------------

### Set Environment Variables

Source: https://www.zoho.com/zeptomail/help/laravel-integration.html

Define the ZeptoMail host, token, and default sender details in your .env file.

```text
ZEPTOMAIL_HOST=zoho.com
ZEPTOMAIL_TOKEN="SEND_MAIL_TOKEN"
MAIL_MAILER=zeptomail
MAIL_FROM_ADDRESS=invoice@zylker.com 
MAIL_FROM_NAME="App Name"
```

--------------------------------

### Failure Response

Source: https://www.zoho.com/zeptomail/help/api/delete-domain.html

Example of an error response when a domain cannot be deleted, such as when it is verified in another account.

```json
     {
         "error":
         {
             "code": "DE_111",
             "message": "Domain verified in another account"
         },
         "status": "failure"
     }
```

--------------------------------

### Add email template response

Source: https://www.zoho.com/zeptomail/help/api/add-template.html

Example of the JSON response returned upon successfully adding an email template.

```json
{
  "data": [
    {
      "htmlbody": "<h1> Hi {{name}}</h1>, invitation link {{link}}",
      "upload_time": "19 Sep 2022 11:32 AM",
      "template_name": "E-invite",
      "template_key": "ea****607",
      "template_size": 9,
      "modified_time": "19 Sep 2022 11:32 AM",
      "subject": "Invitation to the event",
    }
  ],
  "message": "OK",
  "object": "templates"
}
```

--------------------------------

### GET /v1.1/agents/{agentkey}/apikeys

Source: https://www.zoho.com/zeptomail/help/api/list-api-keys.html

Retrieves the send mail token for the specified agent.

```APIDOC
## GET https://api.zeptomail.com/v1.1/agents/{agentkey}/apikeys

### Description
This API lists the send mail token of the desired Agent.

### Method
GET

### Endpoint
https://api.zeptomail.com/v1.1/agents/{agentkey}/apikeys

### Parameters
#### Path Parameters
- **agentkey** (String) - Required - Also known as Agent alias. It represents the Agent whose send mail token should be obtained.

### Response
#### Success Response (200)
- **data** (Array) - List of API keys
- **status** (String) - Status of the request

#### Response Example
{
    "data": [
        {
            "created_time": "06 Jun 2023 07:15 PM",
            "apikey": "OlyO55***",
            "id": "4b960e532bb95634",
            "username": "emailapikey"
        }
    ],
    "status": "success"
}
```

--------------------------------

### GET https://api.zeptomail.com/v1.1/agents

Source: https://www.zoho.com/zeptomail/help/api/list-agents.html

Retrieves a list of all mail agents associated with the ZeptoMail account.

```APIDOC
## GET https://api.zeptomail.com/v1.1/agents

### Description
Lists all the Agents available in your ZeptoMail account.

### Method
GET

### Endpoint
https://api.zeptomail.com/v1.1/agents

### Authentication
Requires OAuth token with scope: Zeptomail.MailAgents.All or Zeptomail.MailAgents.READ

### Response
#### Success Response (200)
- **data** (array) - List of mail agent objects
- **status** (string) - Status of the request

#### Response Example
{
  "data": [
    {
      "mailagent_name": "Notifications",
      "created_time": "04 Jun 2023 08:19 PM",
      "description": "Used to send notification emails",
      "mailagent_key": "4a00b66e61948f67",
      "status": "active"
    }
  ],
  "status": "success"
}
```

--------------------------------

### Send Email with ZeptoMail

Source: https://www.zoho.com/zeptomail/help/ruby-on-rails-for-zeptomail.html

Initialize the client and send an email with recipients, subject, and body content.

```ruby
require 'json'
require 'zoho_zeptomail'

client =  ZohoZeptoMail::Client.new()
email =  ZohoZeptoMail::SendMail.new(client)

email.add_recipients("address" => "ron@zylker.com", "name" => "Ron")
email.add_recipients("address" => "leslie@zylker.com", "name" => "Leslie")
email.add_cc("address" => "chris@zylker.com", "name" => "Chris")
email.add_bcc("address" => "andy@zylker.com", "name" => "Andy")
email.add_from("address"=> "password.reset@finance.zcorp.in", "name"=> "April")
email.add_subject("Password reset email")
email.add_body("Hello \n <p>Here is your password reset email!</p>")
email.send;
```

--------------------------------

### Add Domain Response

Source: https://www.zoho.com/zeptomail/help/api/add-domain.html

Example of a successful JSON response containing domain configuration details like DKIM and CNAME records.

```json
     {
         "data":
         {
             "associated_mailagents":
             [
                 "33cf52b1ecde1da0"
             ],
             "domain_name": "domains.zylker.com",
             "domain_key": "1c7a8298da361",
             "dkim":
             {
                 "public_key": "k=rsa; p=MI***",
                 "host": "5203937._domainkey.domains.zylker.com",
                 "selector": 5203937,
                 "status": "unverified"
             },
             "cname":
             {
                 "host": "bounce.domains.zylker.com",
                 "cname_record": "cluster90.zeptomail.com",
                 "status": "unverified"
             },
             "is_restricted_senders": false,
             "status": "unverified"
         },
         "status": "success"
     }
```

--------------------------------

### GET /agents/{agent-alias}/templates/{template-key}

Source: https://www.zoho.com/zeptomail/help/api/get-template.html

Retrieves the details of a specific email template.

```APIDOC
## GET /agents/{agent-alias}/templates/{template-key}

### Description
Retrieves the details of a single email template. Ensure the template belongs to the specified agent.

### Method
GET

### Endpoint
https://api.zeptomail.com/v1.1/agents/{agent-alias}/templates/{template-key}

### Parameters
#### Path Parameters
- **agent-alias** (String) - Required - Unique alias value given to the Agent.
- **template-key** (String) - Required - Unique key for the template.

### Response
#### Success Response (200)
- **data** (Object) - The template details including htmlbody, created_time, template_name, template_key, modified_time, attachments, subject, template_alias, and sample_merge_info.
- **message** (String) - Status message (e.g., "OK").
- **object** (String) - The object type (e.g., "templates").

#### Response Example
{
   "data": {
       "htmlbody": "<h1> Hi {{name}}</h1>, Invite Link: {{link}}",
       "created_time": "12 Dec 2022 11:18 PM",
       "template_name": "Invite mail update",
       "template_key": "ea36f19a.5ecaba242f82149d.k1.1fb151c0-7a45-11ed-a51f-8a90785fcf47.185077368dc",
       "modified_time": "12 Dec 2022 11:18 PM",
       "attachments": [
           {
               "file_cache_key": "ea36f19a.5ecaba242f82149d.h1.caba3570-58fb-11ed-b527-8a90785fcf47.1842d4e0247",
               "content_type": "text/plain",
               "file_name": "abc.txt"
           }
       ],
       "subject": "Invite mail subject update",
       "template_alias": "invite-email",
       "sample_merge_info": {
           "name": "name_value",
           "link": "link_value"
       }
   },
   "message": "OK",
   "object": "templates"
}
```
Tokens:
Raw