POST 17.0/database/emailsettings/list

Description

Retrieve a list of Email Settings

URI Parameters

None.

ListOptions
Name Description Type Additional information
Fields

Collection of string

None.
Filters

Collection of DatabaseFilter

None.
Order

string

None.

application/json, text/json
Sample: 
{
  "fields": [
    "sample string 1",
    "sample string 2"
  ],
  "filters": [
    {
      "fieldName": "sample string 1",
      "value": "sample string 2",
      "operator": "sample string 3",
      "valueType": "sample string 4"
    },
    {
      "fieldName": "sample string 1",
      "value": "sample string 2",
      "operator": "sample string 3",
      "valueType": "sample string 4"
    }
  ],
  "order": "sample string 1"
}

application/xml, text/xml
Sample: 
<ListOptions xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <Fields>
    <string>sample string 1</string>
    <string>sample string 2</string>
  </Fields>
  <Filters>
    <DatabaseFilter>
      <FieldName>sample string 1</FieldName>
      <Value>sample string 2</Value>
      <Operator>sample string 3</Operator>
      <ValueType>sample string 4</ValueType>
    </DatabaseFilter>
    <DatabaseFilter>
      <FieldName>sample string 1</FieldName>
      <Value>sample string 2</Value>
      <Operator>sample string 3</Operator>
      <ValueType>sample string 4</ValueType>
    </DatabaseFilter>
  </Filters>
  <Order>sample string 1</Order>
</ListOptions>

application/x-www-form-urlencoded
Sample:

Sample not available.

Collection of 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
  },
  {
    "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: 
<ArrayOfEmailSettingsUpdate xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <EmailSettingsUpdate>
    <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>
  <EmailSettingsUpdate>
    <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>
</ArrayOfEmailSettingsUpdate>