Mailtrap

resmi

Terintegrasi dengan Mailtrap Email API.

Apa yang bisa Anda lakukan dengan Mailtrap MCP?

  • Kirim email transaksional — Minta asisten mengirim email dengan subjek dan isi teks atau HTML, secara opsional menggunakan templat dan variabel.
  • Uji di Email Sandbox — Kirim pesan ke sandbox dan periksa konten, header, serta lampirannya tanpa mengirimkannya kepada penerima sungguhan.
  • Debug pengiriman dengan log — Daftar dan filter log email terkirim, lalu buka pesan tertentu untuk meninjau riwayat peristiwa dan status pengirimannya.
  • Analisis statistik pengiriman — Dapatkan tingkat pengiriman, pantulan, pembukaan, klik, dan spam untuk rentang tanggal tertentu, yang dirinci berdasarkan domain, kategori, atau tanggal.
  • Kelola templat — Buat, daftar, perbarui, dan hapus templat email yang tersimpan di akun Mailtrap Anda.
  • Kelola domain dan penekanan — Daftar domain, dapatkan petunjuk penyiapan DNS, serta tinjau atau hapus alamat yang ditekan.

Dokumentasi

TypeScript test NPM

MCP Server Resmi Mailtrap

MCP server resmi untuk Mailtrap — platform pengiriman email. Server ini menghubungkan akun Mailtrap Anda ke Claude, Cursor, VS Code, dan asisten AI lain yang kompatibel dengan MCP.

Kirim email transaksional dan massal, uji pesan dengan aman di Email Sandbox, kelola templat, kontak, domain, dan webhook, periksa log email dan statistik pengiriman, atasi masalah keterkiriman, serta kelola sumber daya akun — semuanya menggunakan prompt bahasa alami.

Kemampuan

  • Email API dan SMTP — Kirim email transaksional dan massal, termasuk pesan batch dan berbasis templat.
  • Pengujian email — Uji pesan di Email Sandbox dan periksa konten, header, lampiran, skor spam, serta kompatibilitas dengan klien HTML.
  • Pemantauan pengiriman — Cari log email, periksa riwayat peristiwa, dan analisis tingkat pengiriman, pantulan, pembukaan, klik, dan spam.
  • Infrastruktur email — Kelola domain, verifikasi DNS, webhook, dan penekanan.
  • Kontak — Kelola kontak, daftar, kolom kustom, dan peristiwa, termasuk impor dan ekspor.
  • Pengelolaan akun — Tinjau penggunaan penagihan dan kelola akses, izin, token API, serta sub-akun.

Klien MCP yang Didukung

Berfungsi dengan Claude Desktop, Claude Code, Cursor, VS Code, dan klien lain yang kompatibel dengan MCP. Petunjuk penyiapan untuk masing-masing tersedia di bawah.

Prasyarat

Sebelum menggunakan MCP server ini, Anda perlu:

  1. Buat akun Mailtrap
  2. Verifikasi domain Anda
  3. Dapatkan token API dari pengaturan API Mailtrap
  4. Dapatkan ID Akun dari pengelolaan akun Mailtrap
  5. Instal Node.js versi 22 atau lebih baru, kecuali jika Anda menjalankan image Docker

Variabel Lingkungan yang Wajib:

  • MAILTRAP_API_TOKEN - Wajib untuk semua fungsi
  • MAILTRAP_ACCOUNT_ID - Wajib untuk templat, get-sending-stats, log email, daftar/tampilkan sandbox, domain, dan penekanan. Hanya opsional untuk alat pengiriman (send-email, send-sandbox-email, dan alat batch-send-*), alat kampanye email, get-marketing-stats, alat info perusahaan, alat opt-out pelacakan, dan list-accounts.

Opsional (dapat diberikan sebagai parameter alat):

  • DEFAULT_FROM_EMAIL - Email pengirim default jika from tidak diberikan ke send-email, send-sandbox-email, atau alat batch-send-* (di mana nilai ini mengisi base.from). Memungkinkan penggantian pengirim untuk setiap pemanggilan melalui parameter from.
  • MAILTRAP_SANDBOX_ID - ID sandbox default jika sandbox_id suatu alat tidak diberikan (nama lama test_inbox_id pada alat kirim/daftar/tampilkan pesan sandbox tetap diterima). Memungkinkan penggantian sandbox untuk setiap pemanggilan melalui parameter.
  • MAILTRAP_TEST_INBOX_ID - Alias MAILTRAP_SANDBOX_ID yang sudah tidak digunakan lagi; tetap dibaca sebagai fallback untuk konfigurasi yang sudah ada, dan mencatat peringatan penghentian penggunaan ke stderr saat digunakan.
  • MAILTRAP_ORGANIZATION_ID - Wajib untuk alat organisasi (list-sub-accounts, create-sub-account, delete-sub-account).
  • MAILTRAP_ORGANIZATION_API_TOKEN - Token API dengan cakupan organisasi. Wajib untuk alat organisasi (terpisah dari MAILTRAP_API_TOKEN).

Instalasi Cepat

Install in Cursor

Install with Node in VS Code

Docker

Jalankan server melalui stdio dengan image Docker MCP Catalog:

docker run --rm -i \
  -e MAILTRAP_API_TOKEN="${MAILTRAP_API_TOKEN}" \
  -e MAILTRAP_ACCOUNT_ID="${MAILTRAP_ACCOUNT_ID}" \
  -e DEFAULT_FROM_EMAIL="${DEFAULT_FROM_EMAIL}" \
  -e MAILTRAP_SANDBOX_ID="${MAILTRAP_SANDBOX_ID}" \
  -e MAILTRAP_ORGANIZATION_ID="${MAILTRAP_ORGANIZATION_ID}" \
  -e MAILTRAP_ORGANIZATION_API_TOKEN="${MAILTRAP_ORGANIZATION_API_TOKEN}" \
  mcp/mailtrap

Lihat Prasyarat untuk variabel lingkungan wajib dan opsional.

Untuk membangun dari repositori ini: docker build -t mcp/mailtrap .

Smithery CLI

Smithery adalah registri dan penginstal MCP server yang berfungsi dengan klien AI.

Instal server yang dipublikasikan (mailtrap/mailtrap-mcp) ke klien lokal (ganti nama klien sesuai kebutuhan):

npx -y smithery mcp add mailtrap/mailtrap-mcp --client claude

Lihat dokumentasi Smithery CLI untuk klien lain (cursor, windsurf, dll.) dan untuk memublikasikan pembaruan.

Penyiapan

Claude Desktop

Gunakan MCPB untuk menginstal server Mailtrap. Anda dapat menemukan berkas tersebut di Rilis.
Unduh berkas .MCPB dan buka. Jika Anda menggunakan Claude Desktop, aplikasi akan membukanya dan menyarankan konfigurasi.

Claude Desktop atau Cursor

Tambahkan konfigurasi berikut:

{
  "mcpServers": {
    "mailtrap": {
      "command": "npx",
      "args": ["-y", "mcp-mailtrap"],
      "env": {
        "MAILTRAP_API_TOKEN": "your_mailtrap_api_token",
        "DEFAULT_FROM_EMAIL": "your_sender@example.com",
        "MAILTRAP_ACCOUNT_ID": "your_account_id",
        "MAILTRAP_SANDBOX_ID": "your_sandbox_id"
      }
    }
  }
}

Jika Anda menggunakan asdf untuk mengelola Node.js, Anda harus menggunakan jalur absolut ke executable (contoh untuk Mac)

{
  "mcpServers": {
    "mailtrap": {
      "command": "/Users/<username>/.asdf/shims/npx",
      "args": ["-y", "mcp-mailtrap"],
      "env": {
        "PATH": "/Users/<username>/.asdf/shims:/usr/bin:/bin",
        "ASDF_DIR": "/opt/homebrew/opt/asdf/libexec",
        "ASDF_DATA_DIR": "/Users/<username>/.asdf",
        "ASDF_NODEJS_VERSION": "22.14.0",
        "MAILTRAP_API_TOKEN": "your_mailtrap_api_token",
        "DEFAULT_FROM_EMAIL": "your_sender@example.com",
        "MAILTRAP_ACCOUNT_ID": "your_account_id",
        "MAILTRAP_SANDBOX_ID": "your_sandbox_id"
      }
    }
  }
}

Lokasi berkas konfigurasi Claude Desktop

Mac: ~/Library/Application Support/Claude/claude_desktop_config.json

Windows: %APPDATA%\Claude\claude_desktop_config.json

Lokasi berkas konfigurasi Cursor

Mac: ~/.cursor/mcp.json

Windows: %USERPROFILE%\.cursor\mcp.json

VS Code

Mengubah konfigurasi secara manual

Jalankan di Command Palette: Preferences: Open User Settings (JSON)

Kemudian, tambahkan konfigurasi berikut di berkas pengaturan:

{
  "mcp": {
    "servers": {
      "mailtrap": {
        "command": "npx",
        "args": ["-y", "mcp-mailtrap"],
        "env": {
          "MAILTRAP_API_TOKEN": "your_mailtrap_api_token",
          "DEFAULT_FROM_EMAIL": "your_sender@example.com",
          "MAILTRAP_ACCOUNT_ID": "your_account_id",
          "MAILTRAP_SANDBOX_ID": "your_sandbox_id"
        }
      }
    }
  }
}

[!TIP] Jangan lupa memulai ulang MCP server setelah mengubah bagian "env".

MCP Bundle (MCPB)

Untuk memudahkan instalasi di host yang mendukung MCP Bundle, Anda dapat mendistribusikan berkas bundle .mcpb.

# Build TypeScript and pack the MCPB bundle
npm run mcpb:pack

# Inspect bundle metadata
npm run mcpb:info

# Sign the bundle for distribution (optional)
npm run mcpb:sign

Ini akan membuat mailtrap-mcp.mcpb. Skrip menyalin dist/, manifest.json, icon.png dan lisensi ke dalam mcpb-build/, menginstal dependensi produksi di sana, lalu mengemas direktori tersebut saja. Jangan jalankan mcpb pack . dari direktori root repositori.

