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" لإنشاء بريد إلكتروني على نمط لوحة التحكم مخزن في قاعدة البيانات مع انتهاء صلاحية ثابت لمدة شهرين بدلاً من بريد 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): معرف البريد الإلكتروني - Example:
550e8400-e29b-41d4-a716-446655440000
Error Responses:
- EMAIL_NOT_FOUND (404): معرف البريد الإلكتروني غير صالح أو البريد منتهي الصلاحية
Auth Required: Yes | Rate Limited: No | Group: Emails
GET/api/v1/emails/{id}/messages
الحصول على رسائل لبريد إلكتروني محدد
Parameters:
- id (path, required): معرف البريد الإلكتروني - Example:
550e8400-e29b-41d4-a716-446655440000 - limit (query, optional): عدد الرسائل المراد إرجاعها - Example:
50 - offset (query, optional): عدد الرسائل المراد تخطيها - Example:
0
Error Responses:
- EMAIL_NOT_FOUND (404): معرف البريد الإلكتروني غير صالح أو البريد منتهي الصلاحية
- INVALID_LIMIT (400): معامل الحد خارج النطاق الصالح
Auth Required: Yes | Rate Limited: No | Group: Emails
DELETE/api/v1/emails/{id}
حذف بريد إلكتروني حسب المعرف. يدعم كل من رسائل API القائمة على الوقت (في الذاكرة، محذوفة فوراً) ورسائل لوحة التحكم (مخزنة في قاعدة البيانات، محذوفة فوراً). يُرجع 404 إذا لم يتم العثور على البريد الإلكتروني أو تم حذفه بالفعل.
Parameters:
- id (path, required): معرف البريد الإلكتروني (تنسيق UUID). يمكن أن يكون معرف بريد API قائم على الوقت أو معرف بريد لوحة تحكم تم إنشاؤه باستخدام create_as_dashboard=true - 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 رصيد لكل طلب. تتطلب خطة Basic أو أعلى.
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 رصيد لكل طلب. تتطلب خطة Basic أو أعلى.
Parameters:
- id (path, required): معرف بريد لوحة التحكم (تنسيق 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 رصيد لكل طلب. تتطلب خطة Basic أو أعلى.
Parameters:
- id (path, required): معرف بريد لوحة التحكم - 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) مخزنة في قاعدة البيانات مع انتهاء صلاحية ثابت لمدة شهرين وتكلف 15 رصيداً. رسائل API القائمة على الوقت تدعم خيارات وقت مخصصة (10min, 1hour, 1day, permanent). كلاهما يدعم custom_username. تتطلب خطة Basic أو أعلى.
Parameters:
- create_as_dashboard (query, optional): اضبط على "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