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 administrator for the users in the organization. The details can also be retrieved using REST API's, which can be used for a particular user using the AuthToken for the particular user. 

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 Account Details

/api/accounts

accountsGETTo get the account details of the user currently authenticated 
Update Mail Account Sequence

Admin Authentication: /api/organization/<zoid>/accounts/<accountid>

organization.accounts

PUT

To update the sequence/ order of the Mail Accounts for processing new emails.

User Authentication: /api/accounts/<accountid>

accounts

Update Reply To Address

Admin Authentication: /api/organization/<zoid>/accounts/<accountid>

organization.accounts

PUT

To update the Reply-To address for the particular account. 

User Authentication: /api/accounts/<accountid>

accounts

Resend Verification for Reply To Address

Admin Authentication: /api/organization/<zoid>/accounts/<accountid>

organization.accounts

PUTTo resend the verification for confirmation of the Reply To address for the particular account. 

User Authentication: /api/accounts/<accountid>

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 details

Admin Authentication: /api/organization/<zoid>/accounts/<accountid>

organization.accounts

PUT

To add an email address in Send Mail Details as From Address.

User Authentication: /api/accounts/<accountid>

accounts
Update Send Mail Address

Admin Authentication: /api/organization/<zoid>/accounts/<accountid>

organization.accounts

PUT

To update an existing email address in the Send Mail Details. 

User Authentication: /api/accounts/<accountid>

accounts
Update Display name and Email Address 

Admin Authentication: /api/organization/<zoid>/accounts/<accountid>

organization.accounts

PUT

To update the Display Name and Email address for the user.

User Authentication: /api/accounts/<accountid>

accounts
Update Display name

Admin Authentication: /api/organization/<zoid>/accounts/<accountid>

organization.accounts

PUT

To update the Display Name for a specific from email address for the user. 

User Authentication: /api/accounts/<accountid>

accounts
Update Email Address

Admin Authentication: /api/organization/<zoid>/accounts/<accountid>

organization.accounts

PUT

To update the Email Address of the user.

User Authentication: /api/accounts/<accountid>

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 Forwarding

Admin Authentication: /api/organization/<zoid>/accounts/<accountid>

organization.accounts

PUT

To add automatic email forwarding for the account to a specific email address. 

User Authentication: /api/accounts/<accountid>

accounts
Verify Email Forwarding

Admin Authentication: /api/organization/<zoid>/accounts/<accountid>

organization.accounts

PUT

To verify the email address to which the email forwarding is added.

User Authentication: /api/accounts/<accountid>

accounts
Enable Email Forwarding

Admin Authentication: /api/organization/<zoid>/accounts/<accountid>

organization.accounts

PUT

To enable email forwarding for an verified email address.

User Authentication: /api/accounts/<accountid>

accounts
Resend Verification for Email Forwarding

Admin Authentication: /api/organization/<zoid>/accounts/<accountid>

organization.accounts

PUT

To resend the verification link to the email address to enable Email Forwarding.

User Authentication: /api/accounts/<accountid>

accounts
Disable Email Forwarding

Admin Authentication: /api/organization/<zoid>/accounts/<accountid>

organization.accounts

PUT

To disable the existing Email Forwarding added to an email address. 

User Authentication: /api/accounts/<accountid>

accounts
Delete Zoho Mail copy in Email Forwarding

Admin Authentication: /api/organization/<zoid>/accounts/<accountid>

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>

accounts
Delete Email Forwarding

Admin Authentication: /api/organization/<zoid>/accounts/<accountid>

organization.accounts

PUT

To remove the existing email forwarding for the account and delete the email address reference. 

User Authentication: /api/accounts/<accountid>

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 Reply

Admin Authentication: /api/organization/<zoid>/accounts/<accountid>

organization.accounts

PUT

To add Vacation Reply for the account.

User Authentication: /api/accounts/<accountid>

accounts
Update Vacation Reply

Admin Authentication: /api/organization/<zoid>/accounts/<accountid>

organization.accounts

PUT

To update the Vacation Reply for the account.

User Authentication: /api/accounts/<accountid>

accounts
Remove Vacation Reply

Admin Authentication: /api/organization/<zoid>/accounts/<accountid>

organization.accounts

PUT

To remove the Vacation Reply added to the account.

User Authentication: /api/accounts/<accountid>

accounts