Penggunaan

Setelah dikonfigurasi, Anda dapat meminta agen mengirim email dan mengelola templat, misalnya:

Operasi Pengiriman Email:

  • "Kirim email ke john.doe@example.com dengan subjek 'Rapat Besok' dan pengingat ramah tentang rapat kita yang akan datang."
  • "Kirim email kepada sarah@example.com tentang pembaruan proyek, dan CC tim di team@example.com"
  • "Kirim templat sambutan (uuid b81aabcd-1a1e-41cf-91b6-eca0254b3d96) ke new@example.com dengan variabel { name: 'Alex' }"
  • "Kirim email sandbox ke test@example.com dengan subjek 'Uji Templat' untuk melihat pratinjau tampilan email sambutan kita"

Log Email (debug pengiriman):

  • "Tampilkan log email terkirim terbaru saya"
  • "Tampilkan log email untuk email yang dikirim ke user@example.com"
  • "Dapatkan pesan log email dengan ID abc-123-uuid untuk memeriksa status pengiriman"

Statistik:

  • "Dapatkan statistik pengiriman untuk Januari 2025"
  • "Tampilkan tingkat pengiriman berdasarkan domain untuk bulan lalu"
  • "Bagaimana statistik email saya berdasarkan kategori dari 2025-01-01 hingga 2025-01-31?"
  • "Bagaimana kinerja pemasaran email saya bulan lalu? Bandingkan kampanye dengan otomatisasi"

Operasi Sandbox:

  • "Dapatkan semua pesan dari sandbox saya"
  • "Tampilkan halaman pertama pesan sandbox"
  • "Cari pesan yang berisi 'test' di sandbox saya"
  • "Buat sandbox bernama 'QA' di proyek 42 dan berikan kredensial SMTP-nya"
  • "Hapus semua pesan dari sandbox 1234"
  • "Tampilkan detail pesan sandbox dengan ID 5159037506"

Operasi Templat:

  • "Tampilkan semua templat email di akun Mailtrap saya"
  • "Buat templat email baru bernama 'Email Sambutan' dengan subjek 'Selamat datang di platform kami!'"
  • "Perbarui templat dengan ID 12345 untuk mengubah subjek menjadi 'Pesan Sambutan yang Diperbarui'"
  • "Hapus templat dengan ID 67890"

Domain:

  • "Tampilkan domain saya"
  • "Dapatkan domain dengan ID 3938"
  • "Buat domain untuk example.com"
  • "Aktifkan pelacakan klik untuk domain 3938"
  • "Hapus domain 3938"
  • "Dapatkan domain 3938 beserta petunjuk penyiapan DNS"
  • "Tampilkan info perusahaan untuk domain 3938"
  • "Atur info perusahaan untuk domain 3938 menjadi Acme Inc, 123 Main St, San Francisco, US, 94105, https://acme.com"
  • "Ubah kota pada info perusahaan untuk domain 3938 menjadi New York"

Penekanan:

Opt-out Pelacakan:

  • "Hentikan pelacakan pembukaan dan klik untuk privacy@example.com pada domain 3938"
  • "Tampilkan semua orang yang memilih untuk tidak ikut pelacakan"

Kontak dan Daftar:

  • "Tambahkan john.doe@example.com ke daftar kontak buletin saya"
  • "Tampilkan semua daftar kontak saya"
  • "Buat kolom kontak bernama 'signup_source' untuk melacak asal kontak"
  • "Perbarui kontak john.doe@example.com untuk menetapkan paketnya menjadi 'pro'"
  • "Impor kontak dari CSV ini ke daftar onboarding saya"
  • "Ekspor semua kontak dari daftar buletin saya"
  • "Catat peristiwa 'trial_started' untuk kontak john.doe@example.com"

Webhook:

  • "Tampilkan semua webhook yang dikonfigurasi di akun saya"
  • "Buat webhook yang mengarah ke https://example.com/hooks/mailtrap untuk peristiwa pantulan dan spam"
  • "Perbarui webhook 4821 agar juga mengirim peristiwa pengiriman"
  • "Hapus webhook 4821"

Akun dan Penagihan:

  • "Berapa penggunaan penagihan saya saat ini bulan ini?"
  • "Berapa banyak email yang tersisa dalam paket saya?"
  • "Tampilkan semua orang yang memiliki akses ke akun Mailtrap ini"
  • "Tampilkan sumber daya izin yang tersedia di akun saya"

Token API:

  • "Tampilkan semua token API di akun saya"
  • "Buat token API baru untuk lingkungan staging"
  • "Atur ulang token API dengan ID 1234"
  • "Hapus token API 1234 yang tidak digunakan"

Organisasi dan Sub-Akun:

  • "Tampilkan semua sub-akun di organisasi saya"
  • "Buat sub-akun baru untuk proyek klien 'Acme Corp'"

Nama alat yang diubah

Mailtrap kini menyebut kotak masuk pengujian sebagai sandbox dan domain pengiriman sebagai domain, dan nama alatnya pun mengikuti perubahan tersebut. Nama lama tidak lagi muncul dalam daftar alat, tetapi pemanggilan dengan nama lama tetap berfungsi dan mencatat peringatan penghentian penggunaan ke stderr. Nama tersebut akan dihapus pada rilis mayor mendatang.

Klien MCP dan kerangka kerja agen mencocokkan daftar izinkan, tolak, dan filter dengan nama alat yang diumumkan. Karena itu, pindahkan entri per alat ke nama baru: entri penolakan untuk delete-sending-domain tidak lagi memblokir delete-domain.

Nama lamaNama baru
create-sandbox-inboxcreate-sandbox
get-sandbox-inboxget-sandbox
update-sandbox-inboxupdate-sandbox
delete-sandbox-inboxdelete-sandbox
clean-sandbox-inboxclean-sandbox
list-sending-domainslist-domains
get-sending-domainget-domain
create-sending-domaincreate-domain
update-sending-domainupdate-domain
delete-sending-domaindelete-domain
send-sending-domain-setup-instructionssend-domain-setup-instructions
parameter sending_domain_id pada alat domain dan info perusahaandomain_id
variabel lingkungan MAILTRAP_TEST_INBOX_IDMAILTRAP_SANDBOX_ID

Filter yang mencerminkan kolom API tetap menggunakan namanya: sending_domain_id pada list-email-logs dan sending_domain_ids pada alat statistik.

Alat yang Tersedia

send-email

Mengirim email transaksional melalui Mailtrap. Mendukung dua mode yang saling eksklusif — konten sebaris (subject + text/html) atau berbasis templat (template_uuid).

Parameter:

  • from (opsional): Pengirim sebagai { email, name? } (string email biasa juga diterima saat runtime). Jika tidak diberikan, DEFAULT_FROM_EMAIL akan digunakan.
  • to (opsional): Array penerima sebagai objek { email, name? } (string email biasa atau satu alamat non-array juga diterima saat runtime). Opsional jika cc atau bcc diberikan; setidaknya salah satu dari to / cc / bcc harus berisi penerima.
  • cc (opsional): Array penerima CC sebagai objek { email, name? } (string email biasa juga diterima saat runtime).
  • bcc (opsional): Array penerima BCC sebagai objek { email, name? } (string email biasa juga diterima saat runtime).
  • subject (bersyarat): Baris subjek email. Wajib untuk pengiriman inline; harus dihilangkan saat template_uuid ditetapkan.
  • text (bersyarat): Teks isi email. Wajib (bersama atau sebagai pengganti html) untuk pengiriman inline; harus dihilangkan saat template_uuid ditetapkan.
  • html (bersyarat): Versi HTML isi email. Wajib (bersama atau sebagai pengganti text) untuk pengiriman inline; harus dihilangkan saat template_uuid ditetapkan.
  • category (opsional): Kategori email untuk pelacakan dan analitik. Harus dihilangkan saat template_uuid ditetapkan.
  • template_uuid (opsional): Gunakan templat email Mailtrap sebagai pengganti konten inline. Jika ditetapkan, subject / text / html / category harus dihilangkan (sesuai API Mailtrap).
  • template_variables (opsional): Objek variabel yang disisipkan ke templat yang dirujuk oleh template_uuid. Hanya diizinkan bersama template_uuid.

batch-send-transactional-email

Mengirim sekumpulan email transaksional dalam satu panggilan API Mailtrap (aliran pengiriman default). Kolom bersama ditempatkan di base; penggantian per penerima ditempatkan di requests[]. Setiap permintaan harus menyertakan setidaknya satu penerima melalui to, cc, atau bcc. Aturan saling eksklusif inline-vs-templat yang sama seperti send-email — diperiksa setelah menggabungkan data dasar dengan setiap permintaan.

Parameter:

  • base (opsional): Objek berisi kolom yang digunakan bersama di seluruh batch.
    • from (opsional): Pengirim sebagai { email, name? } (string email biasa juga diterima saat runtime). Menggunakan nilai cadangan DEFAULT_FROM_EMAIL.
    • reply_to (opsional): Alamat balasan.
    • subject / text / html / category (opsional, mode inline): Konten default untuk setiap permintaan.
    • template_uuid / template_variables (opsional, mode templat): Templat + variabel default. Saling eksklusif dengan kolom inline.
    • custom_variables (opsional): Variabel kustom default (bernilai string).
    • headers (opsional): Header kustom default.
  • requests (wajib): Array pesan per penerima yang tidak kosong. Setiap entri memiliki:
    • to (opsional): Array penerima sebagai objek { email, name? } (string email biasa atau satu alamat non-array juga diterima saat runtime). Opsional jika cc atau bcc diberikan; setidaknya salah satu dari to / cc / bcc harus berisi penerima.
    • cc, bcc, reply_to (opsional).
    • Penggantian inline (subject/text/html/category) atau templat (template_uuid/template_variables); kolom yang tidak disertakan menggunakan nilai base yang sesuai.
    • custom_variables, headers (opsional).

batch-send-bulk-email

Mengirim sekumpulan email massal melalui API aliran massal Mailtrap. Bentuk, validasi, dan aturan inline-vs-templat base + requests[] sama seperti batch-send-transactional-email — satu-satunya perbedaan adalah alat ini mengarahkan panggilan melalui endpoint massal, bukan endpoint transaksional. Lihat parameter di atas.

list-email-logs

Menampilkan log email terkirim (riwayat pengiriman) dengan paginasi dan filter opsional. Gunakan untuk men-debug masalah pengiriman dari IDE.

Parameter:

  • search_after (opsional): Kursor paginasi dari next_page_cursor respons sebelumnya
  • sent_after (opsional): Tanggal/waktu ISO 8601; hanya log yang dikirim setelah waktu ini
  • sent_before (opsional): Tanggal/waktu ISO 8601; hanya log yang dikirim sebelum waktu ini
  • from_email (opsional): Filter berdasarkan email pengirim; gunakan bersama from_operator (default: ci_equal)
  • to_email (opsional): Filter berdasarkan email penerima; gunakan bersama to_operator (default: ci_equal)
  • status (opsional): Filter berdasarkan status pengiriman: delivered, not_delivered, enqueued, opted_out; gunakan bersama status_operator (default: equal)
  • subject (opsional): Filter berdasarkan subjek email; gunakan bersama subject_operator (default: ci_contain). Gunakan subject_operator: empty/not_empty untuk memfilter berdasarkan keberadaan subjek.
  • sending_domain_id (opsional): Filter berdasarkan ID domain (angka); gunakan bersama sending_domain_id_operator (default: equal)
  • sending_stream (opsional): Filter berdasarkan aliran: transactional atau bulk; gunakan bersama sending_stream_operator (default: equal)
  • events (opsional): Filter berdasarkan jenis peristiwa: delivery, open, click, bounce, spam, unsubscribe, soft_bounce, reject, suspension; gunakan bersama events_operator (include_event / not_include_event)
  • clicks_count / opens_count (opsional): Filter berdasarkan jumlah klik/buka; gunakan bersama *_operator: equal, greater_than, less_than
  • client_ip / sending_ip (opsional): Filter berdasarkan IP; gunakan bersama *_operator: equal, not_equal, contain, not_contain
  • email_service_provider_response (opsional): Filter berdasarkan teks respons penyedia; gunakan bersama *_operator (ci_contain, dll.)
  • email_service_provider (opsional): Filter berdasarkan penyedia (tepat); gunakan bersama *_operator: equal, not_equal
  • recipient_mx (opsional): Filter berdasarkan MX penerima; gunakan bersama recipient_mx_operator (ci_contain, dll.)
  • category (opsional): Filter berdasarkan kategori email; gunakan bersama category_operator: equal, not_equal

Semua parameter bersifat opsional.

get-email-log-message

Mendapatkan satu pesan log email berdasarkan ID (UUID): ringkasan yang mudah dibaca (from, to, subject, waktu pengiriman, status, kategori, aliran, interaksi, konteks pengiriman), lalu riwayat peristiwa terperinci. Secara opsional, dengan include_content: true, Anda juga dapat memuat dan menampilkan isi pesan (HTML dan teks biasa) saat Mailtrap menyediakan URL pesan mentah.

Parameter:

  • message_id (wajib): UUID pesan log email (dari respons pengiriman atau list-email-logs). Gunakan list-email-logs untuk menemukan ID pesan.
  • include_content (opsional): Saat true, mengambil EML mentah (jika raw_message_url tersedia) dan menambahkan bagian isi HTML dan teks biasa yang telah diurai, serupa dengan show-sandbox-email-message.

get-sending-stats

Mendapatkan statistik pengiriman email (tingkat pengiriman, pantulan, pembukaan, klik, spam) untuk rentang tanggal. Secara opsional, uraikan berdasarkan domain, kategori, penyedia layanan email, atau tanggal. Periksa tingkat pengiriman tanpa meninggalkan editor.

Parameter:

  • start_date (wajib): Tanggal mulai rentang statistik (YYYY-MM-DD)
  • end_date (wajib): Tanggal akhir rentang statistik (YYYY-MM-DD)
  • breakdown (opsional): Cara menguraikan statistik: aggregated (default), by_domain, by_category, by_email_service_provider, atau by_date
  • sending_domain_ids (opsional): Batasi hasil ke ID domain berikut (array bilangan bulat)
  • sending_streams (opsional): Batasi ke transactional dan/atau bulk (array string)
  • categories (opsional): Batasi ke kategori email berikut (array string)
  • email_service_providers (opsional): Batasi ke penyedia berikut, misalnya Google, Yahoo, Outlook (array string)

get-marketing-stats

Mendapatkan statistik Email Marketing agregat di seluruh kampanye dan otomatisasi untuk rentang tanggal: jumlah dan tingkat pengiriman, terkirim, pantulan, pembukaan, klik, spam, dan berhenti berlangganan. delivery_rate dan bounce_rate merupakan bagian dari sent_count; tingkat lainnya merupakan bagian dari delivery_count.

Parameter:

  • start_date (wajib): Awal rentang tanggal (inklusif), YYYY-MM-DD
  • end_date (wajib): Akhir rentang tanggal (inklusif), YYYY-MM-DD
  • sending_domain_ids (opsional): Batasi hasil ke ID domain berikut (array bilangan bulat)
  • sources (opsional): campaigns atau automations membatasi statistik ke sumber tersebut; hilangkan atau berikan keduanya untuk semua lalu lintas Email Marketing (array string)
  • email_service_providers (opsional): Batasi ke penyedia berikut, misalnya Google, Yahoo, Outlook (array string)

create-template

Membuat templat email baru di akun Mailtrap Anda.

Parameter:

  • name (wajib): Nama templat
  • subject (wajib): Baris subjek email
  • html (atau text wajib): Konten HTML templat
  • text (atau html wajib): Versi teks biasa templat
  • category (opsional): Kategori templat (default-nya "General")

list-templates

Menampilkan templat email di akun Mailtrap Anda dengan paginasi token halaman. Jika masih ada templat lain, hasilnya menyebutkan token untuk halaman berikutnya. Halaman merupakan offset dalam daftar terbaru-lebih-dahulu, jadi setelah menghapus templat, tampilkan daftar lagi mulai dari token 1 alih-alih melanjutkan dengan token berikutnya; halaman kosong menyebutkan halaman terakhir yang masih berisi templat.

Parameter:

  • token (opsional): Nomor halaman yang akan diambil (paginasi token halaman). Default-nya 1
  • per_page (opsional): Jumlah templat per halaman. Default-nya 50, maksimum 100. Berikan nilai yang sama di setiap halaman

get-template

Mendapatkan satu templat email berdasarkan ID, termasuk subjek, kategori, dan isi HTML/teks.

Parameter:

  • template_id (wajib): ID templat yang akan diambil

update-template

Memperbarui templat email yang sudah ada.

Parameter:

  • template_id (wajib): ID templat yang akan diperbarui
  • name (opsional): Nama baru untuk templat
  • subject (opsional): Baris subjek email baru
  • html (opsional): Konten HTML baru untuk templat
  • text (opsional): Versi teks biasa baru untuk templat
  • category (opsional): Kategori baru untuk templat

[!NOTE] Setidaknya satu kolom yang dapat diperbarui (name, subject, html, text, atau category) harus diberikan saat memanggil update-template untuk melakukan pembaruan.

delete-template

Menghapus templat email yang sudah ada.

Parameter:

  • template_id (wajib): ID templat yang akan dihapus

send-sandbox-email

Mengirim email ke sandbox Mailtrap Anda untuk keperluan pengembangan dan pengujian. Cocok untuk menguji templat email tanpa mengirim email ke penerima sungguhan. Mendukung dua mode yang sama seperti send-email — konten inline atau berbasis templat (template_uuid).

Parameter:

  • sandbox_id (opsional): Diutamakan. ID sandbox Mailtrap. Wajib diisi kecuali MAILTRAP_SANDBOX_ID ditetapkan.
  • test_inbox_id (opsional): Alias lama untuk sandbox_id jika sandbox_id tidak disertakan.
  • from (opsional): Pengirim sebagai { email, name? } (string email tanpa format tambahan juga diterima saat runtime). Jika tidak diberikan, DEFAULT_FROM_EMAIL akan digunakan.
  • to (opsional): Array penerima sebagai objek { email, name? } (string email tanpa format tambahan dalam array, atau string email biasa yang dipisahkan koma, juga diterima saat runtime). Opsional jika cc atau bcc diberikan; setidaknya satu dari to / cc / bcc harus berisi penerima.
  • cc (opsional): Array penerima CC sebagai objek { email, name? } (string email tanpa format tambahan juga diterima saat runtime).
  • bcc (opsional): Array penerima BCC sebagai objek { email, name? } (string email tanpa format tambahan juga diterima saat runtime).
  • subject (bersyarat): Baris subjek email. Wajib untuk pengiriman inline; harus dihilangkan jika template_uuid ditetapkan.
  • text (bersyarat): Teks isi email. Wajib (bersama atau sebagai pengganti html) untuk pengiriman inline; harus dihilangkan jika template_uuid ditetapkan.
  • html (bersyarat): Versi HTML isi email. Wajib (bersama atau sebagai pengganti text) untuk pengiriman inline; harus dihilangkan jika template_uuid ditetapkan.
  • category (opsional): Kategori email untuk pelacakan. Harus dihilangkan jika template_uuid ditetapkan.
  • template_uuid (opsional): Gunakan templat email Mailtrap sebagai pengganti konten inline. Jika ditetapkan, subject / text / html / category harus dihilangkan.
  • template_variables (opsional): Objek variabel yang disisipkan ke templat yang dirujuk oleh template_uuid. Hanya diizinkan bersama template_uuid.

batch-send-sandbox-email

