Docs
Open Lodol
DocumentationIntegrationsAPI

Zoho Mail

App · Email · 20 actions

Business email. Send, reply to and draft emails, search and read them, and organise them with folders, labels and flags.

Actions

ActionWhat it does
Apply labelAdd one or more labels to emails.
Archive emailsArchive emails, taking them out of their folder's view.
Create folderCreate a mail folder, optionally inside another.
Create labelCreate a label to tag emails with.
Delete emailMove an email to the Trash, or delete it permanently.
Delete folderDelete a folder you created.
Delete labelDelete a label and remove it from every email that has it.
Flag emailsSet or clear the flag on emails.
Get email contentGet an email's body as HTML.
Get email detailsGet an email's subject, sender, recipients, flag and status.
List accountsList the signed-in user's mail accounts and their addresses.
List emailsList emails, newest first by default, optionally filtered.
List foldersList the account's folders, optionally only one type.
List labelsList the account's labels.
Mark as read or unreadMark emails as read or unread.
Move emailsMove emails to another folder.
Reply to emailReply to an email, keeping it in the same conversation.
Save draftSave an email to the Drafts folder without sending it.
Search emailsSearch the account's emails with Zoho Mail's search syntax.
Send emailSend an email from the account.

Apply label

Add one or more labels to emails.

Inputs

Accountaccount_idtextRequired
The mail account.
Email IDsmessage_idslistRequired
One or more emails' messageId values, from 'List emails' or 'Search emails'. Separate several with commas.
Labelslabel_idslistRequired
The labels to add.

Outputs

The labels were applied.

labelIdslist
The labels.
messageIdslist
The emails changed.
updatedtrue/false
Always true.
Example output
{
  "labelIds": [
    "2560636000000011003"
  ],
  "messageIds": [
    "1711540991815100000"
  ],
  "updated": true
}

Archive emails

Archive emails, taking them out of their folder's view.

Inputs

Accountaccount_idtextRequired
The mail account.
Email IDsmessage_idslistRequired
One or more emails' messageId values, from 'List emails' or 'Search emails'. Separate several with commas.

Outputs

The emails were archived.

messageIdslist
The emails changed.
updatedtrue/false
Always true.
Example output
{
  "messageIds": [
    "1711540991815100000"
  ],
  "updated": true
}

Create folder

Create a mail folder, optionally inside another.

Inputs

Accountaccount_idtextRequired
The mail account.
Folder namefolder_nametextRequired
The new folder's name, unique among its siblings.
Parent folderparent_folder_idtext
Optional. Create it inside this folder.

Outputs

A mail folder.

URItext
The folder's API address.
folderIdtext
The folder's id.
folderNametext
The folder's name.
folderTypetext
Inbox, Drafts, Sent, Spam, Trash and so on.
imapAccesstrue/false
Whether the folder is shown over IMAP.
isArchivednumber
1 if the folder is archived, else 0.
pathtext
The folder's path, such as /Inbox/Receipts.
previousFolderIdtext
The id of the folder listed before it.
Example output
{
  "folderId": "2560636000000008014",
  "folderName": "Receipts",
  "folderType": "Inbox",
  "imapAccess": true,
  "isArchived": 0,
  "path": "/Receipts"
}

Create label

Create a label to tag emails with.

Inputs

Accountaccount_idtextRequired
The mail account.
Label namedisplay_nametextRequired
The label's name.
Colorcolortext
Optional. A hex colour such as #ffd700 (the default).

Outputs

A label.

URItext
The label's API address.
colortext
The label's colour, such as #ffd700.
displayNametext
The label's name.
labelIdtext
The label's id.
sequencenumber
The label's position.
tagIdtext
The label's tag id (the same number).
Example output
{
  "color": "#ffd700",
  "displayName": "Clients",
  "labelId": "2560636000000011003",
  "sequence": 1,
  "tagId": "2560636000000011003"
}

Delete email

Move an email to the Trash, or delete it permanently.

Inputs

Accountaccount_idtextRequired
The mail account.
Folderfolder_idtextRequired
The folder the email is in: the email's folderId from 'List emails' or 'Search emails'.
Email IDmessage_idtextRequired
The email's messageId, from 'List emails' or 'Search emails'.
Delete permanentlypermanentlytrue/false
Optional. Skip the Trash; the email cannot be recovered.Default: false.

Outputs

The email was deleted.

dataobject
Zoho Mail's answer, as sent.
deletedtrue/false
Always true.
messageIdtext
The deleted email's id.
permanentlytrue/false
Whether it skipped the Trash.
Example output
{
  "data": {},
  "deleted": true,
  "messageId": "1711540991815100000",
  "permanently": false
}

Delete folder

Delete a folder you created.

Inputs

