Messages

Name:

from

required

Type:

query

Data Type:

string

Description:

Start date in a date range. Only yyyy-MM-dd'T'hh:mm:ss'Z' and yyyy-MM-dd'T'hh:mm:ss+hh:mm, which are part of the ISO 8601 standard, are supported. For example, 2015-10-01T17:53:03Z, where Z indicates that the date is in UTC with a zero offset.

Sample Value: 2017-01-01T01:01:01Z

Name:

to

required

Type:

query

Data Type:

string

Description:

End date in a date range. Only yyyy-MM-dd'T'hh:mm:ss'Z' and yyyy-MM-dd'T'hh:mm:ss+hh:mm, which are part of the ISO 8601 standard, are supported. For example, 2015-10-01T17:53:03+12:00, where +12:00 indicates that the time has 12 hours added to it to represent the local time (2015-10-01T05:53:03Z = 2015-10-01T17:53:03+12:00).

Sample Value: 2017-01-01T01:01:01Z

Name:

page

required

Type:

query

Data Type:

number

Description:

Page number to retrieve (the first page is given a value of 1). If page is not provided, it defaults to 0. For pagination to work, you must specify both page and perPage.

Sample Value: 1

Name:

perPage

required

Type:

query

Data Type:

number

Description:

Number of messages per page. Must be greater than 0. If perPage is not provided, it defaults to 0. For pagination to work, you must specify both perPage and page.

Sample Value: 20

Name:

sort

required

Type:

query

Data Type:

string

Description:

Sorting method to use -- RECENT, OLDEST, UNREAD, STARRED, SENDER and RECIPIENT. If sort is not provided, it defaults to RECENT.

Sample Value: OLDEST

Name:

preview

optional

Type:

query

Data Type:

boolean

Description:

Whether the payload should contain a 50-character preview of each message body.

Name:

search

optional

Type:

query

Data Type:

string

Description:

