API Reference
Log In
API Reference

Get Inbox Message Ids

post
https://sandbox.datamotion.com/SecureMessagingApi/Message/GetInboxMessageIds

This method is used to retrieve the unique message identifiers (MIDs) of messages in a user's Inbox folder. A session key must be submitted via the X-Session-Key header. A successful transaction will receive a 200 status code.

Body Params

The inbox message IDs search option data

int32

The unique folder identifier to search in (must be an Inbox folder ID). 1 is the primary Inbox folder and is the default. Use -1 to get all messages from the primary Inbox folder and all custom Inbox folders.

int32
enum

The message list filter - 0(All), 1(Unread), 2(CmLft). 0(All) is the default.

Allowed:
boolean

A search parameter. If set to true, only messages with attachments will be returned. False is the default.

Headers
string
Responses

400

The InboxMessageIdsSearchOptionData model is required in the request body.

401

The X-Session-Key header is missing. || Bad session key. || Session key expired. || FolderId [FolderId] is not an inbox folder. || FolderId [FolderId] not found. || MessageList filter [MessageListFilter] is not supported.

Updated 10 months ago

Language
Response 
Click Try It! to start a request and see the response here! Or choose an example:
application/json
Updated 10 months ago