集成

zoho-mail

试用

通过 OAuth 代理调用 Zoho Mail REST API,管理账户、文件夹、标签以及邮件收发。

它能做什么

借助 Maton 托管的 OAuth 接入 Zoho Mail 账户,对账户、文件夹、标签和邮件执行 REST API 操作。读取与列表接口可直接调用;写入类操作(创建、更新、删除、发送、移动、加旗标、应用标签)必须在用户确认目标资源和预期效果后才执行。所有请求以 MATON_API_KEY 作为 Bearer 令牌鉴权,多个连接用 Maton-Connection 头区分。

什么时候用它

  • 列出指定文件夹下的最近邮件
  • 按发件人、主题或关键字搜索邮件
  • 新建或重命名文件夹与标签
  • 发送、回复或定时发送邮件

技能文档

Zoho Mail

Access the Zoho Mail API with managed OAuth authentication. Send, receive, search, and manage emails with full folder and label management.

Quick Start

# List all accounts
python <<'EOF'
import urllib.request, os, json
req = urllib.request.Request('https://api.maton.ai/zoho-mail/api/accounts')
req.add_header('Authorization', f'Bearer {os.environ["MATON_API_KEY"]}')
print(json.dumps(json.load(urllib.request.urlopen(req)), indent=2))
EOF

Base URL

https://api.maton.ai/zoho-mail/{native-api-path}

Maton proxies requests to mail.zoho.com and automatically injects your OAuth token.

Authentication

All requests require the Maton API key in the Authorization header:

Authorization: Bearer $MATON_API_KEY

Environment Variable: Set your API key as MATON_API_KEY:

export MATON_API_KEY="YOUR_API_KEY"

Getting Your API Key

  1. Sign in or create an account at maton.ai
  2. Go to maton.ai/settings
  3. Copy your API key

Connection Management

Manage your Zoho Mail OAuth connections at https://api.maton.ai.

List Connections

python <<'EOF'
import urllib.request, os, json
req = urllib.request.Request('https://api.maton.ai/connections?app=zoho-mail&status=ACTIVE')
req.add_header('Authorization', f'Bearer {os.environ["MATON_API_KEY"]}')
print(json.dumps(json.load(urllib.request.urlopen(req)), indent=2))
EOF

Create Connection

python <<'EOF'
import urllib.request, os, json
data = json.dumps({'app': 'zoho-mail'}).encode()
req = urllib.request.Request('https://api.maton.ai/connections', data=data, method='POST')
req.add_header('Authorization', f'Bearer {os.environ["MATON_API_KEY"]}')
req.add_header('Content-Type', 'application/json')
print(json.dumps(json.load(urllib.request.urlopen(req)), indent=2))
EOF

Get Connection

python <<'EOF'
import urllib.request, os, json
req = urllib.request.Request('https://api.maton.ai/connections/{connection_id}')
req.add_header('Authorization', f'Bearer {os.environ["MATON_API_KEY"]}')
print(json.dumps(json.load(urllib.request.urlopen(req)), indent=2))
EOF

Response:

{
  "connection": {
    "connection_id": "{connection_id}",
    "status": "ACTIVE",
    "creation_time": "2025-12-08T07:20:53.488460Z",
    "last_updated_time": "2026-01-31T20:03:32.593153Z",
    "url": "https://connect.maton.ai/?session_token=...",
    "app": "zoho-mail",
    "metadata": {}
  }
}

Open the returned url in a browser to complete OAuth authorization.

Delete Connection

python <<'EOF'
import urllib.request, os, json
req = urllib.request.Request('https://api.maton.ai/connections/{connection_id}', method='DELETE')
req.add_header('Authorization', f'Bearer {os.environ["MATON_API_KEY"]}')
print(json.dumps(json.load(urllib.request.urlopen(req)), indent=2))
EOF

Specifying Connection

If you have multiple Zoho Mail connections, specify which one to use with the Maton-Connection header:

python <<'EOF'
import urllib.request, os, json
req = urllib.request.Request('https://api.maton.ai/zoho-mail/api/accounts')
req.add_header('Authorization', f'Bearer {os.environ["MATON_API_KEY"]}')
req.add_header('Maton-Connection', '{connection_id}')
print(json.dumps(json.load(urllib.request.urlopen(req)), indent=2))
EOF

