POST 17.0/database/emails/list

Description

Retrieve a list of Emails

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 EmailsUpdate
Name Description Type Additional information
ID

integer

None.
Description

string

String length: inclusive between 0 and 75
Subject

string

String length: inclusive between 0 and 255
Body

string

None.
HTMLFileName

string

String length: inclusive between 0 and 255
FromEmail

string

String length: inclusive between 0 and 50
CC

string

String length: inclusive between 0 and 100
BCC

string

String length: inclusive between 0 and 100
EmailSignatureID

integer

None.
TypeID

byte

None.
NewPropertiesOnly

byte

None.
AutoAttachDocumentID

integer

None.
SaveAsCorrespondence

byte

None.
FollowUpTaskInterval

integer

None.
FollowUpTaskPriority

byte

None.
MailshotGroupID

integer

None.
ContentTypeID

byte

None.
ShowOnClientLogin

byte

None.
InActive

byte

None.
LegacyAttachments

string

None.

application/json, text/json
Sample: 
[
  {
    "id": 1,
    "description": "sample string 1",
    "subject": "sample string 2",
    "body": "sample string 3",
    "htmlFileName": "sample string 4",
    "fromEmail": "sample string 5",
    "cc": "sample string 6",
    "bcc": "sample string 7",
    "emailSignatureID": 1,
    "typeID": 64,
    "newPropertiesOnly": 64,
    "autoAttachDocumentID": 1,
    "saveAsCorrespondence": 64,
    "followUpTaskInterval": 1,
    "followUpTaskPriority": 64,
    "mailshotGroupID": 1,
    "contentTypeID": 64,
    "showOnClientLogin": 64,
    "inActive": 64,
    "legacyAttachments": "sample string 8"
  },
  {
    "id": 1,
    "description": "sample string 1",
    "subject": "sample string 2",
    "body": "sample string 3",
    "htmlFileName": "sample string 4",
    "fromEmail": "sample string 5",
    "cc": "sample string 6",
    "bcc": "sample string 7",
    "emailSignatureID": 1,
    "typeID": 64,
    "newPropertiesOnly": 64,
    "autoAttachDocumentID": 1,
    "saveAsCorrespondence": 64,
    "followUpTaskInterval": 1,
    "followUpTaskPriority": 64,
    "mailshotGroupID": 1,
    "contentTypeID": 64,
    "showOnClientLogin": 64,
    "inActive": 64,
    "legacyAttachments": "sample string 8"
  }
]

application/xml, text/xml
Sample: 
<ArrayOfEmailsUpdate xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <EmailsUpdate>
    <ID>1</ID>
    <Description>sample string 1</Description>
    <Subject>sample string 2</Subject>
    <Body>sample string 3</Body>
    <HTMLFileName>sample string 4</HTMLFileName>
    <FromEmail>sample string 5</FromEmail>
    <CC>sample string 6</CC>
    <BCC>sample string 7</BCC>
    <EmailSignatureID>1</EmailSignatureID>
    <TypeID>64</TypeID>
    <NewPropertiesOnly>64</NewPropertiesOnly>
    <AutoAttachDocumentID>1</AutoAttachDocumentID>
    <SaveAsCorrespondence>64</SaveAsCorrespondence>
    <FollowUpTaskInterval>1</FollowUpTaskInterval>
    <FollowUpTaskPriority>64</FollowUpTaskPriority>
    <MailshotGroupID>1</MailshotGroupID>
    <ContentTypeID>64</ContentTypeID>
    <ShowOnClientLogin>64</ShowOnClientLogin>
    <InActive>64</InActive>
    <LegacyAttachments>sample string 8</LegacyAttachments>
  </EmailsUpdate>
  <EmailsUpdate>
    <ID>1</ID>
    <Description>sample string 1</Description>
    <Subject>sample string 2</Subject>
    <Body>sample string 3</Body>
    <HTMLFileName>sample string 4</HTMLFileName>
    <FromEmail>sample string 5</FromEmail>
    <CC>sample string 6</CC>
    <BCC>sample string 7</BCC>
    <EmailSignatureID>1</EmailSignatureID>
    <TypeID>64</TypeID>
    <NewPropertiesOnly>64</NewPropertiesOnly>
    <AutoAttachDocumentID>1</AutoAttachDocumentID>
    <SaveAsCorrespondence>64</SaveAsCorrespondence>
    <FollowUpTaskInterval>1</FollowUpTaskInterval>
    <FollowUpTaskPriority>64</FollowUpTaskPriority>
    <MailshotGroupID>1</MailshotGroupID>
    <ContentTypeID>64</ContentTypeID>
    <ShowOnClientLogin>64</ShowOnClientLogin>
    <InActive>64</InActive>
    <LegacyAttachments>sample string 8</LegacyAttachments>
  </EmailsUpdate>
</ArrayOfEmailsUpdate>