Skip to content
Optiwork API Docs

Read a single message

GET
/mail/mailboxes/{mailbox}/messages/{messageId}/reader
curl --request GET \
  --url https://mail.work.optidata.cloud/api/mail/mailboxes/78/messages/4186/reader \
  --header 'Authorization: Bearer <token>'

The full message record plus its rendered body, in the same shape the conversation reader returns for each of its entries. Attachments come back with a ready-to-use, signed url — see the attachment download endpoint.

Authorizations

Section titled “Authorizations”

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “Path Parameters”
mailbox
required
integer

Id of the mailbox. Every mailbox the caller may use is listed in their account.

messageId
required
string

Id of the message.

Responses

Section titled “ Responses ”

200

Section titled “200”

The message with its rendered body.

Media typeapplication/json

A message together with its rendered, sanitised HTML body.

object
message
required

A message as it appears inside a listing or a thread.

object
id
string | integer
date
string
subject
string | null
fragment
string | null
conversationId
string | integer | null
messageIdHeader

The RFC 5322 Message-ID header.

string | null
sizeBytes
integer | null
folderId
string | integer | null
flags

The state of a message or thread, as a set of booleans.

object
isUnread
boolean
isFlagged

The user starred it.

boolean
hasAttachment
boolean
isReplied
boolean
isSentByMe
boolean
isForwarded
boolean
isInvite

It carries a calendar invitation.

boolean
isDraft
boolean
isDeleted
boolean
isNotificationSent

A read receipt was requested.

boolean
isUrgent
boolean
isLowPriority
boolean
isPriority
boolean
participants

The addresses of a message, grouped by role.

object
from
Array<object>

One participant of a message.

object
name

Display name, when one is known.

string | null
email
string format: email
type

The role the address plays: f sender, t recipient, c carbon copy, b blind copy, r reply-to.

string | null
to
Array<object>

One participant of a message.

object
name

Display name, when one is known.

string | null
email
string format: email
type

The role the address plays: f sender, t recipient, c carbon copy, b blind copy, r reply-to.

string | null
cc
Array<object>

One participant of a message.

object
name

Display name, when one is known.

string | null
email
string format: email
type

The role the address plays: f sender, t recipient, c carbon copy, b blind copy, r reply-to.

string | null
bcc
Array<object>

One participant of a message.

object
name

Display name, when one is known.

string | null
email
string format: email
type

The role the address plays: f sender, t recipient, c carbon copy, b blind copy, r reply-to.

string | null
replyTo
Array<object>

One participant of a message.

object
name

Display name, when one is known.

string | null
email
string format: email
type

The role the address plays: f sender, t recipient, c carbon copy, b blind copy, r reply-to.

string | null
sender
Array<object>

One participant of a message.

object
name

Display name, when one is known.

string | null
email
string format: email
type

The role the address plays: f sender, t recipient, c carbon copy, b blind copy, r reply-to.

string | null
notification
Array<object>

One participant of a message.

object
name

Display name, when one is known.

string | null
email
string format: email
type

The role the address plays: f sender, t recipient, c carbon copy, b blind copy, r reply-to.

string | null
resentFrom
Array<object>

One participant of a message.

object
name

Display name, when one is known.

string | null
email
string format: email
type

The role the address plays: f sender, t recipient, c carbon copy, b blind copy, r reply-to.

string | null
body

Left empty in listings; read the body with a reader operation.

Array
attachments
Array<object>

A file carried by a message.

object
part

MIME part number, used to download it.

string | integer
filename
string | null
contentType
string | null
contentId

The cid an inline image is referenced by inside the body.

string | null
disposition

attachment or inline.

string | null
hasExplicitAttachmentDisposition
boolean
fallbackOrdinal

Position used to name a file that arrived without one.

integer | null
sizeBytes
integer | null
icon

Icon hint for a file-type badge.

string | null
url

Signed download link, populated by the reader operations. Use it as-is.

string | null
inlineAttachments
Array<object>

A file carried by a message.

