รายการเช็คการตั้งค่าเร็ว
- เปิดหน้า API Management ของแดชบอร์ดของคุณและสร้างคีย์ API ส่วนบุคคลของคุณ
- คัดลอก URL ฐาน API ผู้ใช้โดยตรงตามที่แสดง เช่น https://v1.tempmailg.com/api.
- ส่งคำขอทั้งหมดไปยังโฮสต์ API นั้นพร้อม Authorization: Bearer YOUR_USER_API_KEY และ Accept: application/json.
- ติดตามโควต้าการร้องขอรายเดือนของคุณจากหน้าแดชบอร์ดเดียวกันและจากส่วนหัวโควต้าเมื่อมีให้ในการตอบสนอง API ของผู้ใช้. การร้องขอที่สำเร็จแบบ 2xx เท่านั้นจะนับเข้าสู่โควต้า.
การเข้าถึงคีย์ API
เข้าสู่ระบบเพื่อสร้างคีย์ API ส่วนบุคคลและดูรายละเอียดควอต้าแบบเรียลไทม์
การไหลของการรับรองความถูกต้อง
- สร้างคีย์ API ส่วนบุคคลของคุณจากหน้า API Management
- ส่งคีย์เป็นโทเค็น Bearer ในทุกการร้องขอ
- ใช้ URL ฐาน API ผู้ใช้ที่เฉพาะเจาะจงที่แสดงในหน้า API Management ของคุณ
- สร้างคีย์ใหม่เมื่อคุณต้องการยกเลิกคีย์เก่าและเริ่มใช้คีย์ใหม่ทันที
ส่วนหัวที่จำเป็น
Authorization: Bearer YOUR_USER_API_KEY
Accept: application/json
หัวข้อจำกัดอัตรา & โควตา
ส่วนหัวการจำกัดอัตราอธิบายงบประมาณการร้องขอที่ระบุ ส่วนหัวโควต้าถูกใส่เมื่อข้อมูลโควต้ามีให้ใช้งาน; การปฏิเสธการจำกัดต่อนาทีไม่ได้คำนวณโควต้ารายเดือนของคุณเต็มจำนวน.
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— จำนวนคำขอสูงสุดที่อนุญาตต่อหนึ่งนาที (RPM) สำหรับแผนของคุณ.X-RateLimit-Remaining— คำขอ RPM ที่เหลือในหน้าต่างนาทีปัจจุบัน.X-RateLimit-Reset— ไทม์สแตมป์ Unix เมื่อหน้าต่างจำกัดอัตราในนาทีปัจจุบันรีเซ็ต.X-Quota-Limit— ความจุเครดิตรวมต่อเดือนและที่ซื้อสำหรับบัญชีของคุณ.X-Quota-Remaining— จำนวนคำขอ API ที่เหลือในเดือนปัจจุบัน.X-Quota-Used— จำนวนคำขอ API ทั้งหมดที่ใช้ในช่วงระยะเวลาการเรียกเก็บเงินปัจจุบัน.X-Quota-Reset— ไทม์สแตมป์ ISO-8601 เมื่อโควต้ารายเดือนของคุณรีเซ็ต.X-RateLimit-Scope— งบประมาณที่อธิบายโดยหัวข้อ: account, ip, status_endpoint หรือ mailboxX-Mailbox-RateLimit-*— งบประมาณการสร้าง/อัปเดตกล่องจดหมายแยก. การตอบกลับกล่องจดหมายที่สำเร็จจะรักษา RPM ของบัญชีใน X-RateLimit-*; การปฏิเสธเฉพาะกล่องจดหมายจะใช้ขอบเขตของกล่องจดหมายและหน้าต่างการลองใหม่ของมันเอง.Retry-After— วินาทีจนกว่าจะถึงเวลาที่เหมาะสมสำหรับการลองใหม่แบบกำหนดเวลา แผนที่ถูกปิดใช้งานหรือโควต้าที่หมดอาจต้องเปลี่ยนบัญชีแทน ดังนั้นส่วนหัวนี้จึงไม่ปรากฏเสมอไป503 protection_unavailable— การจัดเก็บหรือการประสานงานการป้องกัน API ไม่พร้อมใช้งานชั่วคราว. ลองใหม่ภายหลัง; นี่ไม่ใช่ความล้มเหลวของการชำระเงินหรือการหักเครดิต.
การจัดการเมลบ็อกซ์
ดึงโดเมนที่อนุญาต, สร้างหรือสลับกล่องจดหมาย, เลือกระยะเวลาที่อนุญาต, และลบที่อยู่ที่เป็นของคุณ.
รายการโดเมนที่อนุญาต
แสดงรายการโดเมนที่พร้อมใช้งานสำหรับสร้างอีเมลชั่วคราว. กรองตามประเภทเพื่อดูเฉพาะโดเมนฟรี, พรีเมียม หรือแบบกำหนดเองที่สนับสนุนโดยแผนการสมัครของคุณ.
| พารามิเตอร์ | ตำแหน่ง | ประเภท | สถานะ | คำอธิบาย |
|---|---|---|---|---|
type
|
query | string | ไม่บังคับ |
ตัวกรองระดับโดเมน การละเว้นจะใช้ทั้งหมดเมื่อเปิดการเข้าถึงโดเมนระดับพรีเมียม มิฉะนั้นจะใช้ฟรี ค่าที่รับรู้ได้: free, basic, pro, premium, custom, ultimate, all
ค่าเริ่มต้น:
ขึ้นอยู่กับบัญชี
|
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'
การตอบสนองเชิงอธิบายโดยใช้ข้อมูลสังเคราะห์ ID, ที่อยู่, โทเค็น, เวลา, ขีดจำกัดและจำนวนของแผนจะแตกต่างกัน ตัวอย่างอายุการใช้งานไม่ทับค่าปริยายของแผนของคุณ คำอธิบายฟิลด์การตอบสนองระบุฟิลด์ที่เป็นค่า null และฟิลด์เฉพาะผู้ให้บริการ
ตัวอย่างการตอบสนอง
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
}
]
}
}
| ฟิลด์ | ประเภท | คำอธิบาย |
|---|---|---|
status |
boolean | ว่าการดำเนินการสำเร็จหรือไม่. |
data.requested_type |
string | ใช้ตัวกรองโดเมนแล้ว. |
data.plan |
string | แท็กแผนปัจจุบัน. |
data.plan_name |
string | ชื่อที่อ่านได้ของแผนปัจจุบัน. |
data.allowed_types |
array<string> | ตัวกรองโดเมนที่พร้อมใช้งานสำหรับบัญชีนี้ ตัวกรองที่ได้รับการยอมรับยังอาจถูกห้ามใช้ตามแผนของคุณ. |
data.domains |
array | โดเมนที่เลือกได้หลังจากการกรอง; อาร์เรย์ว่างเป็นค่าที่ถูกต้อง. |
data.domains[].domain |
string | ชื่อโดเมนที่เลือกได้. |
data.domains[].type |
string | ป้ายระดับโดเมนที่อ่านได้. |
data.domains[].custom |
boolean | ว่าเป็นโดเมนที่กำหนดเองหรือไม่. |
สร้างกล่องจดหมายชั่วคราว
สร้างกล่องจดหมายชั่วคราวที่เป็นของคุณเอง. ไม่ระบุชื่อผู้ใช้และโดเมนเพื่อการสร้างแบบสุ่ม, หรือระบุชื่อผู้ใช้ที่กำหนดเองที่ได้รับอนุญาตและโดเมนที่อนุญาต. พารามิเตอร์ provider สามารถเลือกการสร้างนามแฝง Gmail หรือ Outlook ได้.
| พารามิเตอร์ | ตำแหน่ง | ประเภท | สถานะ | คำอธิบาย |
|---|---|---|---|---|
username
|
body | string | ไม่บังคับ |
ชื่อผู้ใช้ที่กำหนดเองแบบเลือกได้: 2 ถึง 64 ตัวอักษร ASCII, ตัวเลข, จุด, ขีดล่าง หรือขีดกลาง ต้องมีสิทธิ์ของแผน; custom_username ก็รับได้เช่นกัน
ค่าเริ่มต้น:
สร้างแบบสุ่ม
|
domain
|
body | string | ไม่บังคับ |
หนึ่งในโดเมนที่อนุญาตที่ส่งกลับโดย GET /domains. การละเว้นจะเลือกโดเมนที่อนุญาตแบบสุ่ม.
ค่าเริ่มต้น:
โดเมนที่อนุญาตแบบสุ่ม
|
lifetime
|
body | string | ไม่บังคับ |
ค่าที่อนุญาต:
10m — 10 นาที
1h — 1 ชั่วโมง
2h — 2 ชั่วโมง
1d — 1 วัน
1w — 1 สัปดาห์
1m — 30 วัน
3m — 90 วัน
6m — 180 วัน
1y — 365 วัน
unlimited — ไม่จำกัด
ค่าเริ่มต้น:
อายุการใช้งานเริ่มต้นของแผน
|
provider
|
body | string | ไม่บังคับ |
ผู้ให้บริการกล่องจดหมาย: standard, gmail_alias, หรือ outlook_alias.
ค่าเริ่มต้น:
standard
|
pin_enabled
|
body | boolean | ไม่บังคับ |
การป้องกัน PIN แบบเลือกได้สำหรับกล่องจดหมายใหม่ เมื่อแผนของคุณอนุญาต ไม่ได้เปลี่ยน PIN ของกล่องจดหมายที่มีอยู่
ค่าเริ่มต้น:
false
|
pin
|
body | string | ไม่บังคับ |
จำเป็นเมื่อ pin_enabled เป็น true: PIN ที่มี 6 ถึง 8 หลัก, ส่งเป็นสตริงเพื่อรักษาเลขศูนย์นำหน้า.
|
pin_confirmation
|
body | string | ไม่บังคับ |
จำเป็นเมื่อ pin_enabled เป็นจริง ต้องตรงกับ pin อย่างแม่นยำ.
|
Idempotency-Key
|
header | string | ไม่บังคับ |
จำเป็นสำหรับการสร้างหรือการลบที่มีการป้องกันด้วย PIN: คีย์ที่คงที่ความยาว 16 ถึง 128 ตัวอักษร. ลองทำคำขอเดียวกันซ้ำด้วยคีย์เดียวกันเพื่อหลีกเลี่ยงการทำงานซ้ำ.
|
username (ชื่อผู้ใช้ที่กำหนดเองหากแผนอนุญาต), domain (โดเมนที่อนุญาต, เช่น example.com), lifetime (ค่าที่อนุญาต: 10m, 1h, 2h, 1d, 1w, 1m, 3m, 6m, 1y, unlimited), provider (standard, gmail_alias, outlook_alias). ละเว้นช่วงอายุการใช้งาน หรือเว้นว่างไว้ เพื่อใช้ Default Email Lifetime ที่กำหนดไว้สำหรับแผนรายเดือน/รายปีปัจจุบันของคุณ. ส่งช่วงอายุที่อนุญาต เช่น 1h เพื่อแทนที่ค่าเริ่มต้นนั้น. Unlimited จะใช้เฉพาะเมื่อกำหนดเป็นค่าเริ่มต้นของแผนหรือเมื่อมีการร้องขออย่างชัดเจนและได้รับอนุญาต. พารามิเตอร์ในส่วน body mailbox_lifetime และ email_lifetime ก็ได้รับการยอมรับเช่นกัน; ค่าที่ไม่ว่างแรกที่พบจะถูกใช้ตามลำดับนี้: lifetime, mailbox_lifetime, email_lifetime. ค่าที่ไม่ถูกต้องหรือไม่ได้รับอนุญาตจะคืนค่า HTTP 422 แทนการเลือกค่าเริ่มต้นโดยเงียบ.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'
การตอบสนองเชิงอธิบายโดยใช้ข้อมูลสังเคราะห์ ID, ที่อยู่, โทเค็น, เวลา, ขีดจำกัดและจำนวนของแผนจะแตกต่างกัน ตัวอย่างอายุการใช้งานไม่ทับค่าปริยายของแผนของคุณ คำอธิบายฟิลด์การตอบสนองระบุฟิลด์ที่เป็นค่า null และฟิลด์เฉพาะผู้ให้บริการ
ตัวอย่างการตอบสนอง
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:17:47+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:17:47+00:00",
"email_token": "encrypted-email-token"
}
}
| ฟิลด์ | ประเภท | คำอธิบาย |
|---|---|---|
status |
boolean | ว่าการดำเนินการสำเร็จหรือไม่. |
data.id |
integer | ID ของกล่องจดหมาย. ID, ที่อยู่และโทเค็นที่สร้างขึ้นจะแตกต่างกันสำหรับแต่ละกล่องจดหมาย |
data.pin_protected |
boolean | ว่ากล่องจดหมายนี้มีการป้องกันด้วย PIN หรือไม่. ไม่ได้คืนค่า PIN หรือแฮชของ PIN. |
data.email |
string | ที่อยู่กล่องจดหมายเต็มที่สร้างแล้ว. |
data.domain |
string | โดเมนของกล่องจดหมายที่สร้างขึ้น. |
data.provider |
string | ผู้ให้บริการกล่องจดหมาย: standard, gmail_alias, หรือ outlook_alias. |
data.expire_at |
string|null | วันหมดอายุที่มีผลเป็น timestamp รูปแบบ ISO-8601 หรือ null สำหรับกล่องจดหมายที่ไม่มีขีดจำกัด |
data.expires_in_seconds |
number|null | วินาทีที่เหลือที่คำนวณได้ต้องเป็นจำนวนเต็มบวกหรือศูนย์; สามารถมีวินาทีเศษส่วนได้ ค่า Null หมายถึงไม่จำกัด ไม่ใช่ศูนย์. |
data.mailbox_state |
string | สถานะกล่องจดหมายปัจจุบัน: ทำงาน, หยุดชั่วคราว, หมดอายุ หรือ ไม่ทำงาน |
data.receiving_enabled |
boolean | ว่ากล่องจดหมายนี้ในขณะนี้รับข้อความขาเข้าหรือไม่. |
data.message_count |
integer | จำนวนข้อความทั้งหมดที่ทราบ; สามารถสะท้อนการซิงโครไนซ์กล่องจดหมายครั้งล่าสุด. |
data.unread_message_count |
integer | จำนวนข้อความที่ยังไม่ได้อ่านที่ทราบ; สามารถสะท้อนการซิงค์กล่องจดหมายครั้งล่าสุดได้. |
data.last_message_received_at |
string|null | เวลาที่รับข้อความล่าสุดที่ทราบในรูปแบบ ISO-8601 หรือ null เมื่อไม่มีข้อมูล |
data.message_count_synced_at |
string|null | เวลาการซิงโครไนซ์จำนวนข้อความล่าสุดในรูปแบบ ISO-8601 หรือ null ก่อนการซิงโครไนซ์ |
data.created_at |
string|null | เวลาการสร้างกล่องจดหมายในรูปแบบ ISO-8601. |
data.email_token |
string | อ้างอิงกล่องจดหมายที่เข้ารหัสแบบไม่เปิดเผย. มันไม่แทนที่การตรวจสอบการรับรอง Bearer, การตรวจสอบความเป็นเจ้าของ หรือการอนุญาต PIN. |
data.pin_grant |
object | เงื่อนไข: การสร้างกล่องจดหมายที่มีการป้องกันด้วย PIN ที่ใช้งานอยู่จะคืนสิทธิ์การอ่านนี้; การสร้างแบบปกติที่ไม่มีการป้องกันจะละเว้นมัน. |
data.pin_grant.mailbox_id |
integer | รหัสกล่องจดหมายที่การให้สิทธิ์การอ่านแบบมีเงื่อนไขถูกผูกไว้. |
data.pin_grant.unlock_token |
string | โทเค็นการอ่านแบบไม่เปิดเผยสำหรับ X-Mailbox-Unlock ด้วยข้อมูลประจำตัวของเจ้าของเดียวกัน เก็บเป็นส่วนตัวและอยู่ในหน่วยความจำ; การให้สิทธิ์การอ่านไม่ได้อนุญาตให้ลบ |
data.pin_grant.scope |
string | ขอบเขตที่อ่านสำหรับการให้สิทธิ์การสร้างแบบมีเงื่อนไข. |
data.pin_grant.idle_timeout_seconds |
integer | เวลาว่างที่อนุญาตสำหรับการให้สิทธิ์การอ่าน, ปกติ 3600 วินาที. |
data.pin_grant.absolute_timeout_seconds |
integer | อายุการใช้งานสูงสุดของสิทธิ์การอ่าน โดยปกติคือ 86400 วินาที. |
data.pin_grant.expires_at |
string | วันหมดอายุของการให้สิทธิ์การอ่านในปัจจุบันในรูปแบบ ISO-8601. |
data.pin_grant.absolute_expires_at |
string | วันหมดอายุของการให้สิทธิ์การอ่านแบบแน่นอนในรูปแบบ ISO-8601. การเปลี่ยนแปลงด้านความปลอดภัยอาจเพิกถอนสิทธิ์ได้ก่อนหน้า. |
อัปเดต / สลับกล่องจดหมาย
สร้างหรือเลือกกล่องจดหมายที่ชื่อผู้ใช้และโดเมนใหม่หลังจากยืนยันความเป็นเจ้าของของกล่องจดหมายปัจจุบัน นี้ไม่ได้ทำการเปลี่ยนชื่อกล่องจดหมายเก่า หรือเปลี่ยนระยะเวลาการใช้งานของมันในที่เดียว เมื่อปลายทางแตกต่างกัน กล่องจดหมายเก่ายังคงอยู่ในประวัติและอาจถูกระงับตามขีดจำกัดของกล่องจดหมายที่ใช้งานอยู่ การใช้ปลายทางที่ใช้งานอยู่ของคุณใหม่จะทำให้ระยะเวลาการใช้งานที่ร้องขอหรือค่าเริ่มต้นของแผนถูกนำมาใช้ใหม่
| พารามิเตอร์ | ตำแหน่ง | ประเภท | สถานะ | คำอธิบาย |
|---|---|---|---|---|
email
|
path | string | จำเป็น |
ที่อยู่อีเมลเต็มปัจจุบันของกล่องจดหมายที่เป็นของคุณเพื่อสลับ. URL-encode แต่ละส่วนของเส้นทาง; เข้ารหัสเครื่องหมายบวกเป็น %2B.
|
username
|
path | string | จำเป็น |
ชื่อผู้ใช้ใหม่ที่ต้องการ: 2 ถึง 64 ตัวอักษรและตัวเลข; อยู่ภายใต้การอนุญาตชื่อผู้ใช้แบบกำหนดเอง.
|
domain
|
path | string | จำเป็น |
ชื่อโดเมนที่อนุญาตใหม่.
|
lifetime
|
body | string | ไม่บังคับ |
ค่าที่อนุญาต:
10m — 10 นาที
1h — 1 ชั่วโมง
2h — 2 ชั่วโมง
1d — 1 วัน
1w — 1 สัปดาห์
1m — 30 วัน
3m — 90 วัน
6m — 180 วัน
1y — 365 วัน
unlimited — ไม่จำกัด
ค่าเริ่มต้น:
อายุการใช้งานเริ่มต้นของแผน
|
pin_enabled
|
body | boolean | ไม่บังคับ |
การป้องกัน PIN แบบเลือกได้สำหรับกล่องจดหมายใหม่ เมื่อแผนของคุณอนุญาต ไม่ได้เปลี่ยน PIN ของกล่องจดหมายที่มีอยู่
ค่าเริ่มต้น:
false
|
pin
|
body | string | ไม่บังคับ |
จำเป็นเมื่อ pin_enabled เป็น true: PIN ที่มี 6 ถึง 8 หลัก, ส่งเป็นสตริงเพื่อรักษาเลขศูนย์นำหน้า.
|
pin_confirmation
|
body | string | ไม่บังคับ |
จำเป็นเมื่อ pin_enabled เป็นจริง ต้องตรงกับ pin อย่างแม่นยำ.
|
Idempotency-Key
|
header | string | ไม่บังคับ |
จำเป็นสำหรับการสร้างหรือการลบที่มีการป้องกันด้วย PIN: คีย์ที่คงที่ความยาว 16 ถึง 128 ตัวอักษร. ลองทำคำขอเดียวกันซ้ำด้วยคีย์เดียวกันเพื่อหลีกเลี่ยงการทำงานซ้ำ.
|
X-Mailbox-Unlock
|
header | string | ไม่บังคับ |
ส่วนหัว, สำหรับกล่องจดหมายที่ได้รับการปกป้องเท่านั้น: ใช้ read unlock_token. เริ่มต้นด้วยการ POST pin และ scope=read ไปยัง URL ปลดล็อก PIN. รักษาการตรวจสอบสิทธิ์ Bearer ปกติของคุณ. <code>https://v1.tempmailg.com/api/mailboxes/{mailbox}/pin/unlock</code>
|
lifetime (ค่าที่อนุญาต: 10m, 1h, 2h, 1d, 1w, 1m, 3m, 6m, 1y, unlimited) ละเว้นช่วงอายุการใช้งาน หรือเว้นว่างไว้ เพื่อใช้ Default Email Lifetime ที่กำหนดไว้สำหรับแผนรายเดือน/รายปีปัจจุบันของคุณ. ส่งช่วงอายุที่อนุญาต เช่น 1h เพื่อแทนที่ค่าเริ่มต้นนั้น. Unlimited จะใช้เฉพาะเมื่อกำหนดเป็นค่าเริ่มต้นของแผนหรือเมื่อมีการร้องขออย่างชัดเจนและได้รับอนุญาต. พารามิเตอร์ในส่วน body mailbox_lifetime และ email_lifetime ก็ได้รับการยอมรับเช่นกัน; ค่าที่ไม่ว่างแรกที่พบจะถูกใช้ตามลำดับนี้: lifetime, mailbox_lifetime, email_lifetime. ค่าที่ไม่ถูกต้องหรือไม่ได้รับอนุญาตจะคืนค่า HTTP 422 แทนการเลือกค่าเริ่มต้นโดยเงียบ.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'
การตอบสนองเชิงอธิบายโดยใช้ข้อมูลสังเคราะห์ ID, ที่อยู่, โทเค็น, เวลา, ขีดจำกัดและจำนวนของแผนจะแตกต่างกัน ตัวอย่างอายุการใช้งานไม่ทับค่าปริยายของแผนของคุณ คำอธิบายฟิลด์การตอบสนองระบุฟิลด์ที่เป็นค่า null และฟิลด์เฉพาะผู้ให้บริการ
ตัวอย่างการตอบสนอง
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:27:47+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:17:47+00:00",
"email_token": "encrypted-email-token"
}
}
| ฟิลด์ | ประเภท | คำอธิบาย |
|---|---|---|
status |
boolean | ว่าการดำเนินการสำเร็จหรือไม่. |
data.id |
integer | ID ของกล่องจดหมาย. ID, ที่อยู่และโทเค็นที่สร้างขึ้นจะแตกต่างกันสำหรับแต่ละกล่องจดหมาย |
data.pin_protected |
boolean | ว่ากล่องจดหมายนี้มีการป้องกันด้วย PIN หรือไม่. ไม่ได้คืนค่า PIN หรือแฮชของ PIN. |
data.email |
string | ที่อยู่กล่องจดหมายเต็มที่สร้างแล้ว. |
data.domain |
string | โดเมนของกล่องจดหมายที่สร้างขึ้น. |
data.provider |
string | ผู้ให้บริการกล่องจดหมาย: standard, gmail_alias, หรือ outlook_alias. |
data.expire_at |
string|null | วันหมดอายุที่มีผลเป็น timestamp รูปแบบ ISO-8601 หรือ null สำหรับกล่องจดหมายที่ไม่มีขีดจำกัด |
data.expires_in_seconds |
number|null | วินาทีที่เหลือที่คำนวณได้ต้องเป็นจำนวนเต็มบวกหรือศูนย์; สามารถมีวินาทีเศษส่วนได้ ค่า Null หมายถึงไม่จำกัด ไม่ใช่ศูนย์. |
data.mailbox_state |
string | สถานะกล่องจดหมายปัจจุบัน: ทำงาน, หยุดชั่วคราว, หมดอายุ หรือ ไม่ทำงาน |
data.receiving_enabled |
boolean | ว่ากล่องจดหมายนี้ในขณะนี้รับข้อความขาเข้าหรือไม่. |
data.message_count |
integer | จำนวนข้อความทั้งหมดที่ทราบ; สามารถสะท้อนการซิงโครไนซ์กล่องจดหมายครั้งล่าสุด. |
data.unread_message_count |
integer | จำนวนข้อความที่ยังไม่ได้อ่านที่ทราบ; สามารถสะท้อนการซิงค์กล่องจดหมายครั้งล่าสุดได้. |
data.last_message_received_at |
string|null | เวลาที่รับข้อความล่าสุดที่ทราบในรูปแบบ ISO-8601 หรือ null เมื่อไม่มีข้อมูล |
data.message_count_synced_at |
string|null | เวลาการซิงโครไนซ์จำนวนข้อความล่าสุดในรูปแบบ ISO-8601 หรือ null ก่อนการซิงโครไนซ์ |
data.created_at |
string|null | เวลาการสร้างกล่องจดหมายในรูปแบบ ISO-8601. |
data.email_token |
string | อ้างอิงกล่องจดหมายที่เข้ารหัสแบบไม่เปิดเผย. มันไม่แทนที่การตรวจสอบการรับรอง Bearer, การตรวจสอบความเป็นเจ้าของ หรือการอนุญาต PIN. |
data.pin_grant |
object | เงื่อนไข: การสร้างกล่องจดหมายที่มีการป้องกันด้วย PIN ที่ใช้งานอยู่จะคืนสิทธิ์การอ่านนี้; การสร้างแบบปกติที่ไม่มีการป้องกันจะละเว้นมัน. |
data.pin_grant.mailbox_id |
integer | รหัสกล่องจดหมายที่การให้สิทธิ์การอ่านแบบมีเงื่อนไขถูกผูกไว้. |
data.pin_grant.unlock_token |
string | โทเค็นการอ่านแบบไม่เปิดเผยสำหรับ X-Mailbox-Unlock ด้วยข้อมูลประจำตัวของเจ้าของเดียวกัน เก็บเป็นส่วนตัวและอยู่ในหน่วยความจำ; การให้สิทธิ์การอ่านไม่ได้อนุญาตให้ลบ |
data.pin_grant.scope |
string | ขอบเขตที่อ่านสำหรับการให้สิทธิ์การสร้างแบบมีเงื่อนไข. |
data.pin_grant.idle_timeout_seconds |
integer | เวลาว่างที่อนุญาตสำหรับการให้สิทธิ์การอ่าน, ปกติ 3600 วินาที. |
data.pin_grant.absolute_timeout_seconds |
integer | อายุการใช้งานสูงสุดของสิทธิ์การอ่าน โดยปกติคือ 86400 วินาที. |
data.pin_grant.expires_at |
string | วันหมดอายุของการให้สิทธิ์การอ่านในปัจจุบันในรูปแบบ ISO-8601. |
data.pin_grant.absolute_expires_at |
string | วันหมดอายุของการให้สิทธิ์การอ่านแบบแน่นอนในรูปแบบ ISO-8601. การเปลี่ยนแปลงด้านความปลอดภัยอาจเพิกถอนสิทธิ์ได้ก่อนหน้า. |
ลบกล่องจดหมาย
ลบกล่องจดหมายที่เป็นของคุณและเรียกใช้การทำความสะอาดข้อความและไฟล์ของมัน รายการบันทึกกล่องจดหมายที่เก็บไว้อาจถูกลบแบบอ่อนภายใน; ที่อยู่นี้จะไม่สามารถใช้ผ่าน API ได้อีกต่อไป
| พารามิเตอร์ | ตำแหน่ง | ประเภท | สถานะ | คำอธิบาย |
|---|---|---|---|---|
email
|
path | string | จำเป็น |
ที่อยู่อีเมลเต็มของกล่องจดหมายที่เป็นของคุณที่ต้องการลบ URL-encode ที่อยู่; เข้ารหัสเครื่องหมายบวกเป็น %2B.
|
X-Mailbox-Unlock
|
header | string | ไม่บังคับ |
ส่วนหัว, เฉพาะกล่องจดหมายที่ได้รับการป้องกัน: ใช้ unlock_token สำหรับการลบแบบใช้ครั้งเดียว ก่อนอื่น POST pin, scope=delete และ action/target_id ที่ได้รับจากการตอบสนอง 423 ไปยัง PIN unlock URL. โทเค็นการอ่านไม่สามารถลบได้. <code>https://v1.tempmailg.com/api/mailboxes/{mailbox}/pin/unlock</code>
|
Idempotency-Key
|
header | string | ไม่บังคับ |
จำเป็นสำหรับการสร้างหรือการลบที่มีการป้องกันด้วย PIN: คีย์ที่คงที่ความยาว 16 ถึง 128 ตัวอักษร. ลองทำคำขอเดียวกันซ้ำด้วยคีย์เดียวกันเพื่อหลีกเลี่ยงการทำงานซ้ำ.
|
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'
การตอบสนองเชิงอธิบายโดยใช้ข้อมูลสังเคราะห์ ID, ที่อยู่, โทเค็น, เวลา, ขีดจำกัดและจำนวนของแผนจะแตกต่างกัน ตัวอย่างอายุการใช้งานไม่ทับค่าปริยายของแผนของคุณ คำอธิบายฟิลด์การตอบสนองระบุฟิลด์ที่เป็นค่า null และฟิลด์เฉพาะผู้ให้บริการ
ตัวอย่างการตอบสนอง
200 OK • JSON{
"status": true,
"message": "Email has been successfully deleted."
}
| ฟิลด์ | ประเภท | คำอธิบาย |
|---|---|---|
status |
boolean | ว่าการดำเนินการสำเร็จหรือไม่. |
message |
string | ผลลัพธ์ของการลบ. แหล่งข้อมูลที่หายไปจะคืนค่า HTTP 404. |
Gmail & Outlook นามแฝง
สร้างกล่องเมลนามแฝง Gmail และ Outlook/Hotmail ที่มีความน่าเชื่อถือสูง.
สร้างนามแฝง Gmail
สร้างกล่องจดหมายชั่วคราวแบบอีเมลแฝง Gmail ใหม่ที่เป็นของผู้ใช้ที่ได้รับการยืนยันตัวตน
| พารามิเตอร์ | ตำแหน่ง | ประเภท | สถานะ | คำอธิบาย |
|---|---|---|---|---|
mode
|
body | string | ไม่บังคับ |
โหมดการสร้าง: auto, dot, plus หรือ plus_dot. รองรับ gmail_alias_mode ด้วย. หากไม่อนุญาตให้เลือกสไตล์ จะใช้ auto.
ค่าเริ่มต้น:
auto
|
username
|
body | string | ไม่บังคับ |
ส่วนต่อท้ายนามแฝงที่กำหนดเอง (ไม่บังคับ): 2 ถึง 32 ตัวอักษร ASCII หรือเลข, แปลงเป็นตัวพิมพ์เล็ก; ขึ้นอยู่กับสิทธิ์ฟีเจอร์. รองรับ custom_username หรือ alias_username.
ค่าเริ่มต้น:
สร้างโดยอัตโนมัติ
|
domain
|
body | string | ไม่บังคับ |
ใช้แบบสุ่ม, gmail.com หรือ googlemail.com; alias_domain ก็รับได้เช่นกัน. การละเว้นหรือการไม่มีสิทธิ์เลือกโดเมนจะใช้แบบสุ่ม.
ค่าเริ่มต้น:
random
|
lifetime
|
body | string | ไม่บังคับ |
ค่าที่อนุญาต:
10m — 10 นาที
1h — 1 ชั่วโมง
2h — 2 ชั่วโมง
1d — 1 วัน
1w — 1 สัปดาห์
1m — 30 วัน
3m — 90 วัน
6m — 180 วัน
1y — 365 วัน
unlimited — ไม่จำกัด
ค่าเริ่มต้น:
อายุการใช้งานเริ่มต้นของแผน
|
pin_enabled
|
body | boolean | ไม่บังคับ |
การป้องกัน PIN แบบเลือกได้สำหรับกล่องจดหมายใหม่ เมื่อแผนของคุณอนุญาต ไม่ได้เปลี่ยน PIN ของกล่องจดหมายที่มีอยู่
ค่าเริ่มต้น:
false
|
pin
|
body | string | ไม่บังคับ |
จำเป็นเมื่อ pin_enabled เป็น true: PIN ที่มี 6 ถึง 8 หลัก, ส่งเป็นสตริงเพื่อรักษาเลขศูนย์นำหน้า.
|
pin_confirmation
|
body | string | ไม่บังคับ |
จำเป็นเมื่อ pin_enabled เป็นจริง ต้องตรงกับ pin อย่างแม่นยำ.
|
Idempotency-Key
|
header | string | ไม่บังคับ |
จำเป็นสำหรับการสร้างหรือการลบที่มีการป้องกันด้วย PIN: คีย์ที่คงที่ความยาว 16 ถึง 128 ตัวอักษร. ลองทำคำขอเดียวกันซ้ำด้วยคีย์เดียวกันเพื่อหลีกเลี่ยงการทำงานซ้ำ.
|
mode (auto, dot, plus, plus_dot), username (ชื่อผู้ใช้ alias ที่กำหนดเอง), domain (เช่น gmail.com, googlemail.com), lifetime (ค่าที่อนุญาต: 10m, 1h, 2h, 1d, 1w, 1m, 3m, 6m, 1y, unlimited). ละเว้นช่วงอายุการใช้งาน หรือเว้นว่างไว้ เพื่อใช้ Default Email Lifetime ที่กำหนดไว้สำหรับแผนรายเดือน/รายปีปัจจุบันของคุณ. ส่งช่วงอายุที่อนุญาต เช่น 1h เพื่อแทนที่ค่าเริ่มต้นนั้น. Unlimited จะใช้เฉพาะเมื่อกำหนดเป็นค่าเริ่มต้นของแผนหรือเมื่อมีการร้องขออย่างชัดเจนและได้รับอนุญาต. พารามิเตอร์ในส่วน body mailbox_lifetime และ email_lifetime ก็ได้รับการยอมรับเช่นกัน; ค่าที่ไม่ว่างแรกที่พบจะถูกใช้ตามลำดับนี้: lifetime, mailbox_lifetime, email_lifetime. ค่าที่ไม่ถูกต้องหรือไม่ได้รับอนุญาตจะคืนค่า HTTP 422 แทนการเลือกค่าเริ่มต้นโดยเงียบ.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'
การตอบสนองเชิงอธิบายโดยใช้ข้อมูลสังเคราะห์ ID, ที่อยู่, โทเค็น, เวลา, ขีดจำกัดและจำนวนของแผนจะแตกต่างกัน ตัวอย่างอายุการใช้งานไม่ทับค่าปริยายของแผนของคุณ คำอธิบายฟิลด์การตอบสนองระบุฟิลด์ที่เป็นค่า null และฟิลด์เฉพาะผู้ให้บริการ
ตัวอย่างการตอบสนอง
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:17:47+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:17:47+00:00",
"email_token": "encrypted-email-token"
}
}
| ฟิลด์ | ประเภท | คำอธิบาย |
|---|---|---|
status |
boolean | ว่าการดำเนินการสำเร็จหรือไม่. |
data.id |
integer | ID ของกล่องจดหมาย. ID, ที่อยู่และโทเค็นที่สร้างขึ้นจะแตกต่างกันสำหรับแต่ละกล่องจดหมาย |
data.pin_protected |
boolean | ว่ากล่องจดหมายนี้มีการป้องกันด้วย PIN หรือไม่. ไม่ได้คืนค่า PIN หรือแฮชของ PIN. |
data.email |
string | ที่อยู่กล่องจดหมายเต็มที่สร้างแล้ว. |
data.domain |
string | โดเมนของกล่องจดหมายที่สร้างขึ้น. |
data.provider |
string | ผู้ให้บริการกล่องจดหมาย: standard, gmail_alias, หรือ outlook_alias. |
data.expire_at |
string|null | วันหมดอายุที่มีผลเป็น timestamp รูปแบบ ISO-8601 หรือ null สำหรับกล่องจดหมายที่ไม่มีขีดจำกัด |
data.expires_in_seconds |
number|null | วินาทีที่เหลือที่คำนวณได้ต้องเป็นจำนวนเต็มบวกหรือศูนย์; สามารถมีวินาทีเศษส่วนได้ ค่า Null หมายถึงไม่จำกัด ไม่ใช่ศูนย์. |
data.mailbox_state |
string | สถานะกล่องจดหมายปัจจุบัน: ทำงาน, หยุดชั่วคราว, หมดอายุ หรือ ไม่ทำงาน |
data.receiving_enabled |
boolean | ว่ากล่องจดหมายนี้ในขณะนี้รับข้อความขาเข้าหรือไม่. |
data.message_count |
integer | จำนวนข้อความทั้งหมดที่ทราบ; สามารถสะท้อนการซิงโครไนซ์กล่องจดหมายครั้งล่าสุด. |
data.unread_message_count |
integer | จำนวนข้อความที่ยังไม่ได้อ่านที่ทราบ; สามารถสะท้อนการซิงค์กล่องจดหมายครั้งล่าสุดได้. |
data.last_message_received_at |
string|null | เวลาที่รับข้อความล่าสุดที่ทราบในรูปแบบ ISO-8601 หรือ null เมื่อไม่มีข้อมูล |
data.message_count_synced_at |
string|null | เวลาการซิงโครไนซ์จำนวนข้อความล่าสุดในรูปแบบ ISO-8601 หรือ null ก่อนการซิงโครไนซ์ |
data.created_at |
string|null | เวลาการสร้างกล่องจดหมายในรูปแบบ ISO-8601. |
data.email_token |
string | อ้างอิงกล่องจดหมายที่เข้ารหัสแบบไม่เปิดเผย. มันไม่แทนที่การตรวจสอบการรับรอง Bearer, การตรวจสอบความเป็นเจ้าของ หรือการอนุญาต PIN. |
data.pin_grant |
object | เงื่อนไข: การสร้างกล่องจดหมายที่มีการป้องกันด้วย PIN ที่ใช้งานอยู่จะคืนสิทธิ์การอ่านนี้; การสร้างแบบปกติที่ไม่มีการป้องกันจะละเว้นมัน. |
data.pin_grant.mailbox_id |
integer | รหัสกล่องจดหมายที่การให้สิทธิ์การอ่านแบบมีเงื่อนไขถูกผูกไว้. |
data.pin_grant.unlock_token |
string | โทเค็นการอ่านแบบไม่เปิดเผยสำหรับ X-Mailbox-Unlock ด้วยข้อมูลประจำตัวของเจ้าของเดียวกัน เก็บเป็นส่วนตัวและอยู่ในหน่วยความจำ; การให้สิทธิ์การอ่านไม่ได้อนุญาตให้ลบ |
data.pin_grant.scope |
string | ขอบเขตที่อ่านสำหรับการให้สิทธิ์การสร้างแบบมีเงื่อนไข. |
data.pin_grant.idle_timeout_seconds |
integer | เวลาว่างที่อนุญาตสำหรับการให้สิทธิ์การอ่าน, ปกติ 3600 วินาที. |
data.pin_grant.absolute_timeout_seconds |
integer | อายุการใช้งานสูงสุดของสิทธิ์การอ่าน โดยปกติคือ 86400 วินาที. |
data.pin_grant.expires_at |
string | วันหมดอายุของการให้สิทธิ์การอ่านในปัจจุบันในรูปแบบ ISO-8601. |
data.pin_grant.absolute_expires_at |
string | วันหมดอายุของการให้สิทธิ์การอ่านแบบแน่นอนในรูปแบบ ISO-8601. การเปลี่ยนแปลงด้านความปลอดภัยอาจเพิกถอนสิทธิ์ได้ก่อนหน้า. |
โดเมนนามแฝง Outlook
ดึงโดเมนนามแฝง Outlook / Hotmail ที่ใช้งานอยู่สำหรับการสร้างกล่องจดหมาย.
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'
การตอบสนองเชิงอธิบายโดยใช้ข้อมูลสังเคราะห์ ID, ที่อยู่, โทเค็น, เวลา, ขีดจำกัดและจำนวนของแผนจะแตกต่างกัน ตัวอย่างอายุการใช้งานไม่ทับค่าปริยายของแผนของคุณ คำอธิบายฟิลด์การตอบสนองระบุฟิลด์ที่เป็นค่า null และฟิลด์เฉพาะผู้ให้บริการ
ตัวอย่างการตอบสนอง
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
}
]
}
}
| ฟิลด์ | ประเภท | คำอธิบาย |
|---|---|---|
status |
boolean | ว่าการดำเนินการสำเร็จหรือไม่. |
data.domains |
array | โดเมน Outlook/Hotmail ที่ใช้งานอยู่; อาร์เรย์ว่างเป็นค่าที่ถูกต้อง. |
data.domains[].domain |
string | ชื่อโดเมนที่พร้อมใช้งาน. |
data.domains[].type |
string | ป้ายกำกับผู้ให้บริการที่อ่านได้. |
data.domains[].selectable |
boolean | ว่าบัญชีของคุณสามารถเลือกโดเมนนี้โดยชัดเจนได้หรือไม่ |
data.domains[].locked |
boolean | ว่าการเลือกโดเมนอย่างชัดเจนถูกล็อกสำหรับบัญชีของคุณหรือไม่. |
data.domains[].disabled_reason |
string|null | เหตุผลที่การเลือกโดเมนถูกล็อก, หรือ null เมื่อสามารถเลือกได้. |
สร้างนามแฝง Outlook
สร้างกล่องจดหมายชั่วคราวของนามแฝง Outlook / Hotmail ใหม่ที่เป็นของผู้ใช้ที่ได้รับการรับรองตัวตน
| พารามิเตอร์ | ตำแหน่ง | ประเภท | สถานะ | คำอธิบาย |
|---|---|---|---|---|
domain
|
body | string | ไม่บังคับ |
ใช้แบบสุ่มหรือโดเมนจาก GET /outlook-alias/domains; outlook_alias_domain ก็รับได้เช่นกัน. หากไม่มีสิทธิ์เลือก จะใช้แบบสุ่ม.
ค่าเริ่มต้น:
โดเมนที่สุ่มได้และพร้อมใช้งาน
|
username
|
body | string | ไม่บังคับ |
ส่วนต่อท้ายนามแฝงที่กำหนดเอง (ไม่บังคับ): 2 ถึง 32 ตัวอักษร ASCII หรือเลข, แปลงเป็นตัวพิมพ์เล็ก; ขึ้นอยู่กับสิทธิ์ฟีเจอร์. รองรับ custom_username หรือ alias_username.
ค่าเริ่มต้น:
สร้างโดยอัตโนมัติ
|
lifetime
|
body | string | ไม่บังคับ |
ค่าที่อนุญาต:
10m — 10 นาที
1h — 1 ชั่วโมง
2h — 2 ชั่วโมง
1d — 1 วัน
1w — 1 สัปดาห์
1m — 30 วัน
3m — 90 วัน
6m — 180 วัน
1y — 365 วัน
unlimited — ไม่จำกัด
ค่าเริ่มต้น:
อายุการใช้งานเริ่มต้นของแผน
|
pin_enabled
|
body | boolean | ไม่บังคับ |
การป้องกัน PIN แบบเลือกได้สำหรับกล่องจดหมายใหม่ เมื่อแผนของคุณอนุญาต ไม่ได้เปลี่ยน PIN ของกล่องจดหมายที่มีอยู่
ค่าเริ่มต้น:
false
|
pin
|
body | string | ไม่บังคับ |
จำเป็นเมื่อ pin_enabled เป็น true: PIN ที่มี 6 ถึง 8 หลัก, ส่งเป็นสตริงเพื่อรักษาเลขศูนย์นำหน้า.
|
pin_confirmation
|
body | string | ไม่บังคับ |
จำเป็นเมื่อ pin_enabled เป็นจริง ต้องตรงกับ pin อย่างแม่นยำ.
|
Idempotency-Key
|
header | string | ไม่บังคับ |
จำเป็นสำหรับการสร้างหรือการลบที่มีการป้องกันด้วย PIN: คีย์ที่คงที่ความยาว 16 ถึง 128 ตัวอักษร. ลองทำคำขอเดียวกันซ้ำด้วยคีย์เดียวกันเพื่อหลีกเลี่ยงการทำงานซ้ำ.
|
domain (เช่น outlook.com, hotmail.com), username (ชื่อผู้ใช้ alias ที่กำหนดเอง), lifetime (ค่าที่อนุญาต: 10m, 1h, 2h, 1d, 1w, 1m, 3m, 6m, 1y, unlimited). ละเว้นช่วงอายุการใช้งาน หรือเว้นว่างไว้ เพื่อใช้ Default Email Lifetime ที่กำหนดไว้สำหรับแผนรายเดือน/รายปีปัจจุบันของคุณ. ส่งช่วงอายุที่อนุญาต เช่น 1h เพื่อแทนที่ค่าเริ่มต้นนั้น. Unlimited จะใช้เฉพาะเมื่อกำหนดเป็นค่าเริ่มต้นของแผนหรือเมื่อมีการร้องขออย่างชัดเจนและได้รับอนุญาต. พารามิเตอร์ในส่วน body mailbox_lifetime และ email_lifetime ก็ได้รับการยอมรับเช่นกัน; ค่าที่ไม่ว่างแรกที่พบจะถูกใช้ตามลำดับนี้: lifetime, mailbox_lifetime, email_lifetime. ค่าที่ไม่ถูกต้องหรือไม่ได้รับอนุญาตจะคืนค่า HTTP 422 แทนการเลือกค่าเริ่มต้นโดยเงียบ.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'
การตอบสนองเชิงอธิบายโดยใช้ข้อมูลสังเคราะห์ ID, ที่อยู่, โทเค็น, เวลา, ขีดจำกัดและจำนวนของแผนจะแตกต่างกัน ตัวอย่างอายุการใช้งานไม่ทับค่าปริยายของแผนของคุณ คำอธิบายฟิลด์การตอบสนองระบุฟิลด์ที่เป็นค่า null และฟิลด์เฉพาะผู้ให้บริการ
ตัวอย่างการตอบสนอง
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:17:47+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:17:47+00:00",
"email_token": "encrypted-email-token"
}
}
| ฟิลด์ | ประเภท | คำอธิบาย |
|---|---|---|
status |
boolean | ว่าการดำเนินการสำเร็จหรือไม่. |
data.id |
integer | ID ของกล่องจดหมาย. ID, ที่อยู่และโทเค็นที่สร้างขึ้นจะแตกต่างกันสำหรับแต่ละกล่องจดหมาย |
data.pin_protected |
boolean | ว่ากล่องจดหมายนี้มีการป้องกันด้วย PIN หรือไม่. ไม่ได้คืนค่า PIN หรือแฮชของ PIN. |
data.email |
string | ที่อยู่กล่องจดหมายเต็มที่สร้างแล้ว. |
data.domain |
string | โดเมนของกล่องจดหมายที่สร้างขึ้น. |
data.provider |
string | ผู้ให้บริการกล่องจดหมาย: standard, gmail_alias, หรือ outlook_alias. |
data.expire_at |
string|null | วันหมดอายุที่มีผลเป็น timestamp รูปแบบ ISO-8601 หรือ null สำหรับกล่องจดหมายที่ไม่มีขีดจำกัด |
data.expires_in_seconds |
number|null | วินาทีที่เหลือที่คำนวณได้ต้องเป็นจำนวนเต็มบวกหรือศูนย์; สามารถมีวินาทีเศษส่วนได้ ค่า Null หมายถึงไม่จำกัด ไม่ใช่ศูนย์. |
data.mailbox_state |
string | สถานะกล่องจดหมายปัจจุบัน: ทำงาน, หยุดชั่วคราว, หมดอายุ หรือ ไม่ทำงาน |
data.receiving_enabled |
boolean | ว่ากล่องจดหมายนี้ในขณะนี้รับข้อความขาเข้าหรือไม่. |
data.message_count |
integer | จำนวนข้อความทั้งหมดที่ทราบ; สามารถสะท้อนการซิงโครไนซ์กล่องจดหมายครั้งล่าสุด. |
data.unread_message_count |
integer | จำนวนข้อความที่ยังไม่ได้อ่านที่ทราบ; สามารถสะท้อนการซิงค์กล่องจดหมายครั้งล่าสุดได้. |
data.last_message_received_at |
string|null | เวลาที่รับข้อความล่าสุดที่ทราบในรูปแบบ ISO-8601 หรือ null เมื่อไม่มีข้อมูล |
data.message_count_synced_at |
string|null | เวลาการซิงโครไนซ์จำนวนข้อความล่าสุดในรูปแบบ ISO-8601 หรือ null ก่อนการซิงโครไนซ์ |
data.created_at |
string|null | เวลาการสร้างกล่องจดหมายในรูปแบบ ISO-8601. |
data.email_token |
string | อ้างอิงกล่องจดหมายที่เข้ารหัสแบบไม่เปิดเผย. มันไม่แทนที่การตรวจสอบการรับรอง Bearer, การตรวจสอบความเป็นเจ้าของ หรือการอนุญาต PIN. |
data.pin_grant |
object | เงื่อนไข: การสร้างกล่องจดหมายที่มีการป้องกันด้วย PIN ที่ใช้งานอยู่จะคืนสิทธิ์การอ่านนี้; การสร้างแบบปกติที่ไม่มีการป้องกันจะละเว้นมัน. |
data.pin_grant.mailbox_id |
integer | รหัสกล่องจดหมายที่การให้สิทธิ์การอ่านแบบมีเงื่อนไขถูกผูกไว้. |
data.pin_grant.unlock_token |
string | โทเค็นการอ่านแบบไม่เปิดเผยสำหรับ X-Mailbox-Unlock ด้วยข้อมูลประจำตัวของเจ้าของเดียวกัน เก็บเป็นส่วนตัวและอยู่ในหน่วยความจำ; การให้สิทธิ์การอ่านไม่ได้อนุญาตให้ลบ |
data.pin_grant.scope |
string | ขอบเขตที่อ่านสำหรับการให้สิทธิ์การสร้างแบบมีเงื่อนไข. |
data.pin_grant.idle_timeout_seconds |
integer | เวลาว่างที่อนุญาตสำหรับการให้สิทธิ์การอ่าน, ปกติ 3600 วินาที. |
data.pin_grant.absolute_timeout_seconds |
integer | อายุการใช้งานสูงสุดของสิทธิ์การอ่าน โดยปกติคือ 86400 วินาที. |
data.pin_grant.expires_at |
string | วันหมดอายุของการให้สิทธิ์การอ่านในปัจจุบันในรูปแบบ ISO-8601. |
data.pin_grant.absolute_expires_at |
string | วันหมดอายุของการให้สิทธิ์การอ่านแบบแน่นอนในรูปแบบ ISO-8601. การเปลี่ยนแปลงด้านความปลอดภัยอาจเพิกถอนสิทธิ์ได้ก่อนหน้า. |
ข้อความและไฟล์แนบ
ดึงกล่องขาเข้าที่เข้ามา, อ่านข้อความ HTML/ข้อความเต็ม, และสตรีมไฟล์แนบ.
แสดงรายการข้อความในกล่องจดหมาย
ดึงสรุปข้อความที่พร้อมใช้งานและเมตาดาต้าเมลบ็อกซ์. การสแกนกล่องขาเข้าแบบมาตรฐานจะคืนชุดข้อความล่าสุดจำนวนสูงสุด 25 ข้อความ; นี่ไม่ใช่ endpoint ที่ทำการแบ่งหน้าเพื่อประวัติเต็ม. ใช้ GET /messages/{messageId} เพื่อรับเนื้อหาฉบับเต็มและไฟล์แนบ.
| พารามิเตอร์ | ตำแหน่ง | ประเภท | สถานะ | คำอธิบาย |
|---|---|---|---|---|
email
|
query | string | จำเป็น |
ที่อยู่อีเมลเต็มของกล่องจดหมายที่เป็นของคุณเพื่ออ่านข้อความจาก. เข้ารหัส URL ค่าคำค้น; เข้ารหัสเครื่องหมายบวกเป็น %2B.
|
X-Mailbox-Unlock
|
header | string | ไม่บังคับ |
ส่วนหัว, สำหรับกล่องจดหมายที่ได้รับการปกป้องเท่านั้น: ใช้ read unlock_token. เริ่มต้นด้วยการ POST pin และ scope=read ไปยัง URL ปลดล็อก PIN. รักษาการตรวจสอบสิทธิ์ Bearer ปกติของคุณ. <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'
การตอบสนองเชิงอธิบายโดยใช้ข้อมูลสังเคราะห์ ID, ที่อยู่, โทเค็น, เวลา, ขีดจำกัดและจำนวนของแผนจะแตกต่างกัน ตัวอย่างอายุการใช้งานไม่ทับค่าปริยายของแผนของคุณ คำอธิบายฟิลด์การตอบสนองระบุฟิลด์ที่เป็นค่า null และฟิลด์เฉพาะผู้ให้บริการ
ตัวอย่างการตอบสนอง
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:17:47",
"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:17:47+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:17:47+00:00",
"message_count_synced_at": "2026-11-19T02:17:47+00:00"
}
| ฟิลด์ | ประเภท | คำอธิบาย |
|---|---|---|
status |
boolean | ว่าการดำเนินการสำเร็จหรือไม่. |
mailbox |
string | ที่อยู่กล่องจดหมายที่มีการร้องขอข้อความ |
email_token |
string | อ้างอิงกล่องจดหมายที่เข้ารหัสแบบไม่โปร่งใส; ยังคงต้องการการตรวจสอบสิทธิ์ปกติ. |
mailbox_provider |
string | ผู้ให้บริการกล่องจดหมาย: standard, gmail_alias, หรือ outlook_alias. |
messages |
array | สรุปข้อความ. กล่องขาเข้าว่างจะคืนอาเรย์ว่าง; ดึงข้อความเดียวเพื่อรับเนื้อหาและไฟล์แนบของมัน. |
expire_at |
string|null | วันหมดอายุที่มีผลเป็น timestamp รูปแบบ ISO-8601 หรือ null สำหรับกล่องจดหมายที่ไม่มีขีดจำกัด |
expires_in_seconds |
number|null | วินาทีที่เหลือที่คำนวณได้ต้องเป็นจำนวนเต็มบวกหรือศูนย์; สามารถมีวินาทีเศษส่วนได้ ค่า Null หมายถึงไม่จำกัด ไม่ใช่ศูนย์. |
mailbox_state |
string | สถานะกล่องจดหมายปัจจุบัน: ทำงาน, หยุดชั่วคราว, หมดอายุ หรือ ไม่ทำงาน |
receiving_enabled |
boolean | ว่ากล่องจดหมายนี้ในขณะนี้รับข้อความขาเข้าหรือไม่. |
message_count |
integer | จำนวนข้อความทั้งหมดที่ทราบ; สามารถสะท้อนการซิงโครไนซ์กล่องจดหมายครั้งล่าสุด. |
unread_message_count |
integer | จำนวนข้อความที่ยังไม่ได้อ่านที่ทราบ; สามารถสะท้อนการซิงค์กล่องจดหมายครั้งล่าสุดได้. |
last_message_received_at |
string|null | เวลาที่รับข้อความล่าสุดที่ทราบในรูปแบบ ISO-8601 หรือ null เมื่อไม่มีข้อมูล |
message_count_synced_at |
string|null | เวลาการซิงโครไนซ์จำนวนข้อความล่าสุดในรูปแบบ ISO-8601 หรือ null ก่อนการซิงโครไนซ์ |
mailbox_limit.limit |
integer | ขีดจำกัดกล่องจดหมายที่ใช้งานได้สำหรับผู้ให้บริการนี้; -1 หมายถึงไม่จำกัด. |
mailbox_limit.limit_label |
string | ป้ายแสดงสำหรับขีดจำกัดกล่องจดหมาย |
mailbox_limit.active_count |
integer | จำนวนกล่องจดหมายที่ใช้งานอยู่สำหรับผู้ให้บริการนี้. |
mailbox_limit.paused_count |
integer | จำนวนกล่องจดหมายที่หยุดชั่วคราวสำหรับผู้ให้บริการนี้. |
mailbox_limit.paused_mailboxes |
array<string> | ที่อยู่ถูกหยุดชั่วคราวเนื่องจากขีดจำกัดกล่องจดหมาย. |
mailbox_limit.remaining |
integer | ช่องกล่องจดหมายที่ใช้งานได้ที่เหลือ; -1 หมายถึงไม่จำกัด. นี่ไม่ใช่โควต้าการร้องขอ API. |
mailbox_limit.remaining_label |
string | แสดงป้ายสำหรับช่องเมลบ็อกซ์ที่เหลืออยู่. |
mailbox_limit.reached |
boolean | ว่าขีดจำกัดกล่องจดหมายที่ใช้งานอยู่ได้ถูกถึงหรือยัง. |
mailbox_limit.blocked |
boolean | ว่าขีดจำกัดกล่องจดหมายที่ใช้งานอยู่เป็นศูนย์หรือไม่. |
mailbox_limit.provider |
string|null | ผู้ให้บริการที่ข้อจำกัดกล่องจดหมายใช้กับ |
messages[].id |
string | รหัสข้อความแบบไม่เปิดเผยที่ใช้โดย endpoint ข้อความเดี่ยว, การลบและไฟล์แนบ. |
messages[].is_seen |
boolean | ว่าข้อความถูกทำเครื่องหมายว่าอ่านแล้วหรือไม่. |
messages[].subject |
string | หัวข้อข้อความ. |
messages[].from |
string | ชื่อแสดงของผู้ส่งหรือที่อยู่. |
messages[].from_email |
string | ที่อยู่อีเมลผู้ส่ง. |
messages[].receivedAt |
string | เวลาที่รับในเขตเวลาแอปพลิเคชัน, รูปแบบเป็น YYYY-MM-DD HH:mm:ss. |
messages[].otp |
string|null | ตรวจพบรหัสใช้ครั้งเดียวเมื่อมีและได้รับอนุญาต; มิฉะนั้นเป็นค่า null. |
messages[].otp_locked |
boolean | ว่ารหัสใช้ครั้งเดียวที่ตรวจพบถูกซ่อนโดยสิทธิ์ของฟีเจอร์หรือไม่. |
messages[].verification_link |
string|null | ตรวจพบ URL การตรวจสอบเมื่อมีและได้รับอนุญาต; มิฉะนั้นเป็น null. |
messages[].verification_link_locked |
boolean | ว่าลิงก์การตรวจสอบที่ตรวจพบถูกซ่อนโดยสิทธิ์ฟีเจอร์หรือไม่. |
messages[].from_name |
string|null | ฟิลด์สรุป Outlook: ชื่อผู้ส่งต้นฉบับ. ไม่ปรากฏในสรุปของ Standard และ Gmail. |
messages[].snippet |
string|null | ฟิลด์สรุปของ Outlook: ตัวอย่างข้อความสั้น. |
messages[].received_at |
string|null | ฟิลด์สรุปของ Outlook: เวลาได้รับตามมาตรฐาน ISO-8601, เมื่อทราบ. |
messages[].has_attachments |
boolean | ฟิลด์สรุป Outlook: ว่ามีเมตาดาต้าไฟล์แนบหรือไม่ การตรวจสอบความพร้อมดาวน์โหลดทำแยกต่างหาก. |
ดึงข้อความเดียว
ดึงข้อความที่เป็นของโดยใช้ ID ข้อความที่เป็นแบบไม่โปร่งใส. ส่งคืนรูปแบบเนื้อหาและเมตาดาต้าไฟล์แนบ. ฟิลด์ของเนื้อขึ้นอยู่กับรูปแบบข้อความ; Outlook จะเพิ่มฟิลด์เฉพาะผู้ให้บริการที่ระบุด้านล่าง.
| พารามิเตอร์ | ตำแหน่ง | ประเภท | สถานะ | คำอธิบาย |
|---|---|---|---|---|
messageId
|
path | string | จำเป็น |
รหัสข้อความที่ไม่ซ้ำกันที่ส่งกลับในรายการข้อความ.
|
X-Mailbox-Unlock
|
header | string | ไม่บังคับ |
ส่วนหัว, สำหรับกล่องจดหมายที่ได้รับการปกป้องเท่านั้น: ใช้ read unlock_token. เริ่มต้นด้วยการ POST pin และ scope=read ไปยัง URL ปลดล็อก PIN. รักษาการตรวจสอบสิทธิ์ Bearer ปกติของคุณ. <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'
การตอบสนองเชิงอธิบายโดยใช้ข้อมูลสังเคราะห์ ID, ที่อยู่, โทเค็น, เวลา, ขีดจำกัดและจำนวนของแผนจะแตกต่างกัน ตัวอย่างอายุการใช้งานไม่ทับค่าปริยายของแผนของคุณ คำอธิบายฟิลด์การตอบสนองระบุฟิลด์ที่เป็นค่า null และฟิลด์เฉพาะผู้ให้บริการ
ตัวอย่างการตอบสนอง
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:17:47",
"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"
}
]
}
}
| ฟิลด์ | ประเภท | คำอธิบาย |
|---|---|---|
status |
boolean | ว่าการดำเนินการสำเร็จหรือไม่. |
data.id |
string | รหัสข้อความแบบออพคิวส. |
data.is_seen |
boolean | สถานะการอ่านข้อความ การอ่านอาจทำเครื่องหมายว่าเห็นแล้ว; ข้อมูลที่แคชอาจสะท้อนสถานะก่อนหน้า |
data.subject |
string | หัวข้อข้อความ. |
data.from |
string | ชื่อแสดงของผู้ส่งหรือที่อยู่. |
data.from_email |
string | ที่อยู่อีเมลผู้ส่ง. |
data.to |
string | ที่อยู่กล่องจดหมายของผู้รับ. |
data.mailbox_provider |
string | ผู้ให้บริการกล่องจดหมาย: standard, gmail_alias, หรือ outlook_alias. |
data.receivedAt |
string | เวลาที่รับในเขตเวลาแอปพลิเคชัน, รูปแบบเป็น YYYY-MM-DD HH:mm:ss. |
data.html |
boolean | ว่าข้อความมีเนื้อหา HTML หรือไม่. |
data.html_content |
string | ส่วนเนื้อหา HTML เมื่อมีอยู่. ข้อความมาตรฐานที่ไม่มี HTML สามารถละเว้นฟิลด์นี้ได้. ปฏิบัติต่อเนื้อหาข้อความว่าไม่เชื่อถือ. |
data.text_content |
string | ข้อความเนื้อหาเมื่อมีอยู่; ข้อความมาตรฐานอาจมีข้อความที่ถูก escape อยู่ในองค์ประกอบ pre หรืออาจละเว้นฟิลด์นี้ |
data.content |
string | เนื้อหาที่ต้องการแสดง, ปกติเป็น HTML เมื่อมีให้ใช้ |
data.attachments |
array | เมตาดาต้าไฟล์แนบ หรืออาเรย์ว่าง การดาวน์โหลดต้องการการตรวจสอบสิทธิ์ปกติและการอนุญาต PIN ที่เกี่ยวข้อง |
data.attachments[].name |
string | ชื่อไฟล์ที่จะทำการเข้ารหัส URL เป็นส่วนเส้นทางเดียวเมื่อดาวน์โหลด. |
data.attachments[].size |
integer | ขนาดไฟล์แนบเป็นไบต์. |
data.attachments[].url |
string | URL ดาวน์โหลด API ของผู้ใช้ที่ผ่านการรับรองถูกเพิ่มไปยังไฟล์แนบพร้อมชื่อไฟล์. URL ไม่รับประกันว่าไฟล์ในเครื่องจะพร้อมใช้งาน. |
data.attachments[].extension |
string | ฟิลด์เมตาดาต้ามาตรฐาน/ของ Gmail: ส่วนขยายไฟล์เมื่อมีการระบุ |
data.attachments[].id |
string | ฟิลด์เมตาดาต้า Outlook: ID ไฟล์แนบของผู้ให้บริการ. |
data.attachments[].content_type |
string | ฟิลด์เมตาดาต้า Outlook: ประเภทเนื้อหา MIME. |
data.from_name |
string|null | ฟิลด์รายละเอียด Outlook: ชื่อผู้ส่งต้นฉบับ. |
data.to_email |
string|null | ฟิลด์รายละเอียด Outlook: ที่อยู่ผู้รับเดิม |
data.received_at |
string|null | ฟิลด์รายละเอียด Outlook: เวลาได้รับตามรูปแบบ ISO-8601. |
data.has_html |
boolean | ฟิลด์รายละเอียด Outlook: ว่ามีเนื้อหา HTML หรือไม่. |
ลบข้อความ
ลบข้อความที่เป็นเจ้าของข้อความเดียว
| พารามิเตอร์ | ตำแหน่ง | ประเภท | สถานะ | คำอธิบาย |
|---|---|---|---|---|
messageId
|
path | string | จำเป็น |
สตริง ID ข้อความที่ไม่ซ้ำเพื่อการลบอย่างถาวร.
|
X-Mailbox-Unlock
|
header | string | ไม่บังคับ |
ส่วนหัว, เฉพาะกล่องจดหมายที่ได้รับการป้องกัน: ใช้ unlock_token สำหรับการลบแบบใช้ครั้งเดียว ก่อนอื่น POST pin, scope=delete และ action/target_id ที่ได้รับจากการตอบสนอง 423 ไปยัง PIN unlock URL. โทเค็นการอ่านไม่สามารถลบได้. <code>https://v1.tempmailg.com/api/mailboxes/{mailbox}/pin/unlock</code>
|
Idempotency-Key
|
header | string | ไม่บังคับ |
จำเป็นสำหรับการสร้างหรือการลบที่มีการป้องกันด้วย PIN: คีย์ที่คงที่ความยาว 16 ถึง 128 ตัวอักษร. ลองทำคำขอเดียวกันซ้ำด้วยคีย์เดียวกันเพื่อหลีกเลี่ยงการทำงานซ้ำ.
|
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'
การตอบสนองเชิงอธิบายโดยใช้ข้อมูลสังเคราะห์ ID, ที่อยู่, โทเค็น, เวลา, ขีดจำกัดและจำนวนของแผนจะแตกต่างกัน ตัวอย่างอายุการใช้งานไม่ทับค่าปริยายของแผนของคุณ คำอธิบายฟิลด์การตอบสนองระบุฟิลด์ที่เป็นค่า null และฟิลด์เฉพาะผู้ให้บริการ
ตัวอย่างการตอบสนอง
200 OK • JSON{
"status": true,
"message": "Message was deleted successfully."
}
| ฟิลด์ | ประเภท | คำอธิบาย |
|---|---|---|
status |
boolean | ว่าการดำเนินการสำเร็จหรือไม่. |
message |
string | ผลลัพธ์ของการลบ. แหล่งข้อมูลที่หายไปจะคืนค่า HTTP 404. |
ดาวน์โหลดไฟล์แนบ
ดาวน์โหลดไฟล์แนบจากข้อความที่เป็นเจ้าของ
| พารามิเตอร์ | ตำแหน่ง | ประเภท | สถานะ | คำอธิบาย |
|---|---|---|---|---|
messageId
|
path | string | จำเป็น |
รหัสของข้อความที่มีไฟล์.
|
filename
|
path | string | จำเป็น |
ชื่อไฟล์และนามสกุลของไฟล์แนบที่ต้องการดาวน์โหลด.
|
X-Mailbox-Unlock
|
header | string | ไม่บังคับ |
ส่วนหัว, สำหรับกล่องจดหมายที่ได้รับการปกป้องเท่านั้น: ใช้ read unlock_token. เริ่มต้นด้วยการ POST pin และ scope=read ไปยัง URL ปลดล็อก PIN. รักษาการตรวจสอบสิทธิ์ Bearer ปกติของคุณ. <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
| ฟิลด์ | ประเภท | คำอธิบาย |
|---|---|---|
Content-Disposition |
header | การตอบสนองที่สำเร็จจะดาวน์โหลดชื่อไฟล์ที่ร้องขอ |
body |
binary | ไฟล์ไบต์เมื่อสำเร็จ ไม่ใช่ JSON. ข้อผิดพลาดจะคืนค่า JSON พร้อมสถานะที่ไม่ใช่ 2xx. |
ขีดจำกัดอัตราและโควต้า
ตรวจสอบงบประมาณการร้องขอแบบเรียลไทม์, ขีดจำกัดอัตรา, และโควต้าบัญชีโดยไม่ใช้เครดิต.
ขีดจำกัดอัตราและโควต้า
ตรวจสอบขีดจำกัดอัตราและสถานะโควต้าปัจจุบันของคุณโดยไม่ใช้การใช้งาน API ใด ๆ endpoint นี้ไม่มีโควต้าและไม่หักเครดิต API รายเดือน (ขีดจำกัดการป้องกันการละเมิด: 60 คำขอ/นาที).
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'
การตอบสนองเชิงอธิบายโดยใช้ข้อมูลสังเคราะห์ ID, ที่อยู่, โทเค็น, เวลา, ขีดจำกัดและจำนวนของแผนจะแตกต่างกัน ตัวอย่างอายุการใช้งานไม่ทับค่าปริยายของแผนของคุณ คำอธิบายฟิลด์การตอบสนองระบุฟิลด์ที่เป็นค่า null และฟิลด์เฉพาะผู้ให้บริการ
ตัวอย่างการตอบสนอง
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"
}
}
}
| ฟิลด์ | ประเภท | คำอธิบาย |
|---|---|---|
data.limit |
integer|string | ขีดจำกัดการร้องขอต่อบัญชีต่อหนึ่งนาที. สตริง unlimited หมายถึงงบประมาณต่อหนึ่งนาทีที่ไม่จำกัด; สิ่งนี้แยกจากโควต้ารายเดือน. |
data.remaining |
integer|string | ช่องว่างนาทีในงบประมาณของบัญชีที่เหลืออยู่ หรือสตริง unlimited. ค่าบวกไม่ได้หมายความว่าคะแนน API ยังเหลืออยู่ |
data.reset |
integer | วินาทีสำหรับหน้าต่างนาทีของบัญชี ไม่ใช่การรีเซ็ตโควต้ารายเดือน การปิดใช้งานหรือการไม่มีขีดจำกัดของงบประมาณนาทีสามารถรักษาค่า 60 วินาทีโดยประมาณ; สิ่งนี้ไม่ได้สัญญาการเข้าถึงหลังจากรอ |
data.plan |
string | แท็กแผนปัจจุบัน ชื่อแผนที่อ่านได้จะถูกจัดให้แยกต่างหากใน data.quota.plan_name. |
data.quota.enabled |
boolean | ว่าการเข้าถึง API ระดับโลกและแผน/เครดิตเปิดใช้งานหรือไม่ ซึ่งไม่ได้บ่งบอกถึงความจุที่เหลือหรือแทนสวิตช์ API ของผู้ใช้. |
data.quota.user_api_status |
boolean | ว่าผู้ใช้ได้เปิดสวิตช์ User API ของตนหรือไม่ การดำเนินการต้องการสวิตช์นี้รวมถึงการเข้าถึงที่เปิดใช้งานและความจุที่พร้อมใช้งาน |
data.quota.plan_name |
string | ชื่อที่อ่านได้ของแผนปัจจุบัน. |
data.quota.period |
string | ช่วงการใช้งานแบบเดือนปฏิทินในรูปแบบ YYYY-MM โดยใช้เขตเวลาแอปพลิเคชัน; ไม่จำเป็นต้องเป็นช่วงการเรียกเก็บเงินของการสมัครสมาชิก. |
data.quota.base_limit |
integer | การจัดสรรแผนรายเดือนพื้นฐาน. ค่า -1 หมายถึงไม่จำกัด. |
data.quota.extra_requests |
integer | ได้รับโควต้ารายเดือนเพิ่มเติมสำหรับช่วงการใช้งานปัจจุบัน; แยกจากเครดิตที่ซื้อไว้. |
data.quota.monthly_limit |
integer | โควต้าพื้นฐานบวกกับคำขอเพิ่มเติมในช่วงเวลาปัจจุบัน. ค่า -1 หมายถึงไม่จำกัด. เครดิตที่ซื้อไม่ได้รวมอยู่. |
data.quota.monthly_remaining |
integer|null | จำนวนเงินอุดมคติรายเดือนที่เหลืออยู่, หรือ null เมื่อโควต้ารายเดือนไม่มีขีดจำกัด. Null ต้องไม่ถูกตีความเป็นศูนย์ |
data.quota.used |
integer | การดำเนินการ API ที่สำเร็จและนับรวมในช่วงระยะการใช้งานปัจจุบัน รวมถึงการดำเนินการที่ใช้เครดิต การตรวจสอบสถานะจะไม่เพิ่มค่าดังกล่าว |
data.quota.purchased_credits |
integer | ยอดเครดิตปัจจุบัน, รวมถึงเครดิตโบนัสจากแผนที่ใช้งานอยู่. เครดิตโบนัสต้องไม่ถูกเพิ่มเข้าไปในยอดนี้อีกครั้ง. |
data.quota.bonus_credits |
integer | ส่วนโบนัสแผนที่ใช้งานของยอดเครดิต; การแยกรายการ purchased_credits ไม่ใช่ความจุเพิ่มเติม. |
data.quota.direct_purchased_credits |
integer | ยอดเครดิตที่เหลือโดยไม่รวมส่วนโบนัสของแผนที่ใช้งานอยู่ ค่าดังกล่าวบวกกับ bonus_credits จะเท่ากับ purchased_credits |
data.quota.remaining |
integer|null | จำนวนเงินที่เหลือต่อเดือนบวกกับยอดเครดิตปัจจุบัน, โดยไม่นับโบนัสซ้ำ. Null หมายถึงโควต้ารายเดือนไม่จำกัด. สิทธิ์ฟีเจอร์แต่ละรายการและขีดจำกัดการร้องขออื่น ๆ ยังคงใช้. |
data.quota.unlimited |
boolean | ว่าขีดจำกัดรายเดือนเป็นไม่จำกัดหรือไม่. สิ่งนี้ไม่ได้ทำให้งบประมาณนาทีของบัญชีหรือขีดจำกัดฟีเจอร์อื่น ๆ เป็นไม่จำกัด. |
data.quota.usage_percent |
integer | เปอร์เซ็นต์ที่ปัดเศษจาก 0 ถึง 100 ที่เข้ากันได้กับแดชบอร์ด: ใช้หารด้วย (ใช้บวกกับที่เหลือ) แล้วคูณด้วย 100. รวมความจุเครดิตที่มีอยู่ ดังนั้นการเติมเงินสามารถทำให้เปอร์เซ็นต์ลดลง. เป็น 0 สำหรับโควต้าที่ไม่จำกัดหรือพูลขนาดศูนย์; ไม่ใช่เปอร์เซ็นต์อัตราจำกัดต่อวินาทีหรือการตัดสินการเข้าถึง. |
data.quota.reset_at |
string | เครื่องหมายเวลา ISO-8601 พร้อมการชดเชยเขตเวลาเพื่อรีเซ็ตโควต้าของเดือนปฏิทินถัดไป นี่ไม่ใช่วันที่หมดอายุการสมัครสมาชิก และการรีเซ็ตรายเดือนจะไม่เติมเครดิตที่ซื้อไว้ใหม่. |
status |
string | ความสำเร็จตามตัวอักษรสำหรับจุดสิ้นสุดสถานะนี้ จุดสิ้นสุดกล่องเมลที่สำเร็จอื่น ๆ ใช้ค่า boolean true |
data.monthly_limit |
integer | นามแฝงความเข้ากันได้ของฟิลด์ data.quota ที่สอดคล้อง; อย่าเพิ่มอีกเมื่อคำนวณยอดคงเหลือ |
data.monthly_remaining |
integer|null | นามแฝงความเข้ากันได้ของฟิลด์ data.quota ที่สอดคล้อง; อย่าเพิ่มอีกเมื่อคำนวณยอดคงเหลือ |
data.purchased_credits |
integer | นามแฝงความเข้ากันได้ของฟิลด์ data.quota ที่สอดคล้อง; อย่าเพิ่มอีกเมื่อคำนวณยอดคงเหลือ |
เว็บฮูคส์ Mailbox (ดันจริงเวลาจริง)
แทนที่จะตรวจสอบ API REST (GET /messages) อย่างสม่ำเสมอเพื่อตรวจสอบอีเมล์ที่เข้ามาใหม่ คุณสามารถตั้งค่าวェ็บฮุคเพื่อส่งข้อความใหม่ไปยังเซิร์ฟเวอร์หรือกระบวนการอัตโนมัติของคุณในเวลาจริง:
เหตุการณ์เว็บฮุคที่รองรับ
แต่ละเว็บฮุคสามารถติดตามเหตุการณ์ประเภทหนึ่งหรือมากกว่าหนึ่งได้ คุณลิงก์เอ็นดพอยต์ของคุณจะได้รับการแจ้งเตือนเหตุการณ์ทุกครั้งที่เหตุการณ์เหล่านั้นเกิดขึ้น
ถูกส่งแบบเรียลไทม์ทุกครั้งที่ข้อความใหม่มาถึงกล่องจดหมายที่เลือก.
จะถูกส่งเมื่อกล่องจดหมายชั่วคราวหมดอายุและการประมวลผล webhook ถูกหยุดชั่วคราว
ถูกส่งเมื่อกล่องเมลที่หมดอายุกลับมาใช้งานได้อีกภายใต้กฎของแผน.
ถูกส่งก่อนที่ webhook และกล่องจดหมายของมันจะถูกลบ.
คำขอ Header และการตรวจสอบ HMAC Signature
ทุกการส่งเว็บฮุคจะประกอบด้วยเฮดเดอร์ความปลอดภัยพิเศษ ใช้เฮดเดอร์ X-TempMailg-Signature เพื่อยืนยันว่ารีควีสที่เข้ามาได้ถูกส่งโดย TempMailg อย่างจริงจังและไม่ได้ถูกแก้ไขหรือเปลี่ยนแปลง
| ชื่อหัวข้อ | ตัวอย่างค่า | คำอธิบาย |
|---|---|---|
User-Agent |
TempMailg-Webhooks/1.0 | ตัวระบุมาตรฐานสำหรับตัวทำงานการส่งเว็บฮุค. |
X-TempMailg-Event |
email.received | ประเภทของเหตุการณ์ที่ทำให้การจัดส่งนี้เกิดขึ้น |
X-TempMailg-Event-Id |
e7b1a2c3-4d5e-6f7a-8b9c-0d1e2f3a4b5c | UUID ที่ไม่ซ้ำกันที่กำหนดให้กับการพยายามส่งนี้ |
X-TempMailg-Timestamp |
1725192000 | ค่าเวลาตาม Unix epoch ที่บ่งบอกว่าเมื่อใดคำขอถูกเริ่มต้น |
X-TempMailg-Signature |
sha256=d7a8fbb307d7809469ca933b02d82941... | ลายเซ็น HMAC-SHA256 ที่คำนวณจาก {timestamp}.{raw_body} โดยใช้ความลับของคุณ. |
X-TempMailg-Test |
false | เป็นจริงเมื่อถูกส่งโดยฟีเจอร์ "Send Test Ping" ในแดชบอร์ดของคุณ. |
การคำนวณลายเซ็นนี้ใช้ HMAC ด้วย SHA256 กับสตริงดังนี้:
hash_hmac('sha256', "${X-TempMailg-Timestamp}.${raw_request_body}", your_webhook_secret)
ตัวอย่างข้อมูลเหตุการณ์ (email.received)
ส่งในรูปแบบ application/json ในร่าง HTTP POST
{
"id": "e7b1a2c3-4d5e-6f7a-8b9c-0d1e2f3a4b5c",
"version": "1.0",
"event": "email.received",
"occurred_at": "2026-11-19T02:17:48+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:17:48+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"
}
}
ตัวอย่างการใช้งาน Receiver
เลือกภาษาของคุณเพื่อดูวิธีรับเว็บฮุคและตรวจสอบลายเซ็น HMAC อย่างปลอดภัย.
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]);
แพลตฟอร์มที่รองรับและการบูรณาการอัตโนมัติ
Webhook ของ TempMailg ทำงานได้ทันทีกับ endpoint HTTPS มาตรฐานและแพลตฟอร์ม no-code/automation ชั้นนำ:
ข้อผิดพลาดทั่วไปและการแก้ไขปัญหา
นี่คือรหัสคำตอบที่พบบ่อยที่สุดที่คุณอาจเห็นขณะรวม API ผู้ใช้
โทเค็น Bearer ไม่ถูกต้อง, ขาดหาย หรือถูกเพิกถอน.
การเป็นเจ้าของ, สิทธิ์ฟีเจอร์, การเข้าถึงโดเมน หรือขนาดไฟล์แนบทำให้การดำเนินการล้มเหลว ตรวจสอบรหัสตอบกลับและข้อความ
ทรัพยากรไม่พบในโฮสต์ที่อนุญาตหรือไม่ได้เป็นเจ้าของโดยผู้ใช้
คีย์การดำเนินการถูกใช้ซ้ำกับรายละเอียดที่แตกต่าง, มีการดำเนินการอื่นที่กำลังรอดำเนินการ, หรือความปลอดภัยของกล่องจดหมายเปลี่ยนแปลง. ตรวจสอบโค้ดก่อนลองใหม่อีกครั้ง.
กล่องจดหมายหมดอายุหรือไม่ทำงาน
พารามิเตอร์ไม่ถูกต้อง, อายุการใช้งานที่ไม่อนุญาต, ความจุอีเมลลักษณะไม่พร้อมใช้งาน, การตั้งค่า PIN ไม่ถูกต้อง หรือ Idempotency-Key ที่หายไป/ไม่ถูกต้อง ทำให้การดำเนินการล้มเหลว.
กล่องจดหมายที่ได้รับการป้องกันต้องการโทเค็น X-Mailbox-Unlock ที่มีขอบเขตที่ถูกต้อง ใช้ action และ target_id จากการตอบกลับสำหรับการลบ ต้องแก้ไขข้อกำหนดการล็อกหรือการกู้คืนก่อนลองใหม่อีกครั้ง.
ขีดจำกัดการร้องขอ, แผนที่ปิดใช้งาน, โควต้าเต็ม, หรือช่วงพักทำให้การดำเนินการไม่สำเร็จ ตรวจสอบเหตุผลและหัวข้องบประมาณที่มีอยู่ Retry-After เป็นตัวเลือก
เซิร์ฟเวอร์ไม่สามารถทำงานให้เสร็จได้ สำหรับการสร้างหรือการลบที่ได้รับการปกป้อง ให้คงคำขอและ Idempotency-Key เดียวกันเมื่อทำการลองใหม่
ไม่สามารถตรวจสอบการจัดเก็บการป้องกันหรือการประสานงานได้. ลองใหม่หลังจากเวลาหน่วงที่ระบุ. การตอบสนองนี้ไม่ใช่การชำระเงินที่ล้มเหลว.
รายการตรวจสอบอย่างรวดเร็ว
- 401 Unauthorized - โทเค็น Bearer หายไป, ไม่ถูกต้อง, ถูกยกเลิก หรือคัดลอกไม่ถูกต้อง
- 403 Forbidden - แผนปัจจุบันไม่มีสิทธิ์การเข้าถึง API ผู้ใช้ ณ ตอนนี้
- 404 Not Found - ทรัพยากรไม่พบ หรือพารามิเตอร์ไม่ถูกต้อง
- 410 Gone / Expired - กล่องจดหมายหมดอายุหรือไม่ใช้งานแล้ว
- 429 Rate Limited - ตรวจสอบเหตุผลของการตอบกลับและส่วนหัวงบประมาณ. Retry-After ใช้เฉพาะกับขีดจำกัดตามเวลา; เครดิตที่หมดหรือการเข้าถึงที่ปิดใช้งานอาจต้องการการเปลี่ยนแปลงบัญชี
ขั้นตอนต่อไปที่แนะนำ
หากคุณเข้าสู่ระบบแล้ว ให้เปิด API Management ก่อนและยืนยันสถานะคีย์ ควอต้า แผนการเข้าถึง และ URL ฐาน API ของผู้ใช้จริงก่อนที่จะแก้ไขแอปภายนอก