If you have multiple connections, always include this header to ensure requests go to the intended account.

Security & Permissions

  • Access is scoped to emails, folders, accounts, and organization settings within the connected Zoho Mail account.
  • All write operations require explicit user approval. Before executing any create, update, or delete call, confirm the target resource and intended effect with the user.

API Reference

Account Operations

Get All Accounts

Retrieve all mail accounts for the authenticated user.

GET /zoho-mail/api/accounts

Example:

python <<'EOF'
import urllib.request, os, json
req = urllib.request.Request('https://api.maton.ai/zoho-mail/api/accounts')
req.add_header('Authorization', f'Bearer {os.environ["MATON_API_KEY"]}')
print(json.dumps(json.load(urllib.request.urlopen(req)), indent=2))
EOF

Get Account Details

GET /zoho-mail/api/accounts/{accountId}

Folder Operations

List All Folders

GET /zoho-mail/api/accounts/{accountId}/folders

Example:

python <<'EOF'
import urllib.request, os, json
req = urllib.request.Request('https://api.maton.ai/zoho-mail/api/accounts/{accountId}/folders')
req.add_header('Authorization', f'Bearer {os.environ["MATON_API_KEY"]}')
print(json.dumps(json.load(urllib.request.urlopen(req)), indent=2))
EOF

Response:

{
  "status": {
    "code": 200,
    "description": "success"
  },
  "data": [
    {
      "folderId": "1367000000000008014",
      "folderName": "Inbox",
      "folderType": "Inbox",
      "path": "/Inbox",
      "imapAccess": true,
      "isArchived": 0,
      "URI": "https://mail.zoho.com/api/accounts/1367000000000008002/folders/1367000000000008014"
    },
    {
      "folderId": "1367000000000008016",
      "folderName": "Drafts",
      "folderType": "Drafts",
      "path": "/Drafts",
      "imapAccess": true,
      "isArchived": 0
    }
  ]
}

Create Folder

POST /zoho-mail/api/accounts/{accountId}/folders
Content-Type: application/json

{
  "folderName": "My Custom Folder"
}

Rename Folder

PUT /zoho-mail/api/accounts/{accountId}/folders/{folderId}
Content-Type: application/json

{
  "folderName": "Renamed Folder"
}

Delete Folder

DELETE /zoho-mail/api/accounts/{accountId}/folders/{folderId}

Label Operations

List Labels

GET /zoho-mail/api/accounts/{accountId}/labels

Example:

python <<'EOF'
import urllib.request, os, json
req = urllib.request.Request('https://api.maton.ai/zoho-mail/api/accounts/{accountId}/labels')
req.add_header('Authorization', f'Bearer {os.environ["MATON_API_KEY"]}')
print(json.dumps(json.load(urllib.request.urlopen(req)), indent=2))
EOF

Create Label

POST /zoho-mail/api/accounts/{accountId}/labels
Content-Type: application/json

{
  "labelName": "Important"
}

Update Label

PUT /zoho-mail/api/accounts/{accountId}/labels/{labelId}
Content-Type: application/json

{
  "labelName": "Updated Label"
}

Delete Label

DELETE /zoho-mail/api/accounts/{accountId}/labels/{labelId}

Email Message Operations

List Emails in Folder

GET /zoho-mail/api/accounts/{accountId}/messages/view?folderId={folderId}

Query Parameters:

ParameterTypeDescription
folderIdlongFolder ID to list messages from
limitintegerNumber of messages to return (default: 50)
startintegerOffset for pagination
sortBystringSort field (e.g., date)
sortOrderbooleantrue for ascending, false for descending

Example:

python <<'EOF'
import urllib.request, os, json
req = urllib.request.Request('https://api.maton.ai/zoho-mail/api/accounts/{accountId}/messages/view?folderId={folderId}&limit=10')
req.add_header('Authorization', f'Bearer {os.environ["MATON_API_KEY"]}')
print(json.dumps(json.load(urllib.request.urlopen(req)), indent=2))
EOF

Search Emails

GET /zoho-mail/api/accounts/{accountId}/messages/search?searchKey={query}

Query Parameters:

