API Email

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 diberi tahu saat pembungkus API bahasa pemrograman tertentu dirilis. Sementara itu, Anda dapat menggunakan pustaka permintaan HTTP yang direkomendasikan ini di aplikasi Anda, atau cukup gunakan ikal seperti pada contoh-contoh di bawah ini.

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

Semua titik akhir memerlukan Kunci API untuk ditetapkan sebagai nilai "nama pengguna" dari permintaan Otorisasi Dasar kepala. Jangan khawatir – contoh disediakan di bawah ini untuk Anda jika Anda tidak yakin apa ini.

Jika terjadi kesalahan, isi respons permintaan API akan berisi pesan kesalahan mendetail.

Layanan kami diterjemahkan ke lebih dari 25 bahasa yang berbeda. Semua pesan respons API diterjemahkan ke lokal terakhir yang terdeteksi dari pengguna yang membuat permintaan API. Anda dapat menimpa ini dengan melewati kebiasaan Accept-Language kepala. Jangan ragu untuk mencobanya menggunakan tarik-turun bahasa di bagian bawah halaman ini.

Jika Anda ingin diberi tahu saat pagination tersedia, silakan kirim email api@forwardemail.net.

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 (Gzip terkompresi CSV file spreadsheet) setelah selesai.

Ini memungkinkan Anda membuat pekerjaan latar belakang dengan a Pekerjaan Cron atau menggunakan milik kami Perangkat lunak penjadwalan pekerjaan Node.js Bree untuk menerima log kapan pun Anda mau. Perhatikan bahwa titik akhir ini terbatas pada 10 permintaan per hari.

Lampirannya berbentuk huruf kecil email-deliverability-logs-YYYY-MM-DD-h-mm-A-z.csv.gz dan email itu sendiri berisi ringkasan singkat dari 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 tugas 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 sintaks ekspresi tugas cron Anda.

Contoh pekerjaan Cron (pada 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 akun

GET /v1/account

Contoh Permintaan:

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

Perbaharui akun

PUT /v1/account

Contoh Permintaan:

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

Harap pastikan bahwa Anda telah mengikuti petunjuk penyiapan untuk domain Anda. Petunjuk ini dapat ditemukan di Akun Saya → Domain → Pengaturan → Konfigurasi SMTP Keluar. Anda perlu memastikan penyiapan DKIM, Return-Path, dan DMARC untuk mengirim SMTP keluar dengan domain Anda.

Buat daftar email

Perhatikan bahwa titik akhir ini tidak mengembalikan email yang sudah dibuat message, headers, accepted, juga bukan rejectedErrors properti.

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

Titik akhir ini paling banyak akan kembali 50 hasil pada suatu waktu. Jika Anda ingin menanyakan beberapa halaman, tambahkan ?page=NUMBER Di mana NUMBER adalah bilangan bulat, mis. ?page=1.

GET /v1/emails

Contoh Permintaan:

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

Buat email

API kami untuk membuat email terinspirasi oleh dan memanfaatkan konfigurasi opsi pesan Nodemailer. Silakan tunda ke Konfigurasi pesan nodemailer untuk semua parameter tubuh di bawah ini.

Perhatikan bahwa dengan pengecualian envelope dan dkim (karena kami mengaturnya secara otomatis untuk Anda), kami mendukung semua opsi Nodemailer. Kami secara otomatis mengatur disableFileAccess dan disableUrlAccess pilihan untuk true untuk tujuan keamanan.

Anda harus melewati opsi tunggal raw dengan email lengkap mentah Anda termasuk header atau lewati opsi parameter tubuh individu di bawah ini.

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

GET /v1/emails/:id

Contoh Permintaan:

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

Hapus surel

Penghapusan email akan mengatur status menjadi "rejected" (dan selanjutnya tidak memprosesnya dalam antrian) jika dan hanya jika status saat ini adalah salah satu dari "pending", "queued", atau "deferred". Kami dapat menghapus email secara otomatis setelah 30 hari setelah dibuat dan/atau dikirim – karena itu Anda harus menyimpan salinan email keluar SMTP di klien, database, atau aplikasi Anda. Anda dapat mereferensikan nilai ID email kami di basis data Anda jika diinginkan – nilai ini dikembalikan dari keduanya Buat email dan Ambil email titik akhir.

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:

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:

Daftar alias domain

GET /v1/domains/example.com/aliases

Contoh Permintaan:

curl https://api.forwardemail.net/v1/domains/example.com/aliases \
  -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 dengan id atau itu name nilai.

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: