Messages

Inspect captured emails

Interactions with messages

Show email message

get

Get email message by ID.

Authorizations

Api-TokenstringRequired

Pass the API token in the Api-Token

Path parameters

account_idinteger · int64 · min: 1Required

Unique account ID

Example: 3229

inbox_idinteger · int64 · min: 1Required

Unique inbox ID

Example: 4015

message_idinteger · int64 · min: 1Required

Unique message ID

Example: 427

Responses

200

Returns email message with its attributes.

application/json

Responseone of

401

Returns unauthorized error message. Check your credentials.

application/json

403

Returns forbidden error message. Check your permissions.

application/json

404

Returns not found error message

application/json

get

/api/accounts/{account_id}/inboxes/{inbox_id}/messages/{message_id}

const { MailtrapClient } = require("mailtrap");

const TOKEN = "YOUR_API_KEY";
const ACCOUNT_ID = "YOUR_ACCOUNT_ID";

const client = new MailtrapClient({ token: TOKEN, accountId: ACCOUNT_ID });

const inboxId = 12345;
const messageId = 67890;

const message = await client.testing.messages.showEmailMessage(inboxId, messageId);

console.log(message);

{
  "id": 2323,
  "inbox_id": 17002,
  "subject": "Test email",
  "sent_at": "2022-07-01T19:29:59.295Z",
  "from_email": "[email protected]",
  "from_name": "John",
  "to_email": "[email protected]",
  "to_name": "Mary",
  "email_size": 300,
  "is_read": false,
  "created_at": "2022-07-01T19:29:59.295Z",
  "updated_at": "2022-07-01T19:29:59.295Z",
  "html_body_size": 150,
  "text_body_size": 100,
  "human_size": "300 Bytes",
  "html_path": "/api/accounts/16297/inboxes/17002/messages/2323/body.html",
  "txt_path": "/api/accounts/16297/inboxes/17002/messages/2323/body.txt",
  "raw_path": "/api/accounts/16297/inboxes/17002/messages/2323/body.raw",
  "download_path": "/api/accounts/16297/inboxes/17002/messages/2323/body.eml",
  "html_source_path": "/api/accounts/16297/inboxes/17002/messages/2323/body.htmlsource",
  "blacklists_report_info": false,
  "smtp_information": {
    "ok": true,
    "data": {
      "mail_from_addr": "[email protected]",
      "client_ip": "193.62.62.184"
    }
  }
}

Delete message

delete

Delete message from inbox.

Authorizations

Api-TokenstringRequired

Pass the API token in the Api-Token

Path parameters

account_idinteger · int64 · min: 1Required

Unique account ID

Example: 3229

inbox_idinteger · int64 · min: 1Required

Unique inbox ID

Example: 4015

message_idinteger · int64 · min: 1Required

Unique message ID

Example: 427

Responses

200

Returns attributes of the deleted message.

application/json

401

Returns unauthorized error message. Check your credentials.

application/json

403

Returns forbidden error message. Check your permissions.

application/json

404

Returns not found error message

application/json

delete

/api/accounts/{account_id}/inboxes/{inbox_id}/messages/{message_id}

const { MailtrapClient } = require("mailtrap");

const TOKEN = "YOUR_API_KEY";
const ACCOUNT_ID = "YOUR_ACCOUNT_ID";

const client = new MailtrapClient({ token: TOKEN, accountId: ACCOUNT_ID });

const inboxId = 12345;
const messageId = 67890;

const result = await client.testing.messages.deleteMessage(inboxId, messageId);

console.log(result);

