Temp Mail API Documentation - Boomlify
Complete API reference for temporary email service integration
POST/api/v1/emails/create
نئی عارضی ای میل ایڈریس بنائیں اب اختیاری custom_username پیرامیٹر کی حمایت کرتا ہے تاکہ ذاتی ایڈریس کے ساتھ ای میلز بنائے جا سکیں۔
Parameters:
- custom_username (query, optional): ای میل ایڈریس کے لیے اختیاری کسٹم صارف نام۔ حروف، نمبر، ڈاٹس، ہائفنز اور انڈر سکورز شامل ہو سکتے ہیں۔ 3-30 حروف ہونے چاہئیں۔ اگر چھوڑ دیا گیا، ایک بے ترتیب صارف نام بنایا جائے گا۔ - Example:
john.doe - time (query, optional): ختم ہونے کا وقت - Example:
permanent - domain (query, optional): ای میل ایڈریس کے لیے اختیاری کسٹم ڈومین۔ آپ کے اکاؤنٹ میں تصدیق شدہ ڈومین ہونا چاہیے (تصدیق کے لیے custom_domains اینڈ پوائنٹ استعمال کریں)۔ اگر متعین نہیں کیا گیا، ایک بے ترتیب عوامی ڈومین استعمال ہوگا۔ - Example:
mail.yourdomain.com - create_as_dashboard (query, optional): 💎 پریمیم فیچر - ڈیٹا بیس میں محفوظ ڈیش بورڈ سٹائل ای میل بنانے کے لیے "true" پر سیٹ کریں جس کی 2 ماہ کی مقرر میعاد ختم ہوتی ہے، وقت پر مبنی API ای میل کے بجائے۔ وقت پر مبنی ای میلز کے لیے چھوڑ دیں یا "false" پر سیٹ کریں (ڈیفالٹ)۔ ڈیش بورڈ ای میلز 15 کریڈٹس لاگت آتی ہیں۔ مفت ٹیئر صارفین کو 403 خرابی ملے گی۔ - Example:
true
Error Responses:
- INVALID_USERNAME (400): کسٹم صارف نام کی تصدیق ناکام ہو گئی۔ صرف درست حروف کے ساتھ 3-30 حروف ہونے چاہئیں۔
- EMAIL_IN_USE (409): کسٹم صارف نام پہلے سے لیا گیا ہے۔ مختلف صارف نام منتخب کریں۔
- DOMAIN_NOT_FOUND (400): متعین کردہ ڈومین موجود نہیں ہے یا تصدیق شدہ نہیں ہے۔ پہلے اپنے اکاؤنٹ میں اس کی تصدیق کریں۔
- DOMAIN_NOT_VERIFIED (400): ڈومین موجود ہے لیکن ابھی تک تصدیق شدہ نہیں ہے۔ پہلے ڈومین کی تصدیق مکمل کریں۔
- DAILY_LIMIT_EXCEEDED (429): آپ نے اس قسم کی ای میل کی یومیہ حد پہنچ گئی ہے
Auth Required: Yes | Rate Limited: Yes | Group: Quickstart
GET/api/v1/emails
آپ کی تمام فعال عارضی ای میلز کی فہرست
Parameters:
- include_expired (query, optional): ختم ہو چکی ای میلز شامل کریں - Example:
true - permanent_only (query, optional): صرف آپ کے محفوظ شدہ مستقل ان باکس دکھائیں۔ ہر درخواست پر 2 کریڈٹ خرچ ہوتا ہے۔ - Example:
true - include_permanent (query, optional): حالیہ کے ساتھ آپ کے محفوظ شدہ مستقل ان باکس شامل کریں۔ ہر درخواست پر 2 کریڈٹ خرچ ہوتا ہے۔ - Example:
true - limit (query, optional): واپس کرنے والی ای میلز کی تعداد - Example:
50
Error Responses:
- INSUFFICIENT_CREDITS (402): محفوظ شدہ مستقل ان باکس کی فہرست بنانے کی کوشش کرتے وقت واپس کیا گیا لیکن اکاؤنٹ میں ناکافی کریڈٹ ہیں۔
Auth Required: Yes | Rate Limited: No | Group: Emails
GET/api/v1/emails/{id}
مخصوص ای میل کی تفصیلات حاصل کریں
Parameters:
- id (path, required): ای میل ID - Example:
550e8400-e29b-41d4-a716-446655440000
Error Responses:
- EMAIL_NOT_FOUND (404): ای میل ID غلط ہے یا ای میل ختم ہو گئی
Auth Required: Yes | Rate Limited: No | Group: Emails
GET/api/v1/emails/{id}/messages
مخصوص ای میل کے لیے پیغامات حاصل کریں
Parameters:
- id (path, required): ای میل ID - Example:
550e8400-e29b-41d4-a716-446655440000 - limit (query, optional): واپس کرنے والے پیغامات کی تعداد - Example:
50 - offset (query, optional): چھوڑنے والے پیغامات کی تعداد - Example:
0
Error Responses:
- EMAIL_NOT_FOUND (404): ای میل ID غلط ہے یا ای میل ختم ہو گئی
- INVALID_LIMIT (400): حد کا پیرامیٹر درست رینج سے باہر ہے
Auth Required: Yes | Rate Limited: No | Group: Emails
DELETE/api/v1/emails/{id}
ID کے ذریعے ای میل حذف کریں۔ وقت پر مبنی API ای میلز (میموری میں، فوری طور پر حذف) اور ڈیش بورڈ ای میلز (ڈیٹا بیس میں محفوظ، فوری طور پر حذف) دونوں کی حمایت کرتا ہے۔ ای میل نہیں ملی یا پہلے سے حذف ہو گئی ہو تو 404 واپس کرتا ہے۔
Parameters:
- id (path, required): ای میل ID (UUID فارمیٹ)۔ وقت پر مبنی API ای میل ID یا create_as_dashboard=true کے ساتھ بنایا گیا ڈیش بورڈ ای میل ID ہو سکتا ہے - Example:
550e8400-e29b-41d4-a716-446655440000
Error Responses:
- EMAIL_NOT_FOUND (404): ای میل موجود نہیں ہے یا پہلے سے حذف ہو گئی ہے
Auth Required: Yes | Rate Limited: No | Group: Emails
GET/api/v1/emails
💎 پریمیم فیچر - ڈیش بورڈ میں بنائی گئی ای میلز سمیت تمام ای میلز کی فہرست بنائیں۔ یہ اینڈ پوائنٹ API سے بنائی گئی ای میلز کو آپ کی ڈیش بورڈ ای میلز کے ساتھ ایک جواب میں ضم کرتا ہے۔ ہر درخواست پر 2 کریڈٹ خرچ ہوتا ہے۔ بیسک پلان یا اس سے اوپر کی ضرورت ہے۔
Parameters:
- include_dashboard (query, required): ڈیش بورڈ ای میلز تک رسائی کے لیے "true" پر سیٹ ہونا چاہیے۔ یہ پریمیم فیچر کو فعال کرتا ہے اور 2 کریڈٹس چارج کرتا ہے۔ - Example:
true - include_expired (query, optional): جواب میں ختم ہو چکی ای میلز شامل کریں (API اور ڈیش بورڈ ای میلز دونوں) - Example:
false - limit (query, optional): واپس کرنے والی ای میلز کی زیادہ سے زیادہ تعداد (زیادہ سے زیادہ: 100) - Example:
50
Error Responses:
- TIER_RESTRICTED (403): یہ ایک پریمیم فیچر ہے۔ مفت ٹیئر صارفین API کے ذریعے ڈیش بورڈ ای میلز تک رسائی حاصل نہیں کر سکتے۔
- INSUFFICIENT_CREDITS (402): یہ آپریشن 2 کریڈٹس لاگت آتی ہے۔ براہ کرم اپنے اکاؤنٹ میں مزید کریڈٹس شامل کریں۔
Auth Required: Yes | Rate Limited: Yes | Group: Dashboard
GET/api/v1/emails/{id}
💎 پریمیم فیچر - مخصوص ڈیش بورڈ ای میل کی تفصیلی معلومات حاصل کریں۔ اگر ای میل API اسٹور میں نہیں ملی، یہ آپ کی ڈیش بورڈ ای میلز میں تلاش کرتا ہے۔ ہر درخواست پر 1 کریڈٹ خرچ ہوتا ہے۔ بیسک پلان یا اس سے اوپر کی ضرورت ہے۔
Parameters:
- id (path, required): ڈیش بورڈ ای میل ID (UUID فارمیٹ) - یہ اپنے ڈیش بورڈ یا list-dashboard-emails اینڈ پوائنٹ سے کاپی کریں - Example:
550e8400-e29b-41d4-a716-446655440000 - include_dashboard (query, required): ڈیش بورڈ ای میلز تلاش کرنے کے لیے "true" ہونا چاہیے۔ 1 کریڈٹ چارج کرتا ہے۔ - Example:
true
Error Responses:
- TIER_RESTRICTED (403): ڈیش بورڈ ای میل تک رسائی کے لیے ادا شدہ پلان کی ضرورت ہے
- INSUFFICIENT_CREDITS (402): یہ آپریشن 1 کریڈٹ لاگت آتی ہے
- EMAIL_NOT_FOUND (404): مطلوبہ ای میل نہیں ملی یا ختم ہو گئی
Auth Required: Yes | Rate Limited: Yes | Group: Dashboard
GET/api/v1/emails/{id}/messages
💎 پریمیم فیچر - پیجینیشن کی حمایت کے ساتھ ڈیش بورڈ ای میل کے لیے موصول تمام پیغامات حاصل کریں۔ تیز جوابی اوقات کے لیے کیش استعمال کرتا ہے۔ ہر درخواست پر 1 کریڈٹ خرچ ہوتا ہے۔ بیسک پلان یا اس سے اوپر کی ضرورت ہے۔
Parameters:
- id (path, required): ڈیش بورڈ ای میل ID - ای میل کا UUID جس کے لیے آپ پیغامات حاصل کرنا چاہتے ہیں - Example:
550e8400-e29b-41d4-a716-446655440000 - include_dashboard (query, required): ڈیش بورڈ ای میل پیغامات تک رسائی کے لیے "true" ہونا چاہیے۔ 1 کریڈٹ چارج کرتا ہے۔ - Example:
true - limit (query, optional): فی صفحہ واپس کرنے والے پیغامات کی زیادہ سے زیادہ تعداد (زیادہ سے زیادہ: 100) - Example:
20 - offset (query, optional): پیجینیشن کے لیے چھوڑنے والے پیغامات کی تعداد (مثلاً، offset=20 اور limit=20 صفحہ 2 حاصل کرتا ہے) - Example:
0
Error Responses:
- TIER_RESTRICTED (403): ڈیش بورڈ ای میل تک رسائی کے لیے ادا شدہ پلان کی ضرورت ہے
- INSUFFICIENT_CREDITS (402): یہ آپریشن 1 کریڈٹ لاگت آتی ہے
- EMAIL_NOT_FOUND (404): مطلوبہ ای میل نہیں ملی یا ختم ہو گئی
Auth Required: Yes | Rate Limited: Yes | Group: Dashboard
GET/api/v1/emails/{id}/telegram-forwarding
Premium Feature - Get Telegram forwarding status for a specific owned mailbox. Supports dashboard mailboxes and permanent API mailboxes. Ownership is checked through the existing cached mailbox lookup paths, and forwarding state is returned from the forwarding cache. Costs 2 credits per request. Requires Basic plan or higher.
Parameters:
- id (path, required): Mailbox ID - Use a dashboard mailbox ID or a permanent API mailbox ID whose Telegram forwarding status you want to inspect - Example:
550e8400-e29b-41d4-a716-446655440000 - include_dashboard (query, required): Must be set to "true" to access Telegram forwarding mailbox status. Charges 2 credits. - Example:
true
Error Responses:
- TIER_RESTRICTED (403): This is a premium feature. Free tier users cannot access dashboard email forwarding via API.
- INSUFFICIENT_CREDITS (402): This operation costs 2 credits. Please add more credits to your account.
- EMAIL_NOT_FOUND (404): The requested mailbox was not found, is unsupported, or has expired
Auth Required: Yes | Rate Limited: Yes | Group: Dashboard
POST/api/v1/emails/{id}/telegram-forwarding
Premium Feature - Enable or disable Telegram forwarding for an owned mailbox. Supports dashboard mailboxes and permanent API mailboxes, while reusing the existing forwarding cache and write-through persistence path. Costs 2 credits per request. Requires Basic plan or higher and an active Telegram binding.
Parameters:
- id (path, required): Mailbox ID - Use a dashboard mailbox ID or a permanent API mailbox ID whose Telegram forwarding you want to update - Example:
550e8400-e29b-41d4-a716-446655440000 - include_dashboard (query, required): Must be set to "true" to update Telegram mailbox forwarding. Charges 2 credits. - Example:
true - is_enabled (body, required): Boolean body field. Set true to enable forwarding or false to disable forwarding. - Example:
true
Error Responses:
- TIER_RESTRICTED (403): This is a premium feature. Free tier users cannot update dashboard email forwarding via API.
- INSUFFICIENT_CREDITS (402): This operation costs 2 credits. Please add more credits to your account.
- NO_TELEGRAM_BINDING (400): Forwarding cannot be enabled until the account has an active verified Telegram binding.
- FORWARDING_LIMIT_EXCEEDED (403): The user has reached the plan limit for active Telegram forwardings.
- EMAIL_NOT_FOUND (404): The requested mailbox was not found, is unsupported, or has expired
Auth Required: Yes | Rate Limited: Yes | Group: Dashboard
POST/api/v1/emails/telegram-forwarding/bulk-enable
Premium Feature - Bulk enable Telegram forwarding for multiple owned mailboxes in one API request. Supports dashboard mailboxes and permanent API mailboxes, reuses the existing per-email forwarding enable flow, and respects the active-forwarding limit. Costs 2 credits per request. Requires Basic plan or higher and an active Telegram binding.
Parameters:
- include_dashboard (query, required): Must be set to "true" to bulk enable Telegram mailbox forwarding. Charges 2 credits. - Example:
true - email_ids (body, required): Body field containing a non-empty array of owned mailbox IDs. In the test form, you can enter a single mailbox ID or a JSON array. - Example:
["550e8400-e29b-41d4-a716-446655440000"]
Error Responses:
- TIER_RESTRICTED (403): This is a premium feature. Free tier users cannot bulk enable dashboard email forwarding via API.
- INSUFFICIENT_CREDITS (402): This operation costs 2 credits total per bulk request.
- NO_TELEGRAM_BINDING (400): Forwarding cannot be enabled until the account has an active verified Telegram binding.
- FORWARDING_LIMIT_EXCEEDED (403): The user has reached the plan limit for active Telegram forwardings.
- EMAIL_NOT_FOUND (404): No matching forwardable mailboxes were found.
Auth Required: Yes | Rate Limited: Yes | Group: Dashboard
POST/api/v1/emails/create
💎 پریمیم فیچر - اختیاری کسٹم صارف نام کے ساتھ نیا ای میل بنائیں۔ ڈیش بورڈ ای میلز (create_as_dashboard=true) 2 ماہ کی مقرر میعاد ختم کے ساتھ DB میں محفوظ ہیں اور 15 کریڈٹس لاگت آتی ہیں۔ وقت پر مبنی API ای میلز کسٹم وقت کے اختیارات (10min, 1hour, 1day, permanent) کی حمایت کرتی ہیں۔ دونوں custom_username کی حمایت کرتے ہیں۔ بیسک پلان یا اس سے اوپر کی ضرورت ہے۔
Parameters:
- create_as_dashboard (query, optional): 2 ماہ کی مقرر میعاد ختم کے ساتھ ڈیٹا بیس میں محفوظ ڈیش بورڈ سٹائل ای میل بنانے کے لیے "true" پر سیٹ کریں۔ اگر چھوڑ دیا گیا، میموری میں وقت پر مبنی API ای میل بناتا ہے۔ دونوں custom_username کی حمایت کرتے ہیں۔ - Example:
true - custom_username (query, optional): ای میل ایڈریس کے لیے اختیاری کسٹم صارف نام۔ حروف، نمبر، ڈاٹس، ہائفنز اور انڈر سکورز شامل ہو سکتے ہیں۔ 3-30 حروف ہونے چاہئیں۔ اگر چھوڑ دیا گیا، ایک بے ترتیب صارف نام بنایا جائے گا۔ - Example:
john.doe - domain (query, optional): ای میل ایڈریس کے لیے اختیاری کسٹم ڈومین نام۔ اگر متعین نہیں کیا گیا، ایک بے ترتیب عوامی ڈومین استعمال ہوگا۔ - Example:
mail.yourdomain.com
Error Responses:
- TIER_RESTRICTED (403): ڈیش بورڈ ای میل بنانے کے لیے ادا شدہ پلان کی ضرورت ہے
- INSUFFICIENT_CREDITS (402): یہ آپریشن 15 کریڈٹس لاگت آتی ہے
- INVALID_USERNAME (400): کسٹم صارف نام کی تصدیق ناکام ہو گئی۔ صرف درست حروف کے ساتھ 3-30 حروف ہونے چاہئیں۔
- EMAIL_IN_USE (409): کسٹم صارف نام پہلے سے لیا گیا ہے۔ مختلف صارف نام منتخب کریں۔
- INVALID_TIME_PARAMETER (400): وقت یہ میں سے ایک ہونا چاہیے: 10min, 1hour, 1day, permanent
Auth Required: Yes | Rate Limited: Yes | Group: Dashboard
GET/api/v1/account/usage
آپ کے API استعمال کی رپورٹ حاصل کریں
Error Responses:
- UNAUTHORIZED (401): API کلید ضروری ہے اور درست ہونی چاہیے
Auth Required: Yes | Rate Limited: No | Group: Account
GET/api/v1/account/info
آپ کے اکاؤنٹ کی معلومات حاصل کریں
Error Responses:
- UNAUTHORIZED (401): API کلید ضروری ہے اور درست ہونی چاہیے
Auth Required: Yes | Rate Limited: No | Group: Account
GET/api/v1/account/credits
کریڈٹ بیلنس اور استعمال کی تفصیلی معلومات حاصل کریں
Error Responses:
- UNAUTHORIZED (401): API کلید ضروری ہے اور درست ہونی چاہیے
Auth Required: Yes | Rate Limited: No | Group: Account