PUT - To Add Send Mail Details

Purpose

This API is used to add send mail details such as the Display name and the Email Address of the user. This can be done by the Admin for a user or by the user for himself.

Request URL 

Using Admin Authentication:

http://<hostname>/api/organization/<zoid>/accounts/<accountid>

Using User Authentication:

https://<hostname>/api/accounts/<accountid>

Request Parameters

ParameterData TypeDescription
zuid* Integerzuid - The unique Zoho User Identifier for the organization 
fromAddress* StringfromAddress - The Email address to be updated as the default email address of the user. 
DisplayName* StringDisplayName - The Name that has to be updated as the Display Name for the Email address provided. 
mode* String mode - The mode of the From Email address added to the account. 
serverName StringIf the mode is external From address, provide the SMTP Server name and port details in the server parameters
serverPort IntegerThe port number in which the SMTP server should be connected
userName String The userName of the account which is set as the From Address, to connect to the SMTP server
Password String The Password corresponding to the account used to connect to the SMTP Server
smtpConnection String The type of SMTP connection to be tried to connect to the server provided

* - Mandatory parameters

Request Body (JSON Object)

ParameterData TypeAllowed ValuesDescription
mode* String 

addsendmaildetails

 

 To add the Send Mail Details like Email Address and Display Name for the account

mode*String
  • alias
  • group
  • extmailbox
  • extfrom
  • backupacc
  • mailbox
The mode of the Email Address to be added in Send Mail Details. The mode represents whether the email address is added as an alias/ group alias or as an external email address. 
smtpConnectionSring
  • plain
  • ssl
  • tls
The SMTP Connection type accepted by the server should be chosen. 
smtpPort Integer
  • 25
  • 465
  • 587
Based on the SMTP Connection chosen, the standard port numbers for each connection types are only supported. 

* - Mandatory parameters

Response Codes

Please refer Response Codes.

Sample Request (Using Admin Authentication)


				{
   "zuid": "1111111",
   "mode": "addsendmaildetails",
   "sendMailDetails": [
      {
         "fromAddress": "austin@zylker.com",
         "displayName": "Austin Keyes",
         "mode": "alias",
         "serverPort": "9225",
         "serverName": "mail-ubuntu2.csez.zohocorpin.com",
         "userName": "austinkeyes",
         "password": "Kan1$gra",
         "smtpConnection": "plain"
      }
   ]
}			

Sample Request (Using User Authentication)


				{
 "mode": "addsendmaildetails",
   "sendMailDetails": [
      {
         "fromAddress": "austin@zylker.com",
         "displayName": "Austin Keyes",
         "mode": "alias",
         "serverPort": "9225",
         "serverName": "mail-ubuntu2.csez.zohocorpin.com",
         "userName": "austinkeyes",
         "password": "Kan1$gra",
         "smtpConnection": "plain"
      }
   ]
}