API Email

Perpustakaan

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.

Bahasa	Perpustakaan
Rubi	Faraday
Piton	permintaan
Jawa	OkeHttp
PHP	membuang waktu
JavaScript	agen super (kami adalah pengelola)
Node.js	agen super (kami adalah pengelola)
Pergilah	net / http
.NET	Istirahat Tajam

Basis URI

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

Autentikasi

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.

Kesalahan

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

Kode	Nama
200	OK
400	Permintaan yang buruk
401	Tidak resmi
403	Terlarang
404	Tidak ditemukan
429	Terlalu Banyak Permintaan
500	Kesalahan server dari dalam
501	Tidak Diimplementasikan
502	Gerbang Buruk
503	Layanan tidak tersedia
504	Gerbang Waktu habis

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.

Lokalisasi

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.

Penomoran halaman

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

Akun

Buat Akun

Parameter tubuh	Yg dibutuhkan	Tipe	Deskripsi
`email`	Iya	Untaian (Email)	Alamat email
`password`	Iya	Tali	Kata sandi

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

Ambil akun

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

Perbaharui akun

Parameter tubuh	Yg dibutuhkan	Tipe	Deskripsi
`email`	Tidak	Untaian (Email)	Alamat email
`given_name`	Tidak	Tali	Nama depan
`family_name`	Tidak	Tali	nama keluarga
`avatar_url`	Tidak	Tali (URL)	Tautan ke gambar avatar

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

Email

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.

