Get Message | AgentMail | Documentation

{
  "inbox_id": "inbox_id",
  "thread_id": "thread_id",
  "message_id": "message_id",
  "labels": [
    "labels",
    "labels"
  ],
  "timestamp": "2024-01-15T09:30:00Z",
  "from": "from",
  "to": [
    "to",
    "to"
  ],
  "size": 1,
  "updated_at": "2024-01-15T09:30:00Z",
  "created_at": "2024-01-15T09:30:00Z",
  "reply_to": [
    "reply_to",
    "reply_to"
  ],
  "cc": [
    "cc",
    "cc"
  ],
  "bcc": [
    "bcc",
    "bcc"
  ],
  "subject": "subject",
  "preview": "preview",
  "text": "text",
  "html": "html",
  "extracted_text": "extracted_text",
  "extracted_html": "extracted_html",
  "attachments": [
    {
      "attachment_id": "attachment_id",
      "size": 1,
      "filename": "filename",
      "content_type": "content_type",
      "content_disposition": "inline",
      "content_id": "content_id"
    },
    {
      "attachment_id": "attachment_id",
      "size": 1,
      "filename": "filename",
      "content_type": "content_type",
      "content_disposition": "inline",
      "content_id": "content_id"
    }
  ],
  "in_reply_to": "in_reply_to",
  "calendar_event_id": "calendar_event_id",
  "references": [
    "references",
    "references"
  ],
  "headers": {
    "headers": "headers"
  },
  "agent_armor": {
    "status": "pending",
    "deadline_at": "2024-01-15T09:30:00Z",
    "started_at": "2024-01-15T09:30:00Z"
  }
}

CLI:

agentmail inboxes messages get --inbox-id <inbox_id> --message-id <message_id>

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

inbox_idstringRequired

The ID of the inbox.

message_idstringRequired

ID of message.

Response

This endpoint returns an object.

inbox_idstring

The ID of the inbox.

thread_idstring

ID of thread.

message_idstring

ID of message.

labelslist of strings

Labels of message.

timestampdatetime

Time at which message was sent or drafted.

fromstring

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

tolist of strings

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

sizeinteger

Size of message in bytes.

updated_atdatetime

Time at which message was last updated.

created_atdatetime

Time at which message was created.

reply_tolist of stringsOptional

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

cclist of stringsOptional

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

bcclist of stringsOptional

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

subjectstringOptional

Subject of message.

previewstringOptional

Text preview of message.

textstringOptional

Plain text body of message.

htmlstringOptional

HTML body of message.

extracted_textstringOptional

Extracted new text content.

extracted_htmlstringOptional

Extracted new HTML content.

attachmentslist of objectsOptional

Attachments in message.

in_reply_tostringOptional

ID of message being replied to.

calendar_event_idstringOptional

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. Calendar is in AgentMail Labs.

referenceslist of stringsOptional

IDs of previous messages in thread.

headersmap from strings to stringsOptional

Headers in message.

agent_armorobjectOptionalBeta

Agent Armor’s result for this message. Present only on messages received while Agent Armor was on for your organization. A scan starts pending and usually completes within seconds. message.security.completed is sent only for complete results, so a message still pending at deadline_at reads unavailable with no event.

Errors

404

Not Found Error