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): 💎 प्रीमियम सुविधा - समय-आधारित API ईमेल के बजाय 2 महीने की निश्चित समाप्ति के साथ डेटाबेस में संग्रहीत डैशबोर्ड-शैली ईमेल बनाने के लिए "true" पर सेट करें। समय-आधारित ईमेल के लिए छोड़ दें या "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