Accountaccount_idtextRequired
The mail account.
Folderfolder_idtextRequired
The folder to delete.

Outputs

The folder was deleted.

deletedtrue/false
Always true.
folderIdtext
The deleted folder's id.
Example output
{
  "deleted": true,
  "folderId": "2560636000000008014"
}

Delete label

Delete a label and remove it from every email that has it.

Inputs

Accountaccount_idtextRequired
The mail account.
Labellabel_idtextRequired
The label to delete.

Outputs

The label was deleted.

deletedtrue/false
Always true.
labelIdtext
The deleted label's id.
Example output
{
  "deleted": true,
  "labelId": "2560636000000011003"
}

Flag emails

Set or clear the flag on emails.

Inputs

Accountaccount_idtextRequired
The mail account.
Email IDsmessage_idslistRequired
One or more emails' messageId values, from 'List emails' or 'Search emails'. Separate several with commas.
FlagflagtextRequired
The flag; No flag clears it.One of: flag_not_set (No flag), info, important, followup (Follow-up).

Outputs

The emails were flagged.

flagtext
The flag set.
messageIdslist
The emails changed.
updatedtrue/false
Always true.
Example output
{
  "flag": "important",
  "messageIds": [
    "1711540991815100000"
  ],
  "updated": true
}

Get email content

Get an email's body as HTML.

Inputs

Accountaccount_idtextRequired
The mail account.
Folderfolder_idtextRequired
The folder the email is in: the email's folderId from 'List emails' or 'Search emails'.
Email IDmessage_idtextRequired
The email's messageId, from 'List emails' or 'Search emails'.
Include quoted textinclude_block_contenttrue/false
Optional. Also include blockquoted (earlier) text.Default: false.

Outputs

An email's body.

contenttext
The body, as HTML.
messageIdtext
The email's id.
Example output
{
  "content": "<div>Hello</div>",
  "messageId": "1711540991815100000"
}

Get email details

Get an email's subject, sender, recipients, flag and status.

Inputs

Accountaccount_idtextRequired
The mail account.
Folderfolder_idtextRequired
The folder the email is in: the email's folderId from 'List emails' or 'Search emails'.
Email IDmessage_idtextRequired
The email's messageId, from 'List emails' or 'Search emails'.

Outputs

An email.

calendarTypetext
Set when the email is an invitation.
ccAddresstext
The Cc recipients; empty when there are none.
flagidtext
The flag: flag_not_set, info, important or followup.
folderIdtext
The id of the folder the email is in.
fromAddresstext
The sender's address.
hasAttachmenttext
1 when the email has attachments.
hasInlinetext
Whether the email has inline images.
messageIdtext
The email's id.
prioritytext
The priority, 3 is normal.
receivedTimetext
Epoch milliseconds.
sendertext
The sender's name.
sentDateInGMTtext
Epoch milliseconds.
sizetext
The size in bytes.
statustext
1 (or read) when read, 0 (or unread) when unread.
status2text
Zoho's secondary status.
subjecttext
The subject.
summarytext
The start of the body.
threadCounttext
How many emails are in the conversation.
threadIdtext
The id of the email's conversation.
toAddresstext
The recipients.
Example output
{
  "ccAddress": "",
  "flagid": "flag_not_set",
  "folderId": "2560636000000008014",
  "fromAddress": "paula@zylker.com",
  "hasAttachment": "0",
  "messageId": "1711540991815100000",
  "receivedTime": "1711540991815",
  "sender": "Paula",
  "status": "0",
  "subject": "Quarterly report",
  "summary": "Please find the numbers below.",
  "threadId": "1711540991815100001",
  "toAddress": "\"Rebecca\"<rebecca@zylker.com>"
}

List accounts

List the signed-in user's mail accounts and their addresses.

Inputs

None.

Outputs

countnumber
How many mail accounts there are.
itemslist
The mail accounts.
Example output
{
  "count": 1,
  "items": [
    {
      "accountDisplayName": "Rebecca",
      "accountId": "2560636000000008002",
      "accountName": "rebecca",
      "displayName": "Rebecca Smith",
      "emailAddress": [
        {
          "isAlias": false,
          "isConfirmed": true,
          "isPrimary": true,
          "mailId": "rebecca@zylker.com"
        }
      ],
      "enabled": true,
      "incomingUserName": "rebecca@zylker.com",
      "primaryEmailAddress": "rebecca@zylker.com",
      "type": "ZOHO_ACCOUNT"
    }
  ]
}

List emails

List emails, newest first by default, optionally filtered.

Inputs

