Daftar periksa pengaturan cepat
- Buka halaman Manajemen API dasbor Anda dan buat kunci API pribadi Anda.
- Salin dengan tepat URL Dasar API Pengguna yang ditampilkan di sana, contohnya https://v1.tempmailg.com/api.
- Kirim setiap permintaan ke host API tersebut dengan Authorization: Bearer YOUR_USER_API_KEY dan Accept: application/json.
- Lacak kuota permintaan bulanan Anda dari halaman dasbor yang sama dan dari header kuota ketika tersedia pada respons API pengguna. Hanya permintaan 2xx yang berhasil yang dihitung dalam kuota.
Alur otentikasi
- Hasilkan kunci API pribadi Anda dari halaman Manajemen API dashboard.
- Kirim kunci sebagai token Bearer dalam setiap permintaan.
- Gunakan URL Dasar API Pengguna khusus yang ditampilkan di halaman Manajemen API Anda.
- Regenerasi kunci kapan saja Anda ingin membatalkan kunci lama dan segera mulai menggunakan kunci baru.
Header yang diperlukan
Authorization: Bearer YOUR_USER_API_KEY
Accept: application/json
Header Batas Kecepatan & Kuota
Header batas laju menjelaskan anggaran permintaan yang ditunjukkan. Header kuota disertakan ketika informasi kuota tersedia; penolakan batas menit tidak menghitung kuota bulanan penuh Anda.
X-RateLimit-Limit: 60
X-RateLimit-Remaining: 45
X-RateLimit-Reset: 1729520000
X-Quota-Limit: 50000
X-Quota-Remaining: 48210
X-Quota-Used: 1790
X-Quota-Reset: 2026-11-01T00:00:00+00:00
X-RateLimit-Scope: account
Retry-After: 42 (when a timed retry is available)
X-RateLimit-Limit— Jumlah permintaan maksimum yang diizinkan per menit (RPM) untuk paket Anda.X-RateLimit-Remaining— Permintaan RPM yang tersisa dalam jendela menit saat ini.X-RateLimit-Reset— Timestamp Unix saat jendela batas laju menit saat ini direset.X-Quota-Limit— Total kapasitas kredit bulanan dan yang dibeli untuk akun Anda.X-Quota-Remaining— Sisa permintaan API yang tersedia pada bulan ini.X-Quota-Used— Total permintaan API yang dikonsumsi selama periode penagihan saat ini.X-Quota-Reset— Timestamp ISO-8601 saat kuota bulanan Anda direset.X-RateLimit-Scope— Anggaran yang dijelaskan oleh header: akun, ip, status_endpoint, atau kotak surat.X-Mailbox-RateLimit-*— Anggaran terpisah untuk pembuatan/pembaruan kotak surat. Respons kotak surat yang berhasil menjaga RPM akun dalam X-RateLimit-*; penolakan khusus kotak surat menggunakan cakupan kotak surat dan jendela percobaan ulang sendiri.Retry-After— Detik hingga percobaan ulang berwaktu sesuai. Rencana yang dinonaktifkan atau kuota yang habis mungkin memerlukan perubahan akun sebagai gantinya, sehingga header ini tidak selalu ada.503 protection_unavailable— Penyimpanan atau koordinasi perlindungan API tidak tersedia sementara. Coba lagi nanti; ini bukan kegagalan pembayaran atau debit kredit.
Manajemen Kotak Surat
Ambil domain yang diizinkan, buat atau ganti kotak surat, pilih masa pakai yang diizinkan, dan hapus alamat yang dimiliki.
Daftar Domain yang Diizinkan
Daftar domain yang tersedia untuk membuat email sementara. Filter berdasarkan tipe untuk melihat hanya domain gratis, premium, atau khusus yang didukung oleh paket langganan Anda.
| Parameter | Lokasi | Jenis | Status | Deskripsi |
|---|---|---|---|---|
type
|
query | string | opsional |
Filter tingkat domain. Penghilangan menggunakan semua ketika akses domain-premium diaktifkan, jika tidak maka gratis. Nilai yang dikenali: free, basic, pro, premium, custom, ultimate, all
Bawaan:
Tergantung akun
|
const response = await fetch('https://v1.tempmailg.com/api/domains?type=free', {
method: 'GET',
headers: {
'Authorization': 'Bearer YOUR_USER_API_KEY',
'Accept': 'application/json',
},
});
if (!response.ok) {
throw new Error(`Request failed with status ${response.status}`);
}
const data = await response.json();
console.log(data);
import requests
headers = {
'Authorization': 'Bearer YOUR_USER_API_KEY',
'Accept': 'application/json',
}
response = requests.get('https://v1.tempmailg.com/api/domains?type=free', headers=headers, timeout=30)
response.raise_for_status()
print(response.json())
<?php
$ch = curl_init('https://v1.tempmailg.com/api/domains?type=free');
curl_setopt_array($ch, [
CURLOPT_CUSTOMREQUEST => 'GET',
CURLOPT_RETURNTRANSFER => true,
CURLOPT_HTTPHEADER => [
'Authorization: Bearer YOUR_USER_API_KEY',
'Accept: application/json',
],
]);
$response = curl_exec($ch);
if ($response === false) {
throw new RuntimeException(curl_error($ch));
}
$statusCode = curl_getinfo($ch, CURLINFO_HTTP_CODE);
curl_close($ch);
var_dump($statusCode, json_decode($response, true));
curl --request GET \
--url 'https://v1.tempmailg.com/api/domains?type=free' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer YOUR_USER_API_KEY'
Respons ilustratif menggunakan data sintetis. ID, alamat, token, cap waktu, batas dan hitungan paket bervariasi. Contoh masa pakai tidak menggantikan default paket Anda. Deskripsi bidang respons mengidentifikasi bidang yang dapat bernilai null dan spesifik penyedia.
Contoh respons
200 OK • JSON{
"status": true,
"data": {
"requested_type": "free",
"plan": "pro",
"plan_name": "Pro Plan",
"allowed_types": [
"free",
"basic",
"pro",
"premium",
"custom",
"ultimate",
"all"
],
"domains": [
{
"domain": "example.com",
"type": "Free",
"custom": false
}
]
}
}
| Bidang | Jenis | Deskripsi |
|---|---|---|
status |
boolean | Apakah operasi berhasil. |
data.requested_type |
string | Filter domain diterapkan. |
data.plan |
string | Tag rencana saat ini. |
data.plan_name |
string | Nama yang dapat dibaca dari paket saat ini. |
data.allowed_types |
array<string> | Filter domain tersedia untuk akun ini. Filter yang dikenali masih dapat dilarang untuk paket Anda. |
data.domains |
array | Domain yang dapat dipilih setelah penyaringan; array kosong dianggap valid. |
data.domains[].domain |
string | Nama domain yang dapat dipilih. |
data.domains[].type |
string | Label tingkat domain yang dapat dibaca. |
data.domains[].custom |
boolean | Apakah ini domain khusus. |
Buat Kotak Surat Sementara
Buat kotak surat sementara yang dimiliki. Abaikan nama pengguna dan domain untuk pembuatan acak, atau berikan nama pengguna khusus yang diizinkan dan domain yang diperbolehkan. Parameter provider dapat memilih pembuatan alias Gmail atau Outlook.
| Parameter | Lokasi | Jenis | Status | Deskripsi |
|---|---|---|---|---|
username
|
body | string | opsional |
Nama pengguna khusus opsional: 2 hingga 64 huruf ASCII, angka, titik, garis bawah, atau tanda hubung. Memerlukan izin paket; custom_username juga diterima.
Bawaan:
Dihasilkan secara acak
|
domain
|
body | string | opsional |
Salah satu domain yang diizinkan yang dikembalikan oleh GET /domains. Penghilangan memilih domain yang diizinkan secara acak.
Bawaan:
Domain yang diizinkan secara acak
|
lifetime
|
body | string | opsional |
nilai yang diizinkan:
10m — 10 Menit
1h — 1 Jam
2h — 2 Jam
1d — 1 Hari
1w — 1 Minggu
1m — 30 Hari
3m — 90 hari
6m — 180 Hari
1y — 365 Hari
unlimited — Tidak Terbatas
Bawaan:
Masa pakai default rencana
|
provider
|
body | string | opsional |
Penyedia kotak surat: standard, gmail_alias, atau outlook_alias.
Bawaan:
standard
|
pin_enabled
|
body | boolean | opsional |
Perlindungan PIN opsional untuk kotak surat baru, bila diizinkan oleh paket Anda. Ini tidak mengubah PIN kotak surat yang sudah ada.
Bawaan:
false
|
pin
|
body | string | opsional |
Diperlukan ketika pin_enabled bernilai true: PIN dengan 6 hingga 8 digit, dikirim sebagai string untuk mempertahankan nol di depan.
|
pin_confirmation
|
body | string | opsional |
Diperlukan ketika pin_enabled bernilai true. Harus persis cocok dengan pin.
|
Idempotency-Key
|
header | string | opsional |
Diperlukan untuk pembuatan atau penghapusan yang dilindungi PIN: kunci stabil 16 hingga 128 karakter. Ulangi permintaan yang sama dengan kunci yang sama untuk menghindari pekerjaan duplikat.
|
username (nama pengguna khusus jika diizinkan oleh paket), domain (domain yang diizinkan, mis. example.com), lifetime (nilai yang diizinkan: 10m, 1h, 2h, 1d, 1w, 1m, 3m, 6m, 1y, unlimited), provider (standard, gmail_alias, outlook_alias). Lewati masa pakai, atau biarkan kosong, untuk menggunakan Default Email Lifetime yang dikonfigurasi untuk paket bulanan/tahunan Anda saat ini. Kirim masa pakai yang diizinkan seperti 1h untuk mengganti default tersebut. Tidak terbatas hanya digunakan ketika dikonfigurasi sebagai default paket atau secara eksplisit diminta dan diizinkan. Parameter tubuh mailbox_lifetime dan email_lifetime juga diterima; nilai tidak kosong pertama yang menang dalam urutan ini: lifetime, mailbox_lifetime, email_lifetime. Nilai yang tidak valid atau tidak diizinkan mengembalikan HTTP 422 alih-alih secara diam-diam memilih nilai default.const response = await fetch('https://v1.tempmailg.com/api/emails', {
method: 'POST',
headers: {
'Authorization': 'Bearer YOUR_USER_API_KEY',
'Accept': 'application/json',
},
});
if (!response.ok) {
throw new Error(`Request failed with status ${response.status}`);
}
const data = await response.json();
console.log(data);
import requests
headers = {
'Authorization': 'Bearer YOUR_USER_API_KEY',
'Accept': 'application/json',
}
response = requests.post('https://v1.tempmailg.com/api/emails', headers=headers, timeout=30)
response.raise_for_status()
print(response.json())
<?php
$ch = curl_init('https://v1.tempmailg.com/api/emails');
curl_setopt_array($ch, [
CURLOPT_CUSTOMREQUEST => 'POST',
CURLOPT_RETURNTRANSFER => true,
CURLOPT_HTTPHEADER => [
'Authorization: Bearer YOUR_USER_API_KEY',
'Accept: application/json',
],
]);
$response = curl_exec($ch);
if ($response === false) {
throw new RuntimeException(curl_error($ch));
}
$statusCode = curl_getinfo($ch, CURLINFO_HTTP_CODE);
curl_close($ch);
var_dump($statusCode, json_decode($response, true));
curl --request POST \
--url 'https://v1.tempmailg.com/api/emails' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer YOUR_USER_API_KEY'
Respons ilustratif menggunakan data sintetis. ID, alamat, token, cap waktu, batas dan hitungan paket bervariasi. Contoh masa pakai tidak menggantikan default paket Anda. Deskripsi bidang respons mengidentifikasi bidang yang dapat bernilai null dan spesifik penyedia.
Contoh respons
200 OK • JSON{
"status": true,
"data": {
"id": 2301,
"pin_protected": false,
"email": "demo123@example.com",
"domain": "example.com",
"provider": "standard",
"expire_at": "2026-11-20T02:18:06+00:00",
"expires_in_seconds": 86399.75,
"mailbox_state": "active",
"receiving_enabled": true,
"message_count": 0,
"unread_message_count": 0,
"last_message_received_at": null,
"message_count_synced_at": null,
"created_at": "2026-11-19T02:18:06+00:00",
"email_token": "encrypted-email-token"
}
}
| Bidang | Jenis | Deskripsi |
|---|---|---|
status |
boolean | Apakah operasi berhasil. |
data.id |
integer | ID Kotak Surat. ID, alamat, dan token yang dihasilkan berbeda untuk setiap kotak surat. |
data.pin_protected |
boolean | Apakah kotak surat ini memiliki perlindungan PIN. Tidak ada PIN atau hash PIN yang dikembalikan. |
data.email |
string | Dihasilkan alamat kotak surat lengkap. |
data.domain |
string | Domain kotak surat yang dihasilkan. |
data.provider |
string | Penyedia kotak surat: standard, gmail_alias, atau outlook_alias. |
data.expire_at |
string|null | Kedaluwarsa efektif sebagai timestamp ISO-8601, atau null untuk kotak surat tak terbatas. |
data.expires_in_seconds |
number|null | Detik yang tersisa (non-negatif) saat dihitung; detik pecahan dimungkinkan. Null berarti tidak terbatas, bukan nol. |
data.mailbox_state |
string | Status kotak surat saat ini: aktif, dijeda, kedaluwarsa, atau tidak aktif. |
data.receiving_enabled |
boolean | Apakah kotak surat ini saat ini menerima pesan masuk. |
data.message_count |
integer | Jumlah total pesan yang diketahui; dapat mencerminkan sinkronisasi kotak surat terakhir. |
data.unread_message_count |
integer | Jumlah pesan belum dibaca yang diketahui; dapat mencerminkan sinkronisasi kotak surat terakhir. |
data.last_message_received_at |
string|null | Waktu pesan yang diterima terakhir yang diketahui dalam format ISO-8601, atau null bila tidak tersedia. |
data.message_count_synced_at |
string|null | Waktu sinkronisasi hitungan pesan terakhir dalam format ISO-8601, atau null sebelum sinkronisasi. |
data.created_at |
string|null | Waktu pembuatan kotak surat dalam format ISO-8601. |
data.email_token |
string | Referensi kotak surat terenkripsi yang tidak transparan. Ini tidak menggantikan otentikasi Bearer, pemeriksaan kepemilikan, atau otorisasi PIN. |
data.pin_grant |
object | Kondisional: pembuatan kotak surat yang dilindungi PIN aktif mengembalikan izin baca ini; pembuatan biasa yang tidak dilindungi mengabaikannya. |
data.pin_grant.mailbox_id |
integer | ID kotak surat yang menjadi ikatan pemberian baca bersyarat. |
data.pin_grant.unlock_token |
string | Token baca tidak transparan untuk X-Mailbox-Unlock dengan kredensial pemilik yang sama. Jaga tetap pribadi dan di memori; izin baca tidak mengizinkan penghapusan. |
data.pin_grant.scope |
string | Cakupan dibaca untuk pemberian pembuatan bersyarat. |
data.pin_grant.idle_timeout_seconds |
integer | Waktu menganggur yang diizinkan untuk hak baca, biasanya 3600 detik. |
data.pin_grant.absolute_timeout_seconds |
integer | Masa hidup maksimum dari izin baca, biasanya 86400 detik. |
data.pin_grant.expires_at |
string | Kedaluwarsa hak baca saat ini dalam format ISO-8601. |
data.pin_grant.absolute_expires_at |
string | Kedaluwarsa hak baca absolut dalam format ISO-8601. Perubahan keamanan dapat mencabut hak tersebut lebih awal. |
Perbarui / Ganti Kotak Surat
Buat atau pilih kotak surat pada nama pengguna dan domain baru setelah memverifikasi kepemilikan kotak surat saat ini. Ini tidak mengganti nama kotak surat lama atau mengubah masa berlakunya secara langsung. Ketika tujuan berbeda, kotak surat lama tetap ada dalam riwayat dan dapat dihentikan oleh batas kotak surat aktif. Menggunakan kembali tujuan aktif Anda sendiri akan menerapkan kembali masa berlaku yang diminta atau default paket.
| Parameter | Lokasi | Jenis | Status | Deskripsi |
|---|---|---|---|---|
email
|
path | string | wajib |
Alamat email lengkap saat ini dari kotak surat yang dimiliki untuk diganti. URL-encode setiap segmen jalur; encode tanda plus sebagai %2B.
|
username
|
path | string | wajib |
Nama pengguna baru yang diinginkan: 2 hingga 64 karakter alfanumerik; tergantung pada izin nama pengguna khusus.
|
domain
|
path | string | wajib |
Nama domain yang diizinkan baru.
|
lifetime
|
body | string | opsional |
nilai yang diizinkan:
10m — 10 Menit
1h — 1 Jam
2h — 2 Jam
1d — 1 Hari
1w — 1 Minggu
1m — 30 Hari
3m — 90 hari
6m — 180 Hari
1y — 365 Hari
unlimited — Tidak Terbatas
Bawaan:
Masa pakai default rencana
|
pin_enabled
|
body | boolean | opsional |
Perlindungan PIN opsional untuk kotak surat baru, bila diizinkan oleh paket Anda. Ini tidak mengubah PIN kotak surat yang sudah ada.
Bawaan:
false
|
pin
|
body | string | opsional |
Diperlukan ketika pin_enabled bernilai true: PIN dengan 6 hingga 8 digit, dikirim sebagai string untuk mempertahankan nol di depan.
|
pin_confirmation
|
body | string | opsional |
Diperlukan ketika pin_enabled bernilai true. Harus persis cocok dengan pin.
|
Idempotency-Key
|
header | string | opsional |
Diperlukan untuk pembuatan atau penghapusan yang dilindungi PIN: kunci stabil 16 hingga 128 karakter. Ulangi permintaan yang sama dengan kunci yang sama untuk menghindari pekerjaan duplikat.
|
X-Mailbox-Unlock
|
header | string | opsional |
Header, hanya kotak surat yang dilindungi: gunakan unlock_token baca. Pertama POST pin dan scope=read ke URL pembuka PIN. Pertahankan otentikasi Bearer normal Anda. <code>https://v1.tempmailg.com/api/mailboxes/{mailbox}/pin/unlock</code>
|
lifetime (nilai yang diizinkan: 10m, 1h, 2h, 1d, 1w, 1m, 3m, 6m, 1y, unlimited). Lewati masa pakai, atau biarkan kosong, untuk menggunakan Default Email Lifetime yang dikonfigurasi untuk paket bulanan/tahunan Anda saat ini. Kirim masa pakai yang diizinkan seperti 1h untuk mengganti default tersebut. Tidak terbatas hanya digunakan ketika dikonfigurasi sebagai default paket atau secara eksplisit diminta dan diizinkan. Parameter tubuh mailbox_lifetime dan email_lifetime juga diterima; nilai tidak kosong pertama yang menang dalam urutan ini: lifetime, mailbox_lifetime, email_lifetime. Nilai yang tidak valid atau tidak diizinkan mengembalikan HTTP 422 alih-alih secara diam-diam memilih nilai default.const response = await fetch('https://v1.tempmailg.com/api/emails/current@example.com/demo123/example.com', {
method: 'POST',
headers: {
'Authorization': 'Bearer YOUR_USER_API_KEY',
'Accept': 'application/json',
},
});
if (!response.ok) {
throw new Error(`Request failed with status ${response.status}`);
}
const data = await response.json();
console.log(data);
import requests
headers = {
'Authorization': 'Bearer YOUR_USER_API_KEY',
'Accept': 'application/json',
}
response = requests.post('https://v1.tempmailg.com/api/emails/current@example.com/demo123/example.com', headers=headers, timeout=30)
response.raise_for_status()
print(response.json())
<?php
$ch = curl_init('https://v1.tempmailg.com/api/emails/current@example.com/demo123/example.com');
curl_setopt_array($ch, [
CURLOPT_CUSTOMREQUEST => 'POST',
CURLOPT_RETURNTRANSFER => true,
CURLOPT_HTTPHEADER => [
'Authorization: Bearer YOUR_USER_API_KEY',
'Accept: application/json',
],
]);
$response = curl_exec($ch);
if ($response === false) {
throw new RuntimeException(curl_error($ch));
}
$statusCode = curl_getinfo($ch, CURLINFO_HTTP_CODE);
curl_close($ch);
var_dump($statusCode, json_decode($response, true));
curl --request POST \
--url 'https://v1.tempmailg.com/api/emails/current@example.com/demo123/example.com' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer YOUR_USER_API_KEY'
Respons ilustratif menggunakan data sintetis. ID, alamat, token, cap waktu, batas dan hitungan paket bervariasi. Contoh masa pakai tidak menggantikan default paket Anda. Deskripsi bidang respons mengidentifikasi bidang yang dapat bernilai null dan spesifik penyedia.
Contoh respons
200 OK • JSON{
"status": true,
"data": {
"id": 2302,
"pin_protected": false,
"email": "demo123@example.com",
"domain": "example.com",
"provider": "standard",
"expire_at": "2026-11-19T02:28:06+00:00",
"expires_in_seconds": 599.75,
"mailbox_state": "active",
"receiving_enabled": true,
"message_count": 0,
"unread_message_count": 0,
"last_message_received_at": null,
"message_count_synced_at": null,
"created_at": "2026-11-19T02:18:06+00:00",
"email_token": "encrypted-email-token"
}
}
| Bidang | Jenis | Deskripsi |
|---|---|---|
status |
boolean | Apakah operasi berhasil. |
data.id |
integer | ID Kotak Surat. ID, alamat, dan token yang dihasilkan berbeda untuk setiap kotak surat. |
data.pin_protected |
boolean | Apakah kotak surat ini memiliki perlindungan PIN. Tidak ada PIN atau hash PIN yang dikembalikan. |
data.email |
string | Dihasilkan alamat kotak surat lengkap. |
data.domain |
string | Domain kotak surat yang dihasilkan. |
data.provider |
string | Penyedia kotak surat: standard, gmail_alias, atau outlook_alias. |
data.expire_at |
string|null | Kedaluwarsa efektif sebagai timestamp ISO-8601, atau null untuk kotak surat tak terbatas. |
data.expires_in_seconds |
number|null | Detik yang tersisa (non-negatif) saat dihitung; detik pecahan dimungkinkan. Null berarti tidak terbatas, bukan nol. |
data.mailbox_state |
string | Status kotak surat saat ini: aktif, dijeda, kedaluwarsa, atau tidak aktif. |
data.receiving_enabled |
boolean | Apakah kotak surat ini saat ini menerima pesan masuk. |
data.message_count |
integer | Jumlah total pesan yang diketahui; dapat mencerminkan sinkronisasi kotak surat terakhir. |
data.unread_message_count |
integer | Jumlah pesan belum dibaca yang diketahui; dapat mencerminkan sinkronisasi kotak surat terakhir. |
data.last_message_received_at |
string|null | Waktu pesan yang diterima terakhir yang diketahui dalam format ISO-8601, atau null bila tidak tersedia. |
data.message_count_synced_at |
string|null | Waktu sinkronisasi hitungan pesan terakhir dalam format ISO-8601, atau null sebelum sinkronisasi. |
data.created_at |
string|null | Waktu pembuatan kotak surat dalam format ISO-8601. |
data.email_token |
string | Referensi kotak surat terenkripsi yang tidak transparan. Ini tidak menggantikan otentikasi Bearer, pemeriksaan kepemilikan, atau otorisasi PIN. |
data.pin_grant |
object | Kondisional: pembuatan kotak surat yang dilindungi PIN aktif mengembalikan izin baca ini; pembuatan biasa yang tidak dilindungi mengabaikannya. |
data.pin_grant.mailbox_id |
integer | ID kotak surat yang menjadi ikatan pemberian baca bersyarat. |
data.pin_grant.unlock_token |
string | Token baca tidak transparan untuk X-Mailbox-Unlock dengan kredensial pemilik yang sama. Jaga tetap pribadi dan di memori; izin baca tidak mengizinkan penghapusan. |
data.pin_grant.scope |
string | Cakupan dibaca untuk pemberian pembuatan bersyarat. |
data.pin_grant.idle_timeout_seconds |
integer | Waktu menganggur yang diizinkan untuk hak baca, biasanya 3600 detik. |
data.pin_grant.absolute_timeout_seconds |
integer | Masa hidup maksimum dari izin baca, biasanya 86400 detik. |
data.pin_grant.expires_at |
string | Kedaluwarsa hak baca saat ini dalam format ISO-8601. |
data.pin_grant.absolute_expires_at |
string | Kedaluwarsa hak baca absolut dalam format ISO-8601. Perubahan keamanan dapat mencabut hak tersebut lebih awal. |
Hapus Kotak Surat
Hapus kotak surat yang dimiliki dan jalankan pembersihan pesan serta file-nya. Catatan kotak surat yang dipertahankan dapat dihapus secara lunak secara internal; alamat tidak lagi dapat digunakan melalui API.
| Parameter | Lokasi | Jenis | Status | Deskripsi |
|---|---|---|---|---|
email
|
path | string | wajib |
Alamat email lengkap dari kotak surat yang dimiliki untuk dihapus. URL-encode alamat tersebut; encode tanda plus sebagai %2B.
|
X-Mailbox-Unlock
|
header | string | opsional |
Header, hanya kotak surat yang dilindungi: gunakan unlock_token hapus satu kali pakai. Pertama POST pin, scope=delete dan action/target_id yang dikembalikan oleh respons 423 ke URL buka kunci PIN. Token baca tidak dapat menghapus. <code>https://v1.tempmailg.com/api/mailboxes/{mailbox}/pin/unlock</code>
|
Idempotency-Key
|
header | string | opsional |
Diperlukan untuk pembuatan atau penghapusan yang dilindungi PIN: kunci stabil 16 hingga 128 karakter. Ulangi permintaan yang sama dengan kunci yang sama untuk menghindari pekerjaan duplikat.
|
const response = await fetch('https://v1.tempmailg.com/api/emails/demo123@example.com', {
method: 'DELETE',
headers: {
'Authorization': 'Bearer YOUR_USER_API_KEY',
'Accept': 'application/json',
},
});
if (!response.ok) {
throw new Error(`Request failed with status ${response.status}`);
}
const data = await response.json();
console.log(data);
import requests
headers = {
'Authorization': 'Bearer YOUR_USER_API_KEY',
'Accept': 'application/json',
}
response = requests.delete('https://v1.tempmailg.com/api/emails/demo123@example.com', headers=headers, timeout=30)
response.raise_for_status()
print(response.json())
<?php
$ch = curl_init('https://v1.tempmailg.com/api/emails/demo123@example.com');
curl_setopt_array($ch, [
CURLOPT_CUSTOMREQUEST => 'DELETE',
CURLOPT_RETURNTRANSFER => true,
CURLOPT_HTTPHEADER => [
'Authorization: Bearer YOUR_USER_API_KEY',
'Accept: application/json',
],
]);
$response = curl_exec($ch);
if ($response === false) {
throw new RuntimeException(curl_error($ch));
}
$statusCode = curl_getinfo($ch, CURLINFO_HTTP_CODE);
curl_close($ch);
var_dump($statusCode, json_decode($response, true));
curl --request DELETE \
--url 'https://v1.tempmailg.com/api/emails/demo123@example.com' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer YOUR_USER_API_KEY'
Respons ilustratif menggunakan data sintetis. ID, alamat, token, cap waktu, batas dan hitungan paket bervariasi. Contoh masa pakai tidak menggantikan default paket Anda. Deskripsi bidang respons mengidentifikasi bidang yang dapat bernilai null dan spesifik penyedia.
Contoh respons
200 OK • JSON{
"status": true,
"message": "Email has been successfully deleted."
}
| Bidang | Jenis | Deskripsi |
|---|---|---|
status |
boolean | Apakah operasi berhasil. |
message |
string | Hasil penghapusan. Sumber daya yang tidak ada mengembalikan HTTP 404. |
Alias Gmail & Outlook
Buat kotak surat alias Gmail dan Outlook/Hotmail dengan reputasi tinggi.
Buat Alias Gmail
Buat kotak surat sementara alias Gmail baru yang dimiliki oleh pengguna yang terautentikasi.
| Parameter | Lokasi | Jenis | Status | Deskripsi |
|---|---|---|---|---|
mode
|
body | string | opsional |
Mode generasi: auto, dot, plus, atau plus_dot. Juga menerima gmail_alias_mode. Jika pemilihan gaya tidak diizinkan, auto digunakan.
Bawaan:
auto
|
username
|
body | string | opsional |
Akhiran alias khusus opsional: 2 hingga 32 huruf atau digit ASCII, dinormalisasi menjadi huruf kecil; tergantung pada izin fitur. Juga menerima custom_username atau alias_username.
Bawaan:
Dibuat secara otomatis
|
domain
|
body | string | opsional |
Gunakan acak, gmail.com atau googlemail.com; alias_domain juga diterima. Penghilangan atau izin pemilihan domain yang tidak tersedia menggunakan acak.
Bawaan:
random
|
lifetime
|
body | string | opsional |
nilai yang diizinkan:
10m — 10 Menit
1h — 1 Jam
2h — 2 Jam
1d — 1 Hari
1w — 1 Minggu
1m — 30 Hari
3m — 90 hari
6m — 180 Hari
1y — 365 Hari
unlimited — Tidak Terbatas
Bawaan:
Masa pakai default rencana
|
pin_enabled
|
body | boolean | opsional |
Perlindungan PIN opsional untuk kotak surat baru, bila diizinkan oleh paket Anda. Ini tidak mengubah PIN kotak surat yang sudah ada.
Bawaan:
false
|
pin
|
body | string | opsional |
Diperlukan ketika pin_enabled bernilai true: PIN dengan 6 hingga 8 digit, dikirim sebagai string untuk mempertahankan nol di depan.
|
pin_confirmation
|
body | string | opsional |
Diperlukan ketika pin_enabled bernilai true. Harus persis cocok dengan pin.
|
Idempotency-Key
|
header | string | opsional |
Diperlukan untuk pembuatan atau penghapusan yang dilindungi PIN: kunci stabil 16 hingga 128 karakter. Ulangi permintaan yang sama dengan kunci yang sama untuk menghindari pekerjaan duplikat.
|
mode (auto, dot, plus, plus_dot), username (nama pengguna alias khusus), domain (misalnya gmail.com, googlemail.com), lifetime (nilai yang diizinkan: 10m, 1h, 2h, 1d, 1w, 1m, 3m, 6m, 1y, unlimited). Lewati masa pakai, atau biarkan kosong, untuk menggunakan Default Email Lifetime yang dikonfigurasi untuk paket bulanan/tahunan Anda saat ini. Kirim masa pakai yang diizinkan seperti 1h untuk mengganti default tersebut. Tidak terbatas hanya digunakan ketika dikonfigurasi sebagai default paket atau secara eksplisit diminta dan diizinkan. Parameter tubuh mailbox_lifetime dan email_lifetime juga diterima; nilai tidak kosong pertama yang menang dalam urutan ini: lifetime, mailbox_lifetime, email_lifetime. Nilai yang tidak valid atau tidak diizinkan mengembalikan HTTP 422 alih-alih secara diam-diam memilih nilai default.const response = await fetch('https://v1.tempmailg.com/api/gmail-alias/emails', {
method: 'POST',
headers: {
'Authorization': 'Bearer YOUR_USER_API_KEY',
'Accept': 'application/json',
},
});
if (!response.ok) {
throw new Error(`Request failed with status ${response.status}`);
}
const data = await response.json();
console.log(data);
import requests
headers = {
'Authorization': 'Bearer YOUR_USER_API_KEY',
'Accept': 'application/json',
}
response = requests.post('https://v1.tempmailg.com/api/gmail-alias/emails', headers=headers, timeout=30)
response.raise_for_status()
print(response.json())
<?php
$ch = curl_init('https://v1.tempmailg.com/api/gmail-alias/emails');
curl_setopt_array($ch, [
CURLOPT_CUSTOMREQUEST => 'POST',
CURLOPT_RETURNTRANSFER => true,
CURLOPT_HTTPHEADER => [
'Authorization: Bearer YOUR_USER_API_KEY',
'Accept: application/json',
],
]);
$response = curl_exec($ch);
if ($response === false) {
throw new RuntimeException(curl_error($ch));
}
$statusCode = curl_getinfo($ch, CURLINFO_HTTP_CODE);
curl_close($ch);
var_dump($statusCode, json_decode($response, true));
curl --request POST \
--url 'https://v1.tempmailg.com/api/gmail-alias/emails' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer YOUR_USER_API_KEY'
Respons ilustratif menggunakan data sintetis. ID, alamat, token, cap waktu, batas dan hitungan paket bervariasi. Contoh masa pakai tidak menggantikan default paket Anda. Deskripsi bidang respons mengidentifikasi bidang yang dapat bernilai null dan spesifik penyedia.
Contoh respons
200 OK • JSON{
"status": true,
"data": {
"id": 2305,
"pin_protected": false,
"email": "example+alias123@gmail.com",
"domain": "gmail.com",
"provider": "gmail_alias",
"expire_at": "2026-11-19T03:18:06+00:00",
"expires_in_seconds": 3599.75,
"mailbox_state": "active",
"receiving_enabled": true,
"message_count": 0,
"unread_message_count": 0,
"last_message_received_at": null,
"message_count_synced_at": null,
"created_at": "2026-11-19T02:18:06+00:00",
"email_token": "encrypted-email-token"
}
}
| Bidang | Jenis | Deskripsi |
|---|---|---|
status |
boolean | Apakah operasi berhasil. |
data.id |
integer | ID Kotak Surat. ID, alamat, dan token yang dihasilkan berbeda untuk setiap kotak surat. |
data.pin_protected |
boolean | Apakah kotak surat ini memiliki perlindungan PIN. Tidak ada PIN atau hash PIN yang dikembalikan. |
data.email |
string | Dihasilkan alamat kotak surat lengkap. |
data.domain |
string | Domain kotak surat yang dihasilkan. |
data.provider |
string | Penyedia kotak surat: standard, gmail_alias, atau outlook_alias. |
data.expire_at |
string|null | Kedaluwarsa efektif sebagai timestamp ISO-8601, atau null untuk kotak surat tak terbatas. |
data.expires_in_seconds |
number|null | Detik yang tersisa (non-negatif) saat dihitung; detik pecahan dimungkinkan. Null berarti tidak terbatas, bukan nol. |
data.mailbox_state |
string | Status kotak surat saat ini: aktif, dijeda, kedaluwarsa, atau tidak aktif. |
data.receiving_enabled |
boolean | Apakah kotak surat ini saat ini menerima pesan masuk. |
data.message_count |
integer | Jumlah total pesan yang diketahui; dapat mencerminkan sinkronisasi kotak surat terakhir. |
data.unread_message_count |
integer | Jumlah pesan belum dibaca yang diketahui; dapat mencerminkan sinkronisasi kotak surat terakhir. |
data.last_message_received_at |
string|null | Waktu pesan yang diterima terakhir yang diketahui dalam format ISO-8601, atau null bila tidak tersedia. |
data.message_count_synced_at |
string|null | Waktu sinkronisasi hitungan pesan terakhir dalam format ISO-8601, atau null sebelum sinkronisasi. |
data.created_at |
string|null | Waktu pembuatan kotak surat dalam format ISO-8601. |
data.email_token |
string | Referensi kotak surat terenkripsi yang tidak transparan. Ini tidak menggantikan otentikasi Bearer, pemeriksaan kepemilikan, atau otorisasi PIN. |
data.pin_grant |
object | Kondisional: pembuatan kotak surat yang dilindungi PIN aktif mengembalikan izin baca ini; pembuatan biasa yang tidak dilindungi mengabaikannya. |
data.pin_grant.mailbox_id |
integer | ID kotak surat yang menjadi ikatan pemberian baca bersyarat. |
data.pin_grant.unlock_token |
string | Token baca tidak transparan untuk X-Mailbox-Unlock dengan kredensial pemilik yang sama. Jaga tetap pribadi dan di memori; izin baca tidak mengizinkan penghapusan. |
data.pin_grant.scope |
string | Cakupan dibaca untuk pemberian pembuatan bersyarat. |
data.pin_grant.idle_timeout_seconds |
integer | Waktu menganggur yang diizinkan untuk hak baca, biasanya 3600 detik. |
data.pin_grant.absolute_timeout_seconds |
integer | Masa hidup maksimum dari izin baca, biasanya 86400 detik. |
data.pin_grant.expires_at |
string | Kedaluwarsa hak baca saat ini dalam format ISO-8601. |
data.pin_grant.absolute_expires_at |
string | Kedaluwarsa hak baca absolut dalam format ISO-8601. Perubahan keamanan dapat mencabut hak tersebut lebih awal. |
Domain Alias Outlook
Ambil domain alias Outlook / Hotmail aktif yang tersedia untuk pembuatan kotak surat.
const response = await fetch('https://v1.tempmailg.com/api/outlook-alias/domains', {
method: 'GET',
headers: {
'Authorization': 'Bearer YOUR_USER_API_KEY',
'Accept': 'application/json',
},
});
if (!response.ok) {
throw new Error(`Request failed with status ${response.status}`);
}
const data = await response.json();
console.log(data);
import requests
headers = {
'Authorization': 'Bearer YOUR_USER_API_KEY',
'Accept': 'application/json',
}
response = requests.get('https://v1.tempmailg.com/api/outlook-alias/domains', headers=headers, timeout=30)
response.raise_for_status()
print(response.json())
<?php
$ch = curl_init('https://v1.tempmailg.com/api/outlook-alias/domains');
curl_setopt_array($ch, [
CURLOPT_CUSTOMREQUEST => 'GET',
CURLOPT_RETURNTRANSFER => true,
CURLOPT_HTTPHEADER => [
'Authorization: Bearer YOUR_USER_API_KEY',
'Accept: application/json',
],
]);
$response = curl_exec($ch);
if ($response === false) {
throw new RuntimeException(curl_error($ch));
}
$statusCode = curl_getinfo($ch, CURLINFO_HTTP_CODE);
curl_close($ch);
var_dump($statusCode, json_decode($response, true));
curl --request GET \
--url 'https://v1.tempmailg.com/api/outlook-alias/domains' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer YOUR_USER_API_KEY'
Respons ilustratif menggunakan data sintetis. ID, alamat, token, cap waktu, batas dan hitungan paket bervariasi. Contoh masa pakai tidak menggantikan default paket Anda. Deskripsi bidang respons mengidentifikasi bidang yang dapat bernilai null dan spesifik penyedia.
Contoh respons
200 OK • JSON{
"status": true,
"data": {
"domains": [
{
"domain": "outlook.com",
"type": "Outlook/Hotmail",
"selectable": true,
"locked": false,
"disabled_reason": null
},
{
"domain": "hotmail.com",
"type": "Outlook/Hotmail",
"selectable": true,
"locked": false,
"disabled_reason": null
}
]
}
}
| Bidang | Jenis | Deskripsi |
|---|---|---|
status |
boolean | Apakah operasi berhasil. |
data.domains |
array | Domain Outlook/Hotmail yang aktif; array kosong dianggap valid. |
data.domains[].domain |
string | Nama domain yang tersedia. |
data.domains[].type |
string | Label penyedia yang dapat dibaca. |
data.domains[].selectable |
boolean | Apakah akun Anda dapat secara eksplisit memilih domain ini. |
data.domains[].locked |
boolean | Apakah pemilihan domain eksplisit terkunci untuk akun Anda. |
data.domains[].disabled_reason |
string|null | Alasan pemilihan domain terkunci, atau null ketika dapat dipilih. |
Buat Alias Outlook
Buat kotak surat alias Outlook / Hotmail sementara baru yang dimiliki oleh pengguna yang terautentikasi.
| Parameter | Lokasi | Jenis | Status | Deskripsi |
|---|---|---|---|---|
domain
|
body | string | opsional |
Gunakan acak atau domain dari GET /outlook-alias/domains; outlook_alias_domain juga diterima. Tanpa izin pemilihan, acak akan digunakan.
Bawaan:
Domain tersedia acak
|
username
|
body | string | opsional |
Akhiran alias khusus opsional: 2 hingga 32 huruf atau digit ASCII, dinormalisasi menjadi huruf kecil; tergantung pada izin fitur. Juga menerima custom_username atau alias_username.
Bawaan:
Dibuat secara otomatis
|
lifetime
|
body | string | opsional |
nilai yang diizinkan:
10m — 10 Menit
1h — 1 Jam
2h — 2 Jam
1d — 1 Hari
1w — 1 Minggu
1m — 30 Hari
3m — 90 hari
6m — 180 Hari
1y — 365 Hari
unlimited — Tidak Terbatas
Bawaan:
Masa pakai default rencana
|
pin_enabled
|
body | boolean | opsional |
Perlindungan PIN opsional untuk kotak surat baru, bila diizinkan oleh paket Anda. Ini tidak mengubah PIN kotak surat yang sudah ada.
Bawaan:
false
|
pin
|
body | string | opsional |
Diperlukan ketika pin_enabled bernilai true: PIN dengan 6 hingga 8 digit, dikirim sebagai string untuk mempertahankan nol di depan.
|
pin_confirmation
|
body | string | opsional |
Diperlukan ketika pin_enabled bernilai true. Harus persis cocok dengan pin.
|
Idempotency-Key
|
header | string | opsional |
Diperlukan untuk pembuatan atau penghapusan yang dilindungi PIN: kunci stabil 16 hingga 128 karakter. Ulangi permintaan yang sama dengan kunci yang sama untuk menghindari pekerjaan duplikat.
|
domain (mis. outlook.com, hotmail.com), username (nama pengguna alias khusus), lifetime (nilai yang diizinkan: 10m, 1h, 2h, 1d, 1w, 1m, 3m, 6m, 1y, unlimited). Lewati masa pakai, atau biarkan kosong, untuk menggunakan Default Email Lifetime yang dikonfigurasi untuk paket bulanan/tahunan Anda saat ini. Kirim masa pakai yang diizinkan seperti 1h untuk mengganti default tersebut. Tidak terbatas hanya digunakan ketika dikonfigurasi sebagai default paket atau secara eksplisit diminta dan diizinkan. Parameter tubuh mailbox_lifetime dan email_lifetime juga diterima; nilai tidak kosong pertama yang menang dalam urutan ini: lifetime, mailbox_lifetime, email_lifetime. Nilai yang tidak valid atau tidak diizinkan mengembalikan HTTP 422 alih-alih secara diam-diam memilih nilai default.const response = await fetch('https://v1.tempmailg.com/api/outlook-alias/emails', {
method: 'POST',
headers: {
'Authorization': 'Bearer YOUR_USER_API_KEY',
'Accept': 'application/json',
},
});
if (!response.ok) {
throw new Error(`Request failed with status ${response.status}`);
}
const data = await response.json();
console.log(data);
import requests
headers = {
'Authorization': 'Bearer YOUR_USER_API_KEY',
'Accept': 'application/json',
}
response = requests.post('https://v1.tempmailg.com/api/outlook-alias/emails', headers=headers, timeout=30)
response.raise_for_status()
print(response.json())
<?php
$ch = curl_init('https://v1.tempmailg.com/api/outlook-alias/emails');
curl_setopt_array($ch, [
CURLOPT_CUSTOMREQUEST => 'POST',
CURLOPT_RETURNTRANSFER => true,
CURLOPT_HTTPHEADER => [
'Authorization: Bearer YOUR_USER_API_KEY',
'Accept: application/json',
],
]);
$response = curl_exec($ch);
if ($response === false) {
throw new RuntimeException(curl_error($ch));
}
$statusCode = curl_getinfo($ch, CURLINFO_HTTP_CODE);
curl_close($ch);
var_dump($statusCode, json_decode($response, true));
curl --request POST \
--url 'https://v1.tempmailg.com/api/outlook-alias/emails' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer YOUR_USER_API_KEY'
Respons ilustratif menggunakan data sintetis. ID, alamat, token, cap waktu, batas dan hitungan paket bervariasi. Contoh masa pakai tidak menggantikan default paket Anda. Deskripsi bidang respons mengidentifikasi bidang yang dapat bernilai null dan spesifik penyedia.
Contoh respons
200 OK • JSON{
"status": true,
"data": {
"id": 2306,
"pin_protected": false,
"email": "example+alias45@outlook.com",
"domain": "outlook.com",
"provider": "outlook_alias",
"expire_at": "2026-11-19T03:18:06+00:00",
"expires_in_seconds": 3599.75,
"mailbox_state": "active",
"receiving_enabled": true,
"message_count": 0,
"unread_message_count": 0,
"last_message_received_at": null,
"message_count_synced_at": null,
"created_at": "2026-11-19T02:18:06+00:00",
"email_token": "encrypted-email-token"
}
}
| Bidang | Jenis | Deskripsi |
|---|---|---|
status |
boolean | Apakah operasi berhasil. |
data.id |
integer | ID Kotak Surat. ID, alamat, dan token yang dihasilkan berbeda untuk setiap kotak surat. |
data.pin_protected |
boolean | Apakah kotak surat ini memiliki perlindungan PIN. Tidak ada PIN atau hash PIN yang dikembalikan. |
data.email |
string | Dihasilkan alamat kotak surat lengkap. |
data.domain |
string | Domain kotak surat yang dihasilkan. |
data.provider |
string | Penyedia kotak surat: standard, gmail_alias, atau outlook_alias. |
data.expire_at |
string|null | Kedaluwarsa efektif sebagai timestamp ISO-8601, atau null untuk kotak surat tak terbatas. |
data.expires_in_seconds |
number|null | Detik yang tersisa (non-negatif) saat dihitung; detik pecahan dimungkinkan. Null berarti tidak terbatas, bukan nol. |
data.mailbox_state |
string | Status kotak surat saat ini: aktif, dijeda, kedaluwarsa, atau tidak aktif. |
data.receiving_enabled |
boolean | Apakah kotak surat ini saat ini menerima pesan masuk. |
data.message_count |
integer | Jumlah total pesan yang diketahui; dapat mencerminkan sinkronisasi kotak surat terakhir. |
data.unread_message_count |
integer | Jumlah pesan belum dibaca yang diketahui; dapat mencerminkan sinkronisasi kotak surat terakhir. |
data.last_message_received_at |
string|null | Waktu pesan yang diterima terakhir yang diketahui dalam format ISO-8601, atau null bila tidak tersedia. |
data.message_count_synced_at |
string|null | Waktu sinkronisasi hitungan pesan terakhir dalam format ISO-8601, atau null sebelum sinkronisasi. |
data.created_at |
string|null | Waktu pembuatan kotak surat dalam format ISO-8601. |
data.email_token |
string | Referensi kotak surat terenkripsi yang tidak transparan. Ini tidak menggantikan otentikasi Bearer, pemeriksaan kepemilikan, atau otorisasi PIN. |
data.pin_grant |
object | Kondisional: pembuatan kotak surat yang dilindungi PIN aktif mengembalikan izin baca ini; pembuatan biasa yang tidak dilindungi mengabaikannya. |
data.pin_grant.mailbox_id |
integer | ID kotak surat yang menjadi ikatan pemberian baca bersyarat. |
data.pin_grant.unlock_token |
string | Token baca tidak transparan untuk X-Mailbox-Unlock dengan kredensial pemilik yang sama. Jaga tetap pribadi dan di memori; izin baca tidak mengizinkan penghapusan. |
data.pin_grant.scope |
string | Cakupan dibaca untuk pemberian pembuatan bersyarat. |
data.pin_grant.idle_timeout_seconds |
integer | Waktu menganggur yang diizinkan untuk hak baca, biasanya 3600 detik. |
data.pin_grant.absolute_timeout_seconds |
integer | Masa hidup maksimum dari izin baca, biasanya 86400 detik. |
data.pin_grant.expires_at |
string | Kedaluwarsa hak baca saat ini dalam format ISO-8601. |
data.pin_grant.absolute_expires_at |
string | Kedaluwarsa hak baca absolut dalam format ISO-8601. Perubahan keamanan dapat mencabut hak tersebut lebih awal. |
Pesan & Lampiran
Ambil kotak masuk yang masuk, baca pesan HTML/teks secara lengkap, dan alirkan lampiran.
Daftar Pesan Kotak Surat
Ambil ringkasan pesan yang tersedia dan metadata kotak surat. Pemindaian kotak masuk standar mengembalikan batch terbaru hingga 25 pesan; ini bukan endpoint riwayat penuh yang dipaginasi. Gunakan GET /messages/{messageId} untuk isi lengkap dan lampiran.
| Parameter | Lokasi | Jenis | Status | Deskripsi |
|---|---|---|---|---|
email
|
query | string | wajib |
Alamat email lengkap dari kotak surat yang dimiliki untuk membaca pesan. URL-encode nilai kueri; encode tanda plus sebagai %2B.
|
X-Mailbox-Unlock
|
header | string | opsional |
Header, hanya kotak surat yang dilindungi: gunakan unlock_token baca. Pertama POST pin dan scope=read ke URL pembuka PIN. Pertahankan otentikasi Bearer normal Anda. <code>https://v1.tempmailg.com/api/mailboxes/{mailbox}/pin/unlock</code>
|
const response = await fetch('https://v1.tempmailg.com/api/messages?email=demo123@example.com', {
method: 'GET',
headers: {
'Authorization': 'Bearer YOUR_USER_API_KEY',
'Accept': 'application/json',
},
});
if (!response.ok) {
throw new Error(`Request failed with status ${response.status}`);
}
const data = await response.json();
console.log(data);
import requests
headers = {
'Authorization': 'Bearer YOUR_USER_API_KEY',
'Accept': 'application/json',
}
response = requests.get('https://v1.tempmailg.com/api/messages?email=demo123@example.com', headers=headers, timeout=30)
response.raise_for_status()
print(response.json())
<?php
$ch = curl_init('https://v1.tempmailg.com/api/messages?email=demo123@example.com');
curl_setopt_array($ch, [
CURLOPT_CUSTOMREQUEST => 'GET',
CURLOPT_RETURNTRANSFER => true,
CURLOPT_HTTPHEADER => [
'Authorization: Bearer YOUR_USER_API_KEY',
'Accept: application/json',
],
]);
$response = curl_exec($ch);
if ($response === false) {
throw new RuntimeException(curl_error($ch));
}
$statusCode = curl_getinfo($ch, CURLINFO_HTTP_CODE);
curl_close($ch);
var_dump($statusCode, json_decode($response, true));
curl --request GET \
--url 'https://v1.tempmailg.com/api/messages?email=demo123@example.com' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer YOUR_USER_API_KEY'
Respons ilustratif menggunakan data sintetis. ID, alamat, token, cap waktu, batas dan hitungan paket bervariasi. Contoh masa pakai tidak menggantikan default paket Anda. Deskripsi bidang respons mengidentifikasi bidang yang dapat bernilai null dan spesifik penyedia.
Contoh respons
200 OK • JSON{
"status": true,
"mailbox": "demo123@example.com",
"email_token": "encrypted-email-token",
"messages": [
{
"is_seen": false,
"subject": "Welcome to Temp Mail",
"from": "Example Sender",
"from_email": "hello@example.org",
"receivedAt": "2026-11-19 02:18:06",
"id": "ap94AWDg123ELQz07vrVB9dLXlbqZM5NGwYxOJKko8n6m1",
"otp": null,
"otp_locked": false,
"verification_link": null,
"verification_link_locked": false
}
],
"mailbox_provider": "standard",
"mailbox_state": "active",
"expire_at": "2026-11-20T02:18:06+00:00",
"expires_in_seconds": 86399.75,
"receiving_enabled": true,
"mailbox_limit": {
"limit": 50,
"limit_label": "50",
"active_count": 1,
"paused_count": 0,
"paused_mailboxes": [],
"remaining": 49,
"remaining_label": "49",
"reached": false,
"blocked": false,
"provider": "standard"
},
"message_count": 1,
"unread_message_count": 1,
"last_message_received_at": "2026-11-19T02:18:06+00:00",
"message_count_synced_at": "2026-11-19T02:18:06+00:00"
}
| Bidang | Jenis | Deskripsi |
|---|---|---|
status |
boolean | Apakah operasi berhasil. |
mailbox |
string | Alamat kotak surat yang pesan-pesannya diminta. |
email_token |
string | Referensi kotak surat terenkripsi yang tidak dapat dibaca; otentikasi normal masih diperlukan. |
mailbox_provider |
string | Penyedia kotak surat: standard, gmail_alias, atau outlook_alias. |
messages |
array | Ringkasan pesan. Kotak masuk kosong mengembalikan array kosong; ambil satu pesan untuk isi dan lampirannya. |
expire_at |
string|null | Kedaluwarsa efektif sebagai timestamp ISO-8601, atau null untuk kotak surat tak terbatas. |
expires_in_seconds |
number|null | Detik yang tersisa (non-negatif) saat dihitung; detik pecahan dimungkinkan. Null berarti tidak terbatas, bukan nol. |
mailbox_state |
string | Status kotak surat saat ini: aktif, dijeda, kedaluwarsa, atau tidak aktif. |
receiving_enabled |
boolean | Apakah kotak surat ini saat ini menerima pesan masuk. |
message_count |
integer | Jumlah total pesan yang diketahui; dapat mencerminkan sinkronisasi kotak surat terakhir. |
unread_message_count |
integer | Jumlah pesan belum dibaca yang diketahui; dapat mencerminkan sinkronisasi kotak surat terakhir. |
last_message_received_at |
string|null | Waktu pesan yang diterima terakhir yang diketahui dalam format ISO-8601, atau null bila tidak tersedia. |
message_count_synced_at |
string|null | Waktu sinkronisasi hitungan pesan terakhir dalam format ISO-8601, atau null sebelum sinkronisasi. |
mailbox_limit.limit |
integer | Batas kotak surat aktif untuk penyedia ini; -1 berarti tidak terbatas. |
mailbox_limit.limit_label |
string | Label tampilan untuk batas kotak surat. |
mailbox_limit.active_count |
integer | Jumlah kotak surat aktif untuk penyedia ini. |
mailbox_limit.paused_count |
integer | Jumlah kotak surat yang dijeda untuk penyedia ini. |
mailbox_limit.paused_mailboxes |
array<string> | Alamat dijeda karena batas kotak surat. |
mailbox_limit.remaining |
integer | Slot kotak surat aktif yang tersisa; -1 berarti tidak terbatas. Ini bukan kuota permintaan API. |
mailbox_limit.remaining_label |
string | Tampilkan label untuk slot kotak surat yang tersisa. |
mailbox_limit.reached |
boolean | Apakah batas kotak surat aktif telah tercapai. |
mailbox_limit.blocked |
boolean | Apakah batas kotak surat aktif adalah nol. |
mailbox_limit.provider |
string|null | Penyedia yang batas kotak suratnya berlaku. |
messages[].id |
string | ID pesan opak yang digunakan oleh endpoint satu-pesan, penghapusan, dan lampiran. |
messages[].is_seen |
boolean | Apakah pesan ditandai sebagai sudah dibaca. |
messages[].subject |
string | Subjek pesan. |
messages[].from |
string | Nama tampilan atau alamat pengirim. |
messages[].from_email |
string | Alamat email pengirim. |
messages[].receivedAt |
string | Waktu diterima dalam zona waktu aplikasi, diformat sebagai YYYY-MM-DD HH:mm:ss. |
messages[].otp |
string|null | Mendeteksi kode satu kali ketika tersedia dan diizinkan; jika tidak, null. |
messages[].otp_locked |
boolean | Apakah kode satu kali yang terdeteksi disembunyikan oleh izin fitur. |
messages[].verification_link |
string|null | URL verifikasi terdeteksi bila tersedia dan diizinkan; jika tidak, null. |
messages[].verification_link_locked |
boolean | Apakah tautan verifikasi yang terdeteksi disembunyikan oleh izin fitur. |
messages[].from_name |
string|null | Bidang ringkasan Outlook: nama pengirim asli. Tidak ada dalam ringkasan Standar dan Gmail. |
messages[].snippet |
string|null | Bidang ringkasan Outlook: pratinjau pesan singkat. |
messages[].received_at |
string|null | Bidang ringkasan Outlook: waktu diterima ISO-8601, bila diketahui. |
messages[].has_attachments |
boolean | Bidang ringkasan Outlook: apakah metadata lampiran ada. Ketersediaan unduhan diperiksa secara terpisah. |
Dapatkan Pesan Tunggal
Ambil pesan yang dimiliki berdasarkan ID pesan yang tidak dapat dilihat. Mengembalikan format badan dan metadata lampiran. Bidang badan tergantung pada format pesan; Outlook menambahkan bidang khusus penyedia yang tercantum di bawah.
| Parameter | Lokasi | Jenis | Status | Deskripsi |
|---|---|---|---|---|
messageId
|
path | string | wajib |
ID pesan unik yang dikembalikan dalam daftar pesan.
|
X-Mailbox-Unlock
|
header | string | opsional |
Header, hanya kotak surat yang dilindungi: gunakan unlock_token baca. Pertama POST pin dan scope=read ke URL pembuka PIN. Pertahankan otentikasi Bearer normal Anda. <code>https://v1.tempmailg.com/api/mailboxes/{mailbox}/pin/unlock</code>
|
const response = await fetch('https://v1.tempmailg.com/api/messages/ap94AWDg123ELQz07vrVB9dLXlbqZM5NGwYxOJKko8n6m1', {
method: 'GET',
headers: {
'Authorization': 'Bearer YOUR_USER_API_KEY',
'Accept': 'application/json',
},
});
if (!response.ok) {
throw new Error(`Request failed with status ${response.status}`);
}
const data = await response.json();
console.log(data);
import requests
headers = {
'Authorization': 'Bearer YOUR_USER_API_KEY',
'Accept': 'application/json',
}
response = requests.get('https://v1.tempmailg.com/api/messages/ap94AWDg123ELQz07vrVB9dLXlbqZM5NGwYxOJKko8n6m1', headers=headers, timeout=30)
response.raise_for_status()
print(response.json())
<?php
$ch = curl_init('https://v1.tempmailg.com/api/messages/ap94AWDg123ELQz07vrVB9dLXlbqZM5NGwYxOJKko8n6m1');
curl_setopt_array($ch, [
CURLOPT_CUSTOMREQUEST => 'GET',
CURLOPT_RETURNTRANSFER => true,
CURLOPT_HTTPHEADER => [
'Authorization: Bearer YOUR_USER_API_KEY',
'Accept: application/json',
],
]);
$response = curl_exec($ch);
if ($response === false) {
throw new RuntimeException(curl_error($ch));
}
$statusCode = curl_getinfo($ch, CURLINFO_HTTP_CODE);
curl_close($ch);
var_dump($statusCode, json_decode($response, true));
curl --request GET \
--url 'https://v1.tempmailg.com/api/messages/ap94AWDg123ELQz07vrVB9dLXlbqZM5NGwYxOJKko8n6m1' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer YOUR_USER_API_KEY'
Respons ilustratif menggunakan data sintetis. ID, alamat, token, cap waktu, batas dan hitungan paket bervariasi. Contoh masa pakai tidak menggantikan default paket Anda. Deskripsi bidang respons mengidentifikasi bidang yang dapat bernilai null dan spesifik penyedia.
Contoh respons
200 OK • JSON{
"status": true,
"data": {
"is_seen": true,
"subject": "Welcome to Temp Mail",
"from": "Example Sender",
"from_email": "hello@example.org",
"to": "demo123@example.com",
"mailbox_provider": "standard",
"receivedAt": "2026-11-19 02:18:06",
"id": "ap94AWDg123ELQz07vrVB9dLXlbqZM5NGwYxOJKko8n6m1",
"html": true,
"html_content": "<p>Hello from the inbox.</p>",
"text_content": "<pre>Hello from the inbox.</pre>",
"content": "<p>Hello from the inbox.</p>",
"attachments": [
{
"name": "file.txt",
"extension": "txt",
"size": 91,
"url": "https://v1.tempmailg.com/api/messages/ap94AWDg123ELQz07vrVB9dLXlbqZM5NGwYxOJKko8n6m1/attachments/file.txt"
}
]
}
}
| Bidang | Jenis | Deskripsi |
|---|---|---|
status |
boolean | Apakah operasi berhasil. |
data.id |
string | ID pesan opak. |
data.is_seen |
boolean | Status baca pesan. Membaca dapat menandainya sebagai terlihat; data cache dapat mencerminkan status sebelumnya. |
data.subject |
string | Subjek pesan. |
data.from |
string | Nama tampilan atau alamat pengirim. |
data.from_email |
string | Alamat email pengirim. |
data.to |
string | Alamat kotak surat penerima. |
data.mailbox_provider |
string | Penyedia kotak surat: standard, gmail_alias, atau outlook_alias. |
data.receivedAt |
string | Waktu diterima dalam zona waktu aplikasi, diformat sebagai YYYY-MM-DD HH:mm:ss. |
data.html |
boolean | Apakah pesan memiliki badan HTML. |
data.html_content |
string | Badan HTML bila ada. Pesan standar tanpa HTML dapat mengabaikan bidang ini. Anggap konten pesan tidak tepercaya. |
data.text_content |
string | Isi teks ketika ada; Pesan standar dapat berisi teks yang di-escape dalam elemen pre atau menghilangkan bidang ini. |
data.content |
string | Badan utama untuk ditampilkan, biasanya HTML bila tersedia. |
data.attachments |
array | Metadata lampiran, atau array kosong. Unduhan memerlukan otentikasi normal dan otorisasi PIN yang berlaku. |
data.attachments[].name |
string | Nama file untuk di-URL-encode sebagai satu segmen jalur saat mengunduh. |
data.attachments[].size |
integer | Ukuran lampiran dalam byte. |
data.attachments[].url |
string | URL unduhan API Pengguna Terautentikasi ditambahkan ke lampiran dengan nama file. URL tidak menjamin bahwa file lokal tersedia. |
data.attachments[].extension |
string | Bidang metadata Standar/Gmail: ekstensi file bila disediakan. |
data.attachments[].id |
string | Bidang metadata Outlook: ID lampiran penyedia. |
data.attachments[].content_type |
string | Bidang metadata Outlook: tipe konten MIME. |
data.from_name |
string|null | Bidang detail Outlook: nama pengirim asli. |
data.to_email |
string|null | Bidang detail Outlook: alamat penerima asli. |
data.received_at |
string|null | Bidang detail Outlook: waktu diterima ISO-8601. |
data.has_html |
boolean | Bidang detail Outlook: apakah ada badan HTML. |
Hapus Pesan
Hapus satu pesan yang dimiliki.
| Parameter | Lokasi | Jenis | Status | Deskripsi |
|---|---|---|---|---|
messageId
|
path | string | wajib |
String ID pesan unik untuk dihapus secara permanen.
|
X-Mailbox-Unlock
|
header | string | opsional |
Header, hanya kotak surat yang dilindungi: gunakan unlock_token hapus satu kali pakai. Pertama POST pin, scope=delete dan action/target_id yang dikembalikan oleh respons 423 ke URL buka kunci PIN. Token baca tidak dapat menghapus. <code>https://v1.tempmailg.com/api/mailboxes/{mailbox}/pin/unlock</code>
|
Idempotency-Key
|
header | string | opsional |
Diperlukan untuk pembuatan atau penghapusan yang dilindungi PIN: kunci stabil 16 hingga 128 karakter. Ulangi permintaan yang sama dengan kunci yang sama untuk menghindari pekerjaan duplikat.
|
const response = await fetch('https://v1.tempmailg.com/api/messages/ap94AWDg123ELQz07vrVB9dLXlbqZM5NGwYxOJKko8n6m1', {
method: 'DELETE',
headers: {
'Authorization': 'Bearer YOUR_USER_API_KEY',
'Accept': 'application/json',
},
});
if (!response.ok) {
throw new Error(`Request failed with status ${response.status}`);
}
const data = await response.json();
console.log(data);
import requests
headers = {
'Authorization': 'Bearer YOUR_USER_API_KEY',
'Accept': 'application/json',
}
response = requests.delete('https://v1.tempmailg.com/api/messages/ap94AWDg123ELQz07vrVB9dLXlbqZM5NGwYxOJKko8n6m1', headers=headers, timeout=30)
response.raise_for_status()
print(response.json())
<?php
$ch = curl_init('https://v1.tempmailg.com/api/messages/ap94AWDg123ELQz07vrVB9dLXlbqZM5NGwYxOJKko8n6m1');
curl_setopt_array($ch, [
CURLOPT_CUSTOMREQUEST => 'DELETE',
CURLOPT_RETURNTRANSFER => true,
CURLOPT_HTTPHEADER => [
'Authorization: Bearer YOUR_USER_API_KEY',
'Accept: application/json',
],
]);
$response = curl_exec($ch);
if ($response === false) {
throw new RuntimeException(curl_error($ch));
}
$statusCode = curl_getinfo($ch, CURLINFO_HTTP_CODE);
curl_close($ch);
var_dump($statusCode, json_decode($response, true));
curl --request DELETE \
--url 'https://v1.tempmailg.com/api/messages/ap94AWDg123ELQz07vrVB9dLXlbqZM5NGwYxOJKko8n6m1' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer YOUR_USER_API_KEY'
Respons ilustratif menggunakan data sintetis. ID, alamat, token, cap waktu, batas dan hitungan paket bervariasi. Contoh masa pakai tidak menggantikan default paket Anda. Deskripsi bidang respons mengidentifikasi bidang yang dapat bernilai null dan spesifik penyedia.
Contoh respons
200 OK • JSON{
"status": true,
"message": "Message was deleted successfully."
}
| Bidang | Jenis | Deskripsi |
|---|---|---|
status |
boolean | Apakah operasi berhasil. |
message |
string | Hasil penghapusan. Sumber daya yang tidak ada mengembalikan HTTP 404. |
Unduh Lampiran
Unduh lampiran dari pesan milik Anda.
| Parameter | Lokasi | Jenis | Status | Deskripsi |
|---|---|---|---|---|
messageId
|
path | string | wajib |
ID pesan yang berisi file.
|
filename
|
path | string | wajib |
Nama file dan ekstensi lampiran yang akan diunduh.
|
X-Mailbox-Unlock
|
header | string | opsional |
Header, hanya kotak surat yang dilindungi: gunakan unlock_token baca. Pertama POST pin dan scope=read ke URL pembuka PIN. Pertahankan otentikasi Bearer normal Anda. <code>https://v1.tempmailg.com/api/mailboxes/{mailbox}/pin/unlock</code>
|
const response = await fetch('https://v1.tempmailg.com/api/messages/ap94AWDg123ELQz07vrVB9dLXlbqZM5NGwYxOJKko8n6m1/attachments/file.txt', {
method: 'GET',
headers: {
'Authorization': 'Bearer YOUR_USER_API_KEY',
'Accept': 'application/json',
},
});
if (!response.ok) {
throw new Error(`Request failed with status ${response.status}`);
}
const blob = await response.blob();
const downloadUrl = window.URL.createObjectURL(blob);
const link = document.createElement('a');
link.href = downloadUrl;
link.download = 'file.txt';
document.body.appendChild(link);
link.click();
link.remove();
window.URL.revokeObjectURL(downloadUrl);
import requests
headers = {
'Authorization': 'Bearer YOUR_USER_API_KEY',
'Accept': 'application/json',
}
response = requests.get('https://v1.tempmailg.com/api/messages/ap94AWDg123ELQz07vrVB9dLXlbqZM5NGwYxOJKko8n6m1/attachments/file.txt', headers=headers, stream=True, timeout=30)
response.raise_for_status()
with open('file.txt', 'wb') as handle:
for chunk in response.iter_content(chunk_size=8192):
if chunk:
handle.write(chunk)
<?php
$fileHandle = fopen('file.txt', 'w');
$ch = curl_init('https://v1.tempmailg.com/api/messages/ap94AWDg123ELQz07vrVB9dLXlbqZM5NGwYxOJKko8n6m1/attachments/file.txt');
curl_setopt_array($ch, [
CURLOPT_CUSTOMREQUEST => 'GET',
CURLOPT_FILE => $fileHandle,
CURLOPT_FOLLOWLOCATION => true,
CURLOPT_HTTPHEADER => [
'Authorization: Bearer YOUR_USER_API_KEY',
'Accept: application/json',
],
]);
if (curl_exec($ch) === false) {
fclose($fileHandle);
throw new RuntimeException(curl_error($ch));
}
curl_close($ch);
fclose($fileHandle);
curl --request GET \
--url 'https://v1.tempmailg.com/api/messages/ap94AWDg123ELQz07vrVB9dLXlbqZM5NGwYxOJKko8n6m1/attachments/file.txt' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer YOUR_USER_API_KEY' \
--output file.txt
| Bidang | Jenis | Deskripsi |
|---|---|---|
Content-Disposition |
header | Respons berhasil mengunduh nama file yang diminta. |
body |
binary | Byte file pada keberhasilan, bukan JSON. Kesalahan mengembalikan JSON dengan status non-2xx. |
Batas Laju & Kuota
Pantau anggaran permintaan waktu nyata, batas kecepatan, dan kuota akun tanpa mengonsumsi kredit.
Batas Kecepatan & Kuota
Periksa batas kecepatan dan status kuota Anda saat ini tanpa mengonsumsi penggunaan API apa pun. Endpoint ini bebas kuota dan tidak mengurangi kredit API bulanan (batas perlindungan penyalahgunaan: 60 permintaan/menit).
const response = await fetch('https://v1.tempmailg.com/api/rate-limit', {
method: 'GET',
headers: {
'Authorization': 'Bearer YOUR_USER_API_KEY',
'Accept': 'application/json',
},
});
if (!response.ok) {
throw new Error(`Request failed with status ${response.status}`);
}
const data = await response.json();
console.log(data);
import requests
headers = {
'Authorization': 'Bearer YOUR_USER_API_KEY',
'Accept': 'application/json',
}
response = requests.get('https://v1.tempmailg.com/api/rate-limit', headers=headers, timeout=30)
response.raise_for_status()
print(response.json())
<?php
$ch = curl_init('https://v1.tempmailg.com/api/rate-limit');
curl_setopt_array($ch, [
CURLOPT_CUSTOMREQUEST => 'GET',
CURLOPT_RETURNTRANSFER => true,
CURLOPT_HTTPHEADER => [
'Authorization: Bearer YOUR_USER_API_KEY',
'Accept: application/json',
],
]);
$response = curl_exec($ch);
if ($response === false) {
throw new RuntimeException(curl_error($ch));
}
$statusCode = curl_getinfo($ch, CURLINFO_HTTP_CODE);
curl_close($ch);
var_dump($statusCode, json_decode($response, true));
curl --request GET \
--url 'https://v1.tempmailg.com/api/rate-limit' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer YOUR_USER_API_KEY'
Respons ilustratif menggunakan data sintetis. ID, alamat, token, cap waktu, batas dan hitungan paket bervariasi. Contoh masa pakai tidak menggantikan default paket Anda. Deskripsi bidang respons mengidentifikasi bidang yang dapat bernilai null dan spesifik penyedia.
Contoh respons
200 OK • JSON{
"status": "success",
"data": {
"limit": 60,
"remaining": 45,
"reset": 32,
"plan": "premium",
"monthly_limit": 50000,
"monthly_remaining": 48210,
"purchased_credits": 5000,
"quota": {
"enabled": true,
"user_api_status": true,
"plan_name": "Premium Plan",
"period": "2026-10",
"base_limit": 50000,
"extra_requests": 0,
"monthly_limit": 50000,
"monthly_remaining": 48210,
"used": 1790,
"purchased_credits": 5000,
"bonus_credits": 1000,
"direct_purchased_credits": 4000,
"remaining": 53210,
"unlimited": false,
"usage_percent": 3,
"reset_at": "2026-11-01T00:00:00+00:00"
}
}
}
| Bidang | Jenis | Deskripsi |
|---|---|---|
data.limit |
integer|string | Batas permintaan per menit akun. String unlimited menunjukkan anggaran menit tak terbatas; ini terpisah dari kuota bulanan. |
data.remaining |
integer|string | Slot anggaran menit akun yang tersisa, atau string unlimited. Nilai positif tidak berarti kredit API masih ada. |
data.reset |
integer | Detik untuk jendela menit akun, bukan reset kuota bulanan. Anggaran menit yang dinonaktifkan atau tidak terbatas dapat mempertahankan nilai nominal 60 detik; ini tidak menjamin akses setelah menunggu. |
data.plan |
string | Tag rencana saat ini. Nama rencana yang dapat dibaca disediakan secara terpisah di data.quota.plan_name. |
data.quota.enabled |
boolean | Apakah akses API global dan rencana/kredit diaktifkan. Ini tidak menunjukkan kapasitas yang tersisa atau menggantikan saklar API pengguna. |
data.quota.user_api_status |
boolean | Apakah pengguna telah mengaktifkan saklar API Pengguna mereka. Operasi memerlukan saklar ini serta akses yang diaktifkan dan kapasitas yang tersedia. |
data.quota.plan_name |
string | Nama yang dapat dibaca dari paket saat ini. |
data.quota.period |
string | Periode penggunaan bulan kalender dalam format YYYY-MM, menggunakan zona waktu aplikasi; tidak selalu merupakan periode penagihan langganan. |
data.quota.base_limit |
integer | Tunjangan dasar bulanan paket. Nilai -1 berarti tidak terbatas. |
data.quota.extra_requests |
integer | Tunjangan bulanan tambahan diberikan untuk periode penggunaan saat ini; terpisah dari kredit yang dibeli. |
data.quota.monthly_limit |
integer | Tunjangan dasar ditambah permintaan ekstra periode saat ini. Nilai -1 berarti tidak terbatas. Kredit yang dibeli tidak termasuk. |
data.quota.monthly_remaining |
integer|null | Sisa alokasi bulanan terbatas, atau null ketika kuota bulanan tidak terbatas. Null tidak boleh diartikan sebagai nol. |
data.quota.used |
integer | Operasi API yang berhasil dan dihitung dalam periode penggunaan saat ini, termasuk operasi yang menggunakan kredit. Pemeriksaan status tidak meningkatkan nilai ini. |
data.quota.purchased_credits |
integer | Saldo kredit saat ini, termasuk kredit bonus paket aktif. Kredit bonus tidak boleh ditambahkan ke saldo ini untuk kedua kalinya. |
data.quota.bonus_credits |
integer | Bagian bonus rencana aktif dari saldo kredit; rincian purchased_credits, bukan kapasitas tambahan. |
data.quota.direct_purchased_credits |
integer | Saldo kredit tidak termasuk bagian plan-bonus yang aktif. Nilai ini ditambah bonus_credits sama dengan purchased_credits. |
data.quota.remaining |
integer|null | Sisa alokasi bulanan ditambah saldo kredit saat ini, tanpa menghitung bonus dua kali. Null berarti kuota bulanan tak terbatas. Izin fitur individu dan batas permintaan lainnya tetap berlaku. |
data.quota.unlimited |
boolean | Apakah kuota bulanan tidak terbatas. Ini tidak membuat anggaran menit akun atau batas fitur lainnya tidak terbatas. |
data.quota.usage_percent |
integer | Persentase bulat yang kompatibel dengan dasbor dari 0 hingga 100: digunakan dibagi dengan digunakan ditambah sisa, dikalikan 100. Ini mencakup kapasitas kredit yang tersedia, sehingga pengisian ulang dapat menurunkan persentase. Nilainya 0 untuk kuota tak terbatas atau kumpulan berukuran nol; ini bukan persentase batas laju per menit atau keputusan akses. |
data.quota.reset_at |
string | Stempel waktu ISO-8601 dengan offset zona waktu untuk reset kuota bulan kalender berikutnya. Ini bukan tanggal kedaluwarsa langganan, dan reset bulanan tidak mengisi ulang kredit yang dibeli. |
status |
string | Keberhasilan literal untuk endpoint status ini. Endpoint kotak surat sukses lainnya menggunakan boolean true. |
data.monthly_limit |
integer | Alias kompatibilitas dari bidang data.quota yang bersangkutan; jangan menambahkannya lagi saat menghitung saldo. |
data.monthly_remaining |
integer|null | Alias kompatibilitas dari bidang data.quota yang bersangkutan; jangan menambahkannya lagi saat menghitung saldo. |
data.purchased_credits |
integer | Alias kompatibilitas dari bidang data.quota yang bersangkutan; jangan menambahkannya lagi saat menghitung saldo. |
Webhook Papan Surat (Push Real-Time)
Sebagai gantinya, daripada terus-menerus memeriksa API REST (GET /messages) untuk memeriksa surat masuk, konfigurasikan Webhooks untuk mendorong pesan baru ke server atau alur kerja otomatisasi Anda secara real-time.
Acara Webhook yang Didukung
Setiap webhook dapat berlangganan pada satu atau lebih jenis acara. Endpoint Anda menerima pemberitahuan acara setiap kali salah satu trigger tersebut terjadi.
Dikirim secara real time setiap kali pesan baru mencapai kotak surat yang dipilih.
Dikirim ketika temporary mailbox kedaluwarsa dan pemrosesan webhook dijeda.
Dikirim ketika kotak surat yang kedaluwarsa menjadi aktif kembali sesuai aturan paket.
Dikirim tepat sebelum webhook dan kotak suratnya dihapus.
Kepala Permintaan & Verifikasi Tanda HMAC
Setiap pengiriman webhook mengandung header keamanan khusus. Gunakan header **X-TempMailg-Signature** untuk memverifikasi bahwa permintaan masuk dikirim secara otentik oleh TempMailg dan tidak telah dimodifikasi.
| Nama Header | Nilai Contoh | Deskripsi |
|---|---|---|
User-Agent |
TempMailg-Webhooks/1.0 | Pengidentifikasi standar untuk pekerja pengiriman webhook. |
X-TempMailg-Event |
email.received | Jenis peristiwa yang memicu pengiriman ini. |
X-TempMailg-Event-Id |
e7b1a2c3-4d5e-6f7a-8b9c-0d1e2f3a4b5c | UUID unik yang diberikan untuk percobaan pengiriman ini. |
X-TempMailg-Timestamp |
1725192000 | Stempel waktu epoch Unix yang menunjukkan kapan permintaan dimulai. |
X-TempMailg-Signature |
sha256=d7a8fbb307d7809469ca933b02d82941... | Tanda tangan HMAC-SHA256 yang dihitung dari {timestamp}.{raw_body} menggunakan rahasia Anda. |
X-TempMailg-Test |
false | Benar ketika dikirim oleh fitur "Send Test Ping" di dasbor Anda. |
Tanda tangan dihitung menggunakan HMAC dengan SHA256 pada string:
hash_hmac('sha256', "${X-TempMailg-Timestamp}.${raw_request_body}", your_webhook_secret)
Contoh Payload Acara (email.received)
Diterima sebagai `application/json` dalam badan permintaan HTTP POST.
{
"id": "e7b1a2c3-4d5e-6f7a-8b9c-0d1e2f3a4b5c",
"version": "1.0",
"event": "email.received",
"occurred_at": "2026-11-19T02:18:06+00:00",
"test": false,
"mailbox": {
"id": 1024,
"email": "developer@v1.tempmailg.com"
},
"data": {
"message_id": "7a8b9c0d1e2f",
"subject": "Your Verification Code: 948201",
"from": "auth@service.com",
"to": "developer@v1.tempmailg.com",
"date": "2026-11-19T02:18:06+00:00",
"attachments_count": 0,
"text_preview": "Hello, your one-time verification code is 948201. It will expire in 10 minutes.",
"email_url": "https://tempmailg.com/mailbox/1024?message=7a8b9c0d1e2f",
"inbox_url": "https://tempmailg.com/mailbox/1024"
}
}
Contoh Implementasi Penerima
Pilih bahasa Anda untuk melihat cara menerima webhook dan memverifikasi tanda tangan HMAC dengan aman.
const express = require('express');
const crypto = require('crypto');
const app = express();
const WEBHOOK_SECRET = 'your_webhook_signing_secret';
// Capture raw body buffer for HMAC-SHA256 signature verification
app.use(express.json({
verify: (req, res, buf) => {
req.rawBody = buf.toString('utf8');
}
}));
app.post('/webhook', (req, res) => {
const timestamp = req.headers['x-tempmailg-timestamp'];
const signatureHeader = req.headers['x-tempmailg-signature'] || '';
// Calculate HMAC-SHA256 signature
const expectedSignature = 'sha256=' + crypto
.createHmac('sha256', WEBHOOK_SECRET)
.update(`${timestamp}.${req.rawBody}`)
.digest('hex');
// Verify signature
if (signatureHeader !== expectedSignature) {
return res.status(401).json({ error: 'Invalid webhook signature' });
}
const { event, mailbox, data } = req.body;
console.log(`[Event: ${event}] Mailbox: ${mailbox.email}`);
if (event === 'email.received') {
console.log(`From: ${data.from}`);
console.log(`Subject: ${data.subject}`);
console.log(`Preview: ${data.text_preview}`);
}
// Acknowledge receipt with HTTP 200
res.status(200).json({ received: true });
});
app.listen(3000, () => console.log('Webhook receiver running on port 3000'));
from flask import Flask, request, jsonify
import hmac
import hashlib
app = Flask(__name__)
WEBHOOK_SECRET = b"your_webhook_signing_secret"
@app.route("/webhook", methods=["POST"])
def handle_webhook():
timestamp = request.headers.get("X-TempMailg-Timestamp", "")
signature_header = request.headers.get("X-TempMailg-Signature", "")
# Calculate expected HMAC-SHA256 signature
raw_body = request.get_data()
signed_payload = f"{timestamp}.".encode("utf-8") + raw_body
expected_signature = "sha256=" + hmac.new(
WEBHOOK_SECRET, signed_payload, hashlib.sha256
).hexdigest()
# Verify signature securely
if not hmac.compare_digest(signature_header, expected_signature):
return jsonify({"error": "Invalid signature"}), 401
payload = request.get_json()
event = payload.get("event")
mailbox = payload.get("mailbox", {}).get("email")
data = payload.get("data", {})
print(f"[{event}] Mailbox: {mailbox}")
if event == "email.received":
print(f"From: {data.get('from')}")
print(f"Subject: {data.get('subject')}")
print(f"Preview: {data.get('text_preview')}")
# Return 200 OK to acknowledge receipt
return jsonify({"received": True}), 200
if __name__ == "__main__":
app.run(port=5000)
<?php
$secret = 'your_webhook_signing_secret';
$rawBody = file_get_contents('php://input');
$timestamp = $_SERVER['HTTP_X_TEMPMAILG_TIMESTAMP'] ?? '';
$receivedSignature = $_SERVER['HTTP_X_TEMPMAILG_SIGNATURE'] ?? '';
// Calculate HMAC-SHA256 signature
$expectedSignature = 'sha256=' . hash_hmac('sha256', $timestamp . '.' . $rawBody, $secret);
// Verify signature
if (!hash_equals($expectedSignature, $receivedSignature)) {
http_response_code(401);
echo json_encode(['error' => 'Invalid signature']);
exit;
}
$payload = json_decode($rawBody, true);
$event = $payload['event'] ?? '';
$mailbox = $payload['mailbox']['email'] ?? '';
$data = $payload['data'] ?? [];
if ($event === 'email.received') {
$sender = $data['from'] ?? '';
$subject = $data['subject'] ?? '';
$preview = $data['text_preview'] ?? '';
// Process new incoming email...
}
// Acknowledge receipt
http_response_code(200);
echo json_encode(['received' => true]);
Platform yang Didukung & Integrasi Otomasi
Webhook TempMailg berfungsi langsung dengan endpoint HTTPS standar dan platform no-code/otomasi terkemuka:
Kesalahan umum dan pemecahan masalah
Ini adalah kode respons paling umum yang mungkin Anda lihat saat mengintegrasikan API pengguna.
Token Bearer tidak valid, hilang, atau dicabut.
Kepemilikan, izin fitur, akses domain, atau ukuran lampiran mencegah operasi. Periksa kode respons dan pesan.
Sumber daya tidak ditemukan di host yang diizinkan atau bukan milik pengguna.
Kunci operasi telah digunakan kembali dengan detail yang berbeda, operasi lain sedang menunggu, atau keamanan kotak surat berubah. Periksa kode sebelum mencoba lagi.
Kotak surat kedaluwarsa atau tidak aktif.
Parameter tidak valid, masa pakai yang tidak diizinkan, kapasitas alias tidak tersedia, pengaturan PIN tidak valid atau Idempotency-Key yang hilang/tidak valid mencegah operasi.
Kotak surat yang dilindungi memerlukan token X-Mailbox-Unlock yang valid dan berskala. Gunakan action dan target_id dari respons untuk penghapusan. Persyaratan penguncian atau pemulihan harus diselesaikan sebelum mencoba lagi.
Batas permintaan, rencana yang dinonaktifkan, kuota habis, atau pendinginan mencegah operasi. Periksa alasan dan header anggaran yang tersedia. Retry-After bersifat opsional.
Server tidak dapat menyelesaikan operasi. Untuk pembuatan atau penghapusan yang dilindungi, pertahankan permintaan yang sama dan Idempotency-Key saat mencoba lagi.
Penyimpanan perlindungan atau koordinasi tidak dapat diverifikasi. Coba lagi setelah penundaan yang ditentukan. Respons ini bukan pembayaran yang gagal.
Daftar periksa cepat
- 401 Unauthorized - Token Bearer hilang, salah, dicabut, atau disalin dengan tidak benar.
- 403 Forbidden - Paket saat ini tidak memiliki akses API pengguna saat ini.
- 404 Not Found - Sumber daya tidak ditemukan atau parameter tidak valid
- 410 Gone / Expired - Kotak surat kedaluwarsa atau tidak lagi aktif.
- 429 Rate Limited - Periksa alasan respons dan header anggaran. Retry-After hanya berlaku untuk batas waktu; kredit yang habis atau akses yang dinonaktifkan mungkin memerlukan perubahan akun.
Rekomendasi langkah selanjutnya
Jika Anda masuk, buka Manajemen API terlebih dahulu dan konfirmasi kunci Anda, kuota, status akses paket, serta URL Dasar API Pengguna yang tepat sebelum men-debug aplikasi eksternal Anda.