Mengirim sekumpulan email ke sandbox Mailtrap Anda dalam satu panggilan API, tanpa mengirimkannya ke penerima sungguhan. Bentuk, validasi, dan aturan inline-vs-template sama dengan base + requests[] pada batch-send-transactional-email — perbedaannya, alat ini merutekan panggilan melalui endpoint sandbox untuk satu sandbox.

Parameter:

  • sandbox_id (opsional): ID sandbox Mailtrap. Wajib diisi kecuali MAILTRAP_SANDBOX_ID ditetapkan; berikan pada setiap panggilan untuk menargetkan sandbox tertentu.
  • base (opsional), requests (wajib): Lihat batch-send-transactional-email di atas.

[!NOTE] Sebagian besar alat sandbox menggunakan sandbox_id (atau menggunakan MAILTRAP_SANDBOX_ID sebagai fallback; env usang MAILTRAP_TEST_INBOX_ID masih berfungsi). send-sandbox-email, get-sandbox-messages, dan show-sandbox-email-message juga menerima test_inbox_id lama. get-sandbox, update-sandbox, delete-sandbox, dan clean-sandbox menggunakan sandbox_id dengan inbox_id lama (ID yang sama; inbox_id tidak digunakan pada alat pesan). Alat email masuk menggunakan inbox_id untuk produk yang berbeda (email yang diterima), bukan sandbox.

get-sandbox-messages

Mengambil daftar pesan dari sandbox Mailtrap Anda. Berguna untuk memeriksa email yang diterima di sandbox selama pengujian.

Parameter:

  • sandbox_id (opsional): Diutamakan. ID sandbox kecuali MAILTRAP_SANDBOX_ID ditetapkan.
  • test_inbox_id (opsional): Alias lama untuk sandbox_id.
  • page (opsional): Nomor halaman untuk paginasi (minimum: 1)
  • last_id (opsional): Paginasi menggunakan ID pesan terakhir. Mengembalikan pesan setelah ID pesan yang ditentukan (minimum: 1)
  • search (opsional): Kueri pencarian untuk memfilter pesan

[!NOTE] Parameter ID sandbox bersifat opsional jika MAILTRAP_SANDBOX_ID ditetapkan. Jika sandbox_id, test_inbox_id, maupun env tidak diberikan, panggilan akan gagal. Paginasi: gunakan page, last_id, atau search sesuai kebutuhan.

show-sandbox-email-message

Menampilkan informasi terperinci dan konten pesan email tertentu dari sandbox Mailtrap Anda, termasuk isi HTML dan teks.

Parameter:

  • sandbox_id (opsional): Diutamakan. ID sandbox kecuali MAILTRAP_SANDBOX_ID ditetapkan.
  • test_inbox_id (opsional): Alias lama untuk sandbox_id.
  • message_id (wajib): ID pesan email sandbox yang akan diambil

[!NOTE] Gunakan get-sandbox-messages terlebih dahulu untuk mendapatkan ID pesan, lalu gunakan alat ini untuk melihat konten lengkap.

list-sandbox-projects

Mencantumkan semua proyek sandbox dan sandbox di dalamnya.

Parameter:

  • Tidak memerlukan parameter

create-sandbox-project

Membuat proyek sandbox baru untuk mengelompokkan sandbox.

Parameter:

  • name (wajib): Nama proyek (2–100 karakter)

get-sandbox-project

Mendapatkan proyek sandbox berdasarkan ID, termasuk sandbox dan jumlah emailnya.

Parameter:

  • project_id (wajib): ID proyek yang akan diambil

update-sandbox-project

Mengganti nama proyek sandbox yang sudah ada.

Parameter:

  • project_id (wajib): ID proyek yang akan diperbarui
  • name (wajib): Nama baru proyek (2–100 karakter)

delete-sandbox-project

Menghapus proyek sandbox beserta semua sandbox di dalamnya.

Parameter:

  • project_id (wajib): ID proyek yang akan dihapus

create-sandbox

Membuat sandbox baru di dalam proyek. Mengembalikan kredensial SMTP sandbox yang baru.

Parameter:

  • project_id (wajib): ID proyek tempat sandbox akan dibuat
  • name (wajib): Nama sandbox

get-sandbox

Mendapatkan detail sandbox, termasuk kredensial SMTP, jumlah email, dan status.

Parameter:

  • sandbox_id (opsional): ID sandbox. Wajib diisi kecuali MAILTRAP_SANDBOX_ID ditetapkan.
  • inbox_id (opsional): Alias lama untuk sandbox_id.

update-sandbox

Memperbarui nama atau nama pengguna email sandbox.

Parameter:

  • sandbox_id (wajib): ID sandbox (alias lama: inbox_id)
  • name (opsional): Nama baru sandbox
  • email_username (opsional): Nama pengguna email baru untuk sandbox

Setidaknya satu dari name atau email_username harus diberikan.

delete-sandbox

Menghapus sandbox beserta semua pesannya.

Parameter:

  • sandbox_id (wajib): ID sandbox (alias lama: inbox_id)

clean-sandbox

Menghapus semua pesan dari sandbox tanpa menghapus sandbox itu sendiri.

Parameter:

  • sandbox_id (wajib): ID sandbox (alias lama: inbox_id)

list-sandboxes

Mencantumkan setiap sandbox yang dapat diakses oleh token API di semua proyek.

Parameter:

  • Tidak memerlukan parameter

mark-sandbox-as-read

Menandai semua pesan di sandbox sebagai telah dibaca.

Parameter:

  • sandbox_id (wajib): ID sandbox yang akan ditindaklanjuti

reset-sandbox-credentials

Mengatur ulang kredensial SMTP untuk sandbox. Mengembalikan nama pengguna/kata sandi baru.

Parameter:

  • sandbox_id (wajib): ID sandbox yang akan ditindaklanjuti

enable-sandbox-email-address

Mengaktifkan alamat penerima email untuk sandbox (mengaktifkan alamat Mailtrap yang mengirimkan pesan ke sandbox melalui SMTP).

Parameter:

  • sandbox_id (wajib): ID sandbox yang akan ditindaklanjuti

reset-sandbox-email-address

Membuat alamat penerima email baru untuk sandbox.

Parameter:

  • sandbox_id (wajib): ID sandbox yang akan ditindaklanjuti

forward-sandbox-message

Meneruskan pesan sandbox ke alamat email eksternal. Penggunaan ini dihitung dalam kuota penerusan bulanan Anda.

Parameter:

  • sandbox_id (opsional): ID sandbox. Menggunakan MAILTRAP_SANDBOX_ID sebagai fallback.
  • message_id (wajib): ID pesan sandbox yang akan diteruskan
  • email (wajib): Alamat email tujuan penerusan pesan

update-sandbox-message

Menandai pesan sandbox sebagai telah dibaca atau belum dibaca.

Parameter:

  • sandbox_id (opsional): ID sandbox. Menggunakan MAILTRAP_SANDBOX_ID sebagai fallback.
  • message_id (wajib): ID pesan sandbox yang akan diperbarui
  • is_read (wajib): true menandai sebagai telah dibaca, false menandai sebagai belum dibaca

delete-sandbox-message

Menghapus satu pesan sandbox.

Parameter:

  • sandbox_id (opsional): ID sandbox. Menggunakan MAILTRAP_SANDBOX_ID sebagai fallback.
  • message_id (wajib): ID pesan sandbox yang akan dihapus

get-sandbox-message-spam-score

Mendapatkan laporan spam SpamAssassin untuk pesan sandbox (skor, aturan, laporan lengkap). Alternatif mandiri untuk include_spam_report: true pada show-sandbox-email-message.

Parameter:

  • sandbox_id (opsional): ID sandbox. Menggunakan MAILTRAP_SANDBOX_ID sebagai fallback.
  • message_id (wajib): ID pesan sandbox

get-sandbox-message-html-analysis

Mendapatkan laporan analisis HTML untuk pesan sandbox (skor kompatibilitas klien, elemen bermasalah). Alternatif mandiri untuk include_html_analysis: true pada show-sandbox-email-message.

Parameter:

  • sandbox_id (opsional): ID sandbox. Menggunakan MAILTRAP_SANDBOX_ID sebagai fallback.
  • message_id (wajib): ID pesan sandbox

get-sandbox-message-headers

Mendapatkan header email yang telah diurai untuk pesan sandbox.

Parameter:

  • sandbox_id (opsional): ID sandbox. Menggunakan MAILTRAP_SANDBOX_ID sebagai fallback.
  • message_id (wajib): ID pesan sandbox

get-sandbox-message-html

Mendapatkan isi HTML yang telah dirender dari pesan sandbox.

Parameter:

  • sandbox_id (opsional): ID sandbox. Menggunakan MAILTRAP_SANDBOX_ID sebagai fallback.
  • message_id (wajib): ID pesan sandbox

get-sandbox-message-text

Mendapatkan isi teks biasa dari pesan sandbox.

Parameter:

  • sandbox_id (opsional): ID sandbox. Menggunakan MAILTRAP_SANDBOX_ID sebagai fallback.
  • message_id (wajib): ID pesan sandbox

get-sandbox-message-raw

Mendapatkan pesan mentah berformat MIME (header + isi) untuk pesan sandbox.

Parameter:

  • sandbox_id (opsional): ID sandbox. Menggunakan MAILTRAP_SANDBOX_ID sebagai fallback.
  • message_id (wajib): ID pesan sandbox

get-sandbox-message-eml

Mendapatkan pesan yang dirender sebagai payload file EML (cocok untuk dilampirkan ke tiket atau diimpor ke klien email lain).

Parameter:

  • sandbox_id (opsional): ID sandbox. Menggunakan MAILTRAP_SANDBOX_ID sebagai fallback.
  • message_id (wajib): ID pesan sandbox

get-sandbox-message-html-source

Mendapatkan sumber HTML pesan sandbox yang belum dirender (HTML sebelum transformasi apa pun di sisi Mailtrap, seperti penulisan ulang tautan CID).

Parameter:

  • sandbox_id (opsional): ID sandbox. Menggunakan MAILTRAP_SANDBOX_ID sebagai fallback.
  • message_id (wajib): ID pesan sandbox

