Search the Inbox

post

https://sandbox.datamotion.com/SecureMessagingApi/Message/Inbox/Search

This method is used to search the user's inbox, based on filter parameters.
A session key must be submitted via the X-Session-Key header.
A successful transaction will receive a 200 status code.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

Mailbox search options data

Filter

string

The search criteria

FolderId

int32

Unique folder identifier of the Inbox or Outbox folder to search.
1 is the primary Inbox folder and is the default when searching an Inbox folder.
3 is the primary Outbox folder. The FolderId is required when searching an Outbox folder.

GetInboxUnReadOnly

boolean

Setting this to true will only return unread messages.
The default is false.

GetRetractedMsgs

boolean

Setting this to true will search retracted messages as well.
The default is false.

OrderBy

string

Field by which to sort the result set

OrderDesc

boolean

Order descending.
The default is false (order ascending).

PageNum

int32

required

Page number to return

PageSize

int32

required

Number of records returned per page

Headers

X-Session-Key

string

Responses

400

The MailboxSearchOptionsData model is required in the request body. ||
The PageNum field is required. ||
The PageSize field is required.

401

The X-Session-Key header is missing. ||
Bad session key. ||
Session key expired. ||
FolderId [FolderId] not found. ||
FolderId [FolderId] is not an inbox folder. ||
Please specify a page size between 1 and 1000. ||
Expected 2 tables from WSGetInboxData but got [NumberOfTables]. ||
Last action [LastAction] is not supported.

200Ok