ParameterTypeDescription
searchKeystringSearch query
limitintegerNumber of results to return
startintegerOffset for pagination

Example:

python <<'EOF'
import urllib.request, os, json
import urllib.parse
query = urllib.parse.quote('from:sender@example.com')
req = urllib.request.Request(f'https://api.maton.ai/zoho-mail/api/accounts/{{accountId}}/messages/search?searchKey={query}')
req.add_header('Authorization', f'Bearer {os.environ["MATON_API_KEY"]}')
print(json.dumps(json.load(urllib.request.urlopen(req)), indent=2))
EOF

Get Email Content

GET /zoho-mail/api/accounts/{accountId}/folders/{folderId}/messages/{messageId}/content

Example:

python <<'EOF'
import urllib.request, os, json
req = urllib.request.Request('https://api.maton.ai/zoho-mail/api/accounts/{accountId}/folders/{folderId}/messages/{messageId}/content')
req.add_header('Authorization', f'Bearer {os.environ["MATON_API_KEY"]}')
print(json.dumps(json.load(urllib.request.urlopen(req)), indent=2))
EOF

Get Email Headers

GET /zoho-mail/api/accounts/{accountId}/folders/{folderId}/messages/{messageId}/header

Get Email Metadata

GET /zoho-mail/api/accounts/{accountId}/folders/{folderId}/messages/{messageId}/details

Get Original Message (MIME)

GET /zoho-mail/api/accounts/{accountId}/messages/{messageId}/originalmessage

Send Email

POST /zoho-mail/api/accounts/{accountId}/messages
Content-Type: application/json

{
  "fromAddress": "sender@yourdomain.com",
  "toAddress": "recipient@example.com",
  "subject": "Email Subject",
  "content": "Email body content",
  "mailFormat": "html"
}

Request Body Fields:

FieldTypeRequiredDescription
fromAddressstringYesSender's email address
toAddressstringYesRecipient's email address
subjectstringYesEmail subject
contentstringYesEmail body content
ccAddressstringNoCC recipient
bccAddressstringNoBCC recipient
mailFormatstringNohtml or plaintext (default: html)
askReceiptstringNoyes or no for read receipt
encodingstringNoCharacter encoding (default: UTF-8)

Example - Send Email:

python <<'EOF'
import urllib.request, os, json
data = json.dumps({
    "fromAddress": "sender@yourdomain.com",
    "toAddress": "recipient@example.com",
    "subject": "Hello from Zoho Mail API",
    "content": "Hello!This is a test email.",
    "mailFormat": "html"
}).encode()
req = urllib.request.Request('https://api.maton.ai/zoho-mail/api/accounts/{accountId}/messages', data=data, method='POST')
req.add_header('Authorization', f'Bearer {os.environ["MATON_API_KEY"]}')
req.add_header('Content-Type', 'application/json')
print(json.dumps(json.load(urllib.request.urlopen(req)), indent=2))
EOF

Scheduling Parameters (Optional):

FieldTypeDescription
isSchedulebooleanEnable scheduling
scheduleTypeinteger1-5 for preset times; 6 for custom
timeZonestringRequired if scheduleType=6 (e.g., GMT 5:30)
scheduleTimestringRequired if scheduleType=6 (format: MM/DD/YYYY HH:MM:SS)

Reply to Email

POST /zoho-mail/api/accounts/{accountId}/messages/{messageId}
Content-Type: application/json

{
  "fromAddress": "sender@yourdomain.com",
  "toAddress": "recipient@example.com",
  "subject": "Re: Original Subject",
  "content": "Reply content"
}

Save Draft

POST /zoho-mail/api/accounts/{accountId}/messages
Content-Type: application/json

{
  "fromAddress": "sender@yourdomain.com",
  "toAddress": "recipient@example.com",
  "subject": "Draft Subject",
  "content": "Draft content",
  "mode": "draft"
}

Update Message (Mark as Read/Unread, Move, Flag)

PUT /zoho-mail/api/accounts/{accountId}/updatemessage
Content-Type: application/json

{
  "messageId": ["messageId1", "messageId2"],
  "folderId": "folderId",
  "mode": "markAsRead"
}