list-sandbox-attachments

Mencantumkan semua lampiran pada pesan sandbox (nama file, jenis konten, ukuran, jalur unduhan).

Parameter:

  • sandbox_id (opsional): ID sandbox. Menggunakan MAILTRAP_SANDBOX_ID sebagai fallback.
  • message_id (wajib): ID pesan sandbox

get-sandbox-attachment

Mendapatkan metadata dan URL unduhan untuk satu lampiran.

Parameter:

  • sandbox_id (opsional): ID sandbox. Menggunakan MAILTRAP_SANDBOX_ID sebagai fallback.
  • message_id (wajib): ID pesan sandbox yang berisi lampiran
  • attachment_id (wajib): ID lampiran yang akan diambil

list-domains

Mencantumkan domain dan status verifikasi DNS-nya.

Parameter:

  • Tidak memerlukan parameter

get-domain

Mendapatkan domain berdasarkan ID beserta status verifikasinya (termasuk catatan DNS). Sertakan petunjuk penyiapan DNS secara opsional dengan menetapkan include_setup_instructions ke true.

Parameter:

  • domain_id (wajib): ID domain (alias lama: sending_domain_id)
  • include_setup_instructions (opsional): Jika true, tambahkan petunjuk penyiapan DNS ke respons. Default: false

create-domain

Membuat domain baru. Setelah dibuat, tambahkan catatan DNS untuk memverifikasi domain (gunakan get-domain dengan include_setup_instructions: true untuk melihat catatannya).

Parameter:

  • domain_name (wajib): Nama domain (misalnya example.com)

update-domain

Perbarui pengaturan pelacakan dan email masuk suatu domain.

Parameter:

  • domain_id (wajib): ID domain (alias lama: sending_domain_id)
  • open_tracking_enabled (opsional): Lacak pembukaan email yang dikirim dari domain ini
  • click_tracking_enabled (opsional): Lacak klik pada tautan di email yang dikirim dari domain ini
  • tracking_opt_out_enabled (opsional): Tambahkan tautan untuk berhenti ikut pelacakan ke email yang dilacak. Memerlukan pelacakan pembukaan atau klik
  • auto_unsubscribe_link_enabled (opsional): Tambahkan tautan berhenti berlangganan ke email secara otomatis
  • inbound_enabled (opsional): Izinkan domain ditautkan ke kotak masuk email masuk sebagai penampung semua alamat

Setidaknya satu pengaturan selain domain_id harus diberikan.

delete-domain

Hapus domain.

Parameter:

  • domain_id (wajib): ID domain yang akan dihapus (alias lama: sending_domain_id)

send-domain-setup-instructions

Kirim petunjuk penyiapan DNS untuk domain melalui email ke alamat tertentu. Berguna untuk meneruskan data DNS kepada rekan tim DevOps.

Parameter:

  • domain_id (wajib): ID domain (alias lama: sending_domain_id)
  • email (wajib): Alamat email untuk mengirim petunjuk penyiapan DNS

get-company-info

Dapatkan informasi perusahaan untuk domain, yang digunakan untuk verifikasi kepatuhan domain.

Parameter:

  • domain_id (wajib): ID domain (alias lama: sending_domain_id)

create-company-info

Tetapkan informasi perusahaan untuk domain, yang diperlukan untuk verifikasi kepatuhan domain.

Parameter:

  • domain_id (wajib): ID domain (alias lama: sending_domain_id)
  • name (wajib): Nama perusahaan atau individu
  • address (wajib): Alamat jalan
  • city (wajib): Kota
  • country (wajib): Negara
  • zip_code (wajib): Kode pos
  • website_url (wajib): URL situs web perusahaan
  • phone (opsional): Nomor telepon
  • privacy_policy_url (opsional): URL halaman kebijakan privasi
  • terms_of_service_url (opsional): URL halaman ketentuan layanan
  • info_level (opsional): business atau individual

update-company-info

Perbarui informasi perusahaan untuk domain.

Parameter:

  • domain_id (wajib): ID domain (alias lama: sending_domain_id)
  • Semua kolom dari create-company-info bersifat opsional. Setidaknya satu harus diberikan; kolom yang tidak disertakan tidak akan berubah.

list-suppressions

Tampilkan atau cari entri penekanan (pantulan permanen, keluhan spam, berhenti berlangganan, impor manual). Mengembalikan hingga 1000 hasil per panggilan.

Parameter:

  • email (opsional): Filter email. Hanya mengembalikan entri penekanan yang cocok dengan alamat ini.

create-suppression

Tambahkan alamat email ke daftar penekanan akun agar Mailtrap berhenti mengirim email ke alamat tersebut.

Parameter:

  • email (wajib): Alamat email yang akan ditekan
  • domain_id (wajib): ID domain yang menerapkan penekanan
  • sending_stream (wajib): transactional atau bulk
  • type (opsional): hard bounce, spam complaint, unsubscription atau manual import. Nilai default-nya adalah manual import

delete-suppression

Hapus entri penekanan berdasarkan ID. Mailtrap akan melanjutkan pengiriman ke email ini kecuali jika email tersebut ditekan lagi.

Parameter:

  • suppression_id (wajib): ID entri penekanan yang akan dihapus

list-tracking-opt-outs

Tampilkan alamat email yang dikecualikan dari pelacakan pembukaan dan klik. Mengembalikan hingga 1000 catatan per panggilan.

Parameter:

  • email (opsional): Filter email. Hanya mengembalikan pengecualian yang cocok dengan alamat ini
  • start_time (opsional): Hanya pengecualian yang dibuat pada atau setelah waktu ini (ISO 8601)
  • end_time (opsional): Hanya pengecualian yang dibuat pada atau sebelum waktu ini (ISO 8601)
  • last_id (opsional): Kursor paginasi — last_id dari respons sebelumnya

create-tracking-opt-out

Kecualikan alamat email dari pelacakan pembukaan dan klik untuk suatu domain.

Parameter:

  • email (wajib): Alamat email yang akan dikecualikan dari pelacakan
  • domain_id (wajib): ID domain yang menerapkan pengecualian

delete-tracking-opt-out

Hapus alamat email dari daftar pengecualian pelacakan agar pelacakan pembukaan dan klik berlaku lagi untuk alamat tersebut.

Parameter:

  • tracking_opt_out_id (wajib): ID pengecualian pelacakan yang akan dihapus

list-webhooks

Tampilkan semua webhook yang dikonfigurasi untuk akun. Mengembalikan catatan webhook lengkap dalam format JSON.

Parameter:

  • Tidak memerlukan parameter

get-webhook

Dapatkan satu webhook berdasarkan ID. Mengembalikan catatan webhook lengkap dalam format JSON. Catatan: signing_secret tidak dikembalikan di sini — hanya tersedia dalam respons dari create-webhook.

Parameter:

  • webhook_id (wajib): ID webhook yang akan diambil

create-webhook

Buat webhook. Respons menyertakan signing_secret untuk memverifikasi tanda tangan payload webhook — rahasia ini dikembalikan hanya saat pembuatan, jadi simpan sekarang. Jika hilang, buat ulang webhook.

Parameter:

  • url (wajib): URL tujuan Mailtrap mengirimkan peristiwa webhook dengan metode POST
  • webhook_type (wajib): "email_sending", "audit_log", atau "inbound_receiving"
  • active (opsional, boolean): nilai default-nya true
  • payload_format (opsional): "json" atau "jsonlines". Nilai default-nya "json"
  • sending_stream (opsional, hanya email_sending): "transactional" atau "bulk"
  • event_types (opsional, hanya email_sending): array berisi delivery, soft_bounce, bounce, suspension, unsubscribe, open, spam_complaint, click, reject
  • domain_id (opsional, hanya email_sending): ID domain untuk membatasi cakupan webhook ini
  • inbound_inbox_id (opsional, hanya inbound_receiving): ID kotak masuk email masuk yang ditautkan ke webhook; abaikan untuk menerapkan webhook ke semua kotak masuk di akun

update-webhook

Perbarui kolom webhook yang dapat diubah. webhook_type, sending_stream, dan domain_id tidak dapat diubah setelah pembuatan — buat ulang webhook jika perlu mengubahnya.

Parameter:

  • webhook_id (wajib): ID webhook yang akan diperbarui
  • url (opsional): URL webhook baru
  • active (opsional, boolean): Aktifkan atau nonaktifkan webhook
  • payload_format (opsional): "json" atau "jsonlines"
  • event_types (opsional, hanya email_sending): array berisi delivery, soft_bounce, bounce, suspension, unsubscribe, open, spam_complaint, click, reject
  • inbound_inbox_id (opsional, hanya inbound_receiving): ID kotak masuk email masuk yang ditautkan ke webhook

delete-webhook

Hapus webhook secara permanen berdasarkan ID. Mengembalikan catatan webhook yang dihapus.

Parameter:

  • webhook_id (wajib): ID webhook yang akan dihapus

get-contact

Dapatkan kontak berdasarkan ID atau email. Mengembalikan catatan kontak lengkap (keanggotaan daftar, status, kolom kustom).

Parameter:

  • contact_identifier (wajib): ID kontak atau alamat email

create-contact

Buat kontak baru.

Parameter:

  • email (wajib): Alamat email
  • fields (opsional): Nilai kolom kustom yang dipetakan berdasarkan tag gabungan (misalnya first_name). Nilainya dapat berupa string, angka, atau boolean
  • list_ids (opsional): ID daftar kontak yang akan diikuti oleh kontak ini
  • unsubscribed (opsional, boolean): Buat kontak dengan status unsubscribed

update-contact

Perbarui kontak yang sudah ada berdasarkan ID atau email. list_ids mengganti seluruh kumpulan keanggotaan kontak; list_ids_included/list_ids_excluded menambahkan/menghapus tanpa mengubah keanggotaan lainnya.

