API Penerusan Email

Daftar Isi

• Perpustakaan
• Basis URI
• Autentikasi
• Kesalahan
• Lokalisasi
• Penomoran halaman
• Akun
  • Buat Akun
  • Ambil akun
  • Perbaharui akun
• Domain
  • Daftar domain
  • Buat domain
  • Ambil domain
  • Verifikasi catatan domain
  • Perbarui domain
  • Hapus domain
• Undangan
  • Terima undangan domain
  • Buat undangan domain
  • Hapus undangan domain
• Anggota
  • Perbarui anggota domain
  • Hapus anggota domain
• Alias
  • Daftar alias domain
  • Buat alias domain baru
  • Ambil alias domain
  • Perbarui alias domain
  • Hapus alias domain

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
Python	permintaan
Jawa	OkeHttp
PHP	membuang waktu
JavaScript	agen super
Node.js	agen super
Pergilah	net / http
.NET	RestSharp

Basis URI

Jalur URI dasar HTTP saat ini adalah: https://api.forwardemail.net. Jalur URI dasar HTTP lama dari https://forwardemail.net:4000 tidak digunakan lagi pada 1 Januari 2021.

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

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

POST /v1/account

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

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 -X GET https://api.forwardemail.net/v1/account \
  -u API_TOKEN:

Perbaharui akun

PUT /v1/account

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

Contoh Permintaan:

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

Domain

Daftar domain

GET /v1/domains

Parameter Pertanyaan	Yg dibutuhkan	Tipe	Deskripsi
name	Tidak	String (didukung oleh RegExp)	Cari domain berdasarkan nama
alias	Tidak	String (didukung oleh RegExp)	Cari domain dengan nama alias
recipient	Tidak	String (didukung oleh RegExp)	Cari domain berdasarkan penerima

Contoh Permintaan:

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

Buat domain

POST /v1/domains

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

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 -X GET https://api.forwardemail.net/v1/domains/example.com \
  -u API_TOKEN:

Verifikasi catatan domain

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

Contoh Permintaan:

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

Perbarui domain

PUT /v1/domains/example.com

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

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:

Undangan

Terima undangan domain

GET /v1/domains/:domain_name/invites

Contoh Permintaan:

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

Buat undangan domain

POST /v1/domains/example.com/invites

Parameter tubuh	Yg dibutuhkan	Tipe	Deskripsi
email	Iya	String (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")

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

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

Contoh Permintaan:

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

Anggota

Perbarui anggota domain

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

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")

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:

Alias

Daftar alias domain

GET /v1/domains/example.com/aliases

Parameter Pertanyaan	Yg dibutuhkan	Tipe	Deskripsi
name	Tidak	String (didukung oleh RegExp)	Cari alias di domain dengan nama
recipient	Tidak	String (didukung oleh RegExp)	Cari alias di domain menurut penerima

Contoh Permintaan:

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

Buat alias domain baru

POST /v1/domains/example.com/aliases

Parameter tubuh	Yg dibutuhkan	Tipe	Deskripsi
name	Iya	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)

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

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)

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: