GET api/2.0/mail/conversations This function requires authentication

Description

Returns the conversations with the parameters specified in the request.

Parameters

Name	Description	Type	Example
folder sent in url	Folder type: 1 - inbox, 2 - sent, 3 - drafts, 4 - trash, 5 - spam optional	number	1234
unread sent in url	Conversation status: unread (true), read (false), or all (null) messages optional	Bool value	true
attachments sent in url	Defines if a conversation has attachments or not: with attachments (true), without attachments (false), or all (null) messages optional	Bool value	true
period_from sent in url	Start search period date optional	number	1234
period_to sent in url	End search period date optional	number	1234
important sent in url	Specifies if only important conversations will be displayed or not optional	Bool value	true
from_address sent in url	Mail address from which the conversation messages were received optional	string	some text
to_address sent in url	Mail address to which the conversation messages were sent optional	string	some text
mailbox_id sent in url	Recipient mailbox ID optional	number	1234
tags sent in url	IDs of tags linked to the target conversation optional	Collection of numbers collection	1234
search sent in url	Text to search in the conversation bodies and subjects optional	string	some text
page_size sent in url	Number of conversations on the page optional	number	1234
sortorder sent in url	Sort order by date: "ascending" or "descending"	string	some text
from_date sent in url	Start date of conversation search optional	Date and Time	Roundtrip format: 2008-04-10T06-30-00.000Z
from_message sent in url	Message from which the conversations are searched optional	number	1234
with_calendar sent in url	Specifies if the conversations have a calendar or not optional	Bool value	true
user_folder_id sent in url	User folder ID optional	Bool value	true
prev_flag sent in url	Direction sort of the conversation list: true for previous, false for next optional	number	1234

Example

GET api/2.0/mail/conversations?folder=1234&unread=true&attachments=true&period_from=1234&period_to=1234&important=true&from_address=%22some+text%22&to_address=%22some+text%22&mailbox_id=1234&tags=%5b%0d%0a++1234%0d%0a%5d&search=%22some+text%22&page_size=1234&sortorder=%22some+text%22&from_date=%222008-04-10T06-30-00.000Z%22&from_message=1234&with_calendar=true&user_folder_id=true&prev_flag=1234
Host: yourportal.onlyoffice.com
Content-Type: application/json
Accept: application/json

Returns

List of filtered conversations

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>