Search string to filter the messages returned. If the search string is not provided, no filtering is applied to the list of messages returned. See Constructing an Advanced Search (https://doki.orionhealth.com/display/DSM2/Find+a+Message+in+a+Folder#FindaMessageinaFolder-ConstructinganAdvancedSearch) to learn more.

Sample Value: OLDEST

Name:

mailboxAddress

required

Type:

path

Data Type:

string

Description:

URL-encoded address of the mailbox.

Sample Value: developer.portal@example.com

Name:

folderPath

required

Type:

path

Data Type:

string

Description:

URL-encoded path of the folder or sub-folder. A period (.) separates the sub-folder from the folder.

Sample Value: Inbox

Name:

body

required

Type:

body

Data Type:

Description:

Body of the request.

Sample Payload:

{
  "folderPath": "Trash",
  "messageUidList": [
    "1",
    "2",
    "3"
  ]
}

Name:

mailboxAddress

required

Type:

path

Data Type:

string

Description:

URL-encoded address of the mailbox.

Sample Value: developer.portal@example.com

Name:

folderPath

required

Type:

path

Data Type:

string

Description:

URL-encoded path of the folder or sub-folder. A period (.) separates the sub-folder from the folder.

Sample Value: Inbox

Name:

body

required

Type:

body

Data Type:

Description:

Body of the request.

Sample Payload:

{
  "messageUidList": [
    "4",
    "5",
    "6"
  ]
}

Name:

mailboxAddress

required

Type:

path

Data Type:

string

Description:

URL-encoded address of the mailbox.

Sample Value: developer.portal@example.com

Name:

folderPath

required

Type:

path

Data Type:

string

Description:

URL-encoded path of the folder or sub-folder. A period (.) separates the sub-folder from the folder.

Sample Value: Inbox

Name:

messageUid

required

Type:

path

Data Type:

string

Description:

Unique identifier of the message.

Sample Value: 1

Name:

mailboxAddress

required

Type:

path

Data Type:

string

Description:

URL-encoded address of the mailbox.

Sample Value: developer.portal@example.com

Name:

folderPath

required

Type:

path

Data Type:

string

Description:

URL-encoded path of the folder or sub-folder. A period (.) separates the sub-folder from the folder.

Sample Value: Inbox

Name:

messageUid

required

Type:

path

Data Type:

string

Description:

Unique identifier of the draft message. Every time you update a draft, the old unique identifier is deleted and a new identifier is assigned.

Sample Value: 1

Name:

body

required

Type:

body

Data Type:

Description:

Body of the request.

Sample Payload:

{
  "to": [
    {
      "name": "example",
      "address": "example.portal@example.com"
    }
  ],
  "cc": [],
  "subject": "create draft example",
  "messageType": "FORWARD",
  "draft": true,
  "priority": "normal",
  "attachmentGroupId": null,
  "attachmentInfo": [],
  "content": {
    "alternatives": [
      {
        "contentType": "text/html",
        "value": "
example text inside draft email
"
      }
    ]
  },
  "draftMessageDescriptor": {
    "folderDescriptor": {
      "mailboxDescriptor": {
        "providerIdentifier": "DIRECT",
        "mailboxIdentifier": "example.provider@example.com",
        "mailboxName": null,
        "shared": false,
        "sharingType": null
      },
      "path": "Drafts",
      "role": "DRAFTS"
    },
    "messageUid": "2"
  },
  "patientIdentifier": null,
  "ccdaTransmission": false
}

Name:

mailboxAddress

required

Type:

path

Data Type:

string

Description:

URL-encoded address of the mailbox.

Sample Value: developer.portal@example.com

Name:

folderPath

required

Type:

path

Data Type:

string

Description:

URL-encoded path of the folder or sub-folder. A period (.) separates the sub-folder from the folder.

Sample Value: Inbox

Name:

messageUid

required

Type:

path

Data Type:

string

Description:

Unique identifier of the message.

Sample Value: 12

Name:

mailboxAddress

required

Type:

path

Data Type:

string

Description:

URL-encoded address of the mailbox.

Sample Value: developer.portal@example.com

Name:

folderPath

required

Type:

path

Data Type:

string

Description:

URL-encoded path of the folder or sub-folder. A period (.) separates the sub-folder from the folder.

Sample Value: Inbox

Name:

messageUid

required

Type:

path

Data Type:

string

Description:

Unique identifier of the message.

Sample Value: 1234

Name:

body

required

Type:

body

Data Type:

Description:

Body of the request.

Sample Payload:

{
  "flagged": true,
  "read": false
}

Name:

mailboxAddress

required

Type:

path

Data Type:

string

Description:

URL-encoded address of the mailbox.

Sample Value: developer.portal@example.com

Name:

folderPath

required

Type:

path

Data Type:

string

Description:

URL-encoded path of the folder or sub-folder. A period (.) separates the sub-folder from the folder.

Sample Value: Inbox

Name:

messageUid

required

Type:

path

Data Type:

string

Description:

Unique identifier of the message.

Sample Value: 1234

Name:

body

required

Type:

body

Data Type:

Description:

Body of the request.

Sample Payload:

{
  "attachmentGroupId": "file_group_yui_3_17_2_1_1440995359278_225",
  "attachmentIdPrefix": "referencedMessageAttachment-",
  "isTransferOfCare": false
}

Name:

mailboxAddress

required

Type:

path

Data Type:

string

Description:

URL-encoded address of the mailbox.

Sample Value: developer.portal@example.com

Name:

folderPath

required

Type:

path

Data Type:

string

Description:

URL-encoded path of the folder or sub-folder. A period (.) separates the sub-folder from the folder.

Sample Value: Inbox

Name:

messageUid

required

Type:

path

Data Type:

string

Description:

Unique identifier of the message.

Sample Value: 12

Name:

attachmentIndex

required

Type:

path

Data Type:

string

Description:

Order in which the file is attached to the message.

Sample Value: 2

Name:

mailboxAddress

required

Type:

path

Data Type:

string

Description:

URL-encoded address of the mailbox.

Sample Value: developer.portal@example.com

Name:

folderPath

required

Type:

path

Data Type:

string

Description:

URL-encoded path of the folder or sub-folder. A period (.) separates the sub-folder from the folder.

Sample Value: Inbox