Search the Inbox

post

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

This method is used to search the user's inbox, based on filter parameters.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

Filter

string

Return result set based on a search criteria (can be a substring). Note: Search criteria will only search SenderEmail and Subject fields.

FolderId

int32

Unique ID of the Inbox folder to search (default Inbox Folder ID = 1)

GetInboxUnReadOnly

boolean

Setting this to true will only return unread messages (default is false)

GetRetractedMsgs

boolean

Setting this to true will search retracted messages as well (default is false)

OrderBy

string

Field by which to sort the result set

OrderDesc

boolean

Order descending (default is false)

PageNum

int32

required

Page number to return

PageSize

int32

required

Number of records returned per page

Headers

X-Session-Key

string

required

The X-Session-Key header must be a valid Session Key retrieved from the Get A Session Key function.

Responses

Language

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200200