Parameter:

  • contact_identifier (wajib): ID kontak atau email
  • email (opsional): Alamat email baru
  • fields (opsional): Nilai kolom kustom yang dipetakan berdasarkan tag gabungan
  • list_ids (opsional): Ganti kumpulan keanggotaan dengan daftar ini secara persis
  • list_ids_included (opsional): ID daftar yang akan ditambahkan (bersifat aditif)
  • list_ids_excluded (opsional): ID daftar yang akan dihapus
  • unsubscribed (opsional, boolean): Tetapkan ke unsubscribed (true) atau subscribed (false)

delete-contact

Hapus kontak secara permanen berdasarkan ID atau email. Mengembalikan catatan kontak yang dihapus jika API memberikan respons berisi catatan tersebut; jika tidak, mengembalikan payload konfirmasi.

Parameter:

  • contact_identifier (wajib): ID kontak atau email

create-contact-event

Catat peristiwa kontak untuk suatu kontak (berdasarkan ID atau email). Digunakan untuk memicu otomatisasi daftar kontak.

Parameter:

  • contact_identifier (wajib): ID kontak atau email
  • name (wajib): Nama peristiwa (sesuai dengan pemicu otomatisasi)
  • params (wajib): Objek berisi pasangan kunci/nilai arbitrer. Nilainya dapat berupa string, angka, boolean, atau null

list-contact-lists

Tampilkan semua daftar kontak untuk akun.

Parameter:

  • search (opsional): Filter daftar kontak berdasarkan nama (pencocokan tanpa membedakan huruf besar dan kecil), misalnya news

get-contact-list

Dapatkan daftar kontak berdasarkan ID.

Parameter:

  • list_id (wajib): ID daftar kontak yang akan diambil

create-contact-list

Buat daftar kontak baru.

Parameter:

  • name (wajib): Nama untuk daftar baru

update-contact-list

Ubah nama daftar kontak yang sudah ada.

Parameter:

  • list_id (wajib): ID daftar kontak
  • name (wajib): Nama baru untuk daftar

delete-contact-list

Hapus daftar kontak secara permanen berdasarkan ID.

Parameter:

  • list_id (wajib): ID daftar kontak yang akan dihapus

list-contact-fields

Tampilkan semua definisi kolom kontak untuk akun.

Parameter:

  • Tidak memerlukan parameter

get-contact-field

Dapatkan definisi kolom kontak berdasarkan ID.

Parameter:

  • field_id (wajib): ID kolom kontak

create-contact-field

Buat definisi kolom kontak baru. merge_tag harus unik dalam akun dan digunakan sebagai nama placeholder dalam variabel templat.

Parameter:

  • name (wajib): Nama tampilan (misalnya "Nama Depan")
  • merge_tag (wajib): Nama placeholder unik (misalnya first_name)
  • data_type (wajib): Salah satu dari text, number, boolean, date

update-contact-field

Perbarui definisi kolom kontak. Kombinasi apa pun dari name, merge_tag, dan data_type dapat diubah.

Parameter:

  • field_id (wajib): ID kolom kontak
  • name (opsional): Nama tampilan baru
  • merge_tag (opsional): Tag gabungan baru (harus tetap unik)
  • data_type (opsional): Salah satu dari text, number, boolean, date

delete-contact-field

Hapus definisi kolom kontak secara permanen berdasarkan ID.

Parameter:

  • field_id (wajib): ID kolom kontak yang akan dihapus

create-contact-import

Impor kontak secara massal. Mengembalikan catatan tugas impor; periksa statusnya dengan get-contact-import.

Parameter:

  • contacts (wajib): Array entri kontak. Setiap entri memerlukan:
    • email (wajib): Alamat email kontak
    • fields (opsional): Nilai kolom kustom yang dipetakan berdasarkan tag gabungan (nilai string atau angka)
    • list_ids_included (opsional): ID daftar tempat kontak akan ditambahkan
    • list_ids_excluded (opsional): ID daftar tempat kontak akan dihapus

get-contact-import

Dapatkan status tugas impor kontak (dibuat/dimulai/selesai/gagal) beserta jumlah kontak yang dibuat/diperbarui/melebihi batas.

Parameter:

  • import_id (wajib): ID tugas impor kontak

create-contact-export

Ekspor kontak yang cocok dengan sekumpulan filter yang digabungkan dengan AND. Mengembalikan catatan tugas ekspor; periksa status dengan get-contact-export untuk mendapatkan URL unduhan setelah status bernilai finished.

Parameter:

  • filters (wajib): Array objek filter. Masing-masing memiliki:
    • name (wajib): Kolom yang akan difilter (list_id, subscription_status, email, dll.)
    • operator (wajib): Salah satu dari equal, not_equal, contains, not_contains, is_empty, is_not_empty
    • value (wajib): Nilai perbandingan (string, angka, boolean, atau array)

get-contact-export

Dapatkan status tugas ekspor kontak. Setelah status menjadi finished, kolom url berisi tautan unduhan CSV.

Parameter:

  • export_id (wajib): ID tugas ekspor kontak

list-email-campaigns

Daftar kampanye email akun, diurutkan dari yang terbaru, dengan paginasi token halaman. Secara opsional, filter berdasarkan nama menggunakan search.

Parameter:

  • token (opsional): Nomor halaman yang akan diambil (paginasi token halaman). Nilai default-nya 1
  • per_page (opsional): Jumlah kampanye per halaman. Nilai default-nya 50, maksimum 100
  • search (opsional): Filter kampanye berdasarkan nama (pencocokan sebagian tanpa membedakan huruf besar-kecil)

get-email-campaign

Dapatkan kampanye email berdasarkan ID.

Parameter:

  • email_campaign_id (wajib): ID kampanye email

create-email-campaign

Buat kampanye email baru. Kampanye selalu dibuat dalam status draft; penjadwalan dan memulai kampanye dilakukan dengan alat terpisah (schedule-email-campaign, start-email-campaign).

Parameter:

  • name (wajib): Nama kampanye
  • domain_id (wajib): ID domain terverifikasi yang digunakan untuk kampanye, seperti yang dikembalikan oleh list-domains
  • from_local_part (wajib): Bagian lokal (sebelum @) dari alamat From
  • template_attributes (wajib): Templat email sebaris. Memiliki:
    • subject (wajib): Baris subjek email (maks. 255 karakter). Mendukung tag gabungan, misalnya Hi {{first_name}}
    • body_html (opsional): Isi HTML (desain). Wajib diisi sebelum kampanye dapat dijadwalkan atau dimulai. Sertakan tautan berhenti berlangganan melalui anchor yang href-nya memuat placeholder __unsubscribe_url__
    • body_text (opsional): Alternatif teks biasa untuk isi email
    • merge_tags (opsional): Nama dasar tag gabungan yang dirujuk dalam subjek/isi, misalnya ["first_name"]
  • from_display_name (opsional): Nama tampilan yang ditampilkan di header From
  • reply_to (opsional): Bagian alamat Reply-To (display_name, local_part, domain)
  • delivery_mode (opsional): rapid (kirim secepat mungkin) atau gradual (batasi laju hingga delivery_options.emails_per_hour)
  • delivery_options (opsional): Opsi pembatasan laju pengiriman (emails_per_hour)
  • contact_list_ids (opsional): ID daftar kontak yang akan dikirimi (dianggap sebagai seluruh kumpulan daftar yang disertakan)
  • contact_segment_ids (opsional): ID segmen kontak yang akan dikirimi (dianggap sebagai seluruh kumpulan segmen yang disertakan)

update-email-campaign

Perbarui kampanye email draft. Hanya kolom yang diberikan yang akan berubah; templat diedit di tempat. Kampanye dalam status lain tidak dapat diperbarui.

Parameter:

  • email_campaign_id (wajib): ID kampanye email yang akan diperbarui
  • Semua parameter lainnya bersifat opsional dan sama dengan create-email-campaign (name, domain_id, from_local_part, from_display_name, reply_to, template_attributes, delivery_mode, delivery_options, contact_list_ids, contact_segment_ids)

delete-email-campaign

Hapus kampanye email berdasarkan ID. Hanya kampanye dalam status draft yang dapat dihapus.

Parameter:

  • email_campaign_id (wajib): ID kampanye email yang akan dihapus

start-email-campaign

Mulai mengirim kampanye email draft segera. Hanya kampanye draft yang dapat dimulai; templat harus memiliki desain body_html, serta audiens dan domain terverifikasi harus ditetapkan.

Parameter:

  • email_campaign_id (wajib): ID kampanye email yang akan dimulai

schedule-email-campaign

Jadwalkan kampanye email draft agar mulai dikirim pada waktu mendatang. Hanya kampanye draft yang dapat dijadwalkan.

Parameter:

  • email_campaign_id (wajib): ID kampanye email yang akan dijadwalkan
  • datetime (wajib): Waktu pengiriman kampanye (ISO 8601). Harus di masa mendatang dan tidak lebih dari 1 bulan ke depan

cancel-email-campaign

Batalkan kampanye email scheduled, sehingga statusnya kembali menjadi draft. Hanya kampanye scheduled yang dapat dibatalkan.

Parameter:

  • email_campaign_id (wajib): ID kampanye email yang akan dibatalkan

terminate-email-campaign

Hentikan kampanye email yang sedang dikirim (started, queued, atau paused), dengan membatalkan pengiriman yang sedang berlangsung.

Parameter:

  • email_campaign_id (wajib): ID kampanye email yang akan dihentikan

reset-email-campaign

Atur ulang kampanye email scheduled ke status draft. Hanya kampanye scheduled yang dapat diatur ulang.

Parameter:

  • email_campaign_id (wajib): ID kampanye email yang akan diatur ulang

get-email-campaign-stats

Dapatkan statistik kinerja agregat untuk kampanye email (jumlah dan rasio pengiriman, pembukaan, klik, email terpental, keluhan spam, dan berhenti berlangganan).

Parameter:

  • email_campaign_id (wajib): ID kampanye email
  • start_date (opsional): Awal rentang agregasi (inklusif), YYYY-MM-DD. Nilai default-nya adalah tanggal kampanye terakhir kali dimulai
  • end_date (opsional): Akhir rentang agregasi (inklusif), YYYY-MM-DD. Nilai default-nya adalah tanggal saat ini