Parameter Pertanyaan	Yg dibutuhkan	Tipe	Deskripsi
`q`	Tidak	String (didukung oleh RegExp)	Telusuri email berdasarkan metadata
`domain`	Tidak	String (didukung oleh RegExp)	Cari email berdasarkan nama domain
`page`	Tidak	Nomor	Halaman untuk mengembalikan hasil (standarnya adalah `1`)
`batas	Tidak	Nomor	Jumlah hasil per halaman yang akan dikembalikan (standarnya adalah `50` – maksimalnya adalah `50` dan minimum adalah `10`)

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.

Parameter tubuh	Yg dibutuhkan	Tipe	Deskripsi
`from`	Tidak	Untaian (Email)	Alamat email pengirim (harus ada sebagai alias domain).
`to`	Tidak	String atau Array	Daftar yang dipisahkan koma atau Array penerima untuk header "Kepada".
`cc`	Tidak	String atau Array	Daftar yang dipisahkan koma atau Array penerima untuk header "Cc".
`bcc`	Tidak	String atau Array	Daftar yang dipisahkan koma atau Array penerima untuk header "Bcc".
`subject`	Tidak	Tali	Subjek email.
`text`	Tidak	String atau Penyangga	Versi teks biasa dari pesan.
`html`	Tidak	String atau Penyangga	Versi HTML pesan.
`attachments`	Tidak	Himpunan	Array objek lampiran (lihat Bidang umum Nodemailer).
`sender`	Tidak	Tali	Alamat email untuk tajuk "Pengirim" (lihat Bidang Nodemailer yang lebih maju).
`replyTo`	Tidak	Tali	Alamat email untuk header "Reply-To".
`inReplyTo`	Tidak	Tali	Pesan-Id pesan dibalas.
`references`	Tidak	String atau Array	Daftar yang dipisahkan ruang atau Array of Message-ID's.
`attachDataUrls`	Tidak	Boolean	Jika `true` kemudian mengkonversi `data:` gambar dalam konten HTML pesan ke lampiran tersemat.
`watchHtml`	Tidak	Tali	Pesan versi HTML khusus Apple Watch (menurut dokumen Nodemailer, jam tangan terbaru tidak memerlukan pengaturan ini).
`amp`	Tidak	Tali	Versi HTML khusus AMP4EMAIL dari pesan tersebut (lihat Contoh Nodemailer).
`icalEvent`	Tidak	Obyek	Acara iCalendar untuk digunakan sebagai konten pesan alternatif (lihat Acara kalender Nodemailer).
`alternatives`	Tidak	Himpunan	Array konten pesan alternatif (lihat Konten alternatif Nodemailer).
`encoding`	Tidak	Tali	Pengodean untuk teks dan string HTML (standarnya adalah `"utf-8"`, tapi mendukung `"hex"` dan `"base64"` nilai encoding juga).
`raw`	Tidak	String atau Penyangga	Pesan berformat RFC822 yang dibuat khusus untuk digunakan (bukan yang dihasilkan oleh Nodemailer – lihat Sumber khusus Nodemailer).
`textEncoding`	Tidak	Tali	Pengkodean yang terpaksa digunakan untuk nilai teks (baik `"quoted-printable"` atau `"base64"`). Nilai default adalah nilai terdekat yang terdeteksi (untuk penggunaan ASCII `"quoted-printable"`).
`priority`	Tidak	Tali	Tingkat prioritas untuk email (bisa jadi `"high"`, `"normal"` (standar), atau `"low"`). Perhatikan bahwa nilai dari `"normal"` tidak menetapkan tajuk prioritas (ini adalah perilaku default). Jika nilai dari `"high"` atau `"low"` diatur, maka `X-Priority`, `X-MSMail-Priority`, dan `Importance` header akan diatur sebagaimana mestinya.
`headers`	Tidak	Objek atau Array	Objek atau Larik bidang tajuk tambahan untuk ditetapkan (lihat Header khusus Nodemailer).
`messageId`	Tidak	Tali	Nilai Message-ID opsional untuk header "Message-ID" (nilai default akan otomatis dibuat jika tidak disetel – perhatikan bahwa nilainya harus mematuhi spesifikasi RFC2822).
`date`	Tidak	Tali atau Tanggal	Nilai Tanggal opsional yang akan digunakan jika tajuk Tanggal tidak ada setelah penguraian, jika tidak, string UTC saat ini akan digunakan jika tidak disetel. Header tanggal tidak boleh lebih dari 30 hari sebelum waktu saat ini.
`list`	Tidak	Obyek	Objek opsional dari `List-*` header (lihat Header daftar Nodemailer).

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"

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

Ambil email

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.

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

Domain

Tip: Titik akhir domain dengan nama domain /v1/domains/:domain_name karena jalurnya dapat dipertukarkan dengan ID domain :domain_id. Ini berarti Anda dapat merujuk ke domain dengan name atau id nilai.

Daftar domain

Parameter Pertanyaan	Yg dibutuhkan	Tipe	Deskripsi
`q`	Tidak	String (didukung oleh RegExp)	Cari domain berdasarkan nama
`name`	Tidak	String (didukung oleh RegExp)	Cari domain berdasarkan nama

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

Buat domain

Parameter tubuh	Yg dibutuhkan	Tipe	Deskripsi
`domain`	Iya	String (FQDN atau IP)	Nama domain yang sepenuhnya memenuhi syarat ("FQDN") atau alamat IP
`plan`	Tidak	String (dapat dihitung)	Jenis paket (harus `"free"`, `"enhanced_protection"`, atau `"team"`, default ke `"free"` atau paket berbayar pengguna saat ini jika ada)
`catchall`	Tidak	String (alamat email yang dibatasi) atau Boolean	Buat alias penampung-semua default, default ke `true` (jika `true` itu akan menggunakan alamat email pengguna API sebagai penerima, dan jika `false` tidak ada catch-all yang akan dibuat). Jika sebuah String dilewatkan, maka itu adalah daftar alamat email yang dibatasi untuk digunakan sebagai penerima (dipisahkan dengan jeda baris, spasi, dan/atau koma)
`has_adult_content_protection`	Tidak	Boolean	Apakah akan mengaktifkan perlindungan konten dewasa Pemindai Spam di domain ini
`has_phishing_protection`	Tidak	Boolean	Apakah akan mengaktifkan perlindungan phishing Pemindai Spam di domain ini
`has_executable_protection`	Tidak	Boolean	Apakah akan mengaktifkan perlindungan yang dapat dijalankan Pemindai Spam di domain ini
`has_virus_protection`	Tidak	Boolean	Apakah akan mengaktifkan perlindungan virus Pemindai Spam di domain ini
`has_recipient_verification`	Tidak	Boolean	Default domain global untuk meminta penerima alias mengklik tautan verifikasi email agar email dapat mengalir

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

Ambil domain

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

Verifikasi catatan domain

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

Perbarui domain

Parameter tubuh	Yg dibutuhkan	Tipe	Deskripsi
`smtp_port`	Tidak	String atau Angka	Port khusus untuk dikonfigurasi untuk penerusan SMTP (defaultnya adalah `"25"`)
`has_adult_content_protection`	Tidak	Boolean	Apakah akan mengaktifkan perlindungan konten dewasa Pemindai Spam di domain ini
`has_phishing_protection`	Tidak	Boolean	Apakah akan mengaktifkan perlindungan phishing Pemindai Spam di domain ini
`has_executable_protection`	Tidak	Boolean	Apakah akan mengaktifkan perlindungan yang dapat dijalankan Pemindai Spam di domain ini
`has_virus_protection`	Tidak	Boolean	Apakah akan mengaktifkan perlindungan virus Pemindai Spam di domain ini
`has_recipient_verification`	Tidak	Boolean	Default domain global untuk meminta penerima alias mengklik tautan verifikasi email agar email dapat mengalir

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

Hapus domain

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

Undangan

Terima undangan domain

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

Buat undangan domain

Parameter tubuh	Yg dibutuhkan	Tipe	Deskripsi
`email`	Iya	Untaian (Email)	Alamat email untuk diundang ke daftar anggota domain
`group`	Iya	String (dapat dihitung)	Grup untuk menambahkan pengguna ke keanggotaan domain (bisa menjadi salah satu dari `"admin"` atau `"user"`)

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

Parameter tubuh	Yg dibutuhkan	Tipe	Deskripsi
`email`	Iya	Untaian (Email)	Alamat email untuk dihapus dari daftar anggota domain

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

Anggota

Perbarui anggota domain

Parameter tubuh	Yg dibutuhkan	Tipe	Deskripsi
`group`	Iya	String (dapat dihitung)	Grup untuk memperbarui pengguna ke keanggotaan domain dengan (bisa menjadi salah satu dari `"admin"` atau `"user"`)

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

Hapus anggota domain

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

Alias

Daftar alias domain

Parameter Pertanyaan	Yg dibutuhkan	Tipe	Deskripsi
`q`	Tidak	String (didukung oleh RegExp)	Telusuri alias di domain menurut nama, label, atau penerima
`name`	Tidak	String (didukung oleh RegExp)	Cari alias di domain dengan nama
`recipient`	Tidak	String (didukung oleh RegExp)	Cari alias di domain menurut penerima

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

Buat alias domain baru

Parameter tubuh	Yg dibutuhkan	Tipe	Deskripsi
`name`	Tidak	Tali	Nama alias (jika tidak diberikan atau jika kosong, maka alias acak dibuat)
`recipients`	Tidak	String atau Array	Daftar penerima (harus dipisahkan baris/spasi/koma String atau Array dari alamat email yang valid, nama domain yang memenuhi syarat ("FQDN"), alamat IP, dan/atau URL webhook – dan jika tidak diberikan atau kosong Array, maka email pengguna yang membuat permintaan API akan ditetapkan sebagai penerima)
`description`	Tidak	Tali	Deskripsi alias
`labels`	Tidak	String atau Array	Daftar label (harus dipisahkan dengan garis / spasi / String atau Array yang dipisahkan koma)
`has_recipient_verification`	Tidak	Boolean	Apakah akan mengaktifkan untuk mewajibkan penerima mengeklik tautan verifikasi email agar email mengalir (default ke setelan domain jika tidak secara eksplisit disetel di badan permintaan)
`is_enabled`	Tidak	Boolean	Apakah akan mengaktifkan untuk menonaktifkan alias ini (jika dinonaktifkan, email tidak akan dialihkan ke mana pun kecuali mengembalikan kode status yang berhasil). Default ke `true`, tetapi jika suatu nilai diteruskan, itu diubah menjadi boolean menggunakan boolean)

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.

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

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

Perbarui alias domain

Parameter tubuh	Yg dibutuhkan	Tipe	Deskripsi
`name`	Tidak	Tali	Nama alias
`recipients`	Iya	String atau Array	Daftar penerima (harus String-break / spasi / dipisahkan koma atau Array alamat email yang valid, nama domain yang memenuhi syarat ("FQDN"), alamat IP, dan / atau URL webhook URL)
`description`	Tidak	Tali	Deskripsi alias
`labels`	Tidak	String atau Array	Daftar label (harus dipisahkan dengan garis / spasi / String atau Array yang dipisahkan koma)
`has_recipient_verification`	Tidak	Boolean	Apakah akan mengaktifkan untuk mewajibkan penerima mengeklik tautan verifikasi email agar email mengalir (default ke setelan domain jika tidak secara eksplisit disetel di badan permintaan)
`is_enabled`	Tidak	Boolean	Apakah akan mengaktifkan untuk menonaktifkan alias ini (jika dinonaktifkan, email akan dialihkan ke mana pun tetapi mengembalikan kode status yang berhasil)

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

Hapus alias domain

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