API Email

Saat ini kami belum merilis pembungkus API apa pun, tetapi kami berencana untuk melakukannya dalam waktu dekat. Kirimkan email ke api@forwardemail.net jika Anda ingin mendapatkan notifikasi ketika pembungkus API untuk bahasa pemrograman tertentu dirilis. Sementara itu, Anda dapat menggunakan pustaka permintaan HTTP yang direkomendasikan ini di aplikasi Anda, atau cukup gunakan keriting seperti pada contoh di bawah ini.

Jalur URI dasar HTTP saat ini adalah: https://api.forwardemail.net.

Semua titik akhir mengharuskan Kunci API Anda ditetapkan sebagai nilai "nama pengguna" dari header Otorisasi Dasar permintaan (dengan pengecualian Alias Kontak, Kalender Alias, dan Kotak Surat Alias yang menggunakan alias nama pengguna dan kata sandi yang dihasilkan).

Jangan khawatir – contoh disediakan di bawah ini untuk Anda jika Anda tidak yakin apa ini.

Jika terjadi kesalahan, badan respons permintaan API akan berisi pesan kesalahan terperinci.

Layanan kami telah diterjemahkan ke lebih dari 25 bahasa. Semua pesan respons API diterjemahkan ke lokal terakhir yang terdeteksi oleh pengguna yang membuat permintaan API. Anda dapat menggantinya dengan memberikan header Accept-Language khusus. Silakan mencobanya menggunakan menu tarik-turun bahasa di bagian bawah halaman ini.

Paginasi didukung oleh semua titik akhir API yang mencantumkan hasil.

Cukup berikan properti querystring page (dan opsional limit).

Properti page harus berupa angka yang lebih besar atau sama dengan 1. Jika Anda memasukkan limit (yang juga berupa angka), maka nilai minimumnya adalah 10 dan maksimumnya adalah 50 (kecuali dinyatakan lain).

Untuk menentukan apakah terdapat lebih banyak hasil yang tersedia atau tidak, kami menyediakan header respons HTTP ini (yang dapat Anda uraikan untuk melakukan paginasi secara terprogram):

Contoh Permintaan:

curl https://api.forwardemail.net/v1/domains/example.com/aliases?page=2&pagination=true \
  -u API_TOKEN:

Ambil log

API kami secara terprogram memungkinkan Anda mengunduh log untuk akun Anda. Mengirimkan permintaan ke titik akhir ini akan memproses semua log untuk akun Anda dan mengirimkannya melalui email kepada Anda sebagai lampiran (file spreadsheet Gzip terkompresi CSV) setelah selesai.

Ini memungkinkan Anda membuat pekerjaan latar belakang dengan Pekerjaan cron atau menggunakan Perangkat lunak penjadwalan pekerjaan Node.js Bree kami untuk menerima log kapan pun Anda mau. Harap dicatat bahwa titik akhir ini dibatasi hingga 10 permintaan per hari.

Lampirannya berupa huruf kecil dari email-deliverability-logs-YYYY-MM-DD-h-mm-A-z.csv.gz dan email itu sendiri berisi ringkasan singkat log yang diambil. Anda juga dapat mengunduh log kapan saja dari Akun Saya → Log.

GET /v1/logs/download

Contoh Permintaan:

curl https://api.forwardemail.net/v1/logs/download \
  -u API_TOKEN:

Contoh pekerjaan Cron (tengah malam setiap hari):

0 0 * * * /usr/bin/curl https://api.forwardemail.net/v1/logs/download -u API_TOKEN: &>/dev/null

Perhatikan bahwa Anda dapat menggunakan layanan seperti Crontab.guru untuk memvalidasi sintaksis ekspresi pekerjaan cron Anda.

Contoh pekerjaan Cron (tengah malam setiap hari dan dengan log untuk hari sebelumnya):

Untuk MacOS:

0 0 * * * /usr/bin/curl https://api.forwardemail.net/v1/logs/download?q=`date -v-1d -u "+%-m/%-d/%y"` -u API_TOKEN: &>/dev/null

