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 Name | URL | OAuth Scope | Method Type | Purpose |
| Get All Accounts of a User | /api/accounts | ZohoMail.accounts | GET | To get the account details of the user currently authenticated user. |
| Get a Specific Account Details | /api/accounts/{accountId} | ZohoMail.accounts | GET | To retrieve details of a specific account. |
| Update Mail Account Sequence | Admin Authentication: /api/organization/{zoid}/accounts/{accountId} | ZohoMail.organization.accounts | PUT | To update the sequence/ order of the mail accounts for processing new emails. |
| User Authentication: /api/accounts/{accountId} | ZohoMail.accounts | |||
| Update Reply To Address | Admin Authentication: /api/organization/{zoid}/accounts/{accountId} | ZohoMail.organization.accounts | PUT | To update the Reply-To address for the particular account. |
| User Authentication: /api/accounts/{accountId} | ZohoMail.accounts | |||
| Resend Verification for Reply To Address | Admin Authentication: /api/organization/{zoid}/accounts/{accountId} | ZohoMail.organization.accounts | PUT | To 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 Name | URL | OAuth Scope | Method Type | Purpose |
| Add send mail details | Admin Authentication: /api/organization/{zoid}/accounts/{accountId} | ZohoMail.organization.accounts | PUT | To 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 name | Admin Authentication: /api/organization/{zoid}/accounts/{accountId} | ZohoMail.organization.accounts | PUT | To update the display name for a specific from email address for the user. |
| User Authentication: /api/accounts/{accountId} | ZohoMail.accounts | |||
| Update Email Address | Admin Authentication: /api/organization/{zoid}/accounts/{accountId} | ZohoMail.organization.accounts | PUT | To 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.accounts | PUT | To 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 Name | URL | OAuth Scope | Method Type | Purpose |
| Add Email Forwarding | Admin Authentication: /api/organization/{zoid}/accounts/{accountId} | ZohoMail.organization.accounts | PUT | To add automatic email forwarding for the account to a specific email address. |
| User Authentication: /api/accounts/{accountId} | ZohoMail.accounts | |||
| Verify Email Forwarding | Admin Authentication: /api/organization/{zoid}/accounts/{accountId} | ZohoMail.organization.accounts | PUT | To verify the email address to which the email forwarding is added. |
| User Authentication: /api/accounts/{accountId} | ZohoMail.accounts | |||
| Resend Verification for Email Forwarding | Admin Authentication: /api/organization/{zoid}/accounts/{accountId} | ZohoMail.organization.accounts | PUT | To resend the verification link to the email address to enable Email Forwarding. |
| User Authentication: /api/accounts/{accountId} | ZohoMail.accounts | |||
| Enable Email Forwarding | Admin Authentication: /api/organization/{zoid}/accounts/{accountId} | ZohoMail.organization.accounts | PUT | To enable email forwarding for an verified email address. |
| User Authentication: /api/accounts/{accountId} | ZohoMail.accounts | |||
| Disable Email Forwarding | Admin Authentication: /api/organization/{zoid}/accounts/{accountId} | ZohoMail.organization.accounts | PUT | To disable the existing Email Forwarding added to an email address. |
| User Authentication: /api/accounts/{accountId} | ZohoMail.accounts | |||
| Delete Zoho Mail copy in Email Forwarding | Admin Authentication: /api/organization/{zoid}/accounts/{accountId} | ZohoMail.organization.accounts | PUT | To 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 Forwarding | Admin Authentication: /api/organization/{zoid}/accounts/{accountId} | ZohoMail.organization.accounts | PUT | To 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 Name | URL | OAuth Scope | Method Type | Purpose |
| Add Vacation Reply | Admin Authentication: /api/organization/{zoid}/accounts/{accountId} | ZohoMail.organization.accounts | PUT | To add vacation reply for the account. |
| User Authentication: /api/accounts/{accountId} | ZohoMail.accounts | |||
| Update Vacation Reply | Admin Authentication: /api/organization/{zoid}/accounts/{accountId} | ZohoMail.organization.accounts | PUT | To update the vacation reply for the account. |
| User Authentication: /api/accounts/{accountId} | ZohoMail.accounts | |||
| Remove Vacation Reply | Admin Authentication: /api/organization/{zoid}/accounts/{accountId} | ZohoMail.organization.accounts | PUT | To remove the vacation reply added to the account. |
| User Authentication: /api/accounts/{accountId} | ZohoMail.accounts |