Check filter results
POST /api/2.0/mail/filters/checkRequest
Checks the results of a filter specified in the request.
Authorization
An API key is a token that you provide when making API calls. Include the token in a header parameter called Authorization.
Example: Authorization: 864FE52C-1C1C-469F-9308-51DAFEFE7436.
Headers
- Accept
enum of string Can be one of:
application/json.- Content-Type
enum of string Can be one of:
application/json.
Body
- filter
unknown Filter parameters: ID, name, position, enabled, conditions, actions, options
- page
array of integer Page number
- pageSize
array of integer Number of messages on the page
Examples
POST /api/2.0/mail/filters/check HTTP/1.1
Accept: application/json
Content-Type: application/json
Host: example.comcurl --request POST \
--url https://example.com/api/2.0/mail/filters/check \
--header 'Accept: application/json' \
--header 'Content-Type: application/json'Responses
200
List of messages
- Attachments
array of object - fileId
integerformat: int32 - fileName
string - size
integerformat: int64 - contentType
string - needSaveToTemp
boolean - contentId
string - fileNumber
integerformat: int32 - storedName
string - streamId
string - attachedAsLink
boolean - tempStoredUrl
string
- Introduction
string - HtmlBody
string - ContentIsBlocked
boolean - Important
boolean - Subject
string - HasAttachments
boolean - Bcc
string - Cc
string - To
string - Address
string - From
string - ReplyTo
string - Id
integerformat: int32 - ChainId
string - ChainDateString
string - DateString
string - DateDisplay
string - TagIds
array of integer - LabelsInString
string - IsNew
boolean - IsAnswered
boolean - IsForwarded
boolean - TextBodyOnly
boolean - Size
integerformat: int64 - EMLLink
string - StreamId
string - RestoreFolderId
enum of integerformat: int32 [0 - Sending, 1 - Inbox, 2 - Sent, 3 - Draft, 4 - Trash, 5 - Spam, 6 - UserFolder, 7 - Templates]
Can be one of:
Sending,Inbox,Sent,Draft,Trash,Spam,UserFolder,Templates.- Folder
enum of integerformat: int32 [0 - Sending, 1 - Inbox, 2 - Sent, 3 - Draft, 4 - Trash, 5 - Spam, 6 - UserFolder, 7 - Templates]
Can be one of:
Sending,Inbox,Sent,Draft,Trash,Spam,UserFolder,Templates.- UserFolderId
array of integer - ChainLength
integerformat: int32 - WasNew
boolean - IsToday
boolean - IsYesterday
boolean - ReceivedDate
string - IsBodyCorrupted
boolean - HasParseError
boolean - MimeMessageId
string - MimeReplyToId
string - CalendarUid
string - ReadRequestStatus
boolean
401
Unauthorized