TRY NEW VERSION

Try now New API BETA

Try out the new view and capabilities of the API documentation

START

POST api/2.0/mail/filters/check This function requires authentication

Description

Checks the results of a filter specified in the request.

Parameters
Name Description Type Example
filter
sent in url
Filter parameters: ID, name, position, enabled, conditions, actions, options ASC.Mail.Data.Contracts.MailSieveFilterData
page
sent in url
Page number
optional
number 1234
pageSize
sent in url
Number of messages on the page
optional
number 1234
Example
POST api/2.0/mail/filters/check?filter=%7b%0d%0a++%22id%22%3a+1%2c%0d%0a++%22name%22%3a+%22name%22%2c%0d%0a++%22position%22%3a+2%2c%0d%0a++%22enabled%22%3a+true%2c%0d%0a++%22conditions%22%3a+%5b%0d%0a++++%7b%0d%0a++++++%22key%22%3a+1%2c%0d%0a++++++%22operation%22%3a+1%2c%0d%0a++++++%22value%22%3a+%22value%22%0d%0a++++%7d%0d%0a++%5d%2c%0d%0a++%22actions%22%3a+%5b%0d%0a++++%7b%0d%0a++++++%22action%22%3a+1%2c%0d%0a++++++%22data%22%3a+%22data%22%0d%0a++++%7d%0d%0a++%5d%2c%0d%0a++%22options%22%3a+%5b%0d%0a++++%7b%0d%0a++++++%22matchMultiConditions%22%3a+1%2c%0d%0a++++++%22applyTo%22%3a+%7b%0d%0a++++++++%22folders%22%3a+%5b%0d%0a++++++++++1%0d%0a++++++++%5d%2c%0d%0a++++++++%22mailboxes%22%3a+%5b%0d%0a++++++++++1%0d%0a++++++++%5d%2c%0d%0a++++++++%22withAttachments%22%3a+1%0d%0a++++++%7d%2c%0d%0a++++++%22ignoreOther%22%3a+true%0d%0a++++%7d%0d%0a++%5d%0d%0a%7d&page=1234&pageSize=1234
Host: yourportal.onlyoffice.com
Content-Type: application/json
Accept: application/json
Returns

List of messages

Example Response

application/json

{
  "status": 0,
  "response": [
    {
      "Attachments": [
        {
          "fileId": 1234,
          "fileName": "fileName",
          "size": 1234,
          "contentType": "contentType",
          "needSaveToTemp": true,
          "contentId": "contentId",
          "fileNumber": 333,
          "storedName": "storedName",
          "streamId": "streamId",
          "savedToMyDocuments": true,
          "tempStoredUrl": "tempStoredUrl"
        }
      ],
      "Introduction": "Introduction",
      "HtmlBody": "HtmlBody",
      "ContentIsBlocked": true,
      "Important": true,
      "Subject": "Subject",
      "HasAttachments": true,
      "Bcc": "Bcc",
      "Cc": "Cc",
      "To": "To",
      "Address": "Address",
      "From": "From",
      "ReplyTo": "ReplyTo",
      "Id": 555,
      "ChainId": "ChainId",
      "ChainDate": "ChainDate",
      "Date": "Date",
      "DateDisplay": "DateDisplay",
      "TagIds": [
        1234
      ],
      "LabelsInString": "LabelsInString",
      "IsNew": true,
      "IsAnswered": true,
      "IsForwarded": true,
      "TextBodyOnly": true,
      "Size": 555555,
      "EMLLink": "EMLLink",
      "StreamId": "StreamId",
      "RestoreFolderId": 1,
      "Folder": 1,
      "UserFolderId": 144,
      "ChainLength": 144,
      "WasNew": false,
      "IsToday": false,
      "IsYesterday": false,
      "ReceivedDate": "2020-12-18T08:12:09.1209967Z",
      "IsBodyCorrupted": false,
      "HasParseError": false,
      "MimeMessageId": "MimeMessageId",
      "MimeReplyToId": "MimeReplyToId",
      "CalendarUid": "CalendarUid"
    }
  ]
}

text/xml

<result>
  <status>0</status>
  <response>
    <Attachments>
      <fileId>1234</fileId>
      <fileName>fileName</fileName>
      <size>1234</size>
      <contentType>contentType</contentType>
      <needSaveToTemp>True</needSaveToTemp>
      <contentId>contentId</contentId>
      <fileNumber>333</fileNumber>
      <storedName>storedName</storedName>
      <streamId>streamId</streamId>
      <savedToMyDocuments>True</savedToMyDocuments>
      <tempStoredUrl>tempStoredUrl</tempStoredUrl>
    </Attachments>
    <Introduction>Introduction</Introduction>
    <HtmlBody>HtmlBody</HtmlBody>
    <ContentIsBlocked>True</ContentIsBlocked>
    <Important>True</Important>
    <Subject>Subject</Subject>
    <HasAttachments>True</HasAttachments>
    <Bcc>Bcc</Bcc>
    <Cc>Cc</Cc>
    <To>To</To>
    <Address>Address</Address>
    <From>From</From>
    <ReplyTo>ReplyTo</ReplyTo>
    <Id>555</Id>
    <ChainId>ChainId</ChainId>
    <ChainDate>ChainDate</ChainDate>
    <Date>Date</Date>
    <DateDisplay>DateDisplay</DateDisplay>
    <TagIds>1234</TagIds>
    <LabelsInString>LabelsInString</LabelsInString>
    <IsNew>True</IsNew>
    <IsAnswered>True</IsAnswered>
    <IsForwarded>True</IsForwarded>
    <TextBodyOnly>True</TextBodyOnly>
    <Size>555555</Size>
    <EMLLink>EMLLink</EMLLink>
    <StreamId>StreamId</StreamId>
    <RestoreFolderId>1</RestoreFolderId>
    <Folder>1</Folder>
    <UserFolderId>144</UserFolderId>
    <ChainLength>144</ChainLength>
    <WasNew>False</WasNew>
    <IsToday>False</IsToday>
    <IsYesterday>False</IsYesterday>
    <ReceivedDate>2020-12-18T08:12:09.1209967Z</ReceivedDate>
    <IsBodyCorrupted>False</IsBodyCorrupted>
    <HasParseError>False</HasParseError>
    <MimeMessageId>MimeMessageId</MimeMessageId>
    <MimeReplyToId>MimeReplyToId</MimeReplyToId>
    <CalendarUid>CalendarUid</CalendarUid>
  </response>
</result>