inboxes > messages

CLI:

agentmail inboxes messages get --inbox-id <inbox_id> --message-id <message_id>
get/v0/inboxes/{inbox_id}/messages/{message_id}

Request

  • Base URL
    https://api.agentmail.to
  • URL
    https://api.agentmail.to/v0/inboxes/{inbox_id}/messages/{message_id}
  • Auth
    HTTP bearer

Path parameters

inbox_idstring required

The ID of the inbox.

message_idstring required

ID of message.

Response

Response with status 200

inbox_idstring required

The ID of the inbox.

thread_idstring required

ID of thread.

message_idstring required

ID of message.

labelsstring[] required

Labels of message.

timestampstring date-time required

Time at which message was sent or drafted.

fromstring required

Address of sender. In format username@domain.com or Display Name <username@domain.com>.

reply_tostring[]

Reply-to addresses. In format username@domain.com or Display Name <username@domain.com>.

tostring[] required

Addresses of recipients. In format username@domain.com or Display Name <username@domain.com>.

ccstring[]

Addresses of CC recipients. In format username@domain.com or Display Name <username@domain.com>.

bccstring[]

Addresses of BCC recipients. In format username@domain.com or Display Name <username@domain.com>.

subjectstring

Subject of message.

previewstring

Text preview of message.

textstring

Plain text body of message.

htmlstring

HTML body of message.

extracted_textstring

Extracted new text content.

extracted_htmlstring

Extracted new HTML content.

in_reply_tostring

ID of message being replied to.

calendar_event_idstring

The calendar event this email's invitation was applied to: set when the email's calendar invitation, update, cancellation or attendee reply changed the inbox's calendar, a few seconds after the email arrives. For an email about one date of a recurring event, it is that date's event ID. Absent on other emails, and on invitations that were not imported. The message.received event for an email with a calendar attachment waits until this is set, at most 20 seconds, so it usually arrives with it. Calendar is available in US production.

referencesstring[]

IDs of previous messages in thread.

headersMessagesMessageHeaders

Headers in message. Authentication-Results is never included, on received or sent messages: the header is unsigned, so a sender can plant a forged copy. Read authentication_results for the verdicts instead. Get Raw Message still returns every copy of the header.

sizeinteger required

Size of message in bytes.

updated_atstring date-time required

Time at which message was last updated.

created_atstring date-time required

Time at which message was created.

Changes

    • info

      the endpoint scheme security Bearer was added to the API

    • info

      the endpoint scheme security BearerAuth was removed from the API

    • info

      api tag inboxes > messages added

    • info

      api tag InboxesMessages removed

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status