{
  "id": 433,
  "inbox_id": 4338,
  "subject": "Test email",
  "sent_at": "2022-06-02T19:24:10.746Z",
  "from_email": "[email protected]",
  "from_name": "John",
  "to_email": "[email protected]",
  "to_name": "Mary",
  "email_size": 300,
  "is_read": false,
  "created_at": "2022-06-02T19:24:10.747Z",
  "updated_at": "2022-06-02T19:24:10.747Z",
  "html_body_size": 150,
  "text_body_size": 100,
  "human_size": "300 Bytes",
  "html_path": "/api/accounts/3775/inboxes/4338/messages/433/body.html",
  "txt_path": "/api/accounts/3775/inboxes/4338/messages/433/body.txt",
  "raw_path": "/api/accounts/3775/inboxes/4338/messages/433/body.raw",
  "download_path": "/api/accounts/3775/inboxes/4338/messages/433/body.eml",
  "html_source_path": "/api/accounts/3775/inboxes/4338/messages/433/body.htmlsource",
  "blacklists_report_info": false,
  "smtp_information": {
    "ok": true,
    "data": {
      "mail_from_addr": "[email protected]",
      "client_ip": "193.62.62.184"
    }
  }
}

Update message

patch

Update message attributes (right now only the is_read attribute is available for modification).

Authorizations

Api-TokenstringRequired

Pass the API token in the Api-Token

Path parameters

account_idinteger · int64 · min: 1Required

Unique account ID

Example: 3229

inbox_idinteger · int64 · min: 1Required

Unique inbox ID

Example: 4015

message_idinteger · int64 · min: 1Required

Unique message ID

Example: 427

Body

Responses

200

Returns attributes of the updated message.

application/json

401

Returns unauthorized error message. Check your credentials.

application/json

403

Returns forbidden error message. Check your permissions.

application/json

404

Returns not found error message

application/json

patch

/api/accounts/{account_id}/inboxes/{inbox_id}/messages/{message_id}

const { MailtrapClient } = require("mailtrap");

const TOKEN = "YOUR_API_KEY";
const ACCOUNT_ID = "YOUR_ACCOUNT_ID";

const client = new MailtrapClient({ token: TOKEN, accountId: ACCOUNT_ID });

const inboxId = 12345;
const messageId = 67890;

const updatedMessage = await client.testing.messages.updateMessage(
  inboxId,
  messageId,
  { isRead: true }
);

console.log(updatedMessage);

{
  "id": 427,
  "inbox_id": 4324,
  "subject": "Test email",
  "sent_at": "2022-06-02T19:24:08.941Z",
  "from_email": "[email protected]",
  "from_name": "John",
  "to_email": "[email protected]",
  "to_name": "Mary",
  "email_size": 300,
  "is_read": false,
  "created_at": "2022-06-02T19:24:08.942Z",
  "updated_at": "2022-06-02T19:24:08.942Z",
  "html_body_size": 150,
  "text_body_size": 100,
  "human_size": "300 Bytes",
  "html_path": "/api/accounts/3761/inboxes/4324/messages/427/body.html",
  "txt_path": "/api/accounts/3761/inboxes/4324/messages/427/body.txt",
  "raw_path": "/api/accounts/3761/inboxes/4324/messages/427/body.raw",
  "download_path": "/api/accounts/3761/inboxes/4324/messages/427/body.eml",
  "html_source_path": "/api/accounts/3761/inboxes/4324/messages/427/body.htmlsource",
  "blacklists_report_info": false,
  "smtp_information": {
    "ok": true,
    "data": {
      "mail_from_addr": "[email protected]",
      "client_ip": "193.62.62.184"
    }
  }
}

Get messages

get

Get all messages in the inbox. The response contains up to 30 messages. Use last_id or page to retrieve more.

Authorizations

Api-TokenstringRequired

Pass the API token in the Api-Token

Path parameters

account_idinteger · int64 · min: 1Required

Unique account ID

Example: 3229

inbox_idinteger · int64 · min: 1Required

Unique inbox ID

Example: 4015

Query parameters

searchstringOptional

Search query string. Matches subject, to_email, and to_name.

Example: welcome

last_idnumber · min: 1Optional

If specified, a page of records before last_id is returned. Overrides page if both are given.

Example: 123

pagenumber · min: 1Optional

Page number for paginated results.

Example: 5

Responses

200

lists messages

application/json

401

Returns unauthorized error message. Check your credentials.

application/json

403

Returns forbidden error message. Check your permissions.

application/json

get

/api/accounts/{account_id}/inboxes/{inbox_id}/messages

import { MailtrapClient } from "mailtrap";

const client = new MailtrapClient({
  token: "YOUR_API_TOKEN",
  accountId: ACCOUNT_ID
});

const messages = await client.testing.messages.getList(inboxId);

messages.forEach(message => {
  console.log(`From: ${message.from_email}`);
  console.log(`Subject: ${message.subject}`);
  console.log(`Received: ${message.created_at}`);
});

[
  {
    "id": 92,
    "inbox_id": 342,
    "subject": "Test email",
    "sent_at": "2022-08-19T11:34:33.839Z",
    "from_email": "[email protected]",
    "from_name": "Ela Marks",
    "to_email": "[email protected]",
    "to_name": "Edmund Maggio",
    "email_size": 300,
    "is_read": false,
    "created_at": "2022-08-19T11:34:33.841Z",
    "updated_at": "2022-08-19T11:34:33.841Z",
    "html_body_size": 150,
    "text_body_size": 100,
    "human_size": "300 Bytes",
    "html_path": "/api/accounts/336/inboxes/342/messages/92/body.html",
    "txt_path": "/api/accounts/336/inboxes/342/messages/92/body.txt",
    "raw_path": "/api/accounts/336/inboxes/342/messages/92/body.raw",
    "download_path": "/api/accounts/336/inboxes/342/messages/92/body.eml",
    "html_source_path": "/api/accounts/336/inboxes/342/messages/92/body.htmlsource",
    "blacklists_report_info": false,
    "smtp_information": {
      "ok": true,
      "data": {
        "mail_from_addr": "[email protected]",
        "client_ip": "75.180.183.201"
      }
    }
  }
]

Forward message

post

Forward message to an email address. The email address must be confirmed by the recipient in advance.

Authorizations

Api-TokenstringRequired

Pass the API token in the Api-Token

Path parameters

account_idinteger · int64 · min: 1Required

Unique account ID

Example: 3229

inbox_idinteger · int64 · min: 1Required

Unique inbox ID

Example: 4015

message_idinteger · int64 · min: 1Required

Unique message ID

Example: 427

Body

emailstringOptionalExample: [email protected]

Responses

200

Returns confirmation about forwarding.

application/json

401

Returns unauthorized error message. Check your credentials.

application/json

403

Returns forbidden error message. Check your permissions.

application/json

404

Returns not found error message

application/json

post

/api/accounts/{account_id}/inboxes/{inbox_id}/messages/{message_id}/forward

const { MailtrapClient } = require("mailtrap");

const TOKEN = "YOUR_API_KEY";
const ACCOUNT_ID = "YOUR_ACCOUNT_ID";

const client = new MailtrapClient({ token: TOKEN, accountId: ACCOUNT_ID });

const inboxId = 12345;
const messageId = 67890;

const result = await client.testing.messages.forward(
  inboxId,
  messageId,
  '[email protected]'
);

console.log(result);

{
  "message": "Your email message has been successfully forwarded"
}

Get message spam score

get

Get a brief spam report by message ID.

Authorizations

Api-TokenstringRequired

Pass the API token in the Api-Token

Path parameters

account_idinteger · int64 · min: 1Required

Unique account ID

Example: 3229

inbox_idinteger · int64 · min: 1Required

Unique inbox ID

Example: 4015

message_idinteger · int64 · min: 1Required

Unique message ID

Example: 427

Responses

200

Returns message spam analysis report.

application/json

401

Returns unauthorized error message. Check your credentials.

application/json

403

Returns forbidden error message. Check your permissions.

application/json

404

Returns not found error message

application/json

get

/api/accounts/{account_id}/inboxes/{inbox_id}/messages/{message_id}/spam_report

const { MailtrapClient } = require("mailtrap");

const client = new MailtrapClient({ token: "YOUR_API_KEY", accountId: "YOUR_ACCOUNT_ID" });

const spamReport = await client.testing.messages.getSpamScore(12345, 67890);
console.log(spamReport);

{
  "report": {
    "ResponseCode": 2,
    "ResponseMessage": "Not spam",
    "ResponseVersion": "1.2",
    "Score": 1.2,
    "Spam": false,
    "Threshold": 5,
    "Details": [
      {
        "Pts": 0,
        "RuleName": "HTML_MESSAGE",
        "Description": "BODY: HTML included in message"
      }
    ]
  }
}

Get message HTML analysis

get

Get a brief HTML report by message ID.

Authorizations

Api-TokenstringRequired

Pass the API token in the Api-Token

Path parameters

account_idinteger · int64 · min: 1Required

Unique account ID

Example: 3229

inbox_idinteger · int64 · min: 1Required

Unique inbox ID

Example: 4015

message_idinteger · int64 · min: 1Required

Unique message ID

Example: 427

Responses

200

Returns message HTML analysis report.

application/json

401

Returns unauthorized error message. Check your credentials.

application/json

403

Returns forbidden error message. Check your permissions.

application/json

404

Returns not found error message

application/json

get

/api/accounts/{account_id}/inboxes/{inbox_id}/messages/{message_id}/analyze

const { MailtrapClient } = require("mailtrap");

const client = new MailtrapClient({ token: "YOUR_API_KEY", accountId: "YOUR_ACCOUNT_ID" });

const htmlAnalysis = await client.testing.messages.getHtmlAnalysis(12345, 67890);
console.log(htmlAnalysis);

{
  "report": {
    "status": "success",
    "errors": [
      {
        "error_line": 15,
        "rule_name": "style",
        "email_clients": {
          "desktop": [
            "Notes 6 / 7"
          ],
          "mobile": [
            "Gmail"
          ]
        }
      },
      {
        "error_line": 7,
        "rule_name": "display",
        "email_clients": {
          "desktop": [
            "AOL Desktop",
            "IBM Notes 9",
            "Outlook 2000–03",
            "Outlook 2007–16",
            "Outlook Express",
            "Postbox",
            "Windows 10 Mail",
            "Windows Live Mail"
          ],
          "mobile": [
            "Android 4.2.2 Mail",
            "Android 4.4.4 Mail",
            "BlackBerry",
            "Gmail Android app IMAP",
            "Google Inbox Android app",
            "Windows Phone 8 Mail",
            "Yahoo! Mail Android app",
            "Yahoo! Mail iOS app"
          ],
          "web": [
            "Yahoo! Mail"
          ]
        }
      }
    ]
  }
}

Get text message

get

Get text email body, if it exists.

Authorizations

Api-TokenstringRequired

Pass the API token in the Api-Token

Path parameters

account_idinteger · int64 · min: 1Required

Unique account ID

Example: 3229

inbox_idinteger · int64 · min: 1Required

Unique inbox ID

Example: 4015

message_idinteger · int64 · min: 1Required

Unique message ID

Example: 427

Responses

200

Returns message body in txt format.

text/plain

ResponsestringExample:

Congrats for sending test email with Mailtrap! Inspect it using the tabs above and learn how this email can be improved. Now send your email using our fake SMTP server and integration of your choice! Good luck! Hope it works.

401

Returns unauthorized error message. Check your credentials.

text/plain

403

Returns forbidden error message. Check your permissions.

text/plain

404

Returns not found error message

application/json

409

Returns conflict error message. Text body does not exist.

text/plain

get

/api/accounts/{account_id}/inboxes/{inbox_id}/messages/{message_id}/body.txt

const { MailtrapClient } = require("mailtrap");
const client = new MailtrapClient({ token: "YOUR_API_KEY", accountId: "YOUR_ACCOUNT_ID" });
const textBody = await client.testing.messages.getTextMessage(12345, 67890);
console.log(textBody);

Congrats for sending test email with Mailtrap!

Inspect it using the tabs above and learn how this email can be improved.
Now send your email using our fake SMTP server and integration of your choice!

Good luck! Hope it works.

Get raw message

get

Get raw email body.

Authorizations

Api-TokenstringRequired

Pass the API token in the Api-Token

Path parameters

account_idinteger · int64 · min: 1Required

Unique account ID

Example: 3229

inbox_idinteger · int64 · min: 1Required

Unique inbox ID

Example: 4015

message_idinteger · int64 · min: 1Required

Unique message ID

Example: 427

Responses

200

Returns raw message body.

text/plain

ResponsestringExample:

From: Magic Elves <[email protected]> To: Mailtrap Inbox <[email protected]> Subject: You are awesome! Content-Type: multipart/alternative; boundary="boundary-string" --boundary-string Content-Type: text/plain; charset="utf-8" Content-Transfer-Encoding: quoted-printable Content-Disposition: inline Congrats for sending test email with Mailtrap! Inspect it using the tabs above and learn how this email can be improved. Now send your email using our fake SMTP server and integration of your choice! Good luck! Hope it works. --boundary-string Content-Type: text/html; charset="utf-8" Content-Transfer-Encoding: quoted-printable Content-Disposition: inline <!doctype html> <html> <head> <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> </head> <body style="font-family: sans-serif;"> <div style="display: block; margin: auto; max-width: 600px;" class="main"> <h1 style="font-size: 18px; font-weight: bold; margin-top: 20px"> Congrats for sending test email with Mailtrap! </h1> <p>Inspect it using the tabs you see above and learn how this email can be improved.</p> <img alt="Inspect with Tabs" src="https://assets-examples.mailtrap.io/integration-examples/welcome.png" style="width: 100%;" > <p>Now send your email using our fake SMTP server and integration of your choice!</p> <p>Good luck! Hope it works.</p> </div> <!-- Example of invalid for email html/css, will be detected by Mailtrap: --> <style> .main { background-color: white; } a:hover { border-left-width: 1em; min-height: 2em; } </style> </body> </html> --boundary-string--

401

Returns unauthorized error message. Check your credentials.

text/plain

403

Returns forbidden error message. Check your permissions.

text/plain

404

Returns not found error message

application/json

409

Returns conflict error message. Raw body does not exist.

text/plain

get

/api/accounts/{account_id}/inboxes/{inbox_id}/messages/{message_id}/body.raw

const { MailtrapClient } = require("mailtrap");
const client = new MailtrapClient({ token: "YOUR_API_KEY", accountId: "YOUR_ACCOUNT_ID" });
const rawBody = await client.testing.messages.getRawMessage(12345, 67890);
console.log(rawBody);

From: Magic Elves <[email protected]>
To: Mailtrap Inbox <[email protected]>
Subject: You are awesome!
Content-Type: multipart/alternative; boundary="boundary-string"

--boundary-string
Content-Type: text/plain; charset="utf-8"
Content-Transfer-Encoding: quoted-printable
Content-Disposition: inline

Congrats for sending test email with Mailtrap!

Inspect it using the tabs above and learn how this email can be improved.
Now send your email using our fake SMTP server and integration of your choice!

Good luck! Hope it works.

--boundary-string
Content-Type: text/html; charset="utf-8"
Content-Transfer-Encoding: quoted-printable
Content-Disposition: inline

<!doctype html>
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
</head>
<body style="font-family: sans-serif;">
  <div style="display: block; margin: auto; max-width: 600px;" class="main">
    <h1 style="font-size: 18px; font-weight: bold; margin-top: 20px">
      Congrats for sending test email with Mailtrap!
    </h1>
    <p>Inspect it using the tabs you see above and learn how this email can be improved.</p>
    <img
      alt="Inspect with Tabs"
      src="https://assets-examples.mailtrap.io/integration-examples/welcome.png"
      style="width: 100%;"
    >
      <p>Now send your email using our fake SMTP server and integration of your choice!</p>
      <p>Good luck! Hope it works.</p>
    </div>
    <!-- Example of invalid for email html/css, will be detected by Mailtrap: -->
    <style>
      .main { background-color: white; }
      a:hover { border-left-width: 1em; min-height: 2em; }
    </style>
  </body>
</html>

--boundary-string--

Get message source

get

Get HTML source of email.

Authorizations

Api-TokenstringRequired

Pass the API token in the Api-Token

Path parameters

account_idinteger · int64 · min: 1Required

Unique account ID

Example: 3229

inbox_idinteger · int64 · min: 1Required

Unique inbox ID

Example: 4015

message_idinteger · int64 · min: 1Required

Unique message ID

Example: 427

Responses

200

Returns HTML source of a message.

text/html

ResponsestringExample:

<!doctype html> <html> <head> <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> </head> <body style="font-family: sans-serif;"> <div style="display: block; margin: auto; max-width: 600px;" class="main"> <h1 style="font-size: 18px; font-weight: bold; margin-top: 20px">Congrats for sending test email with Mailtrap!</h1> <p>Inspect it using the tabs you see above and learn how this email can be improved. </p> <img alt="Inspect with Tabs" src="https://assets-examples.mailtrap.io/integration-examples/welcome.png" style="width: 100%;"> <p>Now send your email using our fake SMTP server and integration of your choice! </p> <p>Good luck! Hope it works.</p> </div> <!-- Example of invalid for email html/css, will be detected by Mailtrap: --> <style> .main { background-color: white; } a:hover { border-left-width: 1em; min-height: 2em; } </style> </body> </html>

401

Returns unauthorized error message. Check your credentials.

text/plain

403

Returns forbidden error message. Check your permissions.

text/plain

404

Returns not found error message

application/json

409

Returns conflict error message. HTML source does not exist.

text/plain

get

/api/accounts/{account_id}/inboxes/{inbox_id}/messages/{message_id}/body.htmlsource

const { MailtrapClient } = require("mailtrap");
const client = new MailtrapClient({ token: "YOUR_API_KEY", accountId: "YOUR_ACCOUNT_ID" });
const htmlSource = await client.testing.messages.getMessageHtmlSource(12345, 67890);
console.log(htmlSource);

<!doctype html>
<html>
  <head>
    <meta http-equiv="Content-Type"
      content="text/html; charset=UTF-8">
  </head>
  <body style="font-family:
    sans-serif;">
    <div style="display: block; margin: auto; max-width:
      600px;" class="main">
      <h1 style="font-size: 18px; font-weight: bold;
        margin-top: 20px">Congrats for sending test email with Mailtrap!</h1>
      <p>Inspect it using the tabs you see above and learn how this email
        can be improved.
      </p>
      <img alt="Inspect with Tabs" src="https://assets-examples.mailtrap.io/integration-examples/welcome.png"
        style="width: 100%;">
      <p>Now send your email using our fake SMTP server
        and integration of your choice!
      </p>
      <p>Good luck! Hope it works.</p>
    </div>
    <!-- Example of invalid for email html/css, will be detected
      by Mailtrap: -->
    <style> .main { background-color: white; } a:hover
      { border-left-width: 1em; min-height: 2em; }
    </style>
  </body>
</html>

Get HTML message

get

Get formatted HTML email body. Not applicable for plain text emails.

Authorizations

Api-TokenstringRequired

Pass the API token in the Api-Token

Path parameters

account_idinteger · int64 · min: 1Required

Unique account ID

Example: 3229

inbox_idinteger · int64 · min: 1Required

Unique inbox ID

Example: 4015

message_idinteger · int64 · min: 1Required

Unique message ID

Example: 427

Responses

200

Returns message body in html format.

text/html

ResponsestringExample:

<!doctype html> <html> <head> <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> </head> <body style="font-family: sans-serif;"> <div style="display: block; margin: auto; max-width: 600px;" class="main"> <h1 style="font-size: 18px; font-weight: bold; margin-top: 20px">Congrats for sending test email with Mailtrap!</h1> <p>Inspect it using the tabs you see above and learn how this email can be improved. </p> <img alt="Inspect with Tabs" src="https://assets-examples.mailtrap.io/integration-examples/welcome.png" style="width: 100%;"> <p>Now send your email using our fake SMTP server and integration of your choice! </p> <p>Good luck! Hope it works.</p> </div> <!-- Example of invalid for email html/css, will be detected by Mailtrap: --> <style> .main { background-color: white; } a:hover { border-left-width: 1em; min-height: 2em; } </style> </body> </html>

401

Returns unauthorized error message. Check your credentials.

application/json

403

Returns forbidden error message. Check your permissions.

application/json

404

Returns not found error message

application/json

409

Returns conflict error message. HTML source does not exist.

text/plain

get

/api/accounts/{account_id}/inboxes/{inbox_id}/messages/{message_id}/body.html

const { MailtrapClient } = require("mailtrap");
const client = new MailtrapClient({ token: "YOUR_API_KEY", accountId: "YOUR_ACCOUNT_ID" });
const htmlBody = await client.testing.messages.getHtmlMessage(12345, 67890);
console.log(htmlBody);

<!doctype html>
<html>
  <head>
    <meta http-equiv="Content-Type"
      content="text/html; charset=UTF-8">
  </head>
  <body style="font-family:
    sans-serif;">
    <div style="display: block; margin: auto; max-width:
      600px;" class="main">
      <h1 style="font-size: 18px; font-weight: bold;
        margin-top: 20px">Congrats for sending test email with Mailtrap!</h1>
      <p>Inspect it using the tabs you see above and learn how this email
        can be improved.
      </p>
      <img alt="Inspect with Tabs" src="https://assets-examples.mailtrap.io/integration-examples/welcome.png"
        style="width: 100%;">
      <p>Now send your email using our fake SMTP server
        and integration of your choice!
      </p>
      <p>Good luck! Hope it works.</p>
    </div>
    <!-- Example of invalid for email html/css, will be detected
      by Mailtrap: -->
    <style> .main { background-color: white; } a:hover
      { border-left-width: 1em; min-height: 2em; }
    </style>
  </body>
</html>

Get message as .eml

get

Get email message in .eml format.

Authorizations

Api-TokenstringRequired

Pass the API token in the Api-Token

Path parameters

account_idinteger · int64 · min: 1Required

Unique account ID

Example: 3229

inbox_idinteger · int64 · min: 1Required

Unique inbox ID

Example: 4015

message_idinteger · int64 · min: 1Required

Unique message ID

Example: 427

Responses

200

Returns .eml of the message.

message/rfc822

Responsestring · binaryExample:

From: Magic Elves <[email protected]> To: Mailtrap Inbox <[email protected]> Subject: You are awesome! Content-Type: multipart/alternative; boundary="boundary-string" --boundary-string Content-Type: text/plain; charset="utf-8" Content-Transfer-Encoding: quoted-printable Content-Disposition: inline Congrats for sending test email with Mailtrap! Inspect it using the tabs above and learn how this email can be improved. Now send your email using our fake SMTP server and integration of your choice! Good luck! Hope it works. --boundary-string Content-Type: text/html; charset="utf-8" Content-Transfer-Encoding: quoted-printable Content-Disposition: inline <!doctype html> <html> <head> <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> </head> <body style="font-family: sans-serif;"> <div style="display: block; margin: auto; max-width: 600px;" class="main"> <h1 style="font-size: 18px; font-weight: bold; margin-top: 20px"> Congrats for sending test email with Mailtrap! </h1> <p>Inspect it using the tabs you see above and learn how this email can be improved.</p> <img alt="Inspect with Tabs" src="https://assets-examples.mailtrap.io/integration-examples/welcome.png" style="width: 100%;" > <p>Now send your email using our fake SMTP server and integration of your choice!</p> <p>Good luck! Hope it works.</p> </div> <!-- Example of invalid for email html/css, will be detected by Mailtrap: --> <style> .main { background-color: white; } a:hover { border-left-width: 1em; min-height: 2em; } </style> </body> </html> --boundary-string--