Mode Options:

  • markAsRead - Mark messages as read
  • markAsUnread - Mark messages as unread
  • moveMessage - Move messages (requires destfolderId)
  • setFlag - Set flag (requires flagid)
  • applyLabel - Apply labels (requires labelId)
  • archive - Archive messages
  • unArchive - Unarchive messages
  • spam - Mark as spam
  • notSpam - Mark as not spam

Example - Mark as Read:

python <<'EOF'
import urllib.request, os, json
data = json.dumps({
    "messageId": ["1234567890123456789"],
    "folderId": "9876543210987654321",
    "mode": "markAsRead"
}).encode()
req = urllib.request.Request('https://api.maton.ai/zoho-mail/api/accounts/{accountId}/updatemessage', data=data, method='PUT')
req.add_header('Authorization', f'Bearer {os.environ["MATON_API_KEY"]}')
req.add_header('Content-Type', 'application/json')
print(json.dumps(json.load(urllib.request.urlopen(req)), indent=2))
EOF

Set Flag on Messages

Flag messages with a color/status indicator.

PUT /zoho-mail/api/accounts/{accountId}/updatemessage
Content-Type: application/json

{
  "mode": "setFlag",
  "messageId": ["messageId1", "messageId2"],
  "flagid": "important"
}

Flag ID Options:

Flag IDDescription
infoInfo flag (blue)
importantImportant flag (red)
followupFollow-up flag (orange)
flag_not_setRemove flag

Optional Parameters:

  • threadId - Array of thread IDs (alternative to messageId)
  • isFolderSpecific - Set to true if using folderId
  • folderId - Folder ID (required if isFolderSpecific is true)
  • isArchive - Set to true to include archived emails

Example - Flag as Important:

python <<'EOF'
import urllib.request, os, json
data = json.dumps({
    "mode": "setFlag",
    "messageId": ["1234567890123456789"],
    "flagid": "important",
    "isFolderSpecific": True,
    "folderId": "9876543210987654321"
}).encode()
req = urllib.request.Request('https://api.maton.ai/zoho-mail/api/accounts/{accountId}/updatemessage', data=data, method='PUT')
req.add_header('Authorization', f'Bearer {os.environ["MATON_API_KEY"]}')
req.add_header('Content-Type', 'application/json')
print(json.dumps(json.load(urllib.request.urlopen(req)), indent=2))
EOF

Apply Label to Messages

Apply one or more labels to messages or threads.

PUT /zoho-mail/api/accounts/{accountId}/updatemessage
Content-Type: application/json

{
  "mode": "applyLabel",
  "messageId": ["messageId1"],
  "labelId": ["labelId1", "labelId2"]
}

Required Parameters:

  • mode - Must be "applyLabel"
  • messageId or threadId - Array of message/thread IDs
  • labelId - Array of label IDs to apply

Optional Parameters:

  • isFolderSpecific - Set to true if using folderId
  • folderId - Folder ID (required if isFolderSpecific is true)
  • isArchive - Set to true to include archived emails

Example - Apply Labels:

python <<'EOF'
import urllib.request, os, json
data = json.dumps({
    "mode": "applyLabel",
    "messageId": ["1234567890123456789"],
    "labelId": ["111222333444555666", "777888999000111222"],
    "isFolderSpecific": True,
    "folderId": "9876543210987654321"
}).encode()
req = urllib.request.Request('https://api.maton.ai/zoho-mail/api/accounts/{accountId}/updatemessage', data=data, method='PUT')
req.add_header('Authorization', f'Bearer {os.environ["MATON_API_KEY"]}')
req.add_header('Content-Type', 'application/json')
print(json.dumps(json.load(urllib.request.urlopen(req)), indent=2))
EOF

Note: Get label IDs by calling GET /zoho-mail/api/accounts/{accountId}/labels first.

Delete Email

DELETE /zoho-mail/api/accounts/{accountId}/folders/{folderId}/messages/{messageId}

Attachment Operations

Upload Attachment

POST /zoho-mail/api/accounts/{accountId}/messages/attachments
Content-Type: multipart/form-data

Get Attachment Info

GET /zoho-mail/api/accounts/{accountId}/folders/{folderId}/messages/{messageId}/attachmentinfo

Download Attachment

