تیزی سے سیٹ اپ چیک لسٹ
- اپنا ڈیش بورڈ API مینجمنٹ صفحہ کھولیں اور اپنی ذاتی API کلید بنائیں۔
- وہاں دکھایا گیا بالکل صارف API بیس یو آر ایل کی نقل کریں ، مثال کے طور پر https://v1.tempmailg.com/api.
- ہر درخواست کو اس API ہوسٹ کے ساتھ بھیجیں Authorization: Bearer YOUR_USER_API_KEY اور Accept: application/json.
- اپنے ماہانہ درخواست کوٹا کو اسی ڈیش بورڈ صفحے سے اور جب صارف API جوابات پر کوٹا ہیڈرز دستیاب ہوں تو ان سے ٹریک کریں۔ صرف کامیاب 2xx درخواستیں کوٹے کی طرف شمار کی جاتی ہیں۔
تصدیقی بہاؤ
- اپنی ذاتی API کے API مینجمنٹ پیج ڈیش بورڈ سے جنریٹ کریں۔
- ہر درخواست میں کلید بطور بیئرر ٹوکن بھیجیں۔
- اپنی API مینجمنٹ پیج پر دکھایا گیا وقف User API بیس URL استعمال کریں۔
- پرانے کو کالعدم کرنے اور فوراً ایک نئی کے استعمال شروع کرنے کے لئے کبھی بھی کے دوبارہ جنریٹ کریں۔
درکار سرورق
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 پروٹیکشن اسٹوریج یا کوآرڈینیشن عارضی طور پر دستیاب نہیں ہے۔ بعد میں دوبارہ کوشش کریں؛ یہ ادائیگی کی ناکامی یا کریڈٹ ڈیبٹ نہیں ہے۔
میل باکس مینجمنٹ
مجاز ڈومینز حاصل کریں، میل بکس بنائیں یا تبدیل کریں، اجازت شدہ مدتوں کا انتخاب کریں، اور ملکیتی ایڈریسز حذف کریں۔
مجاز ڈومینز کی فہرست
عارضی ای میلز بنانے کے لیے دستیاب ڈومینز کی فہرست بنائیں۔ قسم کے لحاظ سے فلٹر کریں تاکہ صرف مفت، پریمیم یا کسٹم ڈومینز دیکھ سکیں جو آپ کے سبسکرپشن پلان کی حمایت کرتے ہیں۔
| پیرامیٹر | مقام | قسم | حیثیت | تفصیل |
|---|---|---|---|---|
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'
مصنوعی ڈیٹا استعمال کرتے ہوئے وضاحتی ردعمل۔ IDs، addresses، tokens، timestamps، plan limits اور counts مختلف ہیں۔ Sample lifetimes آپ کے plan default کو اوور رائڈ نہیں کرتی۔ Response field descriptions nullable اور provider-specific فیلڈز کی نشاندہی کرتی ہیں۔
مثال ردعمل
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 | کیا یہ ایک حسبِ ضرورت ڈومین ہے۔ |
عارضی میل بکس بنائیں
ایک ملکیتی عارضی میل باکس بنائیں۔ بے ترتیب تخلیق کے لیے صارف نام اور ڈومین کو چھوڑ دیں، یا ایک اجازت شدہ حسبِ ضرورت صارف نام اور ایک منظور شدہ ڈومین فراہم کریں۔ پرووائیڈر پیرامیٹر Gmail یا Outlook عرف نام کی تخلیق کا انتخاب کر سکتا ہے۔
| پیرامیٹر | مقام | قسم | حیثیت | تفصیل |
|---|---|---|---|---|
username
|
body | string | اختیاری |
اختیاری حسبِ ضرورت صارف نام: 2 سے 64 ASCII حروف، اعداد، نقطے، انڈر اسکور یا ہائفن۔ پلان کی اجازت درکار ہے؛ custom_username بھی قبول کیا جاتا ہے۔
پہلے سے طے شدہ:
بے ترتیب تیار کردہ
|
domain
|
body | string | اختیاری |
GET /domains کے ذریعے واپس کردہ اجازت شدہ ڈومینز میں سے ایک۔ حذف کرنے سے ایک تصادفی اجازت شدہ ڈومین منتخب ہوتا ہے۔
پہلے سے طے شدہ:
تصادفی اجازت شدہ ڈومین
|
lifetime
|
body | string | اختیاری |
مجاز اقدار:
10m — دس منٹ
1h — 1 گھنٹہ
2h — 2 گھنٹے
1d — 1 دن
1w — 1 ہفتہ
1m — ۳۰ دن
3m — ۹۰ دن
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 درست ہو تو ضروری ہے: 6 سے 8 اعداد کا PIN، جسے لیڈنگ زیرو محفوظ رکھنے کے لیے سٹرنگ کے طور پر بھیجا جاتا ہے۔
|
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). عمر کو چھوڑ دیں، یا اسے خالی چھوڑ دیں، تاکہ آپ کے موجودہ ماہانہ/سالانہ منصوبے کے لیے ترتیب دی گئی ڈیفالٹ ای میل عمر استعمال ہو۔ ڈیفالٹ کو اوور رائڈ کرنے کے لیے 1h جیسی اجازت شدہ عمر بھیجیں۔ لامحدود صرف اس وقت استعمال ہوتی ہے جب اسے منصوبے کے ڈیفالٹ کے طور پر ترتیب دیا گیا ہو یا واضح طور پر طلب اور اجازت دی گئی ہو۔ جسم کے پیرامیٹرز 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'
مصنوعی ڈیٹا استعمال کرتے ہوئے وضاحتی ردعمل۔ IDs، addresses، tokens، timestamps، plan limits اور counts مختلف ہیں۔ Sample lifetimes آپ کے plan default کو اوور رائڈ نہیں کرتی۔ Response field descriptions nullable اور provider-specific فیلڈز کی نشاندہی کرتی ہیں۔
مثال ردعمل
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:58+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:58+00:00",
"email_token": "encrypted-email-token"
}
}
| فیلڈ | قسم | تفصیل |
|---|---|---|
status |
boolean | آپریشن کامیاب ہوا یا نہیں۔ |
data.id |
integer | میل باکس ID۔ ہر میل باکس کے لیے تیار کردہ IDs، addresses اور tokens مختلف ہوتے ہیں۔ |
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 | موثر میعاد ختم ہونے کی تاریخ بطور 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 کے طور پر encode کریں۔
|
username
|
path | string | درکار |
نیا مطلوبہ صارف نام: 2 سے 64 حروفِ عددی اور حروفِ تہجی؛ حسبِ ضرورت صارف نام کی اجازت کے تابع۔
|
domain
|
path | string | درکار |
نیا اجازت شدہ ڈومین نام۔
|
lifetime
|
body | string | اختیاری |
مجاز اقدار:
10m — دس منٹ
1h — 1 گھنٹہ
2h — 2 گھنٹے
1d — 1 دن
1w — 1 ہفتہ
1m — ۳۰ دن
3m — ۹۰ دن
6m — 180 دن
1y — 365 دن
unlimited — لامحدود
پہلے سے طے شدہ:
پلان کی ڈیفالٹ مدت
|
pin_enabled
|
body | boolean | اختیاری |
نئے میل باکس کے لیے اختیاری PIN تحفظ، جب آپ کے پلان کی اجازت ہو۔ یہ موجودہ میل باکس کے PIN کو تبدیل نہیں کرتا۔
پہلے سے طے شدہ:
false
|
pin
|
body | string | اختیاری |
جب pin_enabled درست ہو تو ضروری ہے: 6 سے 8 اعداد کا PIN، جسے لیڈنگ زیرو محفوظ رکھنے کے لیے سٹرنگ کے طور پر بھیجا جاتا ہے۔
|
pin_confirmation
|
body | string | اختیاری |
جب pin_enabled سچ ہو تو ضروری ہے۔ pin کے ساتھ بالکل میچ ہونا چاہیے۔
|
Idempotency-Key
|
header | string | اختیاری |
PIN-محافظت شدہ تخلیق یا حذف کے لیے درکار: ایک مستحکم 16 سے 128 حروف کی کلید۔ ایک ہی کلید کے ساتھ ایک ہی درخواست دوبارہ بھیجیں تاکہ ڈپلیکٹ کام سے بچا جا سکے۔
|
X-Mailbox-Unlock
|
header | string | اختیاری |
ہیڈر، صرف محفوظ شدہ میل بکسز: پڑھنے کے لیے unlock_token استعمال کریں۔ پہلے POST pin اور scope=read کو PIN unlock URL پر بھیجیں۔ اپنی معمول کی Bearer توثیق برقرار رکھیں۔ <code>https://v1.tempmailg.com/api/mailboxes/{mailbox}/pin/unlock</code>
|
lifetime (مجاز اقدار: 10m, 1h, 2h, 1d, 1w, 1m, 3m, 6m, 1y, unlimited)۔ عمر کو چھوڑ دیں، یا اسے خالی چھوڑ دیں، تاکہ آپ کے موجودہ ماہانہ/سالانہ منصوبے کے لیے ترتیب دی گئی ڈیفالٹ ای میل عمر استعمال ہو۔ ڈیفالٹ کو اوور رائڈ کرنے کے لیے 1h جیسی اجازت شدہ عمر بھیجیں۔ لامحدود صرف اس وقت استعمال ہوتی ہے جب اسے منصوبے کے ڈیفالٹ کے طور پر ترتیب دیا گیا ہو یا واضح طور پر طلب اور اجازت دی گئی ہو۔ جسم کے پیرامیٹرز 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'
مصنوعی ڈیٹا استعمال کرتے ہوئے وضاحتی ردعمل۔ IDs، addresses، tokens، timestamps، plan limits اور counts مختلف ہیں۔ Sample lifetimes آپ کے plan default کو اوور رائڈ نہیں کرتی۔ Response field descriptions nullable اور provider-specific فیلڈز کی نشاندہی کرتی ہیں۔
مثال ردعمل
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:58+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:58+00:00",
"email_token": "encrypted-email-token"
}
}
| فیلڈ | قسم | تفصیل |
|---|---|---|
status |
boolean | آپریشن کامیاب ہوا یا نہیں۔ |
data.id |
integer | میل باکس ID۔ ہر میل باکس کے لیے تیار کردہ IDs، addresses اور tokens مختلف ہوتے ہیں۔ |
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 | موثر میعاد ختم ہونے کی تاریخ بطور 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 کے طور پر encode کریں۔
|
X-Mailbox-Unlock
|
header | string | اختیاری |
ہیڈر، صرف محفوظ شدہ میل بکسز: ایک بار استعمال ہونے والا حذف unlock_token استعمال کریں۔ پہلے POST pin، scope=delete اور وہ action/target_id جو 423 ردعمل کے ذریعے PIN unlock URL پر واپس ملتا ہے۔ ایک read token حذف نہیں کر سکتا۔ <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'
مصنوعی ڈیٹا استعمال کرتے ہوئے وضاحتی ردعمل۔ IDs، addresses، tokens، timestamps، plan limits اور counts مختلف ہیں۔ Sample lifetimes آپ کے plan default کو اوور رائڈ نہیں کرتی۔ Response field descriptions nullable اور provider-specific فیلڈز کی نشاندہی کرتی ہیں۔
مثال ردعمل
200 OK • JSON{
"status": true,
"message": "Email has been successfully deleted."
}
| فیلڈ | قسم | تفصیل |
|---|---|---|
status |
boolean | آپریشن کامیاب ہوا یا نہیں۔ |
message |
string | حذف کا نتیجہ۔ ایک غائب وسیلہ HTTP 404 واپس کرتا ہے۔ |
Gmail & Outlook عرفیات
اعلیٰ شہرت والے Gmail اور Outlook/Hotmail عرفی میل بکس بنائیں۔
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 | اختیاری |
Random, gmail.com یا googlemail.com استعمال کریں؛ alias_domain بھی قبول ہے۔ حذف یا غیر دستیاب ڈومین-انتخاب کی اجازت کے لیے random استعمال ہوتا ہے۔
پہلے سے طے شدہ:
random
|
lifetime
|
body | string | اختیاری |
مجاز اقدار:
10m — دس منٹ
1h — 1 گھنٹہ
2h — 2 گھنٹے
1d — 1 دن
1w — 1 ہفتہ
1m — ۳۰ دن
3m — ۹۰ دن
6m — 180 دن
1y — 365 دن
unlimited — لامحدود
پہلے سے طے شدہ:
پلان کی ڈیفالٹ مدت
|
pin_enabled
|
body | boolean | اختیاری |
نئے میل باکس کے لیے اختیاری PIN تحفظ، جب آپ کے پلان کی اجازت ہو۔ یہ موجودہ میل باکس کے PIN کو تبدیل نہیں کرتا۔
پہلے سے طے شدہ:
false
|
pin
|
body | string | اختیاری |
جب pin_enabled درست ہو تو ضروری ہے: 6 سے 8 اعداد کا PIN، جسے لیڈنگ زیرو محفوظ رکھنے کے لیے سٹرنگ کے طور پر بھیجا جاتا ہے۔
|
pin_confirmation
|
body | string | اختیاری |
جب pin_enabled سچ ہو تو ضروری ہے۔ pin کے ساتھ بالکل میچ ہونا چاہیے۔
|
Idempotency-Key
|
header | string | اختیاری |
PIN-محافظت شدہ تخلیق یا حذف کے لیے درکار: ایک مستحکم 16 سے 128 حروف کی کلید۔ ایک ہی کلید کے ساتھ ایک ہی درخواست دوبارہ بھیجیں تاکہ ڈپلیکٹ کام سے بچا جا سکے۔
|
mode (auto, dot, plus, plus_dot), username (حسبِ ضرورت عرفی صارف نام), domain (مثال کے طور پر: gmail.com, googlemail.com), lifetime (مجاز اقدار: 10m, 1h, 2h, 1d, 1w, 1m, 3m, 6m, 1y, unlimited). عمر کو چھوڑ دیں، یا اسے خالی چھوڑ دیں، تاکہ آپ کے موجودہ ماہانہ/سالانہ منصوبے کے لیے ترتیب دی گئی ڈیفالٹ ای میل عمر استعمال ہو۔ ڈیفالٹ کو اوور رائڈ کرنے کے لیے 1h جیسی اجازت شدہ عمر بھیجیں۔ لامحدود صرف اس وقت استعمال ہوتی ہے جب اسے منصوبے کے ڈیفالٹ کے طور پر ترتیب دیا گیا ہو یا واضح طور پر طلب اور اجازت دی گئی ہو۔ جسم کے پیرامیٹرز 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'
مصنوعی ڈیٹا استعمال کرتے ہوئے وضاحتی ردعمل۔ IDs، addresses، tokens، timestamps، plan limits اور counts مختلف ہیں۔ Sample lifetimes آپ کے plan default کو اوور رائڈ نہیں کرتی۔ Response field descriptions nullable اور provider-specific فیلڈز کی نشاندہی کرتی ہیں۔
مثال ردعمل
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:58+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:58+00:00",
"email_token": "encrypted-email-token"
}
}
| فیلڈ | قسم | تفصیل |
|---|---|---|
status |
boolean | آپریشن کامیاب ہوا یا نہیں۔ |
data.id |
integer | میل باکس ID۔ ہر میل باکس کے لیے تیار کردہ IDs، addresses اور tokens مختلف ہوتے ہیں۔ |
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 | موثر میعاد ختم ہونے کی تاریخ بطور 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 / 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'
مصنوعی ڈیٹا استعمال کرتے ہوئے وضاحتی ردعمل۔ IDs، addresses، tokens، timestamps، plan limits اور counts مختلف ہیں۔ Sample lifetimes آپ کے plan default کو اوور رائڈ نہیں کرتی۔ Response field descriptions nullable اور provider-specific فیلڈز کی نشاندہی کرتی ہیں۔
مثال ردعمل
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 Alias بنائیں
تصدیق شدہ صارف کے زیرِ ملکیت ایک نیا 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 — دس منٹ
1h — 1 گھنٹہ
2h — 2 گھنٹے
1d — 1 دن
1w — 1 ہفتہ
1m — ۳۰ دن
3m — ۹۰ دن
6m — 180 دن
1y — 365 دن
unlimited — لامحدود
پہلے سے طے شدہ:
پلان کی ڈیفالٹ مدت
|
pin_enabled
|
body | boolean | اختیاری |
نئے میل باکس کے لیے اختیاری PIN تحفظ، جب آپ کے پلان کی اجازت ہو۔ یہ موجودہ میل باکس کے PIN کو تبدیل نہیں کرتا۔
پہلے سے طے شدہ:
false
|
pin
|
body | string | اختیاری |
جب pin_enabled درست ہو تو ضروری ہے: 6 سے 8 اعداد کا PIN، جسے لیڈنگ زیرو محفوظ رکھنے کے لیے سٹرنگ کے طور پر بھیجا جاتا ہے۔
|
pin_confirmation
|
body | string | اختیاری |
جب pin_enabled سچ ہو تو ضروری ہے۔ pin کے ساتھ بالکل میچ ہونا چاہیے۔
|
Idempotency-Key
|
header | string | اختیاری |
PIN-محافظت شدہ تخلیق یا حذف کے لیے درکار: ایک مستحکم 16 سے 128 حروف کی کلید۔ ایک ہی کلید کے ساتھ ایک ہی درخواست دوبارہ بھیجیں تاکہ ڈپلیکٹ کام سے بچا جا سکے۔
|
domain (مثال کے طور پر outlook.com, hotmail.com), username (حسبِ ضرورت عرفی صارف نام), lifetime (مجاز اقدار: 10m, 1h, 2h, 1d, 1w, 1m, 3m, 6m, 1y, unlimited). عمر کو چھوڑ دیں، یا اسے خالی چھوڑ دیں، تاکہ آپ کے موجودہ ماہانہ/سالانہ منصوبے کے لیے ترتیب دی گئی ڈیفالٹ ای میل عمر استعمال ہو۔ ڈیفالٹ کو اوور رائڈ کرنے کے لیے 1h جیسی اجازت شدہ عمر بھیجیں۔ لامحدود صرف اس وقت استعمال ہوتی ہے جب اسے منصوبے کے ڈیفالٹ کے طور پر ترتیب دیا گیا ہو یا واضح طور پر طلب اور اجازت دی گئی ہو۔ جسم کے پیرامیٹرز 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'
مصنوعی ڈیٹا استعمال کرتے ہوئے وضاحتی ردعمل۔ IDs، addresses، tokens، timestamps، plan limits اور counts مختلف ہیں۔ Sample lifetimes آپ کے plan default کو اوور رائڈ نہیں کرتی۔ Response field descriptions nullable اور provider-specific فیلڈز کی نشاندہی کرتی ہیں۔
مثال ردعمل
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:58+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:58+00:00",
"email_token": "encrypted-email-token"
}
}
| فیلڈ | قسم | تفصیل |
|---|---|---|
status |
boolean | آپریشن کامیاب ہوا یا نہیں۔ |
data.id |
integer | میل باکس ID۔ ہر میل باکس کے لیے تیار کردہ IDs، addresses اور tokens مختلف ہوتے ہیں۔ |
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 | موثر میعاد ختم ہونے کی تاریخ بطور 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 پیغامات واپس کرتے ہیں؛ یہ صفحہ بندی شدہ مکمل تاریخ کا اینڈ پوائنٹ نہیں ہے۔ مکمل باڈیز اور اٹیچمنٹس کے لیے GET /messages/{messageId} استعمال کریں۔
| پیرامیٹر | مقام | قسم | حیثیت | تفصیل |
|---|---|---|---|---|
email
|
query | string | درکار |
پیغام پڑھنے کے لیے مالک کے میل باکس کا مکمل ای میل پتہ۔ استفسار کی قدر کو URL-encode کریں؛ پلس سائن کو %2B کے طور پر انکوڈ کریں۔
|
X-Mailbox-Unlock
|
header | string | اختیاری |
ہیڈر، صرف محفوظ شدہ میل بکسز: پڑھنے کے لیے unlock_token استعمال کریں۔ پہلے POST pin اور scope=read کو PIN unlock URL پر بھیجیں۔ اپنی معمول کی 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'
مصنوعی ڈیٹا استعمال کرتے ہوئے وضاحتی ردعمل۔ IDs، addresses، tokens، timestamps، plan limits اور counts مختلف ہیں۔ Sample lifetimes آپ کے plan default کو اوور رائڈ نہیں کرتی۔ Response field descriptions nullable اور provider-specific فیلڈز کی نشاندہی کرتی ہیں۔
مثال ردعمل
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:58",
"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:58+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:58+00:00",
"message_count_synced_at": "2026-11-19T02:17:58+00:00"
}
| فیلڈ | قسم | تفصیل |
|---|---|---|
status |
boolean | آپریشن کامیاب ہوا یا نہیں۔ |
mailbox |
string | میل باکس کا پتہ جس کے پیغامات کی درخواست کی گئی تھی۔ |
email_token |
string | غیر شفاف مرموز میل باکس حوالہ؛ معمولی توثیق ابھی بھی ضروری ہے۔ |
mailbox_provider |
string | میل باکس فراہم کنندہ: standard, gmail_alias, یا outlook_alias۔ |
messages |
array | پیغام کے خلاصے۔ ایک خالی ان باکس خالی ارے واپس کرتا ہے؛ اس کے باڈی اور منسلکات کے لیے ایک واحد پیغام حاصل کریں۔ |
expire_at |
string|null | موثر میعاد ختم ہونے کی تاریخ بطور 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 | ایک ہی پیغام، حذف اور منسلک اینڈ پوائنٹس کے ذریعے استعمال ہونے والا غیر واضح پیغام شناخت۔ |
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 خلاصہ فیلڈ: اصل بھیجنے والے کا نام۔ معیاری اور Gmail خلاصوں میں موجود نہیں۔ |
messages[].snippet |
string|null | آؤٹ لک سمری فیلڈ: مختصر پیغام کا پیش نظارہ۔ |
messages[].received_at |
string|null | آؤٹ لک سمری فیلڈ: ISO-8601 موصول ہونے کا وقت، جب معلوم ہو۔ |
messages[].has_attachments |
boolean | Outlook summary field: آیا اٹیچمنٹ میٹا ڈیٹا موجود ہے۔ ڈاؤن لوڈ کی دستیابی الگ سے چیک کی جاتی ہے۔ |
ایک پیغام حاصل کریں
اپنی ملکیت کا پیغام اس کے غیر شفاف پیغام ID کے ذریعے حاصل کریں۔ باڈی فارمیٹس اور منسلکہ میٹا ڈیٹا واپس کرتا ہے۔ باڈی فیلڈز پیغام کے فارمیٹ پر منحصر ہیں؛ Outlook نیچے درج فراہم کنندہ مخصوص فیلڈز شامل کرتا ہے۔
| پیرامیٹر | مقام | قسم | حیثیت | تفصیل |
|---|---|---|---|---|
messageId
|
path | string | درکار |
پیغام کی فہرست میں واپس کی جانے والی منفرد پیغام شناخت۔
|
X-Mailbox-Unlock
|
header | string | اختیاری |
ہیڈر، صرف محفوظ شدہ میل بکسز: پڑھنے کے لیے unlock_token استعمال کریں۔ پہلے POST pin اور scope=read کو PIN unlock URL پر بھیجیں۔ اپنی معمول کی 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'
مصنوعی ڈیٹا استعمال کرتے ہوئے وضاحتی ردعمل۔ IDs، addresses، tokens، timestamps، plan limits اور counts مختلف ہیں۔ Sample lifetimes آپ کے plan default کو اوور رائڈ نہیں کرتی۔ Response field descriptions nullable اور provider-specific فیلڈز کی نشاندہی کرتی ہیں۔
مثال ردعمل
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:58",
"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 | متن کا جسم جب موجود ہو؛ معیاری پیغامات میں ایک pre عنصر میں محفوظ شدہ متن شامل ہو سکتا ہے یا اس فیلڈ کو چھوڑ سکتے ہیں۔ |
data.content |
string | نمائش کے لیے ترجیحی باڈی، عام طور پر جب دستیاب ہو تو HTML۔ |
data.attachments |
array | منسلک میٹا ڈیٹا، یا ایک خالی صف۔ ڈاؤن لوڈز کے لیے معمولی توثیق اور قابل اطلاق PIN کی اجازت درکار ہے۔ |
data.attachments[].name |
string | ڈاؤن لوڈ کرتے وقت فائل کا نام کو ایک واحد راستے کے حصے کے طور پر URL-اینکوڈ کریں۔ |
data.attachments[].size |
integer | منسلکہ کا سائز بائٹس میں۔ |
data.attachments[].url |
string | تصدیق شدہ صارف API ڈاؤن لوڈ URL کو فائل نام کے ساتھ منسلکات میں شامل کیا گیا ہے۔ ایک URL اس بات کی ضمانت نہیں دیتا کہ مقامی فائل دستیاب ہے۔ |
data.attachments[].extension |
string | معیاری/جی میل میٹا ڈیٹا فیلڈ: فائل ایکسٹینشن جب فراہم کی جائے۔ |
data.attachments[].id |
string | آؤٹ لک میٹا ڈیٹا فیلڈ: فراہم کنندہ منسلک شناخت۔ |
data.attachments[].content_type |
string | Outlook میٹا ڈیٹا فیلڈ: MIME مواد کی قسم۔ |
data.from_name |
string|null | آؤٹ لک کی تفصیل کا فیلڈ: اصل بھیجنے والے کا نام۔ |
data.to_email |
string|null | Outlook تفصیل کا میدان: اصل وصول کنندہ کا پتہ۔ |
data.received_at |
string|null | Outlook تفصیل کا میدان: ISO-8601 موصول ہونے کا وقت۔ |
data.has_html |
boolean | Outlook تفصیلی فیلڈ: آیا HTML باڈی موجود ہے۔ |
پیغام کو حذف کریں
ایک ملکیت کا پیغام حذف کریں۔
| پیرامیٹر | مقام | قسم | حیثیت | تفصیل |
|---|---|---|---|---|
messageId
|
path | string | درکار |
پائیدار طور پر حذف کرنے کے لیے منفرد پیغام کی شناختی سٹرنگ۔
|
X-Mailbox-Unlock
|
header | string | اختیاری |
ہیڈر، صرف محفوظ شدہ میل بکسز: ایک بار استعمال ہونے والا حذف unlock_token استعمال کریں۔ پہلے POST pin، scope=delete اور وہ action/target_id جو 423 ردعمل کے ذریعے PIN unlock URL پر واپس ملتا ہے۔ ایک read token حذف نہیں کر سکتا۔ <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'
مصنوعی ڈیٹا استعمال کرتے ہوئے وضاحتی ردعمل۔ IDs، addresses، tokens، timestamps، plan limits اور counts مختلف ہیں۔ Sample lifetimes آپ کے plan default کو اوور رائڈ نہیں کرتی۔ Response field descriptions nullable اور provider-specific فیلڈز کی نشاندہی کرتی ہیں۔
مثال ردعمل
200 OK • JSON{
"status": true,
"message": "Message was deleted successfully."
}
| فیلڈ | قسم | تفصیل |
|---|---|---|
status |
boolean | آپریشن کامیاب ہوا یا نہیں۔ |
message |
string | حذف کا نتیجہ۔ ایک غائب وسیلہ HTTP 404 واپس کرتا ہے۔ |
منسلکہ ڈاؤن لوڈ کریں
ایک ملکیت کے پیغام سے منسلک فائل ڈاؤن لوڈ کریں۔
| پیرامیٹر | مقام | قسم | حیثیت | تفصیل |
|---|---|---|---|---|
messageId
|
path | string | درکار |
فائل پر مشتمل پیغام کا ID۔
|
filename
|
path | string | درکار |
ڈاؤن لوڈ کرنے کے لیے منسلک فائل کا نام اور توسیع۔
|
X-Mailbox-Unlock
|
header | string | اختیاری |
ہیڈر، صرف محفوظ شدہ میل بکسز: پڑھنے کے لیے unlock_token استعمال کریں۔ پہلے POST pin اور scope=read کو PIN unlock URL پر بھیجیں۔ اپنی معمول کی 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 نہیں۔ غلطیاں غیر 2xx اسٹیٹس کے ساتھ JSON واپس کرتی ہیں۔ |
ریٹ حدود اور کوٹاز
کریڈٹ استعمال کیے بغیر حقیقی وقت کی درخواست بجٹس، شرح حدود، اور اکاؤنٹ کوٹاز کی نگرانی کریں۔
ریٹ لمٹ اور کوٹا
اپنی موجودہ ریٹ لمٹ اور کوٹا اسٹیٹس کو کسی بھی API استعمال کے بغیر چیک کریں۔ یہ اینڈ پوائنٹ کوٹا-فری ہے اور ماہانہ API کریڈٹس کو کم نہیں کرتا (غلط استعمال کے تحفظ کی حد: 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'
مصنوعی ڈیٹا استعمال کرتے ہوئے وضاحتی ردعمل۔ IDs، addresses، tokens، timestamps، plan limits اور counts مختلف ہیں۔ Sample lifetimes آپ کے plan default کو اوور رائڈ نہیں کرتی۔ Response field descriptions nullable اور provider-specific فیلڈز کی نشاندہی کرتی ہیں۔
مثال ردعمل
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 | یہ کہ آیا صارف نے اپنا یوزر 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 | کریڈٹ بیلنس کا فعال پلان بونس حصہ؛ خریدے گئے_کریڈٹس کی تفصیل، اضافی صلاحیت نہیں۔ |
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 | اس اسٹیٹس اینڈ پوائنٹ کے لیے حقیقی کامیابی۔ دیگر کامیاب میل بکس اینڈ پوائنٹس بولین true استعمال کرتے ہیں۔ |
data.monthly_limit |
integer | مطابقت کا عرفان متعلقہ data.quota فیلڈ کا؛ بیلنس کا حساب لگاتے وقت اسے دوبارہ شامل نہ کریں۔ |
data.monthly_remaining |
integer|null | مطابقت کا عرفان متعلقہ data.quota فیلڈ کا؛ بیلنس کا حساب لگاتے وقت اسے دوبارہ شامل نہ کریں۔ |
data.purchased_credits |
integer | مطابقت کا عرفان متعلقہ data.quota فیلڈ کا؛ بیلنس کا حساب لگاتے وقت اسے دوبارہ شامل نہ کریں۔ |
ای میل بکس ویب ہوکز (ریل ٹائم پش)
آپ جب تک ریسٹ ایپی آئی (GET /messages) کو انکامنگ میل چیک کرنے کے لیے بار بار پولنگ نہیں کرتے، ویبہوکس کی تنظیم کر کے نیے پیغامات کو ریل ٹائم میں اپنے سرور یا اتومیشن ورکفلو تک پش کر سکتے ہیں۔
مستحکم ویبہوک واقعات
ہر ویب ہُک ایک یا زیادہ ایونٹ ٹائپس کی سبسکرائب کر سکتا ہے۔ آپ کا اینڈ پوائنٹ ہر بار ایونٹ کی اطلاع وصول کرتا ہے جب ان میں سے کوئی ٹرگر فعال ہو۔
جب بھی نیا پیغام منتخب کردہ میل باکس تک پہنچے، حقیقی وقت میں بھیجا جاتا ہے۔
عارضی میل باکس کی میعاد ختم ہونے اور ویب ہُک پروسیسنگ کے روک دیے جانے پر بھیجا جاتا ہے۔
منصوبے کے قواعد کے تحت جب ایک میعاد ختم شدہ میل باکس دوبارہ فعال ہو جاتا ہے تو بھیجا جاتا ہے۔
ویب ہُک اور اس کے میل باکس کے حذف ہونے سے بالکل پہلے بھیجا گیا۔
ریقویسٹ ہیڈرز اور ایچ ایم اے سی سگنچر کی تصدیق
ہر ویبہوک ڈلیوری میں خاص سیکیورٹی ہیڈرز شامل ہوتے ہیں۔ **X-TempMailg-Signature** ہیڈر کا استعمال کرکے یقینی بنائیں کہ آئے ہوئے ریقوئسٹس اصل میں ٹیمپ میل جی سے بھیجے گئے ہیں اور ان میں کوئی تبدیلی نہیں کی گئی ہے۔
| ہدایت نام | مثال کی قیمتیں | تفصیل |
|---|---|---|
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 | یونکس ایپوک ٹائم سٹیمپ جو بتاتا ہے کہ درخواست کب شروع کی گئی تھی۔ |
X-TempMailg-Signature |
sha256=d7a8fbb307d7809469ca933b02d82941... | آپ کے سیکرٹ کا استعمال کرتے ہوئے {timestamp}.{raw_body} سے حساب شدہ HMAC-SHA256 دستخط۔ |
X-TempMailg-Test |
false | آپ کے ڈیش بورڈ میں "Send Test Ping" فیچر کے ذریعے بھیجے جانے پر درست۔ |
یہ ہاش کمپیوٹ کرنے کے لیے HMAC کے ساتھ SHA256 کا استعمال کیا جاتا ہے، جس میں یہ سٹرینگ کا استعمال ہوتا ہے:
hash_hmac('sha256', "${X-TempMailg-Timestamp}.${raw_request_body}", your_webhook_secret)
نمونہ واقعہ کی مواد (email.received)
HTTP POST درخواست کے بادی میں `application/json` کے طور پر فراہم کیا گیا۔
{
"id": "e7b1a2c3-4d5e-6f7a-8b9c-0d1e2f3a4b5c",
"version": "1.0",
"event": "email.received",
"occurred_at": "2026-11-19T02:17:59+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:59+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 Webhooks بغیر کسی اضافی ترتیب کے معیاری HTTPS اینڈ پوائنٹس اور نمایاں نو-کوڈ/آٹومیشن پلیٹ فارمز کے ساتھ کام کرتے ہیں:
عام غلطیاں اور ٹربل شوٹنگ
یہ سب سے عام رسپانس کوڈز ہیں جو آپ صارف API کو انٹیگریٹ کرتے وقت دیکھ سکتے ہیں۔
غلط، غائب یا منسوخ شدہ بیئرر ٹوکن۔
ملکیت، خصوصیت کی اجازتیں، ڈومین تک رسائی یا منسلکہ کا سائز آپریشن کو روک دیا۔ ردعمل کا کوڈ اور پیغام چیک کریں۔
وسائل کو اجازت دی گئی میزبان پر نہیں ملا یا صارف کا مالک نہیں ہے۔
آپریشن کلید مختلف تفصیلات کے ساتھ دوبارہ استعمال کی گئی، کوئی اور آپریشن زیر التواء ہے، یا میل باکس سیکیورٹی تبدیل ہو گئی۔ دوبارہ کوشش کرنے سے پہلے کوڈ کا معائنہ کریں۔
میل باکس منسوخ ہو گیا ہے یا غیر فعال ہے۔
غلط پیرامیٹرز، غیرمجاز عمر، غیر دستیاب ایلیاس صلاحیت، غلط PIN سیٹ اپ یا غائب/غلط Idempotency-Key نے آپریشن کو روک دیا۔
ایک محفوظ شدہ میل باکس کو ایک درست اسکوپڈ X-Mailbox-Unlock ٹوکن کی ضرورت ہوتی ہے۔ حذف کرنے کے لیے ردعمل سے ایکشن اور target_id استعمال کریں۔ لاک آؤٹ یا ریکوری کی ضروریات کو دوبارہ کوشش کرنے سے پہلے حل کرنا ضروری ہے۔
درخواست کی حد، غیر فعال پلان، ختم شدہ کوٹا، یا کول ڈاؤن نے آپریشن کو روک دیا۔ وجہ اور دستیاب بجٹ ہیڈرز چیک کریں۔ Retry-After اختیاری ہے۔
سرور آپریشن مکمل نہیں کر سکا۔ محفوظ تخلیق یا حذف کے لیے، دوبارہ کوشش کرتے وقت ایک ہی درخواست اور Idempotency-Key برقرار رکھیں۔
تحفظ اسٹوریج یا ہم آہنگی کی تصدیق نہیں ہو سکی۔ اشارہ کردہ تاخیر کے بعد دوبارہ کوشش کریں۔ یہ ردعمل ناکام ادائیگی نہیں ہے۔
تیزی سے چیک لسٹ
- 401 Unauthorized - بیئرر ٹوکن غائب، غلط، منسوخ، یا غلط طریقے سے کاپی کیا گیا ہے۔
- 403 Forbidden - موجودہ منصوبہ اس وقت صارف API تک رسائی کا حق نہیں ہے۔
- 404 Not Found - مورد نہیں مل سکا یا غیر درست پارامٹر
- 410 Gone / Expired - میل باکس ختم ہو گیا ہے یا اب بھی سرگرم نہیں ہے۔
- 429 Rate Limited - جواب کی وجہ اور بجٹ ہیڈرز چیک کریں۔ Retry-After صرف وقت کی حدوں پر لاگو ہوتا ہے؛ ختم شدہ کریڈٹ یا غیر فعال رسائی کے لیے اکاؤنٹ کی تبدیلی کی ضرورت پڑ سکتی ہے۔
تجویز کردہ اگلا قدم
اگر آپ سائن ان ہیں، تو پہلے API مینجمنٹ کھولیں اور اپنی بیرونی ایپ کو ڈیبگ کرنے سے پہلے اپنی کی، کوٹہ، پلان رسائی کی حیثیت، اور درست User API بیس یو آر ایل کی تصدیق کریں۔