API Reference

Complete API documentation for Mailtrap email infrastructure

Welcome to the Mailtrap API documentation. Our APIs provide comprehensive access to email sending, testing, contact management, and account administration features.

Available APIs

Email API/SMTP

Send transactional and bulk emails with reliable delivery.

Transactional emails
Bulk campaigns
Email templates
Domain management

Email Sandbox

Test emails safely in isolated environments.

Test inboxes
Email inspection
SMTP testing
API automation

Email Marketing

Manage contacts and marketing campaigns.

Contact management
List segmentation
Import/export
Event tracking

Webhooks

Receive real-time event notifications.

Delivery events
Engagement tracking
Bounce handling
Custom processing

Email Templates

Create reusable email designs.

Dynamic content
Variable substitution
Version control
A/B testing

Account Management

Control users and settings.

User permissions
Billing management
Security settings
Audit logs

Quick Start

Get API Credentials

Sign up for a Mailtrap account
Navigate to API Tokens
Generate a new API token with required permissions

Install SDK

Choose your preferred programming language:

npm install mailtrap

The .NET SDK is available via GitHub Packages. First, add the GitHub source:

dotnet nuget add source https://nuget.pkg.github.com/mailtrap/index.json \
  --name github-mailtrap \
  --username GITHUB_USERNAME \
  --password GITHUB_PAT

Then install the package:

dotnet add package Mailtrap -s github-mailtrap

Send First Email

import { MailtrapClient } from "mailtrap";

const mailtrap = new MailtrapClient({
  token: process.env.MAILTRAP_API_KEY, // You can create your API key here https://mailtrap.io/api-tokens
});

mailtrap
  .send({
    from: { name: "Mailtrap Test", email: "[email protected]" },
    to: [{ email: "[email protected]" }],
    subject: "Hello from Mailtrap Node.js",
    text: "Plain text body",
  })
  .then(console.log)
  .catch(console.error);

import mailtrap as mt

API_TOKEN = "<YOUR_API_TOKEN>"  # your API key here https://mailtrap.io/api-tokens

client = mt.MailtrapClient(token=API_TOKEN)

# Create mail object
mail = mt.Mail(
    sender=mt.Address(email="[email protected]", name="John Smith"),
    to=[mt.Address(email="[email protected]")],
    subject="You are awesome!",
    text="Congrats for sending test email with Mailtrap!",
)

client.send(mail)

<?php

use Mailtrap\Helper\ResponseHelper;
use Mailtrap\MailtrapClient;
use Mailtrap\Mime\MailtrapEmail;
use Symfony\Component\Mime\Address;

require __DIR__ . '/vendor/autoload.php';

$mailtrap = MailtrapClient::initSendingEmails(
    apiKey: getenv('MAILTRAP_API_KEY') // your API key here https://mailtrap.io/api-tokens
);

$email = (new MailtrapEmail())
    ->from(new Address('[email protected]'))
    ->to(new Address('[email protected]'))
    ->subject('Hello from Mailtrap PHP')
    ->text('Plain text body');

$response = $mailtrap->send($email);

// Access response body as array (helper optional)
var_dump(ResponseHelper::toArray($response));

require 'mailtrap'

# Create mail object
mail = Mailtrap::Mail.from_content(
  from: { email: '[email protected]', name: 'Mailtrap Test' },
  to: [
    { email: '[email protected]' }
  ],
  reply_to: { email: '[email protected]', name: 'Mailtrap Reply-To' },
  subject: 'You are awesome!',
  text: 'Congrats for sending test email with Mailtrap!'
)

# Create client and send
client = Mailtrap::Client.new(api_key: 'your-api-key')
client.send(mail)

# You can also pass the request parameters directly
client.send(
  from: { email: '[email protected]', name: 'Mailtrap Test' },
  to: [
    { email: '[email protected]' }
  ],
  subject: 'You are awesome!',
  text: 'Congrats for sending test email with Mailtrap!'
)

import io.mailtrap.client.MailtrapClient;
import io.mailtrap.config.MailtrapConfig;
import io.mailtrap.factory.MailtrapClientFactory;
import io.mailtrap.model.request.emails.Address;
import io.mailtrap.model.request.emails.MailtrapMail;

import java.util.List;

public class MailtrapJavaSDKTest {

    private static final String TOKEN = "<YOUR MAILTRAP TOKEN>";
    private static final String SENDER_EMAIL = "[email protected]";
    private static final String RECIPIENT_EMAIL = "[email protected]";

    public static void main(String[] args) {
        final MailtrapConfig config = new MailtrapConfig.Builder()
            .token(TOKEN)
            .build();

        final MailtrapClient client = MailtrapClientFactory.createMailtrapClient(config);

        final MailtrapMail mail = MailtrapMail.builder()
            .from(new Address(SENDER_EMAIL))
            .to(List.of(new Address(RECIPIENT_EMAIL)))
            .subject("Hello from Mailtrap Sending!")
            .text("Welcome to Mailtrap Sending!")
            .build();

        // Send an email using Mailtrap Sending API
        try {
            System.out.println(client.send(mail));
        } catch (Exception e) {
            System.out.println("Caught exception : " + e);
        }
    }
}

using Mailtrap;
using Mailtrap.Emails.Models;
using Mailtrap.Emails.Requests;

using var mailtrapClientFactory = new MailtrapClientFactory("YOUR_API_TOKEN");
var client = mailtrapClientFactory.CreateClient();

var mail = new SendEmailRequest
{
      From = new EmailAddress("[email protected]"),
      To = new[] { new EmailAddress("[email protected]") },
      Subject = "Hello from Mailtrap",
      TextBody = "Welcome to Mailtrap Email API!"
};

await client.Email().Send(mail);

Next Steps

Choose an API to explore:

Getting Started? Begin with the Email API for sending your first email.

Testing? Use the Email Sandbox to safely test email functionality.

NextAuthentication

Last updated 21 days ago

Was this helpful?

Good morning

hashtagAvailable APIs

hashtagEmail API/SMTP

hashtagEmail Sandbox

hashtagEmail Marketing

hashtagWebhooks

hashtagEmail Templatesarrow-up-right

hashtagAccount Management

hashtagQuick Start

hashtagGet API Credentials

hashtagInstall SDK

hashtagSend First Email

hashtagNext Steps

Available APIs

Email API/SMTP

Email Sandbox

Email Marketing

Webhooks

Email Templates

Account Management

Quick Start

Get API Credentials

Install SDK

Send First Email

Next Steps