list-accounts

Daftar akun Mailtrap yang dapat diakses oleh token API saat ini, beserta tingkat akses masing-masing akun. Berfungsi tanpa MAILTRAP_ACCOUNT_ID, jadi gunakan untuk menemukan ID akun Anda.

Parameter:

  • Tidak memerlukan parameter

get-billing-usage

Dapatkan penggunaan siklus penagihan saat ini untuk akun: paket pengiriman dan pengujian, batas, serta jumlah penggunaan saat ini.

Parameter:

  • Tidak memerlukan parameter

list-account-accesses

Daftar akses akun (pengguna, undangan, token API) untuk akun. Filter opsional membatasi hasil ke sumber daya tertentu. Memerlukan izin admin/pemilik akun.

Parameter:

  • domain_uuids (opsional): Filter berdasarkan UUID domain (array string)
  • inbox_ids (opsional): Filter berdasarkan ID sandbox (array string)
  • project_ids (opsional): Filter berdasarkan ID proyek sandbox (array string)

remove-account-access

Hapus akses akun berdasarkan ID. Untuk penentu User, tindakan ini mencabut izinnya; untuk penentu Invite atau ApiToken, tindakan ini menghapus penentu tersebut sepenuhnya. Memerlukan izin admin/pemilik.

Parameter:

  • account_access_id (wajib): ID catatan akses yang akan dihapus

get-permission-resources

Dapatkan semua sumber daya (sandbox, proyek, domain, penagihan, akun) yang dapat diakses token API dengan izin admin, disusun berdasarkan hierarki.

Parameter:

  • Tidak memerlukan parameter

bulk-update-permissions

Buat, perbarui, atau hapus izin secara massal untuk satu akses akun. Pasangan (resource_type, resource_id) yang sudah ada akan diperbarui; pasangan baru akan dibuat. Tetapkan destroy: true pada entri untuk menghapusnya.

Parameter:

  • account_access_id (wajib): ID akses akun target
  • permissions (wajib): Array entri izin. Masing-masing memiliki:
    • resource_id (wajib): ID sumber daya (angka atau string)
    • resource_type (wajib): Salah satu dari account, project, inbox, domain, billing
    • access_level (opsional): admin/100 atau viewer/10
    • destroy (opsional, boolean): Jika bernilai true, hapus izin ini alih-alih membuat atau memperbaruinya

list-api-tokens

Daftar semua token API untuk akun.

Parameter:

  • Tidak memerlukan parameter

create-api-token

Buat token API baru. Respons menyertakan nilai rahasia token — ini adalah satu-satunya kali token lengkap dikembalikan, jadi segera simpan. Jika hilang, buat ulang token tersebut.

Parameter:

  • name (wajib): Nama tampilan token
  • expires_at (opsional): Masa berlaku token sebagai tanggal-waktu ISO 8601. Abaikan untuk menggunakan nilai default server (1 tahun); berikan null secara eksplisit untuk token yang tidak pernah kedaluwarsa. Nilai di masa lalu atau lebih dari 5 tahun ke depan akan ditolak
  • resources (opsional): Array izin sumber daya untuk membatasi cakupan token. Setiap entri memiliki:
    • resource_type (wajib): Salah satu dari account, project, inbox, domain, billing
    • resource_id (wajib): ID sumber daya
    • access_level (wajib): 100 (admin) atau 10 (viewer)

get-api-token

Dapatkan token API berdasarkan ID. Hanya mengembalikan metadata — nilai rahasia token tidak dikembalikan di sini (hanya melalui create-api-token / reset-api-token).

Parameter:

  • api_token_id (wajib): ID token API

reset-api-token

Atur ulang (rotasi) token API berdasarkan ID. Respons menyertakan nilai rahasia token baru — hanya dikembalikan pada pemanggilan ini, jadi segera simpan. Token sebelumnya akan dinonaktifkan.

Parameter:

  • api_token_id (wajib): ID token API yang akan diatur ulang
  • expires_at (opsional): Masa berlaku token baru sebagai tanggal-waktu ISO 8601. Abaikan untuk menggunakan nilai default server (1 tahun); berikan null secara eksplisit untuk token yang tidak pernah kedaluwarsa. Nilai di masa lalu atau lebih dari 5 tahun ke depan akan ditolak

delete-api-token

Hapus token API secara permanen berdasarkan ID. Token tidak dapat lagi digunakan untuk autentikasi setelah dihapus.

Parameter:

  • api_token_id (wajib): ID token API yang akan dihapus

list-sub-accounts

Daftar sub-akun dalam organisasi. Memerlukan variabel env MAILTRAP_ORGANIZATION_ID dan izin pengelolaan sub-akun.

Parameter:

  • Tidak memerlukan parameter

create-sub-account

Buat sub-akun baru di bawah organisasi. Memerlukan variabel env MAILTRAP_ORGANIZATION_ID dan izin pengelolaan sub-akun.

Parameter:

  • name (wajib): Nama tampilan sub-akun baru

delete-sub-account

Hapus sub-akun secara permanen berdasarkan ID, beserta semua datanya. Menghapus sub-akun terakhir akan menghapus organisasi; pemanggilan berulang akan mengembalikan 404. Penghapusan serentak atas sub-akun yang sama akan mengembalikan 409. Memerlukan variabel env MAILTRAP_ORGANIZATION_ID dan izin admin organisasi, serta organisasi harus mengaktifkan fitur Organization & Sub-accounts (jika tidak, 403).

Parameter:

  • sub_account_id (wajib): ID sub-akun yang akan dihapus

list-inbound-folders

Daftar semua folder masuk di akun. Mengembalikan ringkasan berformat.

Parameter:

  • Tidak memerlukan parameter

get-inbound-folder

Dapatkan satu folder masuk berdasarkan ID. Mengembalikan catatan folder lengkap dalam format JSON.

Parameter:

  • folder_id (wajib): ID folder masuk

create-inbound-folder

Buat folder masuk baru.

Parameter:

  • name (wajib): Nama folder

update-inbound-folder

Ubah nama folder masuk.

Parameter:

  • folder_id (wajib): ID folder masuk
  • name (wajib): Nama folder baru

delete-inbound-folder

Hapus folder masuk secara permanen beserta semua kotak masuknya.

Parameter:

  • folder_id (wajib): ID folder masuk

list-inbound-inboxes

Daftar semua kotak masuk dalam folder masuk. Mengembalikan ringkasan berformat.

Parameter:

  • folder_id (wajib): ID folder masuk

get-inbound-inbox

Dapatkan satu kotak masuk berdasarkan ID. Mengembalikan catatan kotak masuk lengkap dalam format JSON.

Parameter:

  • folder_id (wajib): ID folder masuk
  • inbox_id (wajib): ID kotak masuk

create-inbound-inbox

Buat kotak masuk baru di dalam folder.

Parameter:

  • folder_id (wajib): ID folder masuk
  • name (wajib): Nama kotak masuk
  • domain_id (opsional): Kaitkan ke domain kustom (kotak masuk catch-all). Abaikan untuk kotak masuk yang dihosting Mailtrap

update-inbound-inbox

Ganti nama kotak masuk.

Parameter:

  • folder_id (wajib): ID folder masuk
  • inbox_id (wajib): ID kotak masuk
  • name (wajib): Nama baru kotak masuk

delete-inbound-inbox

Hapus kotak masuk secara permanen.

Parameter:

  • folder_id (wajib): ID folder masuk
  • inbox_id (wajib): ID kotak masuk

list-inbound-messages

Daftar pesan yang diterima di kotak masuk (paginasi berbasis kursor). Mengembalikan ringkasan berformat dengan petunjuk halaman berikutnya jika masih ada hasil lainnya.

Parameter:

  • inbox_id (wajib): ID kotak masuk
  • last_id (opsional): Kursor paginasi dari last_id pada respons sebelumnya

get-inbound-message

Dapatkan satu pesan masuk beserta isi lengkap dan URL unduhan lampirannya. Mengembalikan rekaman pesan lengkap dalam format JSON.

Parameter:

  • inbox_id (wajib): ID kotak masuk
  • message_id (wajib): ID pesan

delete-inbound-message

Hapus pesan masuk secara permanen.

Parameter:

  • inbox_id (wajib): ID kotak masuk
  • message_id (wajib): ID pesan

reply-to-inbound-message

Balas pesan masuk (dikirim ke pengirim asli). Mengirim email sungguhan. Alamat dapat berupa string email tanpa format tambahan atau { email, name? }.

Parameter:

  • inbox_id (wajib): ID kotak masuk
  • message_id (wajib): ID pesan yang akan dibalas
  • text / html (setidaknya satu disarankan): Isi balasan
  • from (opsional): Pengirim. Ditolak untuk kotak masuk yang dihosting Mailtrap; wajib untuk kotak masuk domain kustom
  • cc / bcc / reply_to (opsional): Alamat tambahan
  • category (opsional): Kategori pesan
  • attachments (opsional): Array { content (base64), filename, type?, disposition?, content_id? }
  • headers / custom_variables (opsional): Objek berisi nilai string

reply-all-to-inbound-message

Balas pesan masuk dan sertakan penerima lain dari pesan asli. Mengirim email sungguhan. Parameternya sama dengan reply-to-inbound-message.

Parameter:

  • inbox_id (wajib): ID kotak masuk
  • message_id (wajib): ID pesan yang akan dibalas
  • Ditambah kolom pengiriman opsional yang sama seperti reply-to-inbound-message

forward-inbound-message

Teruskan pesan masuk kepada penerima baru. Mengirim email sungguhan.

Parameter:

  • inbox_id (wajib): ID kotak masuk
  • message_id (wajib): ID pesan yang akan diteruskan
  • to (wajib): Setidaknya satu penerima (string email tanpa format tambahan atau { email, name? }, atau array)
  • Ditambah kolom pengiriman opsional yang sama seperti reply-to-inbound-message