401

Returns unauthorized error message. Check your credentials.

text/plain

403

Returns forbidden error message. Check your permissions.

text/plain

404

Returns not found error message

application/json

409

Returns conflict error message. .eml body does not exist.

text/plain

get

/api/accounts/{account_id}/inboxes/{inbox_id}/messages/{message_id}/body.eml

const { MailtrapClient } = require("mailtrap");
const client = new MailtrapClient({ token: "YOUR_API_KEY", accountId: "YOUR_ACCOUNT_ID" });
const emlContent = await client.testing.messages.getMessageAsEml(12345, 67890);
console.log(emlContent);

From: Magic Elves <[email protected]>
To: Mailtrap Inbox <[email protected]>
Subject: You are awesome!
Content-Type: multipart/alternative; boundary="boundary-string"

--boundary-string
Content-Type: text/plain; charset="utf-8"
Content-Transfer-Encoding: quoted-printable
Content-Disposition: inline

Congrats for sending test email with Mailtrap!

Inspect it using the tabs above and learn how this email can be improved.
Now send your email using our fake SMTP server and integration of your choice!

Good luck! Hope it works.

--boundary-string
Content-Type: text/html; charset="utf-8"
Content-Transfer-Encoding: quoted-printable
Content-Disposition: inline

<!doctype html>
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
</head>
<body style="font-family: sans-serif;">
  <div style="display: block; margin: auto; max-width: 600px;" class="main">
    <h1 style="font-size: 18px; font-weight: bold; margin-top: 20px">
      Congrats for sending test email with Mailtrap!
    </h1>
    <p>Inspect it using the tabs you see above and learn how this email can be improved.</p>
    <img
      alt="Inspect with Tabs"
      src="https://assets-examples.mailtrap.io/integration-examples/welcome.png"
      style="width: 100%;"
    >
      <p>Now send your email using our fake SMTP server and integration of your choice!</p>
      <p>Good luck! Hope it works.</p>
    </div>
    <!-- Example of invalid for email html/css, will be detected by Mailtrap: -->
    <style>
      .main { background-color: white; }
      a:hover { border-left-width: 1em; min-height: 2em; }
    </style>
  </body>
</html>

--boundary-string--

Get mail headers

get

Get mail headers of a message

Authorizations

Api-TokenstringRequired

Pass the API token in the Api-Token

Path parameters

account_idinteger · int64 · min: 1Required

Unique account ID

Example: 3229

inbox_idinteger · int64 · min: 1Required

Unique inbox ID

Example: 4015

message_idinteger · int64 · min: 1Required

Unique message ID

Example: 427

Responses

200

Returns mail headers of the message

application/json

401

Returns unauthorized error message. Check your credentials.

application/json

403

Returns forbidden error message. Check your permissions.

application/json

404

Returns not found error message

application/json

get

/api/accounts/{account_id}/inboxes/{inbox_id}/messages/{message_id}/mail_headers

const { MailtrapClient } = require("mailtrap");
const client = new MailtrapClient({ token: "YOUR_API_KEY", accountId: "YOUR_ACCOUNT_ID" });
const mailHeaders = await client.testing.messages.getMailHeaders(12345, 67890);
console.log(mailHeaders);

{
  "headers": {
    "bcc": "[email protected]",
    "cc": "[email protected]",
    "from": "[email protected]",
    "to": "[email protected]",
    "subject": "Your Example Order Confirmation"
  }
}

PreviousInboxes NextAttachments

Last updated 2 hours ago

Was this helpful?

Good afternoon

Show email message

Delete message

Update message

Get messages

Forward message

Get message spam score

Get message HTML analysis

Get text message

Get raw message

Get message source

Get HTML message

Get message as .eml

Get mail headers