Email API

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

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

Semua endpoint memerlukan autentikasi menggunakan Basic Authorization. Kami mendukung dua metode autentikasi:

Autentikasi Token API (Direkomendasikan untuk sebagian besar endpoint)

Tetapkan API key Anda sebagai nilai "username" dengan password kosong:

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

Perhatikan tanda titik dua (:) setelah token API – ini menunjukkan password kosong dalam format Basic Auth.

Autentikasi Kredensial Alias (Untuk email keluar)

Endpoint Create outbound SMTP email juga mendukung autentikasi menggunakan alamat email alias Anda dan password alias yang dihasilkan:

curl -X POST https://api.forwardemail.net/v1/emails \
  -u "alias@yourdomain.com:your_generated_password" \
  -d "to=recipient@example.com" \
  -d "subject=Hello" \
  -d "text=Test email"

Metode ini berguna saat mengirim email dari aplikasi yang sudah menggunakan kredensial SMTP dan membuat migrasi dari SMTP ke API kami menjadi mulus.

Endpoint Khusus Alias

Endpoint Alias Contacts, Alias Calendars, Alias Messages, dan Alias Folders memerlukan kredensial alias dan tidak mendukung autentikasi token API.

Jangan khawatir – contoh diberikan di bawah ini jika Anda tidak yakin apa itu.

Jika terjadi kesalahan, isi respons dari permintaan API akan berisi pesan kesalahan yang rinci.

Layanan kami diterjemahkan ke lebih dari 25 bahasa berbeda. Semua pesan respons API diterjemahkan ke lokal terakhir yang terdeteksi dari pengguna yang melakukan permintaan API. Anda dapat mengubah ini dengan mengirimkan header Accept-Language khusus. Silakan coba menggunakan pilihan bahasa di bagian bawah halaman ini.

Paginasi didukung oleh semua endpoint API yang menampilkan daftar hasil.

Cukup berikan properti querystring page (dan opsional limit).

Properti page harus berupa angka yang lebih besar atau sama dengan 1. Jika Anda memberikan limit (juga angka), maka nilai minimum adalah 10 dan maksimum adalah 50 (kecuali disebutkan lain).

Contoh Permintaan:

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

Mengambil logs

API kami secara programatik memungkinkan Anda mengunduh logs untuk akun Anda. Mengirim permintaan ke endpoint ini akan memproses semua logs untuk akun Anda dan mengirimkannya melalui email sebagai lampiran (file spreadsheet CSV terkompresi Gzip) setelah selesai.

Ini memungkinkan Anda membuat pekerjaan latar belakang dengan Cron job atau menggunakan perangkat lunak penjadwalan pekerjaan Node.js Bree untuk menerima logs kapan pun Anda inginkan. Perlu dicatat bahwa endpoint ini dibatasi hingga 10 permintaan per hari.

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

GET /v1/logs/download

Contoh Permintaan:

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

Contoh Cron job (pada tengah malam setiap hari):

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

Perlu dicatat bahwa Anda dapat menggunakan layanan seperti Crontab.guru untuk memvalidasi sintaks ekspresi cron job Anda.

Contoh Cron job (pada tengah malam setiap hari dan dengan logs 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

Membuat akun

POST /v1/account

Contoh Permintaan:

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

Mengambil akun

GET /v1/account

Contoh Permintaan:

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

Memperbarui 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 instruksi pengaturan untuk domain Anda.

Instruksi 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 instruksi pengaturan untuk domain Anda.

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

Dapatkan batas email SMTP keluar

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

GET /v1/emails/limit

Contoh Permintaan:

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

Daftar email SMTP keluar

Perlu dicatat bahwa endpoint ini tidak mengembalikan nilai properti untuk message, headers, maupun rejectedErrors dari sebuah email.

Untuk mengembalikan properti dan nilainya tersebut, silakan gunakan endpoint Retrieve 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 dan memanfaatkan konfigurasi opsi pesan Nodemailer. Silakan merujuk ke konfigurasi pesan Nodemailer untuk semua parameter body di bawah ini.

Perlu 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 mengirimkan opsi tunggal raw dengan email mentah lengkap Anda termasuk header atau mengirimkan opsi parameter body individual di bawah ini.

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

Otentikasi: Endpoint ini mendukung baik otentikasi token API maupun otentikasi kredensial alias. Lihat bagian Authentication di atas untuk detailnya.

POST /v1/emails

Contoh Permintaan (Token API):

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 (Kredensial Alias):

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

Contoh Permintaan (Email Mentah):

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 mengatur status menjadi "rejected" (dan selanjutnya tidak memprosesnya dalam antrean) jika dan hanya jika status saat ini adalah salah satu dari "pending", "queued", atau "deferred". Kami dapat menghapus email secara otomatis setelah 30 hari sejak dibuat dan/atau dikirim – oleh karena itu Anda harus 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 kedua endpoint 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 catatan 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 catatan 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 catch-all 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 catch-all 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 catch-all 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/NAMA_DOMAIN \
  -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:

Buat kata sandi alias

Perlu dicatat bahwa jika Anda tidak mengirim instruksi melalui email, maka nama pengguna dan kata sandi akan ada di dalam body 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/NAMA_DOMAIN/aliases/ID_ALIAS/generate-password \
  -u API_TOKEN:

Daftar alias domain

GET /v1/domains/NAMA_DOMAIN/aliases

Contoh Permintaan:

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

Buat alias domain baru

POST /v1/domains/NAMA_DOMAIN/aliases

Contoh Permintaan:

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

Mengambil alias domain

Anda dapat mengambil alias domain baik berdasarkan id atau nilai name-nya.

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:

Memperbarui alias domain

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

Permintaan Contoh:

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

Permintaan Contoh:

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

Kami memungkinkan Anda untuk mengenkripsi catatan bahkan pada paket gratis tanpa biaya. Privasi seharusnya bukan fitur, melainkan harus secara inheren terbangun di semua aspek produk. Sebagaimana sangat diminta dalam diskusi Privacy Guides dan pada isu GitHub kami kami telah menambahkannya.

Enkripsi Catatan TXT

POST /v1/encrypt

Permintaan Contoh:

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