Zoho mail

Learn how to use Zoho mail with Composio

Overview

SLUG: ZOHO_MAIL

Description

Zoho Mail is a secure and ad-free email hosting platform with collaboration tools, calendar integration, and extensive administrative controls

Authentication Details

client_id
stringRequired
client_secret
stringRequired
oauth_redirect_uri
stringDefaults to https://backend.composio.dev/api/v1/auth-apps/add
scopes
stringDefaults to ZohoMail.partner.organization.ALL,ZohoMail.organization.accounts.ALL,ZohoMail.accounts.ALL,ZohoMail.organization.subscriptions.ALL,ZohoMail.organization.spam.ALL,ZohoMail.organization.domains.ALL,ZohoMail.organization.groups.ALL,ZohoMail.organization.policy.ALL,ZohoMail.organization.audit.ALL,ZohoMail.folders.ALL,ZohoMail.tags.ALL,ZohoMail.messages.ALL,ZohoMail.tasks.ALL,ZohoMail.links.ALL,ZohoMail.notes.ALL
bearer_token
string
suffix.one
stringRequired

Connecting to Zoho mail

Create an auth config

Use the dashboard to create an auth config for the Zoho mail toolkit. This allows you to connect multiple Zoho mail accounts to Composio for agents to use.

1

Select App

Navigate to [Zoho mail](https://platform.composio.dev?next_page=/marketplace/Zoho mail).

2

Configure Auth Config Settings

Select among the supported auth schemes of and configure them here.

3

Create and Get auth config ID

Click “Create Zoho mail Auth Config”. After creation, copy the displayed ID starting with ac_. This is your auth config ID. This is not a sensitive ID — you can save it in environment variables or a database. This ID will be used to create connections to the toolkit for a given user.

Connect Your Account

Using OAuth2

1from composio import Composio
2
3# Replace these with your actual values
4zoho_mail_auth_config_id = "ac_YOUR_ZOHO_MAIL_CONFIG_ID" # Auth config ID created above
5user_id = "0000-0000-0000" # UUID from database/application
6
7composio = Composio()
8
9
10def authenticate_toolkit(user_id: str, auth_config_id: str):
11 connection_request = composio.connected_accounts.initiate(
12 user_id=user_id,
13 auth_config_id=auth_config_id,
14 )
15
16 print(
17 f"Visit this URL to authenticate Zoho mail: {connection_request.redirect_url}"
18 )
19
20 # This will wait for the auth flow to be completed
21 connection_request.wait_for_connection(timeout=15)
22 return connection_request.id
23
24
25connection_id = authenticate_toolkit(user_id, zoho_mail_auth_config_id)
26
27# You can also verify the connection status using:
28connected_account = composio.connected_accounts.get(connection_id)
29print(f"Connected account: {connected_account}")

Tools

Executing tools

To prototype you can execute some tools to see the responses and working on the [Zoho mail toolkit’s playground](https://app.composio.dev/app/Zoho mail)

Python
1from composio import Composio
2from openai import OpenAI
3import json
4
5openai = OpenAI()
6composio = Composio()
7
8# User ID must be a valid UUID format
9user_id = "0000-0000-0000" # Replace with actual user UUID from your database
10
11tools = composio.tools.get(user_id=user_id, toolkits=["ZOHO_MAIL"])
12
13print("[!] Tools:")
14print(json.dumps(tools))
15
16def invoke_llm(task = "What can you do?"):
17 completion = openai.chat.completions.create(
18 model="gpt-4o",
19 messages=[
20 {
21 "role": "user",
22 "content": task, # Your task here!
23 },
24 ],
25 tools=tools,
26 )
27
28 # Handle Result from tool call
29 result = composio.provider.handle_tool_calls(user_id=user_id, response=completion)
30 print(f"[!] Completion: {completion}")
31 print(f"[!] Tool call result: {result}")
32
33invoke_llm()

Tool List

Tool Name: Domain Operations

Description

Tool to perform domain operations like verify, set primary domain, hosting, aliases, MX/SPF checks, DKIM management, and notifications. Use after creating or retrieving a domain.

Action Parameters

accept_language
string
catchAllAddress
string
dkimId
integer
domainAlias
string
domainName
stringRequired
isDefault
boolean
keySize
integer
mode
stringRequired
notificationAddress
string
region
string
selector
string
use_bearer_auth
boolean
zoid
integerRequired

Action Response

data
object
error
string
status
objectRequired
successful
booleanRequired

Tool Name: Delete Groups in Bulk

Description

Tool to bulk delete multiple groups. Use when you need to remove several groups in one API call.

Action Parameters

accept_language
string
groupList
arrayRequired
region
string
use_bearer_auth
boolean
zoid
integerRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Delete Group

Description

Tool to delete a specific mail group by its zgid. Use when you need to remove a group from your organization after confirming the IDs.

Action Parameters

accept_language
string
region
string
use_bearer_auth
boolean
zgid
integerRequired
zoid
integerRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get Organization User Storage Details

Description

Tool to retrieve storage details for a specific user in the organization. Use when you need to know a user’s total and used storage quotas.

Action Parameters

accept_language
string
region
string
use_bearer_auth
boolean
zoid
integerRequired
zuid
integerRequired

Action Response

data
objectRequired
error
string
status
objectRequired
successful
booleanRequired

Tool Name: Update Organization Spam Process Type

Description

Tool to update organization spam processing type. Use when changing the spam filtering strategy for an organization.

Action Parameters

accept_language
string
mode
stringDefaults to updateSpamProcessType
region
string
spamVO
objectRequired
use_bearer_auth
boolean
zoid
integerRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Update User Storage

Description

Tool to modify a user's base or add-on storage allocation. Use when adjusting storage plan for a user within an organization after confirming the IDs.

Action Parameters

accept_language
string
addonType
array
mode
stringRequired
planType
string
region
string
use_bearer_auth
boolean
zoid
integerRequired
zuid
integerRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Update Group Settings

Description

Tool to update group settings. Use after group creation to adjust general or text settings.

Action Parameters

accept_language
string
groupGeneralSettings
object
groupTextSettings
object
mode
stringRequired
region
string
use_bearer_auth
boolean
zgid
integerRequired
zoid
integerRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired