Send Test Emails

Send emails to sandbox

Test Emails

Send email (including templates)

post

Send email message to the specified inbox.

Authorizations

HeaderAuthBearerAuth

Api-TokenstringRequired

Pass the API token in the Api-Token

Path parameters

inbox_idinteger · int64 · min: 1Required

Unique inbox ID

Example: 4015

Body

application/json

or

or

or

Responses

200

Success. Message has been delivered.

application/json

400

Bad request. Fix errors listed in response before retrying.

application/json

401

Unauthorized. Make sure you are sending correct credentials with the request before retrying.

application/json

429

Billing plan limit exhausted or inbox rate limit exceeded (see the response for details).

application/json

500

Internal error. Mail was not delivered. Retry later or contact support.

application/json

post

/api/send/{inbox_id}

Node.jsPHPPythonRuby.NETJavacURL

import { MailtrapClient } from "mailtrap";

const client = new MailtrapClient({
  token: "YOUR_API_TOKEN",
  testInboxId: TEST_INBOX_ID,
  sandbox: true
});

await client.send({
  from: { email: "[email protected]", name: "Test Sender" },
  to: [{ email: "[email protected]", name: "Test User" }],
  subject: "Test Email",
  text: "This is a test email for sandbox.",
  html: "<p>This is a <b>test email</b> for sandbox.</p>"
});

{
  "success": true,
  "message_ids": [
    "0c7fd939-02cf-11ed-88c2-0a58a9feac02"
  ]
}

Batch send email (including templates)

post

Batch send email (text, html, text&html, templates). Please note that the endpoint will return a 200-level http status, even when sending for individual messages may fail. Users of this endpoint should check the success and errors for each message in the response (the results are ordered the same as the original messages - requests). Please note that the endpoint accepts up to 500 messages per API call, and up to 50 MB payload size, including attachments.

Authorizations

HeaderAuthBearerAuth

Api-TokenstringRequired

Pass the API token in the Api-Token

Path parameters

inbox_idinteger · int64 · min: 1Required

Unique inbox ID

Example: 4015

Body

application/json

Responses

200

Success. Check individual responses if messages have been delivered.

application/json

400

Bad request. Fix errors listed in response before retrying.

application/json

401

Unauthorized. Make sure you are sending correct credentials with the request before retrying.

application/json

500

Internal error. Messages were not delivered. Retry later or contact support.

application/json

post

/api/batch/{inbox_id}

Node.jsPHPPythonRuby.NETJava

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

const TOKEN = "YOUR_API_KEY";
const TEST_INBOX_ID = 12345;

const client = new MailtrapClient({
  token: TOKEN,
  sandbox: true,
  testInboxId: TEST_INBOX_ID
});

client.batchSend({
  base: {
    from: { name: "Test Sender", email: "[email protected]" },
    subject: "Batch Email",
    text: "Batch email content"
  },
  requests: [
    {
      to: [{ email: "[email protected]" }],
      custom_variables: { user_id: 1 }
    },
    {
      to: [{ email: "[email protected]" }],
      custom_variables: { user_id: 2 }
    }
  ]
})
  .then(console.log)
  .catch(console.error);

{
  "success": true,
  "responses": [
    {
      "success": true,
      "message_ids": [
        "0c7fd939-02cf-11ed-88c2-0a58a9feac02"
      ],
      "errors": [
        "text"
      ]
    }
  ],
  "errors": [
    "text"
  ]
}