list-inbound-threads

Daftar utas percakapan di kotak masuk (paginasi berbasis kursor), dengan filter opsional berdasarkan search. Mengembalikan ringkasan berformat dengan petunjuk halaman berikutnya jika masih ada hasil lainnya.

Parameter:

  • inbox_id (wajib): ID kotak masuk
  • last_id (opsional): Kursor paginasi dari last_id pada respons sebelumnya
  • search (opsional): Teks yang tidak membedakan huruf besar-kecil, dicocokkan dengan subjek utas dan alamat from/to/cc/bcc pada pesannya. Gunakan nilai yang sama saat melakukan paginasi

get-inbound-thread

Dapatkan satu utas masuk beserta pesan-pesannya (dari yang terlama). Mengembalikan rekaman utas lengkap dalam format JSON.

Parameter:

  • inbox_id (wajib): ID kotak masuk
  • thread_id (wajib): ID utas

delete-inbound-thread

Hapus utas masuk secara permanen.

Parameter:

  • inbox_id (wajib): ID kotak masuk
  • thread_id (wajib): ID utas

list-inbound-forward-rules

Daftar aturan penerusan kotak masuk. Mengembalikan ringkasan berformat.

Parameter:

  • inbox_id (wajib): ID kotak masuk

get-inbound-forward-rule

Dapatkan satu aturan penerusan masuk berdasarkan ID. Mengembalikan rekaman aturan lengkap, termasuk kondisi dan tujuannya, dalam format JSON.

Parameter:

  • inbox_id (wajib): ID kotak masuk
  • forward_rule_id (wajib): ID aturan penerusan

create-inbound-forward-rule

Buat aturan penerusan pada kotak masuk. Pesan yang diterima dan memenuhi semua kondisi akan diteruskan ke tujuan aturan.

Parameter:

  • inbox_id (wajib): ID kotak masuk
  • name (wajib): Nama aturan, unik dalam kotak masuk
  • conditions (opsional): Array { match_type, operator, value?, header_key? }. match_type adalah sender, recipient, atau header; operator adalah equal, not_equal, contains, starts_with, ends_with, empty, atau not_empty (empty/not_empty hanya untuk header, dan tidak menerima value); header_key wajib untuk header. Abaikan atau berikan [] untuk mencocokkan semua pesan
  • destinations (opsional): Array { email } untuk meneruskan pesan yang cocok

update-inbound-forward-rule

Perbarui aturan penerusan masuk. Hanya kolom yang diberikan yang akan berubah; array conditions atau destinations yang diberikan akan menggantikan seluruh kumpulan.

Parameter:

  • inbox_id (wajib): ID kotak masuk
  • forward_rule_id (wajib): ID aturan penerusan
  • name (opsional): Nama aturan baru
  • conditions (opsional): Kumpulan kondisi pengganti (formatnya sama seperti saat membuat); [] menghapus semua kondisi sehingga aturan cocok dengan setiap pesan
  • destinations (opsional): Kumpulan tujuan pengganti; [] menghapus semua tujuan

delete-inbound-forward-rule

Hapus aturan penerusan masuk secara permanen.

Parameter:

  • inbox_id (wajib): ID kotak masuk
  • forward_rule_id (wajib): ID aturan penerusan

Pengembangan

  1. Klon repositori:
git clone https://github.com/mailtrap/mailtrap-mcp.git
cd mailtrap-mcp
  1. Instal dependensi:
npm install

Konfigurasi dengan Claude Desktop atau Cursor

[!TIP] Lihat lokasi file konfigurasi di bagian Penyiapan.

Tambahkan konfigurasi berikut:

{
  "mcpServers": {
    "mailtrap": {
      "command": "node",
      "args": ["/path/to/mailtrap-mcp/dist/index.js"],
      "env": {
        "MAILTRAP_API_TOKEN": "your_mailtrap_api_token",
        "DEFAULT_FROM_EMAIL": "your_sender@example.com",
        "MAILTRAP_ACCOUNT_ID": "your_account_id",
        "MAILTRAP_SANDBOX_ID": "your_sandbox_id"
      }
    }
  }
}

Jika Anda menggunakan asdf untuk mengelola Node.js, gunakan jalur absolut ke executable:

(contoh untuk Mac)

{
  "mcpServers": {
    "mailtrap": {
      "command": "/Users/<username>/.asdf/shims/node",
      "args": ["/path/to/mailtrap-mcp/dist/index.js"],
      "env": {
        "PATH": "/Users/<username>/.asdf/shims:/usr/bin:/bin",
        "ASDF_DIR": "/opt/homebrew/opt/asdf/libexec",
        "ASDF_DATA_DIR": "/Users/<username>/.asdf",
        "ASDF_NODEJS_VERSION": "22.14.0",
        "MAILTRAP_API_TOKEN": "your_mailtrap_api_token",
        "DEFAULT_FROM_EMAIL": "your_sender@example.com",
        "MAILTRAP_ACCOUNT_ID": "your_account_id",
        "MAILTRAP_SANDBOX_ID": "your_sandbox_id"
      }
    }
  }
}

VS Code

[!TIP] Lihat lokasi file konfigurasi di bagian Penyiapan.

{
  "mcp": {
    "servers": {
      "mailtrap": {
        "command": "node",
        "args": ["/path/to/mailtrap-mcp/dist/index.js"],
        "env": {
          "MAILTRAP_API_TOKEN": "your_mailtrap_api_token",
          "DEFAULT_FROM_EMAIL": "your_sender@example.com",
          "MAILTRAP_ACCOUNT_ID": "your_account_id",
          "MAILTRAP_SANDBOX_ID": "your_sandbox_id"
        }
      }
    }
  }
}

Pengujian

Menjalankan alat dengan Mailtrap sungguhan

Ada dua cara untuk menguji alat secara menyeluruh dengan akun Mailtrap sungguhan: UI browser MCP Inspector untuk eksplorasi interaktif, atau mode CLI-nya untuk pemanggilan sekali jalan dari shell.

Keduanya mengharuskan bundle dibuat terlebih dahulu:

npm run build

dan MAILTRAP_API_TOKEN + MAILTRAP_ACCOUNT_ID diekspor di shell Anda (skrip mcp:cli meneruskan keduanya ke server yang dijalankan).

UI Browser

npm run dev

Inspector menampilkan URL seperti http://localhost:6274. Buka URL tersebut, pilih tab Tools, pilih alat (misalnya get-template), isi parameter dalam format JSON, lalu klik Run. Respons Mailtrap akan muncul di panel di bawahnya.

CLI

Untuk pemanggilan sekali jalan tanpa UI, gunakan npm run mcp:cli. Berikan flag CLI Inspector setelah -- agar npm meneruskannya tanpa perubahan:

# List all tools
npm run mcp:cli -- --method tools/list

# Call a tool — flags after the `--`
npm run mcp:cli -- \
  --method tools/call \
  --tool-name get-template \
  --tool-arg template_id=12345

# Multiple --tool-arg flags for tools with several params
npm run mcp:cli -- \
  --method tools/call \
  --tool-name send-domain-setup-instructions \
  --tool-arg domain_id=3938 \
  --tool-arg email=devops@example.com

Menjalankan Server MCPB

# Run the MCPB server directly
node dist/mcpb-server.js

# Or use the provided binary
mailtrap-mcpb-server

[!TIP] Untuk pengembangan dengan MCP Inspector:

npm run dev:mcpb

Penanganan Kesalahan

Server ini menggunakan penanganan kesalahan terstruktur yang selaras dengan konvensi MCP:

  • VALIDATION_ERROR: Kegagalan validasi input
  • CONFIGURATION_ERROR: Konfigurasi tidak ada atau tidak valid
  • EXECUTION_ERROR: Kesalahan eksekusi saat runtime
  • TIMEOUT: Waktu operasi habis (default 30 detik)

Kesalahan menyertakan pesan yang dapat ditindaklanjuti dan dicatat dalam format terstruktur.

Keamanan

  • Input divalidasi melalui skema Zod
  • Variabel lingkungan ditangani dengan aman
  • Perlindungan batas waktu pada operasi (30 detik)
  • Detail sensitif disamarkan dalam keluaran kesalahan

Pencatatan Log

Log JSON terstruktur dengan tingkat: INFO, WARN, ERROR, DEBUG.

Aktifkan pencatatan log debug dengan mengatur DEBUG=true.

# Example: enable debug logging
DEBUG=true node dist/mcpb-server.js

Penting: Server menulis log ke stderr agar stdout tetap dikhususkan untuk frame JSON-RPC. Ini mencegah host mengalami kesalahan penguraian JSON akibat log yang tercampur.

Contoh analisis log menggunakan jq:

# Filter error logs
node dist/mcpb-server.js 2>&1 | jq 'select(.level == "error")'

# Filter debug logs
node dist/mcpb-server.js 2>&1 | jq 'select(.level == "debug")'

Pemecahan Masalah

Masalah umum:

  1. Token API tidak ada: pastikan MAILTRAP_API_TOKEN telah diatur
  2. Sandbox tidak berfungsi: berikan sandbox_id dalam pemanggilan alat (atau test_inbox_id lama pada alat kirim/daftar/tampilkan pesan), atau atur env MAILTRAP_SANDBOX_ID
  3. Kesalahan waktu habis: periksa konektivitas jaringan dan status API Mailtrap
  4. Kesalahan validasi: pastikan semua kolom wajib telah diisi

Kontribusi

Laporan bug dan pull request dipersilakan di GitHub. Proyek ini dimaksudkan sebagai ruang kolaborasi yang aman dan ramah, dan kontributor diharapkan mematuhi kode etik.

Lisensi

Paket ini tersedia sebagai sumber terbuka berdasarkan ketentuan Lisensi MIT.

Kode Etik

Setiap orang yang berinteraksi di basis kode, pelacak masalah, ruang obrolan, dan milis proyek Mailtrap diharapkan mematuhi kode etik.