List a message's attachments

GET/api/v1/mailbox/messages/{message_id}/attachments
Requires amailbox token— it acts as one mailbox holder, not as the organization.

Errors

Status When
401 No token, or the session expired or was signed out. Sign in again with POST /mailbox-auth/login.
403 The account has a temporary password: until POST /security/password succeeds, every other call answers this with error_code: password_change_required.
404 Message not found.

Parameters

NameInTypeDescription
message_idrequiredpathstring

Request

GET/api/v1/mailbox/messages/{message_id}/attachments
curl -X GET 'https://courier.mailyte.com/api/v1/mailbox/messages/01JBT8XQ2M9WYC3K4F6R7S8T9V/attachments' \
  -H 'Authorization: Bearer MAILBOX_TOKEN'

Response

Successful Response

  • dataarray<object>
    • indexinteger

      Position in the message; pass it to the attachment download.

    • namestring
    • typestring

      MIME type, e.g. application/pdf.

    • sizeinteger

      Bytes.

    • is_inlineboolean

      An image shown inside the body (a cid: reference) rather than a file.

    • content_idstring or null

      The cid: the body refers to, for inline images.

200application/json
{
  "type": "success",
  "msg": "Attachments retrieved successfully",
  "data": [
    {
      "index": 1,
      "name": "q3-figures.pdf",
      "type": "application/pdf",
      "size": 248311,
      "is_inline": false,
      "content_id": null
    }
  ]
}

Returned inside the standard envelope.

Errors

StatusWhen
401No token, or the session expired or was signed out. Sign in again with `POST /mailbox-auth/login`.
403The account has a temporary password: until `POST /security/password` succeeds, every other call answers this with `error_code: password_change_required`.
404Message not found.
422Validation Error

Every status, with what causes it and what to do, is on the error reference.