Get message summary | mailpit unofficial

1 parameter

IDstringrequired

Message database ID or "latest"

3 status codes

200Message

Attachmentsarray<object>optional

Message attachments

Bccarray<AddressRepresentsASingleMailAddress>optional

Bcc addresses

Ccarray<AddressRepresentsASingleMailAddress>optional

Cc addresses

Datestringoptional

Message RFC3339Nano date & time (if set), else date & time received ([extended RFC3339](https://tools.ietf.org/html/rfc3339#section-5.6) format with optional nano seconds)

Fromobjectoptional

An address such as "Barry Gibbs <bg@example.com>" is represented as Address{Name: "Barry Gibbs", Address: "bg@example.com"}.

HTMLstringoptional

Message body HTML

IDstringoptional

Database ID

Inlinearray<object>optional

Inline message attachments

ListUnsubscribeobjectoptional

ListUnsubscribe contains a summary of List-Unsubscribe & List-Unsubscribe-Post headers including validation of the link structure

MessageIDstringoptional

Message ID

ReplyToarray<AddressRepresentsASingleMailAddress>optional

ReplyTo addresses

ReturnPathstringoptional

Return-Path

Sizeintegeroptional

Message size in bytes

Subjectstringoptional

Message subject

Tagsarray<string>optional

Message tags

Textstringoptional

Message body text

Toarray<AddressRepresentsASingleMailAddress>optional

To addresses

Usernamestringoptional

Username used for authentication (if provided) with the SMTP or Send API

400Server error will return with a 400 status code with the error message in the body

404Not found error will return a 404 status code

Error handling

A 400 is returned: Server error will return with a 400 status code with the error message in the body. A 404 is returned: Not found error will return a 404 status code.

import { Client } from "acme-sdk";

const client = new Client({
  baseUrl: "https://api.acme.com",
});

const result = await client.message.get({ iD: "c0a80123-4567-89ab-cdef-0123456789ab" });

{
  "Attachments": [
    {
      "Checksums": {
        "MD5": "example_value",
        "SHA1": "example_value",
        "SHA256": "example_value"
      },
      "ContentID": "550e8400-e29b-41d4-a716-446655440000",
      "ContentType": "example_value",
      "FileName": "Example Name",
      "PartID": "550e8400-e29b-41d4-a716-446655440000",
      "Size": 1
    }
  ],
  "Bcc": [
    {
      "Address": "example_value",
      "Name": "Example Name"
    }
  ],
  "Cc": [
    {
      "Address": "example_value",
      "Name": "Example Name"
    }
  ],
  "Date": "2026-01-15T09:00:00Z",
  "From": {
    "Address": "example_value",
    "Name": "Example Name"
  },
  "HTML": "example_value",
  "ID": "550e8400-e29b-41d4-a716-446655440000",
  "Inline": [
    {
      "Checksums": {
        "MD5": "example_value",
        "SHA1": "example_value",
        "SHA256": "example_value"
      },
      "ContentID": "550e8400-e29b-41d4-a716-446655440000",
      "ContentType": "example_value",
      "FileName": "Example Name",
      "PartID": "550e8400-e29b-41d4-a716-446655440000",
      "Size": 1
    }
  ],
  "ListUnsubscribe": {
    "Errors": "example_value",
    "Header": "example_value",
    "HeaderPost": "example_value",
    "Links": [
      "https://example.com"
    ]
  },
  "MessageID": "550e8400-e29b-41d4-a716-446655440000",
  "ReplyTo": [
    {
      "Address": "example_value",
      "Name": "Example Name"
    }
  ],
  "ReturnPath": "example_value",
  "Size": 1,
  "Subject": "Example Subject",
  "Tags": [
    "example_value"
  ],
  "Text": "example_value",
  "To": [
    {
      "Address": "example_value",
      "Name": "Example Name"
    }
  ],
  "Username": "janedoe"
}

Request

Response

Errors