object
part

MIME part number, used to download it.

string | integer
filename
string | null
contentType
string | null
contentId

The cid an inline image is referenced by inside the body.

string | null
disposition

attachment or inline.

string | null
hasExplicitAttachmentDisposition
boolean
fallbackOrdinal

Position used to name a file that arrived without one.

integer | null
sizeBytes
integer | null
icon

Icon hint for a file-type badge.

string | null
url

Signed download link, populated by the reader operations. Use it as-is.

string | null
tagIds
Array<string | integer>
invite

The calendar invitation carried by the message, when there is one.

object | null
share

The folder-sharing offer carried by the message, when there is one.

object | null
body
required

Sanitised HTML, ready to render.

string | null
Example
{
  "message": {
    "id": "4186",
    "participants": {
      "from": [
        {
          "name": "Jane Doe",
          "email": "jane.doe@acme.example",
          "type": "f"
        }
      ],
      "to": [
        {
          "name": "Jane Doe",
          "email": "jane.doe@acme.example",
          "type": "f"
        }
      ],
      "cc": [
        {
          "name": "Jane Doe",
          "email": "jane.doe@acme.example",
          "type": "f"
        }
      ],
      "bcc": [
        {
          "name": "Jane Doe",
          "email": "jane.doe@acme.example",
          "type": "f"
        }
      ],
      "replyTo": [
        {
          "name": "Jane Doe",
          "email": "jane.doe@acme.example",
          "type": "f"
        }
      ],
      "sender": [
        {
          "name": "Jane Doe",
          "email": "jane.doe@acme.example",
          "type": "f"
        }
      ],
      "notification": [
        {
          "name": "Jane Doe",
          "email": "jane.doe@acme.example",
          "type": "f"
        }
      ],
      "resentFrom": [
        {
          "name": "Jane Doe",
          "email": "jane.doe@acme.example",
          "type": "f"
        }
      ]
    },
    "attachments": [
      {
        "part": "2",
        "filename": "report.docx",
        "contentType": "application/pdf",
        "disposition": "attachment"
      }
    ],
    "inlineAttachments": [
      {
        "part": "2",
        "filename": "report.docx",
        "contentType": "application/pdf",
        "disposition": "attachment"
      }
    ]
  }
}

401

Section titled “401”

Missing, malformed or expired authentication key.

Media typeapplication/json

Authentication failures use an error key rather than message.

object
error
required
string
Examples
Examplemissing

No bearer token sent

{
  "error": "JWT passport exception: Missing bearer token in request"
}

403

Section titled “403”

The caller may not act on this mailbox, user or resource.

Media typeapplication/json

Generic error envelope used by policy, binding and framework failures.

object
message
required

Human-readable description of the failure.

string
Examples
Exampledenied
{
  "message": "This action is unauthorized."
}

429

Section titled “429”

Rate limit exceeded. Retry after the window resets.

Media typeapplication/json

Generic error envelope used by policy, binding and framework failures.

object
message
required

Human-readable description of the failure.

string
Examples
Examplethrottled
{
  "message": "Too Many Attempts."
}

502

Section titled “502”

The mail platform did not answer as expected — a folder or message that does not exist, or a transient failure. reference is the code to quote to support and fault_code names the underlying condition. A 503 with the same envelope means the platform is in maintenance; retry shortly.

Media typeapplication/json

Failure raised by the mail platform behind the API rather than by the request itself.

object
error
required

What went wrong, phrased for the end user.

string
status
required

Repeats the HTTP status code.

integer
help
required

Suggested next step.

string
reference
required

Support reference, e.g. MZ-502.

string
fault_code

Names the underlying condition, e.g. mail.NO_SUCH_FOLDER.

string | null
Examples

Unknown folder

{
  "error": "The mail server did not answer as expected, so this action could not be completed.",
  "status": 502,
  "help": "If the problem persists, contact support and inform the error code above.",
  "reference": "MZ-502",
  "fault_code": "mail.NO_SUCH_FOLDER"
}