{ "opencollection": "1.0.0", "info": { "name": "Zoho Mail Accounts Messages API", "version": "1.0.0" }, "request": { "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://accounts.zoho.com/oauth/v2/auth", "accessTokenUrl": "https://accounts.zoho.com/oauth/v2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "items": [ { "info": { "name": "Messages", "type": "folder" }, "items": [ { "info": { "name": "List emails in folder", "type": "http" }, "http": { "method": "GET", "url": "https://mail.zoho.com/api/accounts/:accountId/messages", "params": [ { "name": "accountId", "value": "", "type": "path", "description": "The unique identifier for the email account." }, { "name": "folderId", "value": "", "type": "query", "description": "Folder ID to list messages from" }, { "name": "start", "value": "", "type": "query", "description": "Starting index for pagination" }, { "name": "limit", "value": "", "type": "query", "description": "Number of messages to retrieve" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://accounts.zoho.com/oauth/v2/auth", "accessTokenUrl": "https://accounts.zoho.com/oauth/v2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Get all or a specific set of emails in a folder based on view options." }, { "info": { "name": "Send an email", "type": "http" }, "http": { "method": "POST", "url": "https://mail.zoho.com/api/accounts/:accountId/messages", "params": [ { "name": "accountId", "value": "", "type": "path", "description": "The unique identifier for the email account." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://accounts.zoho.com/oauth/v2/auth", "accessTokenUrl": "https://accounts.zoho.com/oauth/v2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Send an email specifying the From, To, Cc, Bcc, Subject, Encoding and Email format." }, { "info": { "name": "Search emails", "type": "http" }, "http": { "method": "GET", "url": "https://mail.zoho.com/api/accounts/:accountId/messages/search", "params": [ { "name": "accountId", "value": "", "type": "path", "description": "The unique identifier for the email account." }, { "name": "searchKey", "value": "", "type": "query", "description": "Search keyword or phrase" }, { "name": "folder", "value": "", "type": "query", "description": "Folder ID to search within" }, { "name": "start", "value": "", "type": "query", "description": "Starting index for pagination" }, { "name": "limit", "value": "", "type": "query", "description": "Number of results to return" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://accounts.zoho.com/oauth/v2/auth", "accessTokenUrl": "https://accounts.zoho.com/oauth/v2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Retrieve messages using custom search criteria." }, { "info": { "name": "Upload an attachment", "type": "http" }, "http": { "method": "POST", "url": "https://mail.zoho.com/api/accounts/:accountId/messages/attachments", "params": [ { "name": "accountId", "value": "", "type": "path", "description": "The unique identifier for the email account." } ], "body": { "type": "multipart-form", "data": [ { "name": "attach", "type": "text", "value": "" } ] }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://accounts.zoho.com/oauth/v2/auth", "accessTokenUrl": "https://accounts.zoho.com/oauth/v2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Upload a file before attaching it to an email." }, { "info": { "name": "Reply to email", "type": "http" }, "http": { "method": "POST", "url": "https://mail.zoho.com/api/accounts/:accountId/messages/:messageId", "params": [ { "name": "accountId", "value": "", "type": "path", "description": "The unique identifier for the email account." }, { "name": "messageId", "value": "", "type": "path", "description": "The unique identifier for the email message." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://accounts.zoho.com/oauth/v2/auth", "accessTokenUrl": "https://accounts.zoho.com/oauth/v2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Respond to a received message." }, { "info": { "name": "Get emails in folder by view", "type": "http" }, "http": { "method": "GET", "url": "https://mail.zoho.com/api/accounts/:accountId/messages/view", "params": [ { "name": "accountId", "value": "", "type": "path", "description": "The unique identifier for the email account." }, { "name": "folderId", "value": "", "type": "query", "description": "Folder ID to retrieve emails from" }, { "name": "start", "value": "", "type": "query", "description": "Starting index for pagination" }, { "name": "limit", "value": "", "type": "query", "description": "Number of messages to retrieve" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://accounts.zoho.com/oauth/v2/auth", "accessTokenUrl": "https://accounts.zoho.com/oauth/v2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Get details of all or a specific set of emails in a folder based on view options." }, { "info": { "name": "Update message(s)", "type": "http" }, "http": { "method": "PUT", "url": "https://mail.zoho.com/api/accounts/:accountId/updatemessage", "params": [ { "name": "accountId", "value": "", "type": "path", "description": "The unique identifier for the email account." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://accounts.zoho.com/oauth/v2/auth", "accessTokenUrl": "https://accounts.zoho.com/oauth/v2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Perform bulk operations on messages: mark as read/unread, move, flag, apply or remove labels, archive/unarchive, mark as spam/not spam." }, { "info": { "name": "Delete email", "type": "http" }, "http": { "method": "DELETE", "url": "https://mail.zoho.com/api/accounts/:accountId/folders/:folderId/messages/:messageId", "params": [ { "name": "accountId", "value": "", "type": "path", "description": "The unique identifier for the email account." }, { "name": "folderId", "value": "", "type": "path", "description": "The unique identifier for the folder." }, { "name": "messageId", "value": "", "type": "path", "description": "The unique identifier for the email message." } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://accounts.zoho.com/oauth/v2/auth", "accessTokenUrl": "https://accounts.zoho.com/oauth/v2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Permanently delete an email message." }, { "info": { "name": "Get email headers", "type": "http" }, "http": { "method": "GET", "url": "https://mail.zoho.com/api/accounts/:accountId/folders/:folderId/messages/:messageId/header", "params": [ { "name": "accountId", "value": "", "type": "path", "description": "The unique identifier for the email account." }, { "name": "folderId", "value": "", "type": "path", "description": "The unique identifier for the folder." }, { "name": "messageId", "value": "", "type": "path", "description": "The unique identifier for the email message." } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://accounts.zoho.com/oauth/v2/auth", "accessTokenUrl": "https://accounts.zoho.com/oauth/v2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Retrieve the headers of a specific email message." }, { "info": { "name": "Get email content", "type": "http" }, "http": { "method": "GET", "url": "https://mail.zoho.com/api/accounts/:accountId/folders/:folderId/messages/:messageId/content", "params": [ { "name": "accountId", "value": "", "type": "path", "description": "The unique identifier for the email account." }, { "name": "folderId", "value": "", "type": "path", "description": "The unique identifier for the folder." }, { "name": "messageId", "value": "", "type": "path", "description": "The unique identifier for the email message." } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://accounts.zoho.com/oauth/v2/auth", "accessTokenUrl": "https://accounts.zoho.com/oauth/v2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Retrieve the body/content of a specific email message." }, { "info": { "name": "Get email metadata", "type": "http" }, "http": { "method": "GET", "url": "https://mail.zoho.com/api/accounts/:accountId/folders/:folderId/messages/:messageId/details", "params": [ { "name": "accountId", "value": "", "type": "path", "description": "The unique identifier for the email account." }, { "name": "folderId", "value": "", "type": "path", "description": "The unique identifier for the folder." }, { "name": "messageId", "value": "", "type": "path", "description": "The unique identifier for the email message." } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://accounts.zoho.com/oauth/v2/auth", "accessTokenUrl": "https://accounts.zoho.com/oauth/v2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Retrieve metadata and details for a specific email message." }, { "info": { "name": "Get attachment information", "type": "http" }, "http": { "method": "GET", "url": "https://mail.zoho.com/api/accounts/:accountId/folders/:folderId/messages/:messageId/attachmentinfo", "params": [ { "name": "accountId", "value": "", "type": "path", "description": "The unique identifier for the email account." }, { "name": "folderId", "value": "", "type": "path", "description": "The unique identifier for the folder." }, { "name": "messageId", "value": "", "type": "path", "description": "The unique identifier for the email message." } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://accounts.zoho.com/oauth/v2/auth", "accessTokenUrl": "https://accounts.zoho.com/oauth/v2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Retrieve information about attachments in a specific email." }, { "info": { "name": "Get attachment content", "type": "http" }, "http": { "method": "GET", "url": "https://mail.zoho.com/api/accounts/:accountId/folders/:folderId/messages/:messageId/attachments/:attachmentId", "params": [ { "name": "accountId", "value": "", "type": "path", "description": "The unique identifier for the email account." }, { "name": "folderId", "value": "", "type": "path", "description": "The unique identifier for the folder." }, { "name": "messageId", "value": "", "type": "path", "description": "The unique identifier for the email message." }, { "name": "attachmentId", "value": "", "type": "path", "description": "The unique identifier for the attachment." } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://accounts.zoho.com/oauth/v2/auth", "accessTokenUrl": "https://accounts.zoho.com/oauth/v2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Get the content stream of attachments in an email." }, { "info": { "name": "Get original message", "type": "http" }, "http": { "method": "GET", "url": "https://mail.zoho.com/api/accounts/:accountId/messages/:messageId/originalmessage", "params": [ { "name": "accountId", "value": "", "type": "path", "description": "The unique identifier for the email account." }, { "name": "messageId", "value": "", "type": "path", "description": "The unique identifier for the email message." } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://accounts.zoho.com/oauth/v2/auth", "accessTokenUrl": "https://accounts.zoho.com/oauth/v2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Obtain the MIME representation of the original email message." } ] } ], "bundled": true }