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): ইমেইল ঠিকানার জন্য ঐচ্ছিক কাস্টম ব্যবহারকারীর নাম। অক্ষর, সংখ্যা, ডট, হাইফেন এবং আন্ডারস্কোর থাকতে পারে। ৩-৩০ অক্ষর হতে হবে। বাদ দিলে, একটি র্যান্ডম ব্যবহারকারীর নাম তৈরি করা হবে। - Example:
john.doe - time (query, optional): মেয়াদ শেষ হওয়ার সময় - Example:
permanent - domain (query, optional): ইমেইল ঠিকানার জন্য ঐচ্ছিক কাস্টম ডোমেইন। আপনার অ্যাকাউন্টে একটি যাচাই করা ডোমেইন হতে হবে (যাচাই করতে custom_domains এন্ডপয়েন্ট ব্যবহার করুন)। নির্দিষ্ট না করলে, একটি র্যান্ডম পাবলিক ডোমেইন ব্যবহার করা হবে। - Example:
mail.yourdomain.com - create_as_dashboard (query, optional): 💎 প্রিমিয়াম ফিচার - ডাটাবেসে সংরক্ষিত ড্যাশবোর্ড-স্টাইল ইমেইল তৈরি করতে "true" সেট করুন যার স্থির ২-মাসের মেয়াদ শেষ হবে, সময়-ভিত্তিক API ইমেইলের পরিবর্তে। বাদ দিন বা সময়-ভিত্তিক ইমেইলের জন্য "false" সেট করুন (ডিফল্ট)। ড্যাশবোর্ড ইমেইল ১৫ ক্রেডিট খরচ করে। ফ্রি টিয়ার ব্যবহারকারীরা ৪০৩ এরর পাবে। - Example:
true
Error Responses:
- INVALID_USERNAME (400): কাস্টম ব্যবহারকারীর নাম যাচাইকরণ ব্যর্থ হয়েছে। শুধুমাত্র বৈধ অক্ষর সহ ৩-৩০ অক্ষর হতে হবে।
- 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 ইমেইল (মেমোরিতে, সঙ্গে সঙ্গে মুছে যায়) এবং ড্যাশবোর্ড ইমেইল (ডাটাবেস-সংরক্ষিত, সঙ্গে সঙ্গে মুছে যায়) উভয়ই সমর্থন করে। ইমেইল পাওয়া না গেলে বা ইতিমধ্যে মুছে গেলে ৪০৪ রিটার্ন করে।
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-তৈরি ইমেইলগুলিকে আপনার ড্যাশবোর্ড ইমেইলগুলির সাথে একক রেসপন্সে একত্রিত করে। প্রতি অনুরোধে ২ ক্রেডিট খরচ হয়। বেসিক প্ল্যান বা উচ্চতর প্রয়োজন।
Parameters:
- include_dashboard (query, required): ড্যাশবোর্ড ইমেইল অ্যাক্সেস করতে অবশ্যই "true" সেট করতে হবে। এটি প্রিমিয়াম ফিচার সক্রিয় করে এবং ২ ক্রেডিট চার্জ করে। - Example:
true - include_expired (query, optional): রেসপন্সে মেয়াদ শেষ হওয়া ইমেইল অন্তর্ভুক্ত করুন (API এবং ড্যাশবোর্ড ইমেইল উভয়ই) - Example:
false - limit (query, optional): ফেরত দেওয়ার জন্য সর্বোচ্চ ইমেইল সংখ্যা (সর্বোচ্চ: ১০০) - Example:
50
Error Responses:
- TIER_RESTRICTED (403): এটি একটি প্রিমিয়াম ফিচার। ফ্রি টিয়ার ব্যবহারকারীরা API এর মাধ্যমে ড্যাশবোর্ড ইমেইল অ্যাক্সেস করতে পারবে না।
- INSUFFICIENT_CREDITS (402): এই অপারেশন ২ ক্রেডিট খরচ করে। অনুগ্রহ করে আপনার অ্যাকাউন্টে আরও ক্রেডিট যোগ করুন।
Auth Required: Yes | Rate Limited: Yes | Group: Dashboard
GET/api/v1/emails/{id}
💎 প্রিমিয়াম ফিচার - একটি নির্দিষ্ট ড্যাশবোর্ড ইমেইলের বিস্তারিত তথ্য পান। যদি ইমেইল API স্টোরে পাওয়া না যায়, এটি আপনার ড্যাশবোর্ড ইমেইলগুলিতে অনুসন্ধান করে। প্রতি অনুরোধে ১ ক্রেডিট খরচ হয়। বেসিক প্ল্যান বা উচ্চতর প্রয়োজন।
Parameters:
- id (path, required): ড্যাশবোর্ড ইমেইল ID (UUID ফরম্যাট) - এটি আপনার ড্যাশবোর্ড বা list-dashboard-emails এন্ডপয়েন্ট থেকে কপি করুন - Example:
550e8400-e29b-41d4-a716-446655440000 - include_dashboard (query, required): ড্যাশবোর্ড ইমেইল অনুসন্ধান করতে অবশ্যই "true" হতে হবে। ১ ক্রেডিট চার্জ করে। - Example:
true
Error Responses:
- TIER_RESTRICTED (403): ড্যাশবোর্ড ইমেইল অ্যাক্সেসের জন্য একটি পেইড প্ল্যান প্রয়োজন
- INSUFFICIENT_CREDITS (402): এই অপারেশন ১ ক্রেডিট খরচ করে
- EMAIL_NOT_FOUND (404): অনুরোধ করা ইমেইল পাওয়া যায়নি বা মেয়াদ শেষ হয়ে গেছে
Auth Required: Yes | Rate Limited: Yes | Group: Dashboard
GET/api/v1/emails/{id}/messages
💎 প্রিমিয়াম ফিচার - পেজিনেশন সমর্থন সহ একটি ড্যাশবোর্ড ইমেইলের জন্য প্রাপ্ত সমস্ত বার্তা পুনরুদ্ধার করুন। দ্রুত রেসপন্স সময়ের জন্য ক্যাশ ব্যবহার করে। প্রতি অনুরোধে ১ ক্রেডিট খরচ হয়। বেসিক প্ল্যান বা উচ্চতর প্রয়োজন।
Parameters:
- id (path, required): ড্যাশবোর্ড ইমেইল ID - যে ইমেইলের জন্য আপনি বার্তা আনতে চান তার UUID - Example:
550e8400-e29b-41d4-a716-446655440000 - include_dashboard (query, required): ড্যাশবোর্ড ইমেইল বার্তা অ্যাক্সেস করতে অবশ্যই "true" হতে হবে। ১ ক্রেডিট চার্জ করে। - Example:
true - limit (query, optional): প্রতি পেজে ফেরত দেওয়ার জন্য সর্বোচ্চ বার্তা সংখ্যা (সর্বোচ্চ: ১০০) - Example:
20 - offset (query, optional): পেজিনেশনের জন্য এড়িয়ে যাওয়ার জন্য বার্তা সংখ্যা (যেমন, offset=20 এবং limit=20 দিয়ে পেজ ২ পাওয়া যায়) - Example:
0
Error Responses:
- TIER_RESTRICTED (403): ড্যাশবোর্ড ইমেইল অ্যাক্সেসের জন্য একটি পেইড প্ল্যান প্রয়োজন
- INSUFFICIENT_CREDITS (402): এই অপারেশন ১ ক্রেডিট খরচ করে
- 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) স্থির ২-মাসের মেয়াদ শেষ সহ DB-তে সংরক্ষিত হয় এবং ১৫ ক্রেডিট খরচ করে। সময়-ভিত্তিক API ইমেইল কাস্টম সময় বিকল্প সমর্থন করে (10min, 1hour, 1day, permanent)। উভয়ই custom_username সমর্থন করে। বেসিক প্ল্যান বা উচ্চতর প্রয়োজন।
Parameters:
- create_as_dashboard (query, optional): স্থির ২-মাসের মেয়াদ শেষ সহ ডাটাবেসে সংরক্ষিত একটি ড্যাশবোর্ড-স্টাইল ইমেইল তৈরি করতে "true" সেট করুন। বাদ দিলে, মেমোরিতে একটি সময়-ভিত্তিক API ইমেইল তৈরি করে। উভয়ই custom_username সমর্থন করে। - Example:
true - custom_username (query, optional): ইমেইল ঠিকানার জন্য ঐচ্ছিক কাস্টম ব্যবহারকারীর নাম। অক্ষর, সংখ্যা, ডট, হাইফেন এবং আন্ডারস্কোর থাকতে পারে। ৩-৩০ অক্ষর হতে হবে। বাদ দিলে, একটি র্যান্ডম ব্যবহারকারীর নাম তৈরি করা হবে। - Example:
john.doe - domain (query, optional): ইমেইল ঠিকানার জন্য ঐচ্ছিক কাস্টম ডোমেইন নাম। নির্দিষ্ট না করলে, একটি র্যান্ডম পাবলিক ডোমেইন ব্যবহার করা হবে। - Example:
mail.yourdomain.com
Error Responses:
- TIER_RESTRICTED (403): ড্যাশবোর্ড ইমেইল তৈরি করার জন্য একটি পেইড প্ল্যান প্রয়োজন
- INSUFFICIENT_CREDITS (402): এই অপারেশন ১৫ ক্রেডিট খরচ করে
- INVALID_USERNAME (400): কাস্টম ব্যবহারকারীর নাম যাচাইকরণ ব্যর্থ হয়েছে। শুধুমাত্র বৈধ অক্ষর সহ ৩-৩০ অক্ষর হতে হবে।
- 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