Untuk Linux dan Ubuntu:

0 0 * * * /usr/bin/curl https://api.forwardemail.net/v1/logs/download?q=`date --date "-1 days" -u "+%-m/%-d/%y"` -u API_TOKEN: &>/dev/null

Buat akun

POST /v1/account

Contoh Permintaan:

curl -X POST https://api.forwardemail.net/v1/account \
  -u API_TOKEN: \
  -d "email=user%40gmail.com"

Ambil kembali akun

GET /v1/account

Contoh Permintaan:

curl https://api.forwardemail.net/v1/account \
  -u API_TOKEN:

Perbarui akun

PUT /v1/account

Contoh Permintaan:

curl -X PUT https://api.forwardemail.net/v1/account \
  -u API_TOKEN: \
  -d "email=user%40gmail.com"

Daftar kontak

GET /v1/contacts

Segera hadir

Buat kontak

POST /v1/contacts

Segera hadir

Ambil kontak

GET /v1/contacts/:id

Segera hadir

Perbarui kontak

PUT /v1/contacts/:id

Segera hadir

Hapus kontak

DELETE /v1/contacts/:id

Segera hadir

Daftar kalender

GET /v1/calendars

Segera hadir

Buat kalender

POST /v1/calendars

Segera hadir

Ambil kalender

GET /v1/calendars/:id

Segera hadir

Perbarui kalender

PUT /v1/calendars/:id

Segera hadir

Hapus kalender

DELETE /v1/calendars/:id

Segera hadir

Pastikan Anda telah mengikuti petunjuk pengaturan untuk domain Anda.

Petunjuk ini dapat ditemukan di bagian FAQ kami Apakah Anda mendukung penerimaan email dengan IMAP?.

Daftar dan cari pesan

GET /v1/messages

Segera hadir

Buat pesan

POST /v1/messages

Segera hadir

Ambil pesan

GET /v1/messages/:id

Segera hadir

Perbarui pesan

PUT /v1/messages/:id

Segera hadir

Hapus pesan

DELETE /v1/messages:id

Segera hadir

Daftar folder

GET /v1/folders

Segera hadir

Buat folder

POST /v1/folders

Segera hadir

Ambil folder

GET /v1/folders/:id

Segera hadir

Perbarui folder

PUT /v1/folders/:id

Segera hadir

Hapus folder

DELETE /v1/folders/:id

Segera hadir

Salin folder

POST /v1/folders/:id/copy

Segera hadir

Pastikan Anda telah mengikuti petunjuk pengaturan untuk domain Anda.

Petunjuk ini dapat ditemukan di Akun Saya → Domain → Pengaturan → Konfigurasi SMTP Keluar. Anda perlu memastikan pengaturan DKIM, Return-Path, dan DMARC untuk mengirimkan SMTP keluar dengan domain Anda.

Dapatkan batas email SMTP keluar

Ini adalah titik akhir sederhana yang mengembalikan objek JSON berisi count dan limit untuk jumlah pesan keluar SMTP harian per akun.

GET /v1/emails/limit

Contoh Permintaan:

curl https://api.forwardemail.net/v1/emails/limit \
  -u API_TOKEN:

Daftar email SMTP keluar

Perhatikan bahwa titik akhir ini tidak mengembalikan nilai properti untuk message, headers, atau rejectedErrors email.

Untuk mengembalikan properti dan nilainya, silakan gunakan titik akhir Ambil email dengan ID email.

GET /v1/emails

Contoh Permintaan:

curl https://api.forwardemail.net/v1/emails?limit=1 \
  -u API_TOKEN:

Buat email SMTP keluar

API kami untuk membuat email terinspirasi oleh dan memanfaatkan konfigurasi opsi pesan Nodemailer. Harap gunakan Konfigurasi pesan Nodemailer untuk semua parameter isi di bawah ini.

