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 header (kecuali 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, isi respons permintaan API akan berisi pesan kesalahan mendetail.

[!TIP] Jika Anda menerima kode status 5xx (yang seharusnya tidak terjadi), silakan hubungi kami di api@forwardemail.net dan kami akan membantu Anda untuk menyelesaikan masalah Anda segera.

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.

[!NOTE] Sejak 1 November 2024, titik akhir API untuk Daftar domain dan Daftar alias domain akan default ke 1000 hasil maksimal per halaman. Jika Anda ingin ikut serta dalam perilaku ini lebih awal, Anda dapat meneruskannya ?paginate=true sebagai parameter querystring tambahan ke URL untuk kueri titik akhir.

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 1Jika Anda memberikan limit (juga angka), maka nilai minimumnya adalah 10 dan maksimum adalah 50 (kecuali dinyatakan lain).

Untuk menentukan apakah ada hasil tambahan yang tersedia atau tidak, kami berikan 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 (Bahasa Indonesia: 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"

[!NOTE] Tidak seperti titik akhir API lainnya, ini memerlukan Autentikasi "nama pengguna" sama dengan alias nama pengguna dan "kata sandi" sama dengan alias kata sandi yang dihasilkan sebagai header Otorisasi Dasar.

[!PERINGATAN] Bagian titik akhir ini masih dalam tahap pengerjaan dan akan dirilis (semoga) pada tahun 2024. Untuk sementara, harap gunakan klien IMAP dari menu tarik-turun "Aplikasi" di navigasi situs web kami.

[!NOTE] Dukungan CardDAV belum tersedia, ikuti diskusi ini di GitHub untuk pembaruan.

Daftar kontak

GET /v1/contacts

Segera akan datang

Buat kontak

POST /v1/contacts

Segera akan datang

Ambil kembali kontak

GET /v1/contacts/:id

Segera akan datang

Perbarui kontak

PUT /v1/contacts/:id

Segera akan datang

Hapus kontak

DELETE /v1/contacts/:id

Segera akan datang

[!NOTE] Tidak seperti titik akhir API lainnya, ini memerlukan Autentikasi "nama pengguna" sama dengan alias nama pengguna dan "kata sandi" sama dengan alias kata sandi yang dihasilkan sebagai header Otorisasi Dasar.

[!PERINGATAN] Bagian titik akhir ini masih dalam tahap pengerjaan dan akan dirilis (semoga) pada tahun 2024. Untuk sementara, harap gunakan klien IMAP dari menu tarik-turun "Aplikasi" di navigasi situs web kami.

Daftar kalender

GET /v1/calendars

Segera akan datang

Buat kalender

POST /v1/calendars

Segera akan datang

Ambil kalender

GET /v1/calendars/:id

Segera akan datang

Perbarui kalender

PUT /v1/calendars/:id

Segera akan datang

Hapus kalender

DELETE /v1/calendars/:id

Segera akan datang

[!NOTE] Tidak seperti titik akhir API lainnya, ini memerlukan Autentikasi "nama pengguna" sama dengan alias nama pengguna dan "kata sandi" sama dengan alias kata sandi yang dihasilkan sebagai header Otorisasi Dasar.

[!PERINGATAN] Bagian titik akhir ini masih dalam tahap pengerjaan dan akan dirilis (semoga) pada tahun 2024. Untuk sementara, harap gunakan klien IMAP dari menu tarik-turun "Aplikasi" di navigasi situs web kami.

Pastikan Anda telah mengikuti petunjuk 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 akan datang

Buat pesan

[!NOTE] Ini akan NOT kirim email – ini hanya akan menambahkan pesan ke folder kotak surat Anda (misalnya ini mirip dengan IMAP APPEND perintah). Jika Anda ingin mengirim email, maka lihat Buat email SMTP keluar di bawah. Setelah membuat email SMTP keluar, Anda dapat menambahkan salinannya menggunakan titik akhir ini ke kotak surat alias Anda untuk tujuan penyimpanan.

POST /v1/messages

Segera akan datang

Ambil pesan

GET /v1/messages/:id

Segera akan datang

Perbarui pesan

PUT /v1/messages/:id

Segera akan datang

Hapus pesan

DELETE /v1/messages:id

Segera akan datang

[!TIP] Titik akhir folder dengan jalur folder /v1/folders/:path karena titik akhirnya dapat dipertukarkan dengan ID folder :idIni berarti Anda dapat merujuk ke folder dengan salah satu path atau id nilai.

[!PERINGATAN] Bagian titik akhir ini masih dalam tahap pengerjaan dan akan dirilis (semoga) pada tahun 2024. Untuk sementara, harap gunakan klien IMAP dari menu tarik-turun "Aplikasi" di navigasi situs web kami.

Daftar folder

GET /v1/folders

Segera akan datang

Buat folder

POST /v1/folders

Segera akan datang

Ambil kembali folder

GET /v1/folders/:id

Segera akan datang

Perbarui folder

PUT /v1/folders/:id

Segera akan datang

Hapus folder

DELETE /v1/folders/:id

Segera akan datang

Salin folder

POST /v1/folders/:id/copy

Segera akan datang

Pastikan Anda telah mengikuti petunjuk pengaturan 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.

Dapatkan batas email SMTP keluar

Ini adalah titik akhir sederhana yang mengembalikan objek JSON yang 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 email message, headers, juga bukan rejectedErrors.

Untuk mengembalikan properti tersebut dan nilainya, silakan gunakan Ambil email titik akhir 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. 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.

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

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 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:

[!TIP] Titik akhir domain dengan nama domain /v1/domains/:domain_name karena titik akhirnya dapat dipertukarkan dengan ID domain :domain_id. Ini berarti Anda dapat merujuk ke domain dengan name atau id nilai.

Daftar domain

[!NOTE] Sejak 1 November 2024, titik akhir API untuk Daftar domain dan Daftar alias domain akan default ke 1000 hasil maksimal per halaman. Jika Anda ingin ikut serta dalam perilaku ini lebih awal, Anda dapat meneruskannya ?paginate=true sebagai parameter querystring tambahan ke URL untuk kueri titik akhir. Lihat Penomoran halaman untuk lebih banyak wawasan.

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

[!PENTING] Jika pengguna yang diundang sudah menjadi anggota yang diterima di domain lain tempat admin yang mengundangnya menjadi anggota, maka undangan akan diterima secara otomatis dan tidak akan dikirimi email.

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

Perhatikan bahwa jika Anda tidak mengirimkan instruksi melalui email, maka nama pengguna dan kata sandi akan ada 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

[!NOTE] Sejak 1 November 2024, titik akhir API untuk Daftar domain dan Daftar alias domain akan default ke 1000 hasil maksimal per halaman. Jika Anda ingin ikut serta dalam perilaku ini lebih awal, Anda dapat meneruskannya ?paginate=true sebagai parameter querystring tambahan ke URL untuk kueri titik akhir. Lihat Penomoran halaman untuk lebih banyak wawasan.

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 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:

Kami mengizinkan Anda mengenkripsi catatan bahkan pada paket gratis tanpa biaya. Privasi tidak boleh menjadi sebuah fitur, privasi harus menjadi bagian integral dari semua aspek produk. Seperti yang sangat diminta dalam a Diskusi Panduan Privasi dan seterusnya masalah GitHub kami kami telah menambahkan ini.

Enkripsi Catatan TXT

POST /v1/encrypt

Contoh Permintaan:

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