۲۱. فهرست تنظیم سریع
- ۲۲. صفحه مدیریت API داشبورد خود را باز کنید و کلید API شخصی خود را ایجاد کنید.
- ۲۳. URL پایه API کاربر را کپی کنید، به عنوان مثال https://v1.tempmailg.com/api.
- ۲۴. هر درخواست را به آن میزبان API با Authorization: Bearer YOUR_USER_API_KEY ۲۵. و Accept: application/json.
- سهمیه درخواست ماهانه خود را از همان صفحه داشبورد و از سرآیندهای سهمیه هنگام در دسترس بودن در پاسخهای API کاربر پیگیری کنید. فقط درخواستهای موفق 2xx در محاسبه سهمیه لحاظ میشوند.
۶. جریان احراز هویت
- ۷. کلید API شخصی خود را از صفحه مدیریت API در داشبورد تولید کنید.
- ۸. کلید را به عنوان یک توکن Bearer در هر درخواست ارسال کنید.
- ۹. از URL پایه اختصاصی API کاربر که در صفحه مدیریت API شما نشان داده شده است، استفاده کنید.
- ۱۰. کلید را در هر زمان که میخواهید کلید قدیمی را باطل کنید و بلافاصله از یک کلید جدید استفاده کنید، بازسازی کنید.
۱۳. سرصفحههای مورد نیاز
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— زمانسنج یونیکس زمانی که پنجره محدودیت نرخ دقیقه جاری بازنشانی میشود.X-Quota-Limit— کل ظرفیت اعتبار ماهانه و خریداریشده برای حساب شما.X-Quota-Remaining— درخواستهای API باقیمانده در ماه جاری.X-Quota-Used— کل درخواستهای API مصرفشده در دوره صورتحساب فعلی.X-Quota-Reset— زمانسنج ISO-8601 زمانی که سهمیه ماهانه شما بازنشانی میشود.X-RateLimit-Scope— بودجهای که توسط سرآیندها توصیف شده است: account, ip, status_endpoint یا mailbox.X-Mailbox-RateLimit-*— بودجه جداگانه برای ایجاد/بهروزرسانی صندوقپست. پاسخهای موفق صندوقپست، RPM حساب را در X-RateLimit-* حفظ میکند؛ رد فقط صندوقپست از محدوده صندوقپست و پنجرهٔ تلاش مجدد خود استفاده میکند.Retry-After— ثانیهها تا زمانی که یک تلاش مجدد زمانبندی شده مناسب باشد. یک طرح غیرفعال یا سهمیهٔ تمامشده ممکن است به جای آن نیاز به تغییر حساب داشته باشد، بنابراین این سرصفحه همیشه وجود ندارد.503 protection_unavailable— ذخیرهسازی یا هماهنگی حفاظت API موقتاً در دسترس نیست. بعداً دوباره تلاش کنید؛ این یک شکست پرداخت یا بدهی اعتبار نیست.
Mailbox Management
Fetch allowed domains, create, update lifetimes, switch, and delete temporary email addresses.
List Allowed Domains
List available domains for creating temporary emails. Filter by type to see only free, premium, or custom domains supported by your subscription plan.
| پارامتر | موقعیت | ۱۳. نوع | وضعیت | ۲۲. توضیحات |
|---|---|---|---|---|
type
|
query | string | اختیاری |
Domain tier filter. Allowed values: free, basic, pro, premium, custom, ultimate, all
پیشفرض:
free
|
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'
پاسخ نمونه
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
}
]
}
}
Create Temporary Mailbox
Create a new temporary email address. By default, a random email address is generated. You can customize the email username, domain, or domain type by providing the appropriate parameters in the JSON request body.
| پارامتر | موقعیت | ۱۳. نوع | وضعیت | ۲۲. توضیحات |
|---|---|---|---|---|
username
|
body | string | اختیاری |
Custom mailbox username prefix (subject to plan custom username permissions).
پیشفرض:
Randomly generated
|
domain
|
body | string | اختیاری |
One of the allowed domains returned by GET /domains.
پیشفرض:
Default allowed domain
|
lifetime
|
body | string | اختیاری |
Mailbox duration: 10m, 1h, 2h, 1d, 1w, 1m, or unlimited (also accepts mailbox_lifetime or email_lifetime).
پیشفرض:
Plan default lifetime
|
provider
|
body | string | اختیاری |
Mailbox provider: standard, gmail_alias, or outlook_alias.
پیشفرض:
standard
|
username (custom username if allowed by plan), domain (allowed domain, e.g. example.com), lifetime (allowed values: 10m, 1h, 2h, 1d, 1w, 1m, unlimited), provider (standard, gmail_alias, outlook_alias). Omit lifetime, or leave it empty, to use the Default Email Lifetime configured for your current monthly/yearly plan. Send a permitted lifetime such as 1h to override that default. Unlimited is used only when configured as the plan default or explicitly requested and permitted. The body parameters mailbox_lifetime and email_lifetime are also accepted; the first non-empty value wins in this order: lifetime, mailbox_lifetime, email_lifetime. Invalid or disallowed values return HTTP 422 instead of silently selecting a 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'
پاسخ نمونه
200 OK • JSON{
"status": true,
"data": {
"id": 2301,
"email": "customuser@example.com",
"domain": "example.com",
"provider": "standard",
"expire_at": "2026-10-30T06:07:26+00:00",
"expires_in_seconds": 86400,
"created_at": "2026-10-29T06:07:26+00:00",
"email_token": "encrypted-email-token"
}
}
Update / Switch Mailbox
Update or switch an existing owned mailbox to a new username and allowed domain. This operation applies only to mailboxes owned by the authenticated user.
| پارامتر | موقعیت | ۱۳. نوع | وضعیت | ۲۲. توضیحات |
|---|---|---|---|---|
email
|
path | string | الزامی |
Current full email address of the owned mailbox to switch.
|
username
|
path | string | الزامی |
New desired username prefix.
|
domain
|
path | string | الزامی |
New allowed domain name.
|
lifetime
|
body | string | اختیاری |
Optional new mailbox lifetime duration.
پیشفرض:
Current remaining / plan default
|
lifetime (allowed values: 10m, 1h, 2h, 1d, 1w, 1m, unlimited). Omit lifetime, or leave it empty, to use the Default Email Lifetime configured for your current monthly/yearly plan. Send a permitted lifetime such as 1h to override that default. Unlimited is used only when configured as the plan default or explicitly requested and permitted. The body parameters mailbox_lifetime and email_lifetime are also accepted; the first non-empty value wins in this order: lifetime, mailbox_lifetime, email_lifetime. Invalid or disallowed values return HTTP 422 instead of silently selecting a 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'
پاسخ نمونه
200 OK • JSON{
"status": true,
"data": {
"id": 2302,
"email": "demo123@example.com",
"domain": "example.com",
"expire_at": "2026-10-29T06:17:26+00:00",
"expires_in_seconds": 600,
"created_at": "2026-10-29T06:07:26+00:00",
"email_token": "encrypted-email-token"
}
}
Delete Mailbox
Delete a temporary email address. The email address is immediately marked as expired and soft-deleted, along with all its associated messages.
| پارامتر | موقعیت | ۱۳. نوع | وضعیت | ۲۲. توضیحات |
|---|---|---|---|---|
email
|
path | string | الزامی |
Full email address of the owned mailbox to delete.
|
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'
پاسخ نمونه
200 OK • JSON{
"status": true,
"message": "Email has been successfully deleted."
}
نامهای مستعار Gmail و Outlook
Generate high-reputation Gmail and Outlook/Hotmail alias mailboxes.
Create Gmail Alias
Create a new Gmail alias temporary mailbox owned by the authenticated user.
| پارامتر | موقعیت | ۱۳. نوع | وضعیت | ۲۲. توضیحات |
|---|---|---|---|---|
mode
|
body | string | اختیاری |
Generation mode: auto, dot, plus, or plus_word.
پیشفرض:
auto
|
username
|
body | string | اختیاری |
Custom alias username prefix.
پیشفرض:
Auto-generated
|
domain
|
body | string | اختیاری |
Allowed domain: gmail.com or googlemail.com.
پیشفرض:
gmail.com
|
lifetime
|
body | string | اختیاری |
Duration: 10m, 1h, 2h, 1d, 1w, 1m, or unlimited.
پیشفرض:
Plan default lifetime
|
mode (auto, dot, plus, plus_word), username (custom alias username), domain (e.g. gmail.com, googlemail.com), lifetime (allowed values: 10m, 1h, 2h, 1d, 1w, 1m, unlimited). Omit lifetime, or leave it empty, to use the Default Email Lifetime configured for your current monthly/yearly plan. Send a permitted lifetime such as 1h to override that default. Unlimited is used only when configured as the plan default or explicitly requested and permitted. The body parameters mailbox_lifetime and email_lifetime are also accepted; the first non-empty value wins in this order: lifetime, mailbox_lifetime, email_lifetime. Invalid or disallowed values return HTTP 422 instead of silently selecting a 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'
پاسخ نمونه
200 OK • JSON{
"status": true,
"data": {
"id": 2305,
"email": "myname.alias123@gmail.com",
"domain": "gmail.com",
"provider": "gmail_alias",
"expire_at": "2026-10-29T07:07:27+00:00",
"expires_in_seconds": 3600,
"created_at": "2026-10-29T06:07:27+00:00",
"email_token": "encrypted-email-token"
}
}
Outlook Alias Domains
Fetch active Outlook / Hotmail alias domains available for mailbox generation.
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'
پاسخ نمونه
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
}
]
}
}
Create Outlook Alias
Create a new Outlook / Hotmail alias temporary mailbox owned by the authenticated user.
| پارامتر | موقعیت | ۱۳. نوع | وضعیت | ۲۲. توضیحات |
|---|---|---|---|---|
domain
|
body | string | اختیاری |
Target Outlook domain, e.g. outlook.com or hotmail.com.
پیشفرض:
First available
|
username
|
body | string | اختیاری |
Custom alias prefix if allowed by subscription.
پیشفرض:
Auto-generated
|
lifetime
|
body | string | اختیاری |
Duration: 10m, 1h, 2h, 1d, 1w, 1m, or unlimited.
پیشفرض:
Plan default lifetime
|
domain (e.g. outlook.com, hotmail.com), username (custom alias username), lifetime (allowed values: 10m, 1h, 2h, 1d, 1w, 1m, unlimited). Omit lifetime, or leave it empty, to use the Default Email Lifetime configured for your current monthly/yearly plan. Send a permitted lifetime such as 1h to override that default. Unlimited is used only when configured as the plan default or explicitly requested and permitted. The body parameters mailbox_lifetime and email_lifetime are also accepted; the first non-empty value wins in this order: lifetime, mailbox_lifetime, email_lifetime. Invalid or disallowed values return HTTP 422 instead of silently selecting a 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'
پاسخ نمونه
200 OK • JSON{
"status": true,
"data": {
"id": 2306,
"email": "fastuser_alias45@outlook.com",
"domain": "outlook.com",
"provider": "outlook_alias",
"expire_at": "2026-10-29T07:07:28+00:00",
"expires_in_seconds": 3600,
"created_at": "2026-10-29T06:07:28+00:00",
"email_token": "encrypted-email-token"
}
}
Messages & Attachments
Fetch incoming inboxes, read full HTML/text messages, and stream attachments.
List Mailbox Messages
Retrieve all messages from a temporary email inbox. Returns message details, including message ID, sender, subject, received date, read status, and email preview.
| پارامتر | موقعیت | ۱۳. نوع | وضعیت | ۲۲. توضیحات |
|---|---|---|---|---|
email
|
query | string | الزامی |
Full email address of the owned mailbox to read messages from.
|
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'
پاسخ نمونه
200 OK • JSON{
"status": true,
"mailbox": "randombox@example.com",
"messages": [
{
"is_seen": false,
"subject": "Welcome to Temp Mail",
"from": "Example Sender",
"from_email": "hello@example.org",
"to": "randombox@example.com",
"receivedAt": "2026-10-29 06:07:28",
"id": "ap94AWDg123ELQz07vrVB9dLXlbqZM5NGwYxOJKko8n6m1",
"html": true,
"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"
}
]
}
]
}
Get Single Message
Retrieve a specific email message by its ID (`hash_id`). Returns the full message content, including the HTML body and attachments.
| پارامتر | موقعیت | ۱۳. نوع | وضعیت | ۲۲. توضیحات |
|---|---|---|---|---|
messageId
|
path | string | الزامی |
Unique message ID returned in the message list.
|
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'
پاسخ نمونه
200 OK • JSON{
"status": true,
"data": {
"is_seen": true,
"subject": "Welcome to Temp Mail",
"from": "Example Sender",
"from_email": "hello@example.org",
"to": "randombox@example.com",
"receivedAt": "2026-10-29 06:07:28",
"id": "ap94AWDg123ELQz07vrVB9dLXlbqZM5NGwYxOJKko8n6m1",
"html": true,
"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"
}
]
}
}
حذف پیام
حذف یک پیام متعلق به کاربر
| پارامتر | موقعیت | ۱۳. نوع | وضعیت | ۲۲. توضیحات |
|---|---|---|---|---|
messageId
|
path | string | الزامی |
Unique message ID string to permanently delete.
|
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'
پاسخ نمونه
200 OK • JSON{
"status": true,
"message": "Message was deleted successfully."
}
Download Attachment
۲. دانلود یک فایل پیوست از یک پیام متعلق به کاربر.
| پارامتر | موقعیت | ۱۳. نوع | وضعیت | ۲۲. توضیحات |
|---|---|---|---|---|
messageId
|
path | string | الزامی |
ID of the message containing the file.
|
filename
|
path | string | الزامی |
Filename and extension of the attachment to download.
|
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
Rate Limits & Quotas
Monitor real-time request budgets, rate limits, and account quotas without consuming credits.
Rate Limit & Quota
Check your current rate limit and quota status without consuming any API usage. This endpoint is quota-free and does not deduct monthly API credits (abuse protection limit: 60 requests/min).
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'
پاسخ نمونه
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 | Account requests-per-minute limit. The string unlimited denotes an unlimited minute budget; this is independent of monthly quota. |
data.remaining |
integer|string | Remaining account minute-budget slots, or the string unlimited. A positive value does not mean that API credits remain. |
data.reset |
integer | Seconds for the account minute window, not the monthly quota reset. Disabled or unlimited minute budgets can retain a nominal 60-second value; this does not promise access after waiting. |
data.plan |
string | Current plan tag. The readable plan name is provided separately in data.quota.plan_name. |
data.quota.enabled |
boolean | Whether global and plan/credit API access is enabled. This does not indicate remaining capacity or replace the user API switch. |
data.quota.user_api_status |
boolean | Whether the user has enabled their User API switch. Operations require this switch as well as enabled access and available capacity. |
data.quota.plan_name |
string | Readable name of the current plan. |
data.quota.period |
string | Calendar-month usage period in YYYY-MM format, using the application timezone; not necessarily the subscription billing period. |
data.quota.base_limit |
integer | Base monthly plan allowance. A value of -1 means unlimited. |
data.quota.extra_requests |
integer | Additional monthly allowance granted for the current usage period; separate from purchased credits. |
data.quota.monthly_limit |
integer | Base allowance plus current-period extra requests. A value of -1 means unlimited. Purchased credits are not included. |
data.quota.monthly_remaining |
integer|null | Remaining finite monthly allowance, or null when monthly quota is unlimited. Null must not be interpreted as zero. |
data.quota.used |
integer | Successful, counted API operations in the current usage period, including operations using credits. Status checks do not increase this value. |
data.quota.purchased_credits |
integer | Current credit balance, including active plan bonus credits. Bonus credits must not be added to this balance a second time. |
data.quota.bonus_credits |
integer | Active plan-bonus portion of the credit balance; a breakdown of purchased_credits, not additional capacity. |
data.quota.direct_purchased_credits |
integer | Credit balance excluding the active plan-bonus portion. This value plus bonus_credits equals purchased_credits. |
data.quota.remaining |
integer|null | Monthly remaining allowance plus the current credit balance, without double-counting bonuses. Null means unlimited monthly quota. Individual feature permissions and other request limits still apply. |
data.quota.unlimited |
boolean | Whether monthly quota is unlimited. This does not make the account minute budget or other feature limits unlimited. |
data.quota.usage_percent |
integer | Dashboard-compatible rounded percentage from 0 to 100: used divided by used plus remaining, multiplied by 100. It includes available credit capacity, so recharging can lower the percentage. It is 0 for unlimited quota or a zero-sized pool; it is not the minute rate-limit percentage or an access decision. |
data.quota.reset_at |
string | ISO-8601 timestamp with timezone offset for the next calendar-month quota reset. This is not the subscription expiry date, and the monthly reset does not refill purchased credits. |
وبهوکهای پست الکترونیکی (پشتیبانی در زمان واقعی)
بدون این که بهطور تکراری به API REST (GET /messages) مراجعه کنید تا ایمیلهای دریافتی را بررسی کنید، وبهوکها را پیکربندی کنید تا پیامهای جدید را به صورت زمانحالی به سرور یا فرآیند خودتوماتیک شما ارسال کنند.
رویدادهای وبهوک پشتیبانیشده
هر وبهوک میتواند به یک یا چند نوع رویداد مشترک شود. آدرسنامهٔ شما یک اطلاعرسانی رویداد دریافت میکند هر بار که یکی از این رویدادها فعال میشود.
Dispatched in real time whenever a new message reaches the selected mailbox.
Dispatched when the temporary mailbox expires and webhook processing is paused.
Dispatched when an expired mailbox becomes active again under plan rules.
Dispatched right before the webhook and its mailbox are deleted.
سربرگهای درخواست و تأیید امضا HMAC
هر ارسال وبهوک حاوی سربرگهای امنیتی ویژه است. از سربرگ X-TempMailg-Signature برای تأیید استفاده کنید که درخواستهای ورودی بهطور واقعی توسط TempMailg ارسال شده و تغییر نکردهاند.
| نام سربرگ | مثال | ۲۲. توضیحات |
|---|---|---|
User-Agent |
TempMailg-Webhooks/1.0 | Standard identifier for the webhook delivery worker. |
X-TempMailg-Event |
email.received | The type of event that triggered this delivery. |
X-TempMailg-Event-Id |
e7b1a2c3-4d5e-6f7a-8b9c-0d1e2f3a4b5c | Unique UUID assigned to this delivery attempt. |
X-TempMailg-Timestamp |
1725192000 | Unix epoch timestamp indicating when the request was initiated. |
X-TempMailg-Signature |
sha256=d7a8fbb307d7809469ca933b02d82941... | HMAC-SHA256 signature calculated from {timestamp}.{raw_body} using your secret. |
X-TempMailg-Test |
false | True when dispatched by the "Send Test Ping" feature in your dashboard. |
امضای محاسبه شده با استفاده از 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-10-29T06:07:31+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-10-29T06:07:31+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"
}
}
نمونههای پیادهسازی گیرنده
زبان خود را انتخاب کنید تا ببینید چگونه وبهوکها را دریافت کنید و امضاهای 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]);
پلتفرمهای پشتیبانیشده و ادغامهای خودکار
وبهوکهای TempMailg بهصورت آماده با نقاط انتهایی استاندارد HTTPS و پلتفرمهای پیشرو بدون کد/اتوماتیک کار میکنند:
۲۰. اشکالات رایج و رفع اشکال
۲۱. اینها کدهای پاسخ رایجترین هستند که ممکن است در حین یکپارچهسازی API کاربر ببینید.
۵. توکن Bearer نامعتبر یا از دست رفته.
۶. دسترسی API کاربر برای برنامه فعلی کاربر غیرفعال است.
۷. منبع در میزبان مجاز یافت نشد یا متعلق به کاربر نیست.
۸. صندوق پستی منقضی شده یا غیرفعال است.
۹. اعتبار سنجی ناموفق بود یا صندوق پستی/دامنه درخواستی مجاز نیست.
A request limit, disabled plan, exhausted quota, or cooldown prevented the operation. Check the reason and available budget headers. Retry-After is optional.
Protection storage or coordination could not be verified. Retry after the indicated delay. This response is not a failed payment.
۲۲. چک لیست سریع
- 401 Unauthorized - ۲۳. توکن Bearer از دست رفته، اشتباه، لغو شده یا به درستی کپی نشده است.
- 403 Forbidden - ۲۴. برنامه فعلی در حال حاضر حق دسترسی به API کاربر را ندارد.
- 404 Not Found - مورد مورد نظر یافت نشد یا پارامتر نامعتبر است
- 410 Gone / Expired - صندوق پستی منقضی شده یا دیگر فعال نیست.
- 429 Rate Limited - حد اعتبار ماهانه به پایان رسید — خرید اعتبار یا منتظر بازنشانی باشید
قدم بعدی توصیه شده
اگر وارد سیستم شده اید، ابتدا مدیریت API را باز کنید و کلید، سهم، وضعیت دسترسی برنامه و URL پایه API کاربر را قبل از اشکال زدایی برنامه خارجی خود تایید کنید.