TempMailg اے پی آئی دستاویزات

اپنی ذاتی API کلید بنانے، وقف صارف API میزبان کو مربوط کرنے، میل باکس پیغامات کو پڑھنے، ملکیتی میل باکسز کا نظم کرنے، اور Temp Mail کو اپنی ایپس یا آٹومیشن میں ضم کرنے کے لیے اس دستاویز کا استعمال کریں۔

صارف اے پی آئی بیس یو آر ایل

درخواست فارمیٹ اپنی API کلید کو صرف Authorization Bearer ہیڈر میں استعمال کریں اور Endpoint URLs کو صاف رکھیں۔

API کی بنانے کے لیے لاگ اِن کریں۔ اکاؤنٹ بنائیں۔

تیزی سے سیٹ اپ چیک لسٹ

اپنا ڈیش بورڈ API مینجمنٹ صفحہ کھولیں اور اپنی ذاتی API کلید بنائیں۔
وہاں دکھایا گیا بالکل صارف API بیس یو آر ایل کی نقل کریں ، مثال کے طور پر https://v1.yourdomain.com/api.
ہر درخواست کو اس API ہوسٹ کے ساتھ بھیجیں Authorization: Bearer YOUR_USER_API_KEY اور Accept: application/json.
اسی ڈیش بورڈ صفحہ سے اپنے ماہانہ درخواست کے کوٹہ کو ٹریک کریں اور ہر صارف API کے جواب پر واپس آنے والے کوٹہ ہیڈرز سے۔ صرف کامیاب 2xx درخواستیں کوٹہ میں شمار ہوتی ہیں۔

اگر API 404 واپس آتا ہے یقینی بنائیں کہ آپ مندرجہ ذیل API مینجمنٹ پیج پر دکھائے گئے وقف User API ہوسٹ کو بالکل وہی کہیں ہیں۔

ای پی آئی کے کے رسائی

اپنی ذاتی API کی بنانے اور لائیو کوٹہ کی تفصیلات دیکھنے کے لیے سائن ان کریں۔

لاگ ان رجسٹریشن

تصدیقی بہاؤ

اپنی ذاتی API کے API مینجمنٹ پیج ڈیش بورڈ سے جنریٹ کریں۔
ہر درخواست میں کلید بطور بیئرر ٹوکن بھیجیں۔
اپنی API مینجمنٹ پیج پر دکھایا گیا وقف User API بیس URL استعمال کریں۔
پرانے کو کالعدم کرنے اور فوراً ایک نئی کے استعمال شروع کرنے کے لئے کبھی بھی کے دوبارہ جنریٹ کریں۔

کے دیکھنے کی صلاحیت آپ کا صارف API کے آپ کے API مینجمنٹ پیج کے اندر دکھائی دیتا رہتا ہے یہاں تک کہ آپ اسے دوبارہ جنریٹ یا منسوخ کریں۔

درکار سرورق

Authorization: Bearer YOUR_USER_API_KEY
Accept: application/json

ہر ردعمل پر واپس آئے کوٹا سرورق

ان کوٹہ کی قدروں میں 2xx کے کامیاب جوابات کے بعد ہی اضافہ ہوتا ہے۔

X-RateLimit-Limit: 50000
X-RateLimit-Used: 124
X-RateLimit-Remaining: 49876
X-RateLimit-Reset: 2026-05-01T00:00:00+05:00

صارف API اختتامی پوائنٹس

ذیل میں ہر اختتامی نقطہ ایک ہی بنیادی URL اور ایک ہی بیئرر ٹوکن استعمال کرتا ہے۔ میل باکس، پیغام، اور منسلکہ درخواستوں کو تصدیق شدہ صارف اکاؤنٹ کے خلاف چیک کیا جاتا ہے۔

GET https://v1.tempmailg.com/api/domains?type={type}

موجودہ صارف کے منصوبے اور اکاؤنٹ کے لیے اجازت دی گئی ڈومینز کو حاصل کریں۔

اجازت یافتہ قسم کی قدریں: free, premium, all. مفت پلان صرف استعمال کر سکتا ہے۔ free. پریمیم پلان استعمال کر سکتا ہے۔ free, premium, یا 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'

مثال ردعمل

{
    "status": true,
    "data": {
        "requested_type": "free",
        "allowed_types": [
            "free"
        ],
        "domains": [
            {
                "domain": "example.com",
                "type": "Free",
                "custom": false
            }
        ]
    }
}

POST https://v1.tempmailg.com/api/emails

توثیق شدہ صارف کے لیے ایک نئی رینڈم میل باکس بنائیں۔

رینڈم میل باکس بنائیں

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'

مثال ردعمل

{
    "status": true,
    "data": {
        "id": 2301,
        "email": "randombox@example.com",
        "domain": "example.com",
        "expire_at": "2026-06-28T09:47:26+00:00",
        "expires_in_seconds": 600,
        "created_at": "2026-06-28T09:37:26+00:00",
        "email_token": "encrypted-email-token"
    }
}

POST https://v1.tempmailg.com/api/emails/{email}/{username}/{domain}

موجودہ ملکیت والی میل باکس کو ایک نئے صارف نام اور اجازت دی گئی ڈومین میں اپ ڈیٹ یا سوئچ کریں۔

{email} میں ایک موجودہ ملکیتی میل باکس ای میل استعمال کریں۔

ملکیت والی میل باکس کو اپ ڈیٹ کریں

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'

مثال ردعمل

{
    "status": true,
    "data": {
        "id": 2302,
        "email": "demo123@example.com",
        "domain": "example.com",
        "expire_at": "2026-06-28T09:47:26+00:00",
        "expires_in_seconds": 600,
        "created_at": "2026-06-28T09:37:26+00:00",
        "email_token": "encrypted-email-token"
    }
}

DELETE https://v1.tempmailg.com/api/emails/{email}

ایک ملکیتی میل باکس کو حذف کریں۔

ملکیت والی میل باکس حذف کریں

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'

مثال ردعمل

{
    "status": true,
    "message": "Email has been successfully deleted."
}

GET https://v1.tempmailg.com/api/messages?email={email}

ایک ملکیتی میل باکس کے لیے پیغامات کی فہرست بنائیں۔

ای میل کوئری پیرامیٹر کو توثیق شدہ صارف اکاؤنٹ سے تعلق رکھنا چاہیے۔

میل باکس پیغامات پڑھیں

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'

مثال ردعمل

{
    "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-06-28 09:37:26",
            "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 https://v1.tempmailg.com/api/messages/{messageId}

ایک ملکیت کا پیغام پڑھیں۔

ایک پیغام پڑھیں

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'

مثال ردعمل

{
    "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-06-28 09:37:26",
        "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"
            }
        ]
    }
}

DELETE https://v1.tempmailg.com/api/messages/{messageId}

ایک ملکیت کا پیغام حذف کریں۔

ایک پیغام حذف کریں

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'

مثال ردعمل

{
    "status": true,
    "message": "Message was deleted successfully."
}

GET https://v1.tempmailg.com/api/messages/{messageId}/attachments/{filename}

ایک ملکیت کے پیغام سے منسلک فائل ڈاؤن لوڈ کریں۔

اس اینڈ پوائنٹ براہ راست فائل ڈاؤن لوڈ کرتا ہے۔

ایک منسلک فائل ڈاؤن لوڈ کریں

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

رویہ ڈاؤن لوڈ کریں۔ یہ اختتامی نقطہ JSON باڈی کے بجائے براہ راست درخواست کردہ فائل کو واپس کرتا ہے۔

عام غلطیاں اور ٹربل شوٹنگ

یہ سب سے عام رسپانس کوڈز ہیں جو آپ صارف API کو انٹیگریٹ کرتے وقت دیکھ سکتے ہیں۔

401 بیئرر ٹوکن غلط یا غائب ہے۔

403 موجودہ صارف منصوبے کے لئے صارف API رسائی کو غیر فعال کر دیا گیا ہے۔

404 وسائل کو اجازت دی گئی میزبان پر نہیں ملا یا صارف کا مالک نہیں ہے۔

410 میل باکس منسوخ ہو گیا ہے یا غیر فعال ہے۔

422 توثیق ناکام ہو گئی یا مطلوبہ میل باکس / ڈومین کی اجازت نہیں ہے۔

429 ماہانہ صارف API کوٹا سے تجاوز کر گیا ہے۔

تیزی سے چیک لسٹ

401 - بیئرر ٹوکن غائب، غلط، منسوخ، یا غلط طریقے سے کاپی کیا گیا ہے۔
403 - موجودہ منصوبہ اس وقت صارف API تک رسائی کا حق نہیں ہے۔
404 - میل باکس، پیغام، یا منسلک کرنے صارف یا غلط ہوسٹ کا استعمال ہو رہا ہے کے لئے نہیں ہے۔
410 - میل باکس ختم ہو گیا ہے یا اب بھی سرگرم نہیں ہے۔
429 - ماہانہ درخواست کوٹا موجودہ مدت کے لئے مکمل طور پر استعمال ہو چکا ہے۔

تجویز کردہ اگلا قدم

اگر آپ سائن ان ہیں، تو پہلے API مینجمنٹ کھولیں اور اپنی بیرونی ایپ کو ڈیبگ کرنے سے پہلے اپنی کی، کوٹہ، پلان رسائی کی حیثیت، اور درست User API بیس یو آر ایل کی تصدیق کریں۔

API کی کنفیگر کرنے کے لیے لاگ اِن کریں۔