PUT 17.0/database/emailsettings/{id}

Description

Update existing Email Settings

URI Parameters
Name Description Type Additional information
id

integer

Required

EmailSettingsUpdate
Name Description Type Additional information
ID

integer

None.
EmailAddress

string

String length: inclusive between 0 and 50
SMTPServerName

string

String length: inclusive between 0 and 100
SMTPUserName

string

String length: inclusive between 0 and 255
SMTPUserPassword

string

String length: inclusive between 0 and 255
SMTPAuthenticationType

byte

None.
SMTPPort

integer

None.
SMTPSSL

byte

None.
IMAPServerName

string

String length: inclusive between 0 and 100
IMAPUserName

string

String length: inclusive between 0 and 50
IMAPUserPassword

string

String length: inclusive between 0 and 50
IMAPPort

integer

None.
IMAPSSL

byte

None.
SendingPause

integer

None.
DefaultAccount

byte

None.
ProcessInbox

byte

None.
AuthenticationMethod

byte

None.
OAuthToken

string

String length: inclusive between 0 and 1024
AuthenticationStatus

byte

None.
InActive

byte

None.

application/json, text/json
Sample: 
{
  "id": 1,
  "emailAddress": "sample string 1",
  "smtpServerName": "sample string 2",
  "smtpUserName": "sample string 3",
  "smtpUserPassword": "sample string 4",
  "smtpAuthenticationType": 64,
  "smtpPort": 1,
  "smtpssl": 64,
  "imapServerName": "sample string 5",
  "imapUserName": "sample string 6",
  "imapUserPassword": "sample string 7",
  "imapPort": 1,
  "imapssl": 64,
  "sendingPause": 1,
  "defaultAccount": 64,
  "processInbox": 64,
  "authenticationMethod": 64,
  "oAuthToken": "sample string 8",
  "authenticationStatus": 64,
  "inActive": 64
}

application/xml, text/xml
Sample: 
<EmailSettingsUpdate xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <ID>1</ID>
  <EmailAddress>sample string 1</EmailAddress>
  <SMTPServerName>sample string 2</SMTPServerName>
  <SMTPUserName>sample string 3</SMTPUserName>
  <SMTPUserPassword>sample string 4</SMTPUserPassword>
  <SMTPAuthenticationType>64</SMTPAuthenticationType>
  <SMTPPort>1</SMTPPort>
  <SMTPSSL>64</SMTPSSL>
  <IMAPServerName>sample string 5</IMAPServerName>
  <IMAPUserName>sample string 6</IMAPUserName>
  <IMAPUserPassword>sample string 7</IMAPUserPassword>
  <IMAPPort>1</IMAPPort>
  <IMAPSSL>64</IMAPSSL>
  <SendingPause>1</SendingPause>
  <DefaultAccount>64</DefaultAccount>
  <ProcessInbox>64</ProcessInbox>
  <AuthenticationMethod>64</AuthenticationMethod>
  <OAuthToken>sample string 8</OAuthToken>
  <AuthenticationStatus>64</AuthenticationStatus>
  <InActive>64</InActive>
</EmailSettingsUpdate>

application/x-www-form-urlencoded
Sample:

Sample not available.

EmailSettings
Name Description Type Additional information
ID

integer

None.
EmailAddress

string

String length: inclusive between 0 and 50
SMTPServerName

string

String length: inclusive between 0 and 100
SMTPUserName

string

String length: inclusive between 0 and 255
SMTPUserPassword

string

String length: inclusive between 0 and 255
SMTPAuthenticationType

byte

None.
SMTPPort

integer

None.
SMTPSSL

byte

None.
IMAPServerName

string

String length: inclusive between 0 and 100
IMAPUserName

string

String length: inclusive between 0 and 50
IMAPUserPassword

string

String length: inclusive between 0 and 50
IMAPPort

integer

None.
IMAPSSL

byte

None.
SendingPause

integer

None.
DefaultAccount

byte

None.
ProcessInbox

byte

None.
AuthenticationMethod

byte

None.
OAuthToken

string

String length: inclusive between 0 and 1024
AuthenticationStatus

byte

None.
InActive

byte

None.

application/json, text/json
Sample: 
{
  "id": 1,
  "emailAddress": "sample string 2",
  "smtpServerName": "sample string 3",
  "smtpUserName": "sample string 4",
  "smtpUserPassword": "sample string 5",
  "smtpAuthenticationType": 64,
  "smtpPort": 7,
  "smtpssl": 64,
  "imapServerName": "sample string 9",
  "imapUserName": "sample string 10",
  "imapUserPassword": "sample string 11",
  "imapPort": 12,
  "imapssl": 64,
  "sendingPause": 14,
  "defaultAccount": 64,
  "processInbox": 64,
  "authenticationMethod": 64,
  "oAuthToken": "sample string 18",
  "authenticationStatus": 64,
  "inActive": 64
}

application/xml, text/xml
Sample: 
<EmailSettings xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <ID>1</ID>
  <EmailAddress>sample string 2</EmailAddress>
  <SMTPServerName>sample string 3</SMTPServerName>
  <SMTPUserName>sample string 4</SMTPUserName>
  <SMTPUserPassword>sample string 5</SMTPUserPassword>
  <SMTPAuthenticationType>64</SMTPAuthenticationType>
  <SMTPPort>7</SMTPPort>
  <SMTPSSL>64</SMTPSSL>
  <IMAPServerName>sample string 9</IMAPServerName>
  <IMAPUserName>sample string 10</IMAPUserName>
  <IMAPUserPassword>sample string 11</IMAPUserPassword>
  <IMAPPort>12</IMAPPort>
  <IMAPSSL>64</IMAPSSL>
  <SendingPause>14</SendingPause>
  <DefaultAccount>64</DefaultAccount>
  <ProcessInbox>64</ProcessInbox>
  <AuthenticationMethod>64</AuthenticationMethod>
  <OAuthToken>sample string 18</OAuthToken>
  <AuthenticationStatus>64</AuthenticationStatus>
  <InActive>64</InActive>
</EmailSettings>