Get Message | AgentMail | Documentation

from agentmail import AgentMail
client = AgentMail(
    api_key="YOUR_TOKEN_HERE",
)
client.inboxes.messages.get(
    inbox_id="inbox_id",
    message_id="message_id",
)

{
  "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",
  "references": [
    "references",
    "references"
  ],
  "headers": {
    "headers": "headers"
  }
}

CLI:

$ agentmail inboxes:messages retrieve --inbox-id <inbox_id> --message-id <message_id>

**CLI:** ```bash agentmail inboxes:messages retrieve --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 strings

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

cclist of strings

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

bcclist of strings

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.

attachmentslist of objects

Attachments in message.

in_reply_tostring

ID of message being replied to.

referenceslist of strings

IDs of previous messages in thread.

headersmap from strings to strings

Headers in message.

Errors

404

Not Found Error