GET /zoho-mail/api/accounts/{accountId}/folders/{folderId}/messages/{messageId}/attachments/{attachmentId}

Pagination

Zoho Mail uses offset-based pagination:

GET /zoho-mail/api/accounts/{accountId}/messages/view?folderId={folderId}&start=0&limit=50
  • start: Offset index (default: 0)
  • limit: Number of records to return (default: 50)

For subsequent pages, increment start by limit:

  • Page 1: start=0&limit=50
  • Page 2: start=50&limit=50
  • Page 3: start=100&limit=50

Code Examples

JavaScript

const response = await fetch(
  'https://api.maton.ai/zoho-mail/api/accounts',
  {
    headers: {
      'Authorization': `Bearer ${process.env.MATON_API_KEY}`
    }
  }
);
const data = await response.json();

Python

import os
import requests

response = requests.get(
    'https://api.maton.ai/zoho-mail/api/accounts',
    headers={'Authorization': f'Bearer {os.environ["MATON_API_KEY"]}'}
)
data = response.json()

Notes

  • Account IDs are required for most operations - first call /api/accounts to get your account ID
  • Message IDs and Folder IDs are numeric strings
  • The fromAddress must be associated with the authenticated account
  • Default folders include: Inbox, Drafts, Templates, Snoozed, Sent, Spam, Trash, Outbox
  • Supported encodings: Big5, EUC-JP, EUC-KR, GB2312, ISO-2022-JP, ISO-8859-1, KOI8-R, Shift_JIS, US-ASCII, UTF-8, WINDOWS-1251
  • Some operations (labels, folder management, sending) require additional OAuth scopes. If you receive an INVALID_OAUTHSCOPE error, contact Maton support at support@maton.ai with the specific operations/APIs you need and your use-case
  • IMPORTANT: When using curl commands, use curl -g when URLs contain brackets to disable glob parsing
  • IMPORTANT: When piping curl output to jq or other commands, environment variables like $MATON_API_KEY may not expand correctly in some shell environments

Error Handling

StatusMeaning
400Missing Zoho Mail connection or invalid request
401Invalid or missing Maton API key
429Rate limited
4xx/5xxPassthrough error from Zoho Mail API

Troubleshooting: API Key Issues

  1. Check that the MATON_API_KEY environment variable is set:
echo $MATON_API_KEY
  1. Verify the API key is valid by listing connections:
python <<'EOF'
import urllib.request, os, json
req = urllib.request.Request('https://api.maton.ai/connections')
req.add_header('Authorization', f'Bearer {os.environ["MATON_API_KEY"]}')
print(json.dumps(json.load(urllib.request.urlopen(req)), indent=2))
EOF

Troubleshooting: Invalid App Name

  1. Ensure your URL path starts with zoho-mail. For example:
  • Correct: https://api.maton.ai/zoho-mail/api/accounts
  • Incorrect: https://api.maton.ai/api/accounts

Resources

常见问题

如何完成鉴权?
请求头携带 Bearer MATON_API_KEY,Maton 将请求转发至 mail.zoho.com 并自动注入 OAuth 令牌。
能否同时管理多个 Zoho Mail 账户?
可以。每个账户分别建立连接,请求时通过 Maton-Connection 头指定使用哪一个连接。
写入操作会如何处理?
创建、更新、删除、发送、回复、移动、加旗标和应用标签之前,都需要先向用户确认目标资源与预期效果,确认后才执行调用。

相关技能

通过托管 OAuth 网关读写 Zoho 日历的日历与事件。

486 次安装4 星标

通过 Maton 托管的 OAuth 代理读写 Zoho CRM 记录,所有写入操作均需用户确认。

463 次安装6 星标

通过托管 OAuth 读写 Zoho Recruit 的候选人、职位和面试数据。

487 次安装3 星标

通过托管 OAuth 连接 Zoho Inventory API,对商品、销售订单、发票、联系人、账单等记录进行读写。

493 次安装3 星标

通过托管 OAuth 网关读写 Zoho Projects 资源,所有写操作执行前需用户确认。

35 次安装

通过 Maton API 代理,使用托管 OAuth 管理 Zoho Bookings 的预约、服务、员工和工作区。

39 次安装