Harap dicatat bahwa kecuali envelope dan dkim (karena kami mengaturnya secara otomatis untuk Anda), kami mendukung semua opsi Nodemailer. Kami secara otomatis mengatur opsi disableFileAccess dan disableUrlAccess ke true demi keamanan.

Anda harus meneruskan opsi tunggal raw dengan email lengkap mentah Anda termasuk header atau meneruskan opsi parameter isi individual di bawah.

Titik akhir API ini akan otomatis mengodekan emoji untuk Anda jika ditemukan di header (misalnya, baris subjek Subject: 🤓 Hello akan otomatis dikonversi menjadi Subject: =?UTF-8?Q?=F0=9F=A4=93?= Hello). Tujuan kami adalah membuat API email yang sangat ramah pengembang dan anti-dummy.

POST /v1/emails

Contoh Permintaan:

curl -X POST https://api.forwardemail.net/v1/emails \
  -u API_TOKEN: \
  -d "from=alias@example.com" \
  -d "to=user%40gmail.com" \
  -d "subject=test" \
  -d "text=test"

Contoh Permintaan:

curl -X POST https://api.forwardemail.net/v1/emails \
  -u API_TOKEN: \
  -d "raw=`cat file.eml`"

Ambil email SMTP keluar

GET /v1/emails/:id

Contoh Permintaan:

curl https://api.forwardemail.net/v1/emails/:id \
  -u API_TOKEN:

Hapus email SMTP keluar

Penghapusan email akan menetapkan status ke "rejected" (dan selanjutnya tidak akan diproses dalam antrean) jika dan hanya jika status saat ini adalah "pending", "queued", atau "deferred". Kami dapat menghapus email secara otomatis setelah 30 hari sejak email dibuat dan/atau dikirim – oleh karena itu, Anda sebaiknya menyimpan salinan email SMTP keluar di klien, basis data, atau aplikasi Anda. Anda dapat merujuk nilai ID email kami di basis data Anda jika diinginkan – nilai ini dikembalikan dari titik akhir Buat email dan Ambil email.

DELETE /v1/emails/:id

Contoh Permintaan:

curl -X DELETE https://api.forwardemail.net/v1/emails/:id \
  -u API_TOKEN:

Daftar domain

GET /v1/domains

Contoh Permintaan:

curl https://api.forwardemail.net/v1/domains \
  -u API_TOKEN:

Buat domain

POST /v1/domains

Contoh Permintaan:

curl -X POST https://api.forwardemail.net/v1/domains \
  -u API_TOKEN: \
  -d domain=example.com \
  -d plan=free

Ambil domain

GET /v1/domains/example.com

Contoh Permintaan:

curl https://api.forwardemail.net/v1/domains/example.com \
  -u API_TOKEN:

Verifikasi rekaman domain

GET /v1/domains/example.com/verify-records

Contoh Permintaan:

curl https://api.forwardemail.net/v1/domains/example.com/verify-records \
  -u API_TOKEN:

Verifikasi rekaman SMTP domain

GET /v1/domains/example.com/verify-smtp

Contoh Permintaan:

curl https://api.forwardemail.net/v1/domains/example.com/verify-smtp \
  -u API_TOKEN:

Daftar kata sandi tangkap-semua di seluruh domain

GET /v1/domains/example.com/catch-all-passwords

Contoh Permintaan:

curl https://api.forwardemail.net/v1/domains/example.com/catch-all-passwords \
  -u API_TOKEN:

Buat kata sandi penampung semua domain

POST /v1/domains/example.com/catch-all-passwords

Contoh Permintaan:

curl BASE_URL/v1/domains/example.com/catch-all-passwords \
  -u API_TOKEN:

Hapus kata sandi tangkap-semua di seluruh domain

DELETE /v1/domains/example.com/catch-all-passwords/:token_id

Contoh Permintaan:

curl -X DELETE https://api.forwardemail.net/v1/domains/:domain_name/catch-all-passwords/:token_id \
  -u API_TOKEN:

Perbarui domain

PUT /v1/domains/example.com

Contoh Permintaan:

curl -X PUT https://api.forwardemail.net/v1/domains/example.com \
  -u API_TOKEN:

Hapus domain

DELETE /v1/domains/:domain_name

Contoh Permintaan:

curl -X DELETE https://api.forwardemail.net/v1/domains/:domain_name \
  -u API_TOKEN:

Terima undangan domain

GET /v1/domains/:domain_name/invites

Contoh Permintaan:

curl https://api.forwardemail.net/v1/domains/:domain_name/invites \
  -u API_TOKEN:

Buat undangan domain

POST /v1/domains/example.com/invites

Contoh Permintaan:

curl -X POST https://api.forwardemail.net/v1/domains/example.com/invites \
  -u API_TOKEN: \
  -d "email=user%40gmail.com" \
  -d group=admin

Hapus undangan domain

DELETE /v1/domains/:domain_name/invites

Contoh Permintaan:

curl -X DELETE https://api.forwardemail.net/v1/domains/:domain_name/invites \
  -u API_TOKEN:

Perbarui anggota domain

PUT /v1/domains/example.com/members/:member_id

Contoh Permintaan:

curl -X PUT https://api.forwardemail.net/v1/domains/example.com/members/:member_id \
  -u API_TOKEN:

Hapus anggota domain

DELETE /v1/domains/:domain_name/members/:member_id

Contoh Permintaan:

curl -X DELETE https://api.forwardemail.net/v1/domains/:domain_name/members/:member_id \
  -u API_TOKEN:

Hasilkan kata sandi alias

Perhatikan bahwa jika Anda tidak mengirimkan instruksi melalui email, maka nama pengguna dan kata sandi akan berada di badan respons JSON dari permintaan yang berhasil dalam format { username: 'alias@yourdomain.com', password: 'some-generated-password' }.

POST /v1/domains/example.com/aliases/:alias_id/generate-password

Contoh Permintaan:

curl -X POST https://api.forwardemail.net/v1/domains/example.com/aliases/:alias_id/generate-password \
  -u API_TOKEN:

Daftar alias domain

GET /v1/domains/example.com/aliases

Contoh Permintaan:

curl https://api.forwardemail.net/v1/domains/example.com/aliases?pagination=true \
  -u API_TOKEN:

Buat alias domain baru

POST /v1/domains/example.com/aliases

Contoh Permintaan:

curl -X POST https://api.forwardemail.net/v1/domains/example.com/aliases \
  -u API_TOKEN:

Ambil alias domain

Anda dapat mengambil alias domain berdasarkan nilai id atau name.

GET /v1/domains/:domain_name/aliases/:alias_id

Contoh Permintaan:

curl https://api.forwardemail.net/v1/domains/:domain_name/aliases/:alias_id \
  -u API_TOKEN:

GET /v1/domains/:domain_name/aliases/:alias_name

Contoh Permintaan:

curl https://api.forwardemail.net/v1/domains/:domain_name/aliases/:alias_name \
  -u API_TOKEN:

Perbarui alias domain

PUT /v1/domains/example.com/aliases/:alias_id

Contoh Permintaan:

curl -X PUT https://api.forwardemail.net/v1/domains/example.com/aliases/:alias_id \
  -u API_TOKEN:

Hapus alias domain

DELETE /v1/domains/:domain_name/aliases/:alias_id

Contoh Permintaan:

curl -X DELETE https://api.forwardemail.net/v1/domains/:domain_name/aliases/:alias_id \
  -u API_TOKEN:

Kami mengizinkan Anda mengenkripsi data, bahkan dengan paket gratis, tanpa biaya. Privasi seharusnya bukan hanya sebuah fitur, melainkan sudah terintegrasi secara inheren dalam semua aspek produk. Sesuai permintaan yang tinggi pada Diskusi Panduan Privasi dan masalah GitHub kami, kami telah menambahkan fitur ini.

Enkripsi Rekaman TXT

POST /v1/encrypt

Contoh Permintaan:

curl -X POST https://api.forwardemail.net/v1/encrypt \
  -d "input=user@gmail.com"