Accountaccount_idtextRequired
The mail account.
Folderfolder_idtext
Optional. Only this folder.
Read statusread_statustext
Optional. All emails (the default), unread or read.One of: all, unread, read.
Flagflagtext
Optional. Only emails with this flag.One of: flag_not_set (No flag), info, important, followup (Follow-up).
Labellabel_idtext
Optional. Only emails with this label.
Conversation IDthread_idtext
Optional. Only this conversation: an email's threadId.
Sort bysort_bytext
Optional. Date (the default), email id or size.One of: date, messageId (Email id), size.
Ordersort_ordertext
Optional. Descending (newest first, the default) or ascending.One of: descending, ascending.
With attachments onlyattachments_onlytrue/false
Optional. Only emails with attachments.Default: false.
Flagged onlyflagged_onlytrue/false
Optional. Only flagged emails.Default: false.
Include archivedinclude_archivedtrue/false
Optional. Also list archived emails.Default: false.
Page sizelimitnumber
Optional. How many to return, 1 to 200. Default 50.From 1 to 200.
Offsetoffsetnumber
Optional. How many to skip: the next_offset of the previous page.At least 0.

Outputs

countnumber
How many emails are on this page.
has_moretrue/false
Whether another page is probably available.
itemslist
The emails.
next_offsetnumber
Pass as 'Offset' to fetch the next page; empty on the last.
Example output
{
  "count": 1,
  "has_more": false,
  "items": [
    {
      "ccAddress": "",
      "flagid": "flag_not_set",
      "folderId": "2560636000000008014",
      "fromAddress": "paula@zylker.com",
      "hasAttachment": "0",
      "messageId": "1711540991815100000",
      "receivedTime": "1711540991815",
      "sender": "Paula",
      "status": "0",
      "subject": "Quarterly report",
      "summary": "Please find the numbers below.",
      "threadId": "1711540991815100001",
      "toAddress": "\"Rebecca\"<rebecca@zylker.com>"
    }
  ],
  "next_offset": null
}

List folders

List the account's folders, optionally only one type.

Inputs

Accountaccount_idtextRequired
The mail account.
Folder typefolder_typetext
Optional. Only folders of this type, such as Sent.One of: Inbox, Drafts, Templates, Snoozed, Sent, Spam, Trash, Outbox.

Outputs

countnumber
How many folders there are.
itemslist
The folders.
Example output
{
  "count": 1,
  "items": [
    {
      "folderId": "2560636000000008014",
      "folderName": "Receipts",
      "folderType": "Inbox",
      "imapAccess": true,
      "isArchived": 0,
      "path": "/Receipts"
    }
  ]
}

List labels

List the account's labels.

Inputs

Accountaccount_idtextRequired
The mail account.

Outputs

countnumber
How many labels there are.
itemslist
The labels.
Example output
{
  "count": 1,
  "items": [
    {
      "color": "#ffd700",
      "displayName": "Clients",
      "labelId": "2560636000000011003",
      "sequence": 1,
      "tagId": "2560636000000011003"
    }
  ]
}

Mark as read or unread

Mark emails as read or unread.

Inputs

Accountaccount_idtextRequired
The mail account.
Email IDsmessage_idslistRequired
One or more emails' messageId values, from 'List emails' or 'Search emails'. Separate several with commas.
Mark asread_statustextRequired
Read or unread.One of: read, unread.

Outputs

The emails were marked.

messageIdslist
The emails changed.
readStatustext
read or unread.
updatedtrue/false
Always true.
Example output
{
  "messageIds": [
    "1711540991815100000"
  ],
  "readStatus": "read",
  "updated": true
}

Move emails

Move emails to another folder.

Inputs

Accountaccount_idtextRequired
The mail account.
Email IDsmessage_idslistRequired
One or more emails' messageId values, from 'List emails' or 'Search emails'. Separate several with commas.
To folderdestination_folder_idtextRequired
The folder to move them to.

Outputs

The emails were moved.

folderIdtext
The folder they were moved to.
messageIdslist
The emails changed.
updatedtrue/false
Always true.
Example output
{
  "folderId": "2560636000000008014",
  "messageIds": [
    "1711540991815100000"
  ],
  "updated": true
}

Reply to email

Reply to an email, keeping it in the same conversation.

Inputs

Accountaccount_idtextRequired
The mail account.
Email IDmessage_idtextRequired
The email's messageId, from 'List emails' or 'Search emails'.
Toto_addresstextRequired
The recipients' email addresses, separated by commas.
Fromfrom_addresstext
Optional. The address to send from; the account's primary address by default.
Cccc_addresstext
Optional. Cc addresses, separated by commas.
Bccbcc_addresstext
Optional. Bcc addresses, separated by commas.
Subjectsubjecttext
Optional. The subject line.
Bodycontenttext
Optional. The email's body; HTML unless Format is Plain text.
Formatmail_formattext
Optional. HTML (the default) or plain text.One of: html, plaintext (Plain text).
Ask for a read receiptask_receipttrue/false
Optional. Ask the recipient to confirm they read it.Default: false.

Outputs

What Zoho Mail answered to a reply.

dataobject
Zoho Mail's answer, as sent.
fromAddresstext
The address it was sent from.
inReplyTotext
The id of the email replied to.
messageIdtext
The reply's id, when Zoho Mail returns one.
subjecttext
The subject.
toAddresstext
The recipients.
Example output
{
  "data": {},
  "fromAddress": "rebecca@zylker.com",
  "inReplyTo": "1711540991815100000",
  "subject": "Quarterly report",
  "toAddress": "paula@zylker.com"
}

Save draft

Save an email to the Drafts folder without sending it.

Inputs

Accountaccount_idtextRequired
The mail account.
Toto_addresstextRequired
The recipients' email addresses, separated by commas.
Fromfrom_addresstext
Optional. The address to send from; the account's primary address by default.
Cccc_addresstext
Optional. Cc addresses, separated by commas.
Bccbcc_addresstext
Optional. Bcc addresses, separated by commas.
Subjectsubjecttext
Optional. The subject line.
Bodycontenttext
Optional. The email's body; HTML unless Format is Plain text.
Formatmail_formattext
Optional. HTML (the default) or plain text.One of: html, plaintext (Plain text).

Outputs

What Zoho Mail answered to a saved draft.

dataobject
Zoho Mail's answer, as sent.
fromAddresstext
The From address.
messageIdtext
The draft's id, when Zoho Mail returns one.
subjecttext
The subject.
toAddresstext
The recipients.
Example output
{
  "data": {},
  "fromAddress": "rebecca@zylker.com",
  "subject": "Quarterly report",
  "toAddress": "paula@zylker.com"
}

Search emails

Search the account's emails with Zoho Mail's search syntax.

Inputs

Accountaccount_idtextRequired
The mail account.
Searchsearch_keytext
Optional if a date is set. field:value terms, such as subject:invoice, sender:ana@example.com, entire:hello or has:attachment. Join with :: for AND or :or: for OR.
From datereceived_fromdate
Optional. Only emails from this day on.
To datereceived_todate
Optional. Only emails up to this day.
Page sizelimitnumber
Optional. How many to return, 1 to 200. Default 50.From 1 to 200.
Offsetoffsetnumber
Optional. How many to skip: the next_offset of the previous page.At least 0.

Outputs

countnumber
How many matching emails are on this page.
has_moretrue/false
Whether another page is probably available.
itemslist
The matching emails.
next_offsetnumber
Pass as 'Offset' to fetch the next page; empty on the last.
Example output
{
  "count": 1,
  "has_more": false,
  "items": [
    {
      "ccAddress": "",
      "flagid": "flag_not_set",
      "folderId": "2560636000000008014",
      "fromAddress": "paula@zylker.com",
      "hasAttachment": "0",
      "messageId": "1711540991815100000",
      "receivedTime": "1711540991815",
      "sender": "Paula",
      "status": "0",
      "subject": "Quarterly report",
      "summary": "Please find the numbers below.",
      "threadId": "1711540991815100001",
      "toAddress": "\"Rebecca\"<rebecca@zylker.com>"
    }
  ],
  "next_offset": null
}

Send email

Send an email from the account.

Inputs

Accountaccount_idtextRequired
The mail account.
Toto_addresstextRequired
The recipients' email addresses, separated by commas.
Fromfrom_addresstext
Optional. The address to send from; the account's primary address by default.
Cccc_addresstext
Optional. Cc addresses, separated by commas.
Bccbcc_addresstext
Optional. Bcc addresses, separated by commas.
Subjectsubjecttext
Optional. The subject line.
Bodycontenttext
Optional. The email's body; HTML unless Format is Plain text.
Formatmail_formattext
Optional. HTML (the default) or plain text.One of: html, plaintext (Plain text).
Ask for a read receiptask_receipttrue/false
Optional. Ask the recipient to confirm they read it.Default: false.

Outputs

What Zoho Mail answered to a send.

dataobject
Zoho Mail's answer, as sent.
fromAddresstext
The address it was sent from.
messageIdtext
The new email's id, when Zoho Mail returns one.
subjecttext
The subject.
toAddresstext
The recipients.
Example output
{
  "data": {},
  "fromAddress": "rebecca@zylker.com",
  "subject": "Quarterly report",
  "toAddress": "paula@zylker.com"
}

Zoho Invoice

Previous Page

Zoho Notebook

Next Page

On this page

ActionsApply labelArchive emailsCreate folderCreate labelDelete emailDelete folderDelete labelFlag emailsGet email contentGet email detailsList accountsList emailsList foldersList labelsMark as read or unreadMove emailsReply to emailSave draftSearch emailsSend email