GET api/customeremail/search?CustomerID={CustomerID}&EmailSentID={EmailSentID}&ResultsLimit={ResultsLimit}

Search emails based on search parameters.

Requires Authorisation

The api request must supply authenticated token in a custom variable in the request header. The custom variable name is configured in web.config. The default name of the custom variable is “X-Fern-Token”.

Requires Api License and User Access

The api requires license and user permission for API ID, GETapi/customeremail/search. The user permission can be defined on User Settings screen in Abacus. For license, please contact Fern manager.

Request Information

URI Parameters

Name	Description	Type	Additional information
CustomerID	Customer ID.	integer
EmailSentID	Email sent ID.	integer
ResultsLimit	Limit the number of results found.	integer	If no value is passed then it will return all the results. If 0 is passed, then no results will be returned.

Body Parameters

None.

Response Information

Response Codes

Success Status:

OK (200), please see resource description below.

Failed Status(es):

Resource Description

Returns emails that matches the search paramenters.

Collection of EmailDto

Name	Description	Type	Additional information
ToAddress	Email ToAddress.	string
EmailSubject	Subject of the EMail.	string
Body	Body of the Email.	string
BodyHTML	Indicates whether body of the email is in HTML format.	boolean
AttachmentFile	Attachment file of the Email.	Stream
AttachmentFileName	Name of the file attached with the email.	string
CustomerID	Customer Id .	integer
PersonID	Customer's Person Id.	integer
LogEmail	Indicates whether email is logged successfully or not.	boolean
Password	Password to provide password protect for the attached file.	string	This value is optional.
Type	Attached file's type.	string
FilePath	Path in which document should be saved.	string
IsZip	Indicates whether the attcahed file should be zipped or not.	boolean

Response Formats

application/json, text/json

Sample:

[
  {
    "toAddress": "sample string 1",
    "emailSubject": "sample string 2",
    "body": "sample string 3",
    "bodyHTML": true,
    "attachmentFile": null,
    "attachmentFileName": "sample string 4",
    "customerID": 1,
    "personID": 1,
    "logEmail": true,
    "password": "sample string 5",
    "type": "sample string 6",
    "filePath": "sample string 7",
    "isZip": true
  },
  {
    "toAddress": "sample string 1",
    "emailSubject": "sample string 2",
    "body": "sample string 3",
    "bodyHTML": true,
    "attachmentFile": null,
    "attachmentFileName": "sample string 4",
    "customerID": 1,
    "personID": 1,
    "logEmail": true,
    "password": "sample string 5",
    "type": "sample string 6",
    "filePath": "sample string 7",
    "isZip": true
  }
]

application/xml, text/xml

Sample:

<ArrayOfEmailDto xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Fern.Abacus.ObjectModel.Dto.CU">
  <EmailDto>
    <AttachmentFile xmlns:d3p1="http://schemas.datacontract.org/2004/07/System.IO" i:nil="true" />
    <AttachmentFileName>sample string 4</AttachmentFileName>
    <Body>sample string 3</Body>
    <BodyHTML>true</BodyHTML>
    <CustomerID>1</CustomerID>
    <EmailSubject>sample string 2</EmailSubject>
    <FilePath>sample string 7</FilePath>
    <IsZip>true</IsZip>
    <LogEmail>true</LogEmail>
    <Password>sample string 5</Password>
    <PersonID>1</PersonID>
    <ToAddress>sample string 1</ToAddress>
    <Type>sample string 6</Type>
  </EmailDto>
  <EmailDto>
    <AttachmentFile xmlns:d3p1="http://schemas.datacontract.org/2004/07/System.IO" i:nil="true" />
    <AttachmentFileName>sample string 4</AttachmentFileName>
    <Body>sample string 3</Body>
    <BodyHTML>true</BodyHTML>
    <CustomerID>1</CustomerID>
    <EmailSubject>sample string 2</EmailSubject>
    <FilePath>sample string 7</FilePath>
    <IsZip>true</IsZip>
    <LogEmail>true</LogEmail>
    <Password>sample string 5</Password>
    <PersonID>1</PersonID>
    <ToAddress>sample string 1</ToAddress>
    <Type>sample string 6</Type>
  </EmailDto>
</ArrayOfEmailDto>