User Mail Account Details

The User Mail Account APIs help you to get and update information about the mail accounts and the related configurations and settings of the users in the organization. The following are part of Mail Accounts API

  • Mail Accounts of the user
  • Send Mail Details of the user
  • Email Forwarding
  • Vacation Reply details of the user

These details can be retrieved by the users themselves and can also be retrieved using REST APIs, using the AuthToken.

User Account  API

The User Account Access Mode APIs help you to enable/ disable the external access modes for the account, like POP/ IMAP and Active Sync for the user. Further you can enable/ disable incoming/ outgoing for the account using the APIs.

Method NameURLOAuth ScopeMethod TypePurpose
Get All Accounts of a User/api/accountsZohoMail.accountsGETTo get the account details of the user currently authenticated user.
Get a Specific Account Details/api/accounts/{accountId}ZohoMail.accountsGET To retrieve details of a specific account.
Update Mail Account SequenceAdmin Authentication: /api/organization/{zoid}/accounts/{accountId}ZohoMail.organization.accountsPUTTo update the sequence/ order of the mail accounts for processing new emails.
User Authentication:
/api/accounts/{accountId}
ZohoMail.accounts
Update Reply To AddressAdmin Authentication: /api/organization/{zoid}/accounts/{accountId}ZohoMail.organization.accountsPUTTo update the Reply-To address for the particular account. 
User Authentication:
/api/accounts/{accountId}
ZohoMail.accounts
Resend Verification for Reply To AddressAdmin Authentication: /api/organization/{zoid}/accounts/{accountId}ZohoMail.organization.accountsPUTTo resend the verification for confirmation of the Reply-To address for the particular account. 
User Authentication:
/api/accounts/{accountId}
ZohoMail.accounts

Send Mail Details API

The Send Mail Details APIs help you to get and update information about the send mail addresses (From Addresses) of the specific user accounts.

Method NameURLOAuth ScopeMethod TypePurpose
Add send mail detailsAdmin Authentication: /api/organization/{zoid}/accounts/{accountId}ZohoMail.organization.accountsPUTTo add send mail details such as the display name and the email address of the user. 
User Authentication: /api/accounts/{accountId}ZohoMail.accounts
Update Display nameAdmin Authentication: /api/organization/{zoid}/accounts/{accountId}ZohoMail.organization.accountsPUTTo update the display name for a specific from email address for the user. 
User Authentication: 
/api/accounts/{accountId}
ZohoMail.accounts
Update Email AddressAdmin Authentication: /api/organization/{zoid}/accounts/{accountId}ZohoMail.organization.accountsPUTTo update email address for the user.
User Authentication: 
/api/accounts/{accountId}
ZohoMail.accounts
Update Display name and Email Address Admin Authentication: /api/organization/{zoid}/accounts/{accountId}ZohoMail.organization.accountsPUTTo update the display name and email address for the user.
User Authentication: 
/api/accounts/{accountId}
ZohoMail.accounts 

User Email Forward API

The User Email Forward APIs help you to get, add or update the Email Forwarding details of the account.

Method NameURLOAuth ScopeMethod TypePurpose
Add Email ForwardingAdmin Authentication: /api/organization/{zoid}/accounts/{accountId}ZohoMail.organization.accountsPUTTo add automatic email forwarding for the account to a specific email address. 
User Authentication: /api/accounts/{accountId}ZohoMail.accounts
Verify Email ForwardingAdmin Authentication: /api/organization/{zoid}/accounts/{accountId}ZohoMail.organization.accountsPUTTo verify the email address to which the email forwarding is added.
User Authentication: 
/api/accounts/{accountId}
ZohoMail.accounts
Resend Verification for Email ForwardingAdmin Authentication: /api/organization/{zoid}/accounts/{accountId}ZohoMail.organization.accountsPUTTo resend the verification link to the email address to enable Email Forwarding.
User Authentication: /api/accounts/{accountId}ZohoMail.accounts
Enable Email ForwardingAdmin Authentication: /api/organization/{zoid}/accounts/{accountId}ZohoMail.organization.accountsPUTTo enable email forwarding for an verified email address.
User Authentication: 
/api/accounts/{accountId}
ZohoMail.accounts
Disable Email ForwardingAdmin Authentication: /api/organization/{zoid}/accounts/{accountId}ZohoMail.organization.accountsPUTTo disable the existing Email Forwarding added to an email address. 
User Authentication:
 /api/accounts/{accountId}
ZohoMail.accounts
Delete Zoho Mail copy in Email ForwardingAdmin Authentication: /api/organization/{zoid}/accounts/{accountId}ZohoMail.organization.accountsPUTTo delete the copy of the email in Zoho Mail inbox, after the email has been forwarded.
User Authentication: 
/api/accounts/{accountId}
ZohoMail.accounts
Remove Email ForwardingAdmin Authentication: /api/organization/{zoid}/accounts/{accountId}ZohoMail.organization.accountsPUTTo remove the existing email forwarding for the account and delete the email address reference. 
User Authentication:
/api/accounts/{accountId}
ZohoMail.accounts

Vacation Reply API

The Vacation Reply APIs help you add, retrieve or remove the Vacation Reply details of the account.

Method NameURLOAuth ScopeMethod TypePurpose
Add Vacation ReplyAdmin Authentication: 
/api/organization/{zoid}/accounts/{accountId}
ZohoMail.organization.accountsPUTTo add vacation reply for the account.
User Authentication: 
/api/accounts/{accountId}
ZohoMail.accounts
Update Vacation ReplyAdmin Authentication: 
/api/organization/{zoid}/accounts/{accountId}
ZohoMail.organization.accountsPUTTo update the vacation reply for the account.
User Authentication: 
/api/accounts/{accountId}
ZohoMail.accounts
Remove Vacation ReplyAdmin Authentication: 
/api/organization/{zoid}/accounts/{accountId}
ZohoMail.organization.accountsPUTTo remove the vacation reply added to the account.
User Authentication: 
/api/accounts/{accountId}
ZohoMail.accounts