واجهة برمجة تطبيقات البريد الإلكتروني

المكتبات

لم نُصدر حتى الآن أي غلافات لواجهات برمجة التطبيقات، لكننا نخطط لذلك قريبًا. أرسل بريدًا إلكترونيًا إلى [email protected] إذا كنت ترغب في تلقي إشعار عند إصدار غلاف واجهة برمجة التطبيقات (API) الخاص بلغة برمجة معينة. في هذه الأثناء، يمكنك استخدام مكتبات طلبات HTTP الموصى بها في تطبيقك، أو ببساطة استخدام حليقة كما هو الحال في الأمثلة أدناه.

لغة	مكتبة
روبي	فاراداي
بايثون	الطلبات
جافا	أوكهتب
PHP	أسرف في الشراب
جافا سكريبت	عامل فائق (نحن الصيانة)
Node.js	عامل فائق (نحن الصيانة)
يذهب	net/http
.NET	ريست شارب

عنوان URI الأساسي

مسار URI الأساسي HTTP الحالي هو: https://api.forwardemail.net.

المصادقة

تتطلب جميع نقاط النهاية الخاصة بك مفتاح API ليتم تعيينه كقيمة "اسم المستخدم" للطلب التفويض الأساسي الرأس (باستثناء جهات اتصال مستعارة, تقويمات الأسماء المستعارة، و صناديق البريد المستعارة التي تستخدم تم إنشاء اسم المستخدم وكلمة المرور المستعارة)..

لا تقلق - فيما يلي أمثلة لك إذا لم تكن متأكدًا مما يعنيه هذا.

الأخطاء

في حالة حدوث أي أخطاء، سيحتوي نص الاستجابة لطلب واجهة برمجة التطبيقات على رسالة خطأ مفصلة.

شفرة	اسم
200	OK
400	اقتراح غير جيد
401	غير مصرح به
403	مُحرَّم
404	لم يتم العثور عليه
429	طلبات كثيرة جدًا
500	خطأ في الخادم الداخلي
501	لم يتم التنفيذ
502	بوابة سيئة
503	الخدمة غير متوفرة
504	مهلة البوابة

[نصيحة!] إذا تلقيت رمز حالة 5xx (وهو أمر غير متوقع)، يُرجى التواصل معنا على [email protected] وسنساعدك على حل مشكلتك على الفور.

التوطين

تُترجم خدمتنا إلى أكثر من 25 لغة مختلفة. تُترجم جميع رسائل استجابة واجهة برمجة التطبيقات (API) إلى آخر إعدادات محلية تم اكتشافها للمستخدم الذي يُجري طلب واجهة برمجة التطبيقات. يمكنك تجاوز ذلك بتمرير أمر مخصص. Accept-Language لا تتردد في تجربته باستخدام القائمة المنسدلة للغة أسفل هذه الصفحة.

الترقيم الصفحي

[ملاحظة!] اعتبارًا من 1 نوفمبر 2024، نقاط نهاية واجهة برمجة التطبيقات لـ قائمة المجالات و قائمة أسماء النطاقات المستعارة سوف يتم تعيينه افتراضيا إلى 1000 الحد الأقصى للنتائج في الصفحة. إذا كنت ترغب في الاشتراك في هذا السلوك مبكرًا، يمكنك المرور ?paginate=true كمعلمة سلسلة استعلام إضافية لعنوان URL لاستعلام نقطة النهاية.

يتم دعم الترقيم الصفحي من قبل جميع نقاط نهاية واجهة برمجة التطبيقات التي تسرد النتائج.

قم ببساطة بتوفير خصائص سلسلة الاستعلام page (واختياريا limit).

العقار page يجب أن يكون الرقم أكبر من أو يساوي 1. إذا قمت بتوفير limit (أيضًا رقم)، ثم تكون القيمة الدنيا هي 10 والحد الأقصى هو 50 (ما لم يُذكر خلاف ذلك).

معلمات سلسلة الاستعلام	مطلوب	يكتب	وصف
`page`	لا	رقم	صفحة النتائج المراد إرجاعها. إذا لم يتم تحديدها، `page` القيمة ستكون `1`. يجب أن يكون رقمًا أكبر من أو يساوي `1`.
`limit`	لا	رقم	عدد النتائج المعروضة في كل صفحة. الافتراضي هو `10` إذا لم يتم تحديده، يجب أن يكون الرقم أكبر من أو يساوي `1`، وأقل من أو يساوي `50`.

لتحديد ما إذا كانت هناك نتائج أخرى متاحة أم لا، فإننا نوفر رؤوس استجابة HTTP التالية (والتي يمكنك تحليلها من أجل تقسيم الصفحات برمجيًا):

رأس استجابة HTTP	مثال	وصف
`X-Page-Count`	`X-Page-Count: 3`	إجمالي عدد الصفحات المتاحة.
`X-Page-Current`	`X-Page-Current: 1`	الصفحة الحالية للنتائج التي تم إرجاعها (على سبيل المثال، استنادًا إلى `page` معلمات سلسلة الاستعلام).
`X-Page-Size`	`X-Page-Size: 10`	العدد الإجمالي للنتائج في الصفحة التي تم إرجاعها (على سبيل المثال، بناءً على `limit` معلمة سلسلة الاستعلام والنتائج الفعلية التي تم إرجاعها).
`X-Item-Count`	`X-Item-Count: 30`	العدد الإجمالي للعناصر المتوفرة في جميع الصفحات.
`Link`	`Link: <https://api.forwardemail.net/v1/emails?page=1>; rel="prev", <https://api.forwardemail.net/v1/emails?page=3>; rel="next", <https://api.forwardemail.net/v1/emails?page=3; rel="last", https://api.forwardemail.net/v1/emails?page=1; rel="first"`	نحن نقدم `Link` يمكنك تحليل رأس استجابة HTTP كما هو موضح في المثال. هذا هو مشابه لـ GitHub (على سبيل المثال، لن يتم توفير جميع القيم إذا لم تكن ذات صلة أو متاحة، على سبيل المثال `"next"` لن يتم توفيرها إذا لم تكن هناك صفحة أخرى).

مثال على الطلب:

curl https://api.forwardemail.net/v1/domains/example.com/aliases?page=2&pagination=true \
  -u API_TOKEN:

السجلات

استرجاع السجلات

تتيح لك واجهة برمجة التطبيقات (API) الخاصة بنا تنزيل سجلات حسابك برمجيًا. سيؤدي إرسال طلب إلى هذه النقطة النهائية إلى معالجة جميع سجلات حسابك وإرسالها إليك عبر البريد الإلكتروني كمرفق (جي زيب مضغوط CSV ملف جدول البيانات) بمجرد اكتماله.

يتيح لك هذا إنشاء وظائف خلفية باستخدام مهمة كرون أو باستخدام موقعنا برنامج جدولة المهام Node.js Bree لتلقي السجلات وقتما تشاء. لاحظ أن هذه النقطة النهائية محدودة بـ 10 طلبات يوميا.

المرفق هو الشكل الصغير لـ email-deliverability-logs-YYYY-MM-DD-h-mm-A-z.csv.gz ويحتوي البريد الإلكتروني نفسه على ملخص موجز للسجلات المسترجعة. يمكنك أيضًا تنزيل السجلات في أي وقت من حسابي → السجلات

GET /v1/logs/download

معلمات سلسلة الاستعلام	مطلوب	يكتب	وصف
`domain`	لا	سلسلة (FQDN)	تصفية السجلات حسب النطاق المؤهل بالكامل ("FQDN"). إذا لم تُوفِّر هذه الميزة، فسيتم استرداد جميع السجلات عبر جميع النطاقات.
`q`	لا	خيط	البحث عن السجلات حسب البريد الإلكتروني أو المجال أو الاسم المستعار أو عنوان IP أو التاريخ (`M/Y`, `M/D/YY`, `M-D`, `M-D-YY`، أو `M.D.YY` شكل).
`bounce_category`	لا	خيط	ابحث عن السجلات حسب فئة الارتداد المحددة (على سبيل المثال `blocklist`).
`response_code`	لا	رقم	البحث عن السجلات بواسطة رمز استجابة خطأ محدد (على سبيل المثال `421` أو `550`).

مثال على الطلب:

curl https://api.forwardemail.net/v1/logs/download \
  -u API_TOKEN:

مثال على مهمة Cron (في منتصف الليل كل يوم):

0 0 * * * /usr/bin/curl https://api.forwardemail.net/v1/logs/download -u API_TOKEN: &>/dev/null

لاحظ أنه يمكنك استخدام خدمات مثل Crontab.guru للتحقق من صحة صيغة تعبير مهمة cron الخاصة بك.

مثال على مهمة Cron (في منتصف الليل كل يوم ومع سجلات اليوم السابق):

بالنسبة لنظام MacOS:

0 0 * * * /usr/bin/curl https://api.forwardemail.net/v1/logs/download?q=`date -v-1d -u "+%-m/%-d/%y"` -u API_TOKEN: &>/dev/null

بالنسبة إلى Linux و Ubuntu:

0 0 * * * /usr/bin/curl https://api.forwardemail.net/v1/logs/download?q=`date --date "-1 days" -u "+%-m/%-d/%y"` -u API_TOKEN: &>/dev/null

حساب

إنشاء حساب

POST /v1/account

معلمة الجسم	مطلوب	يكتب	وصف
`email`	نعم	سلسلة (البريد الإلكتروني)	عنوان البريد الإلكتروني
`password`	نعم	خيط	كلمة المرور

مثال على الطلب:

curl -X POST https://api.forwardemail.net/v1/account \
  -u API_TOKEN: \
  -d "email=user%40gmail.com"

استرداد الحساب

GET /v1/account

مثال على الطلب:

curl https://api.forwardemail.net/v1/account \
  -u API_TOKEN:

تحديث الحساب

PUT /v1/account

معلمة الجسم	مطلوب	يكتب	وصف
`email`	لا	سلسلة (البريد الإلكتروني)	عنوان البريد الإلكتروني
`given_name`	لا	خيط	الاسم الأول
`family_name`	لا	خيط	اسم العائلة
`avatar_url`	لا	سلسلة (عنوان URL)	رابط لصورة الرمزية

مثال على الطلب:

curl -X PUT https://api.forwardemail.net/v1/account \
  -u API_TOKEN: \
  -d "email=user%40gmail.com"

جهات اتصال مستعارة (CardDAV)

[ملاحظة!] على عكس نقاط نهاية واجهة برمجة التطبيقات الأخرى، تتطلب هذه المصادقة "اسم المستخدم" يساوي اسم المستخدم المستعار و"كلمة المرور" تساوي كلمة المرور المستعارة التي تم إنشاؤها كرؤوس تفويض أساسية.

[!تحذير] هذا القسم الخاص بنقطة النهاية قيد التطوير، ومن المؤمل إصداره في عام ٢٠٢٤. في هذه الأثناء، يُرجى استخدام برنامج IMAP من قائمة "التطبيقات" المنسدلة في شريط التنقل بموقعنا الإلكتروني.

قائمة جهات الاتصال

GET /v1/contacts

قريباً

إنشاء جهة اتصال

POST /v1/contacts

قريباً

استرجاع جهة الاتصال

GET /v1/contacts/:id

قريباً

تحديث جهة الاتصال

PUT /v1/contacts/:id

قريباً

حذف جهة الاتصال

DELETE /v1/contacts/:id

قريباً

تقويمات الاسم المستعار (CalDAV)

[ملاحظة!] على عكس نقاط نهاية واجهة برمجة التطبيقات الأخرى، تتطلب هذه المصادقة "اسم المستخدم" يساوي اسم المستخدم المستعار و"كلمة المرور" تساوي كلمة المرور المستعارة التي تم إنشاؤها كرؤوس تفويض أساسية.

[!تحذير] هذا القسم الخاص بنقطة النهاية قيد التطوير، ومن المؤمل إصداره في عام ٢٠٢٤. في هذه الأثناء، يُرجى استخدام برنامج IMAP من قائمة "التطبيقات" المنسدلة في شريط التنقل بموقعنا الإلكتروني.

قائمة التقويمات

GET /v1/calendars

قريباً

إنشاء التقويم

POST /v1/calendars

قريباً

استرجاع التقويم

GET /v1/calendars/:id

قريباً

تحديث التقويم

PUT /v1/calendars/:id

قريباً

حذف التقويم

DELETE /v1/calendars/:id

قريباً

رسائل الاسم المستعار (IMAP/POP3)

[ملاحظة!] على عكس نقاط نهاية واجهة برمجة التطبيقات الأخرى، تتطلب هذه المصادقة "اسم المستخدم" يساوي اسم المستخدم المستعار و"كلمة المرور" تساوي كلمة المرور المستعارة التي تم إنشاؤها كرؤوس تفويض أساسية.

[!تحذير] هذا القسم الخاص بنقطة النهاية قيد التطوير، ومن المؤمل إصداره في عام ٢٠٢٤. في هذه الأثناء، يُرجى استخدام برنامج IMAP من قائمة "التطبيقات" المنسدلة في شريط التنقل بموقعنا الإلكتروني.

يرجى التأكد من أنك اتبعت تعليمات الإعداد الخاصة بنطاقك.

يمكن العثور على هذه التعليمات في قسم الأسئلة الشائعة لدينا هل تدعم تلقي البريد الإلكتروني باستخدام IMAP؟.

قائمة الرسائل والبحث عنها

GET /v1/messages

قريباً

إنشاء رسالة

[ملاحظة!] سيتم ذلك NOT إرسال بريد إلكتروني - سيؤدي ذلك ببساطة إلى إضافة الرسالة إلى مجلد صندوق البريد الخاص بك (على سبيل المثال، هذا مشابه لبروتوكول IMAP APPEND إذا كنت ترغب في إرسال بريد إلكتروني، فراجع إنشاء بريد إلكتروني SMTP صادر بعد إنشاء بريد SMTP الصادر، يمكنك إضافة نسخة منه باستخدام هذه النقطة النهائية إلى صندوق بريد اسمك المستعار لأغراض التخزين.

POST /v1/messages

قريباً

استرجاع الرسالة

GET /v1/messages/:id

قريباً

تحديث الرسالة

PUT /v1/messages/:id

قريباً

حذف الرسالة

DELETE /v1/messages:id

قريباً

مجلدات الأسماء المستعارة (IMAP/POP3)

[!TIP] نهايات المجلدات مع مسار المجلد /v1/folders/:path حيث أن نقطة النهاية الخاصة بهم قابلة للتبديل مع معرف المجلد :id. وهذا يعني أنه يمكنك الرجوع إلى المجلد إما عن طريق اسمه أو عنوانه. path أو id قيمة.

[!تحذير] هذا القسم الخاص بنقطة النهاية قيد التطوير، ومن المؤمل إصداره في عام ٢٠٢٤. في هذه الأثناء، يُرجى استخدام برنامج IMAP من قائمة "التطبيقات" المنسدلة في شريط التنقل بموقعنا الإلكتروني.

قائمة المجلدات

GET /v1/folders

قريباً

إنشاء مجلد

POST /v1/folders

قريباً

استرجاع المجلد

GET /v1/folders/:id

قريباً

تحديث المجلد

PUT /v1/folders/:id

قريباً

حذف المجلد

DELETE /v1/folders/:id

قريباً

نسخ المجلد

POST /v1/folders/:id/copy

قريباً

رسائل البريد الإلكتروني الصادرة

يرجى التأكد من أنك اتبعت تعليمات الإعداد الخاصة بنطاقك.

يمكن العثور على هذه التعليمات في حسابي ← النطاقات ← الإعدادات ← تكوين SMTP الصادريجب عليك التأكد من إعداد DKIM وReturn-Path وDMARC لإرسال SMTP الصادر مع نطاقك.

الحصول على حد البريد الإلكتروني الصادر SMTP

هذه نقطة نهاية بسيطة تقوم بإرجاع كائن JSON يحتوي على count و limit لعدد رسائل SMTP الصادرة يوميًا على أساس كل حساب.

GET /v1/emails/limit

مثال على الطلب:

curl https://api.forwardemail.net/v1/emails/limit \
  -u API_TOKEN:

قائمة رسائل البريد الإلكتروني الصادرة SMTP

لاحظ أن نقطة النهاية هذه لا تقوم بإرجاع قيم الخصائص لرسائل البريد الإلكتروني message, headers، ولا rejectedErrors.

لإرجاع تلك الخصائص وقيمها، يرجى استخدام استرجاع البريد الإلكتروني نقطة نهاية مع معرف البريد الإلكتروني.

GET /v1/emails

معلمات سلسلة الاستعلام	مطلوب	يكتب	وصف
`q`	لا	سلسلة (مدعومة بـ RegExp)	البحث عن رسائل البريد الإلكتروني حسب البيانات الوصفية
`domain`	لا	سلسلة (مدعومة بـ RegExp)	البحث عن رسائل البريد الإلكتروني حسب اسم النطاق
`sort`	لا	خيط	فرز حسب حقل معين (بادئة بواصلة واحدة) `-` (للفرز في الاتجاه المعاكس لهذا الحقل). الافتراضي هو `created_at` إذا لم يتم ضبطه.
`page`	لا	رقم	يرى الترقيم الصفحي لمزيد من المعرفة
`limit`	لا	رقم	يرى الترقيم الصفحي لمزيد من المعرفة

مثال على الطلب:

curl https://api.forwardemail.net/v1/emails?limit=1 \
  -u API_TOKEN:

إنشاء بريد إلكتروني SMTP صادر

واجهة برمجة التطبيقات (API) الخاصة بنا لإنشاء بريد إلكتروني مستوحاة من إعدادات خيارات الرسائل في Nodemailer وتستفيد منها. يُرجى مراجعة تكوين رسالة Nodemailer لجميع معلمات الجسم أدناه.

لاحظ أنه باستثناء envelope و dkim (بما أننا نُعيّنها لك تلقائيًا)، فنحن ندعم جميع خيارات Nodemailer. نُعيّنها تلقائيًا disableFileAccess و disableUrlAccess خيارات ل true لأغراض أمنية.

يجب عليك إما اجتياز الخيار الفردي raw مع بريدك الإلكتروني الخام الكامل بما في ذلك العناوين أو مرر خيارات معلمات الجسم الفردية أدناه.

ستقوم نقطة نهاية واجهة برمجة التطبيقات هذه بترميز الرموز التعبيرية لك تلقائيًا إذا تم العثور عليها في الرؤوس (على سبيل المثال سطر موضوع Subject: 🤓 Hello يتم تحويله إلى Subject: =?UTF-8?Q?=F0=9F=A4=93?= Hello كان هدفنا هو إنشاء واجهة برمجة تطبيقات بريد إلكتروني سهلة الاستخدام للغاية للمطورين ومقاومة للأخطاء.

POST /v1/emails

معلمة الجسم	مطلوب	يكتب	وصف
`from`	لا	سلسلة (البريد الإلكتروني)	عنوان البريد الإلكتروني للمرسل (يجب أن يكون موجودًا كاسم مستعار للنطاق).
`to`	لا	سلسلة أو مصفوفة	قائمة مفصولة بفاصلة أو مجموعة من المستلمين لعنوان "إلى".
`cc`	لا	سلسلة أو مصفوفة	قائمة مفصولة بفاصلة أو مجموعة من المستلمين لعنوان "Cc".
`bcc`	لا	سلسلة أو مصفوفة	قائمة مفصولة بفاصلة أو مجموعة من المستلمين لعنوان "Bcc".
`subject`	لا	خيط	موضوع البريد الإلكتروني.
`text`	لا	سلسلة أو مخزن مؤقت	النسخة النصية العادية للرسالة.
`html`	لا	سلسلة أو مخزن مؤقت	النسخة HTML من الرسالة.
`attachments`	لا	مصفوفة	مجموعة من كائنات المرفقات (انظر الحقول المشتركة في Nodemailer).
`sender`	لا	خيط	عنوان البريد الإلكتروني لرأس "المرسل" (انظر مجالات Nodemailer الأكثر تقدمًا).
`replyTo`	لا	خيط	عنوان البريد الإلكتروني لعنوان "الرد على".
`inReplyTo`	لا	خيط	معرف الرسالة التي يتم الرد عليها.
`references`	لا	سلسلة أو مصفوفة	قائمة منفصلة بمسافة أو مجموعة من معرفات الرسائل.
`attachDataUrls`	لا	منطقي	لو `true` ثم يتحول `data:` الصور الموجودة في محتوى HTML للرسالة إلى المرفقات المضمنة.
`watchHtml`	لا	خيط	إصدار HTML خاص بـ Apple Watch من الرسالة (وفقًا لوثائق Nodemailer(لا تتطلب الساعات الحديثة هذا الإعداد).
`amp`	لا	خيط	إصدار HTML خاص بـ AMP4EMAIL من الرسالة (انظر مثال Nodemailer).
`icalEvent`	لا	هدف	حدث iCalendar لاستخدامه كمحتوى رسالة بديل (انظر أحداث تقويم Nodemailer).
`alternatives`	لا	مصفوفة	مجموعة من محتوى الرسائل البديلة (انظر المحتوى البديل لـ Nodemailer).
`encoding`	لا	خيط	الترميز للنصوص وسلاسل HTML (الافتراضي هو `"utf-8"`، لكنه يدعم `"hex"` و `"base64"` (ترميز القيم أيضًا).
`raw`	لا	سلسلة أو مخزن مؤقت	رسالة مخصصة بتنسيق RFC822 لاستخدامها (بدلاً من الرسالة التي تم إنشاؤها بواسطة Nodemailer - راجع مصدر مخصص لـ Nodemailer).
`textEncoding`	لا	خيط	الترميز الذي يجب استخدامه لقيم النص (إما `"quoted-printable"` أو `"base64"`). القيمة الافتراضية هي أقرب قيمة تم اكتشافها (للاستخدام في ASCII `"quoted-printable"`).
`priority`	لا	خيط	مستوى الأولوية للبريد الإلكتروني (يمكن أن يكون إما `"high"`, `"normal"` (افتراضي)، أو `"low"`). لاحظ أن قيمة `"normal"` لا يُعيِّن رأسًا ذا أولوية (هذا هو السلوك الافتراضي). إذا كانت القيمة `"high"` أو `"low"` تم ضبطه، ثم `X-Priority`, `X-MSMail-Priority`، و `Importance` العناوين سيتم ضبطها وفقا لذلك.
`headers`	لا	كائن أو مصفوفة	كائن أو مجموعة من حقول الرأس الإضافية التي يجب تعيينها (انظر رؤوس Nodemailer المخصصة).
`messageId`	لا	خيط	قيمة معرف الرسالة الاختيارية لرأس "معرف الرسالة" (سيتم إنشاء قيمة افتراضية تلقائيًا إذا لم يتم تعيينها - لاحظ أنه يجب تعيين القيمة الالتزام بمواصفات RFC2822).
`date`	لا	سلسلة أو تاريخ	قيمة تاريخ اختيارية تُستخدم في حال فقدان عنوان التاريخ بعد التحليل، وإلا فسيتم استخدام سلسلة التوقيت العالمي المنسق (UTC) الحالية في حال عدم ضبطها. لا يمكن أن يكون عنوان التاريخ متقدمًا عن الوقت الحالي بأكثر من 30 يومًا.
`list`	لا	هدف	كائن اختياري لـ `List-*` العناوين (انظر عناوين قائمة Nodemailer).

مثال على الطلب:

curl -X POST https://api.forwardemail.net/v1/emails \
  -u API_TOKEN: \
  -d "[email protected]" \
  -d "to=user%40gmail.com" \
  -d "subject=test" \
  -d "text=test"

مثال على الطلب:

curl -X POST https://api.forwardemail.net/v1/emails \
  -u API_TOKEN: \
  -d "raw=`cat file.eml`"

استرداد البريد الإلكتروني الصادر SMTP

GET /v1/emails/:id

مثال على الطلب:

curl https://api.forwardemail.net/v1/emails/:id \
  -u API_TOKEN:

حذف البريد الإلكتروني الصادر SMTP

سيؤدي حذف البريد الإلكتروني إلى تعيين الحالة إلى "rejected" (وبعد ذلك لا تتم معالجتها في قائمة الانتظار) إذا وفقط إذا كانت الحالة الحالية هي واحدة من "pending", "queued"، أو "deferred"قد نقوم بحذف رسائل البريد الإلكتروني تلقائيًا بعد 30 يومًا من إنشائها و/أو إرسالها، لذا يُرجى الاحتفاظ بنسخة من رسائل SMTP الصادرة في عميلك أو قاعدة بياناتك أو تطبيقك. يمكنك الرجوع إلى قيمة مُعرّف البريد الإلكتروني لدينا في قاعدة بياناتك إذا رغبت في ذلك، حيث يتم إرجاع هذه القيمة من كلا الطرفين. إنشاء بريد إلكتروني و استرجاع البريد الإلكتروني نقاط النهاية.

DELETE /v1/emails/:id

مثال على الطلب:

curl -X DELETE https://api.forwardemail.net/v1/emails/:id \
  -u API_TOKEN:

المجالات

[!TIP] نقاط نهاية النطاق مع اسم النطاق /v1/domains/:domain_name حيث أن نقطة النهاية الخاصة بهم قابلة للتبديل مع معرف المجال :domain_id. وهذا يعني أنه يمكنك الإشارة إلى المجال إما عن طريق name أو id قيمة.

قائمة المجالات

[ملاحظة!] اعتبارًا من 1 نوفمبر 2024، نقاط نهاية واجهة برمجة التطبيقات لـ قائمة المجالات و قائمة أسماء النطاقات المستعارة سوف يتم تعيينه افتراضيا إلى 1000 الحد الأقصى للنتائج في الصفحة. إذا كنت ترغب في الاشتراك في هذا السلوك مبكرًا، يمكنك المرور ?paginate=true كمعامل سلسلة استعلام إضافي لعنوان URL لاستعلام نقطة النهاية. انظر الترقيم الصفحي لمزيد من التبصر.

GET /v1/domains

معلمات سلسلة الاستعلام	مطلوب	يكتب	وصف
`q`	لا	سلسلة (مدعومة بـ RegExp)	البحث عن النطاقات حسب الاسم
`name`	لا	سلسلة (مدعومة بـ RegExp)	البحث عن النطاقات حسب الاسم
`sort`	لا	خيط	فرز حسب حقل معين (بادئة بواصلة واحدة) `-` (للفرز في الاتجاه المعاكس لهذا الحقل). الافتراضي هو `created_at` إذا لم يتم ضبطه.
`page`	لا	رقم	يرى الترقيم الصفحي لمزيد من المعرفة
`limit`	لا	رقم	يرى الترقيم الصفحي لمزيد من المعرفة

مثال على الطلب:

curl https://api.forwardemail.net/v1/domains \
  -u API_TOKEN:

إنشاء المجال

POST /v1/domains

معلمة الجسم	مطلوب	يكتب	وصف
`domain`	نعم	سلسلة (FQDN أو IP)	اسم النطاق المؤهل بالكامل ("FQDN") أو عنوان IP
`team_domain`	لا	سلسلة (معرف المجال أو اسم المجال؛ FQDN)	تعيين هذا النطاق تلقائيًا للفريق نفسه من نطاق آخر. هذا يعني أن جميع أعضاء هذا النطاق سيتم تعيينهم كأعضاء في الفريق، `plan` سيتم ضبطه تلقائيًا على `team` كذلك. يمكنك ضبط هذا على `"none"` إذا لزم الأمر لتعطيل هذا صراحةً، ولكن هذا ليس ضروريًا.
`plan`	لا	سلسلة (قابلة للعد)	نوع الخطة (يجب أن يكون `"free"`, `"enhanced_protection"`، أو `"team"`، الافتراضي هو `"free"` أو خطة المستخدم المدفوعة الحالية إذا كان مشتركًا في واحدة منها)
`catchall`	لا	سلسلة (عناوين بريد إلكتروني محددة) أو قيمة منطقية	إنشاء اسم مستعار افتراضي لجميع العناصر، والافتراضي هو `true` (لو `true` سيتم استخدام عنوان البريد الإلكتروني لمستخدم واجهة برمجة التطبيقات كمستلم، وإذا `false` لن يتم إنشاء أي عناوين شاملة. إذا تم تمرير سلسلة، فستكون قائمة محددة من عناوين البريد الإلكتروني لاستخدامها كمستلمين (مفصولة بفاصل أسطر، ومسافة، و/أو فاصلة).
`has_adult_content_protection`	لا	منطقي	ما إذا كان سيتم تمكين حماية محتوى البالغين من Spam Scanner على هذا المجال
`has_phishing_protection`	لا	منطقي	ما إذا كان سيتم تمكين حماية Spam Scanner من التصيد الاحتيالي على هذا المجال
`has_executable_protection`	لا	منطقي	ما إذا كان سيتم تمكين حماية الملفات القابلة للتنفيذ من Spam Scanner على هذا المجال
`has_virus_protection`	لا	منطقي	ما إذا كان سيتم تمكين الحماية من الفيروسات من خلال Spam Scanner على هذا المجال
`has_recipient_verification`	لا	منطقي	النطاق العالمي الافتراضي لمعرفة ما إذا كان يجب على مستلمي الأسماء المستعارة النقر فوق رابط التحقق من البريد الإلكتروني لتدفق رسائل البريد الإلكتروني
`ignore_mx_check`	لا	منطقي	هل يجب تجاهل فحص سجل MX على النطاق للتحقق؟ هذا مخصص بشكل أساسي للمستخدمين الذين لديهم قواعد تكوين متقدمة لتبادل MX ويحتاجون إلى الاحتفاظ بتبادل MX الحالي وإعادة توجيهه إلينا.
`retention_days`	لا	رقم	عدد صحيح بين `0` و `30` الذي يتوافق مع عدد أيام الاحتفاظ لتخزين رسائل البريد الإلكتروني الصادرة من SMTP بعد تسليمها بنجاح أو حدوث خطأ دائم فيها. `0`، مما يعني أن رسائل البريد الإلكتروني SMTP الصادرة يتم مسحها وتحريرها على الفور من أجل أمنك.
`bounce_webhook`	لا	سلسلة (URL) أو منطقية (خطأ)	ال `http://` أو `https://` رابط ويب هوك من اختيارك لإرسال ويب هوك المرتدّ إليه. سنرسل `POST` اطلب إلى عنوان URL هذا معلومات حول إخفاقات SMTP الصادرة (على سبيل المثال، الإخفاقات الناعمة أو الصعبة - حتى تتمكن من إدارة المشتركين لديك وإدارة بريدك الإلكتروني الصادر برمجيًا).
`max_quota_per_alias`	لا	خيط	الحد الأقصى لحصة التخزين للأسماء المستعارة على اسم النطاق هذا. أدخل قيمة مثل "1 غيغابايت" ليتم تحليلها بواسطة بايتات.

مثال على الطلب:

curl -X POST https://api.forwardemail.net/v1/domains \
  -u API_TOKEN: \
  -d domain=example.com \
  -d plan=free

استرجاع المجال

GET /v1/domains/example.com

مثال على الطلب:

curl https://api.forwardemail.net/v1/domains/example.com \
  -u API_TOKEN:

التحقق من سجلات المجال

GET /v1/domains/example.com/verify-records

مثال على الطلب:

curl https://api.forwardemail.net/v1/domains/example.com/verify-records \
  -u API_TOKEN:

التحقق من سجلات SMTP للمجال

GET /v1/domains/example.com/verify-smtp

مثال على الطلب:

curl https://api.forwardemail.net/v1/domains/example.com/verify-smtp \
  -u API_TOKEN:

قائمة كلمات المرور الشاملة على مستوى المجال

GET /v1/domains/example.com/catch-all-passwords

مثال على الطلب:

curl https://api.forwardemail.net/v1/domains/example.com/catch-all-passwords \
  -u API_TOKEN:

إنشاء كلمة مرور شاملة على مستوى المجال

POST /v1/domains/example.com/catch-all-passwords

معلمة الجسم	مطلوب	يكتب	وصف
`new_password`	لا	خيط	كلمة مرورك الجديدة المخصصة لاستخدامها في كلمة مرور النطاق الشاملة. يُرجى العلم أنه يمكنك تركها فارغة أو حذفها تمامًا من نص طلب واجهة برمجة التطبيقات إذا كنت ترغب في الحصول على كلمة مرور قوية ومولدة عشوائيًا.
`description`	لا	خيط	الوصف لأغراض التنظيم فقط.

مثال على الطلب:

curl BASE_URL/v1/domains/example.com/catch-all-passwords \
  -u API_TOKEN:

إزالة كلمة المرور الشاملة على مستوى المجال

DELETE /v1/domains/example.com/catch-all-passwords/:token_id

مثال على الطلب:

curl -X DELETE https://api.forwardemail.net/v1/domains/:domain_name/catch-all-passwords/:token_id \
  -u API_TOKEN:

تحديث المجال

PUT /v1/domains/example.com

معلمة الجسم	مطلوب	يكتب	وصف
`smtp_port`	لا	سلسلة أو رقم	منفذ مخصص لتكوينه لإعادة توجيه SMTP (الافتراضي هو `"25"`)
`has_adult_content_protection`	لا	منطقي	ما إذا كان سيتم تمكين حماية محتوى البالغين من Spam Scanner على هذا المجال
`has_phishing_protection`	لا	منطقي	ما إذا كان سيتم تمكين حماية Spam Scanner من التصيد الاحتيالي على هذا المجال
`has_executable_protection`	لا	منطقي	ما إذا كان سيتم تمكين حماية الملفات القابلة للتنفيذ من Spam Scanner على هذا المجال
`has_virus_protection`	لا	منطقي	ما إذا كان سيتم تمكين الحماية من الفيروسات من خلال Spam Scanner على هذا المجال
`has_recipient_verification`	لا	منطقي	النطاق العالمي الافتراضي لمعرفة ما إذا كان يجب على مستلمي الأسماء المستعارة النقر فوق رابط التحقق من البريد الإلكتروني لتدفق رسائل البريد الإلكتروني
`ignore_mx_check`	لا	منطقي	هل يجب تجاهل فحص سجل MX على النطاق للتحقق؟ هذا مخصص بشكل أساسي للمستخدمين الذين لديهم قواعد تكوين متقدمة لتبادل MX ويحتاجون إلى الاحتفاظ بتبادل MX الحالي وإعادة توجيهه إلينا.
`retention_days`	لا	رقم	عدد صحيح بين `0` و `30` الذي يتوافق مع عدد أيام الاحتفاظ لتخزين رسائل البريد الإلكتروني الصادرة من SMTP بعد تسليمها بنجاح أو حدوث خطأ دائم فيها. `0`، مما يعني أن رسائل البريد الإلكتروني SMTP الصادرة يتم مسحها وتحريرها على الفور من أجل أمنك.
`bounce_webhook`	لا	سلسلة (URL) أو منطقية (خطأ)	ال `http://` أو `https://` رابط ويب هوك من اختيارك لإرسال ويب هوك المرتدّ إليه. سنرسل `POST` اطلب إلى عنوان URL هذا معلومات حول إخفاقات SMTP الصادرة (على سبيل المثال، الإخفاقات الناعمة أو الصعبة - حتى تتمكن من إدارة المشتركين لديك وإدارة بريدك الإلكتروني الصادر برمجيًا).
`max_quota_per_alias`	لا	خيط	الحد الأقصى لحصة التخزين للأسماء المستعارة على اسم النطاق هذا. أدخل قيمة مثل "1 غيغابايت" ليتم تحليلها بواسطة بايتات.

مثال على الطلب:

curl -X PUT https://api.forwardemail.net/v1/domains/example.com \
  -u API_TOKEN:

حذف المجال

DELETE /v1/domains/:domain_name

مثال على الطلب:

curl -X DELETE https://api.forwardemail.net/v1/domains/:domain_name \
  -u API_TOKEN:

دعوات

قبول دعوة النطاق

GET /v1/domains/:domain_name/invites

مثال على الطلب:

curl https://api.forwardemail.net/v1/domains/:domain_name/invites \
  -u API_TOKEN:

إنشاء دعوة للمجال

POST /v1/domains/example.com/invites

معلمة الجسم	مطلوب	يكتب	وصف
`email`	نعم	سلسلة (البريد الإلكتروني)	عنوان البريد الإلكتروني للدعوة إلى قائمة أعضاء المجال
`group`	نعم	سلسلة (قابلة للعد)	المجموعة التي سيتم إضافة المستخدم إليها إلى عضوية المجال (يمكن أن تكون واحدة من `"admin"` أو `"user"`)

مثال على الطلب:

curl -X POST https://api.forwardemail.net/v1/domains/example.com/invites \
  -u API_TOKEN: \
  -d "email=user%40gmail.com" \
  -d group=admin

[هام!] إذا كان المستخدم المدعو عضوًا مقبولًا في أي نطاق آخر ينتمي إليه المسؤول الذي دعاه، فسيتم قبول الدعوة تلقائيًا ولن يتم إرسال بريد إلكتروني.

إزالة دعوة النطاق

DELETE /v1/domains/:domain_name/invites

معلمة الجسم	مطلوب	يكتب	وصف
`email`	نعم	سلسلة (البريد الإلكتروني)	عنوان البريد الإلكتروني المراد إزالته من قائمة أعضاء المجال

مثال على الطلب:

curl -X DELETE https://api.forwardemail.net/v1/domains/:domain_name/invites \
  -u API_TOKEN:

أعضاء

تحديث عضو المجال

PUT /v1/domains/example.com/members/:member_id

معلمة الجسم	مطلوب	يكتب	وصف
`group`	نعم	سلسلة (قابلة للعد)	مجموعة لتحديث المستخدم إلى عضوية المجال مع (يمكن أن تكون واحدة من `"admin"` أو `"user"`)

مثال على الطلب:

curl -X PUT https://api.forwardemail.net/v1/domains/example.com/members/:member_id \
  -u API_TOKEN:

إزالة عضو المجال

DELETE /v1/domains/:domain_name/members/:member_id

مثال على الطلب:

curl -X DELETE https://api.forwardemail.net/v1/domains/:domain_name/members/:member_id \
  -u API_TOKEN:

أسماء مستعارة

إنشاء كلمة مرور مستعارة

لاحظ أنه إذا لم تقم بإرسال تعليمات عبر البريد الإلكتروني، فسيكون اسم المستخدم وكلمة المرور في نص استجابة JSON لطلب ناجح بالتنسيق { username: '[email protected]', password: 'some-generated-password' }.

POST /v1/domains/example.com/aliases/:alias_id/generate-password

معلمة الجسم	مطلوب	يكتب	وصف
`new_password`	لا	خيط	كلمة مرورك الجديدة المخصصة للاسم المستعار. يُرجى العلم أنه يمكنك تركها فارغة أو حذفها تمامًا من نص طلب واجهة برمجة التطبيقات إذا كنت ترغب في الحصول على كلمة مرور قوية ومولدة عشوائيًا.
`password`	لا	خيط	كلمة المرور الحالية للاسم المستعار لتغيير كلمة المرور دون حذف مساحة تخزين صندوق بريد IMAP الحالية (انظر `is_override` الخيار أدناه إذا لم تعد لديك كلمة المرور الحالية).
`is_override`	لا	منطقي	USE WITH CAUTIONسيؤدي هذا إلى إلغاء كلمة مرور الاسم المستعار وقاعدة البيانات الحالية تمامًا، وحذف تخزين IMAP الحالي نهائيًا وإعادة تعيين قاعدة بيانات البريد الإلكتروني SQLite الخاصة بالاسم المستعار بالكامل. يُرجى عمل نسخة احتياطية إن أمكن إذا كان لديك صندوق بريد مرتبط بهذا الاسم المستعار.
`emailed_instructions`	لا	خيط	عنوان البريد الإلكتروني لإرسال كلمة المرور الخاصة بالاسم المستعار وتعليمات الإعداد إليه.

مثال على الطلب:

curl -X POST https://api.forwardemail.net/v1/domains/example.com/aliases/:alias_id/generate-password \
  -u API_TOKEN:

قائمة أسماء النطاقات المستعارة

[ملاحظة!] اعتبارًا من 1 نوفمبر 2024، نقاط نهاية واجهة برمجة التطبيقات لـ قائمة المجالات و قائمة أسماء النطاقات المستعارة سوف يتم تعيينه افتراضيا إلى 1000 الحد الأقصى للنتائج في الصفحة. إذا كنت ترغب في الاشتراك في هذا السلوك مبكرًا، يمكنك المرور ?paginate=true كمعامل سلسلة استعلام إضافي لعنوان URL لاستعلام نقطة النهاية. انظر الترقيم الصفحي لمزيد من التبصر.

GET /v1/domains/example.com/aliases

معلمات سلسلة الاستعلام	مطلوب	يكتب	وصف
`q`	لا	سلسلة (مدعومة بـ RegExp)	البحث عن الأسماء المستعارة في المجال حسب الاسم أو التسمية أو المستلم
`name`	لا	سلسلة (مدعومة بـ RegExp)	البحث عن الأسماء المستعارة في المجال حسب الاسم
`recipient`	لا	سلسلة (مدعومة بـ RegExp)	البحث عن الأسماء المستعارة في المجال حسب المستلم
`sort`	لا	خيط	فرز حسب حقل معين (بادئة بواصلة واحدة) `-` (للفرز في الاتجاه المعاكس لهذا الحقل). الافتراضي هو `created_at` إذا لم يتم ضبطه.
`page`	لا	رقم	يرى الترقيم الصفحي لمزيد من المعرفة
`limit`	لا	رقم	يرى الترقيم الصفحي لمزيد من المعرفة

مثال على الطلب:

curl https://api.forwardemail.net/v1/domains/example.com/aliases?pagination=true \
  -u API_TOKEN:

إنشاء اسم نطاق مستعار جديد

POST /v1/domains/example.com/aliases

معلمة الجسم	مطلوب	يكتب	وصف
`name`	لا	خيط	اسم مستعار (إذا لم يتم توفيره أو إذا كان فارغًا، فسيتم إنشاء اسم مستعار عشوائي)
`recipients`	لا	سلسلة أو مصفوفة	قائمة المستلمين (يجب أن تكون عبارة عن سلسلة أو مجموعة من عناوين البريد الإلكتروني الصالحة، وأسماء النطاقات المؤهلة بالكامل ("FQDN")، وعناوين IP، و/أو عناوين URL الخاصة بالويب هوك - وإذا لم يتم توفيرها أو كانت مجموعة فارغة، فسيتم تعيين بريد المستخدم الإلكتروني الذي يقوم بطلب واجهة برمجة التطبيقات كمستلم)
`description`	لا	خيط	وصف الاسم المستعار
`labels`	لا	سلسلة أو مصفوفة	قائمة العلامات (يجب أن تكون مفصولة بفاصل سطر/مسافة/فاصلة في سلسلة أو مصفوفة)
`has_recipient_verification`	لا	منطقي	مطالبة المستلمين بالنقر فوق رابط التحقق من البريد الإلكتروني لتدفق رسائل البريد الإلكتروني (يتم تعيينه افتراضيًا على إعداد المجال إذا لم يتم تعيينه صراحةً في نص الطلب)
`is_enabled`	لا	منطقي	هل سيتم تفعيل هذا الاسم المستعار أم تعطيله (في حال تعطيله، لن يتم توجيه رسائل البريد الإلكتروني إلى أي مكان، بل ستعرض رموز حالة ناجحة). عند تمرير قيمة، يتم تحويلها إلى قيمة منطقية باستخدام منطقي)
`error_code_if_disabled`	لا	الرقم (إما `250`, `421`، أو `550`)	سيتم رفض البريد الإلكتروني الوارد إلى هذا الاسم المستعار إذا `is_enabled` يكون `false` مع أي منهما `250` (لا يتم التسليم بهدوء في أي مكان، على سبيل المثال ثقب أسود أو `/dev/null`), `421` (رفض مؤقت؛ وإعادة المحاولة لمدة تصل إلى حوالي 5 أيام) أو `550` الفشل الدائم والرفض. الافتراضي هو `250`.
`has_imap`	لا	منطقي	ما إذا كان سيتم تمكين أو تعطيل تخزين IMAP لهذا الاسم المستعار (إذا تم تعطيله، فلن يتم تخزين رسائل البريد الإلكتروني الواردة المستلمة تخزين IMAP. إذا تم تمرير قيمة، يتم تحويلها إلى قيمة منطقية باستخدام منطقي)
`has_pgp`	لا	منطقي	سواء لتمكين أو تعطيل تشفير OpenPGP ل تخزين البريد الإلكتروني المشفر باستخدام IMAP/POP3/CalDAV/CardDAV باستخدام الاسم المستعار `public_key`.
`public_key`	لا	خيط	مفتاح OpenPGP العام بتنسيق ASCII Armor (انقر هنا لمشاهدة مثال؛ على سبيل المثال مفتاح GPG لـ `[email protected]`). هذا ينطبق فقط إذا كان لديك `has_pgp` تم ضبطه على `true`. تعرف على المزيد حول التشفير الشامل في قسم الأسئلة الشائعة.
`max_quota`	لا	خيط	الحد الأقصى لحصة التخزين لهذا الاسم المستعار. اتركه فارغًا لإعادة ضبط الحد الأقصى لحصة النطاق الحالية، أو أدخل قيمة مثل "1 غيغابايت" التي سيتم تحليلها بواسطة بايتات. لا يمكن تعديل هذه القيمة إلا بواسطة مسؤولي المجال.
`vacation_responder_is_enabled`	لا	منطقي	ما إذا كان سيتم تمكين أو تعطيل الرد التلقائي على الإجازة.
`vacation_responder_start_date`	لا	خيط	تاريخ بدء الاستجابة للعطلة (إذا تم تمكينه ولم يتم تحديد تاريخ بدء هنا، فإنه يفترض أنه بدأ بالفعل). نحن ندعم تنسيقات التاريخ مثل `MM/DD/YYYY`, `YYYY-MM-DD`، وتنسيقات التاريخ الأخرى عبر التحليل الذكي باستخدام `dayjs`.
`vacation_responder_end_date`	لا	خيط	تاريخ انتهاء صلاحية المستجيب المؤقت (إذا تم تمكينه ولم يتم تحديد تاريخ انتهاء صلاحية هنا، فإنه يفترض أنه لن ينتهي أبدًا ويستجيب إلى الأبد). نحن ندعم تنسيقات التاريخ مثل `MM/DD/YYYY`, `YYYY-MM-DD`، وتنسيقات التاريخ الأخرى عبر التحليل الذكي باستخدام `dayjs`.
`vacation_responder_subject`	لا	خيط	الموضوع في نص عادي للمستجيب التلقائي، على سبيل المثال "خارج المكتب". نستخدم `striptags` لإزالة كافة HTML هنا.
`vacation_responder_message`	لا	خيط	رسالة بنص عادي لمستجيب الإجازة، على سبيل المثال "سأكون خارج المكتب حتى فبراير". نستخدم `striptags` لإزالة كافة HTML هنا.

مثال على الطلب:

curl -X POST https://api.forwardemail.net/v1/domains/example.com/aliases \
  -u API_TOKEN:

استرداد اسم النطاق المستعار

يمكنك استرداد اسم نطاق مستعار إما عن طريق id أو لها name قيمة.

GET /v1/domains/:domain_name/aliases/:alias_id

مثال على الطلب:

curl https://api.forwardemail.net/v1/domains/:domain_name/aliases/:alias_id \
  -u API_TOKEN:

GET /v1/domains/:domain_name/aliases/:alias_name

مثال على الطلب:

curl https://api.forwardemail.net/v1/domains/:domain_name/aliases/:alias_name \
  -u API_TOKEN:

تحديث اسم النطاق المستعار

PUT /v1/domains/example.com/aliases/:alias_id

معلمة الجسم	مطلوب	يكتب	وصف
`name`	لا	خيط	الاسم المستعار
`recipients`	لا	سلسلة أو مصفوفة	قائمة المستلمين (يجب أن تكون مفصولة بفاصل أسطر/مسافة/فاصلة، أو سلسلة أو مجموعة من عناوين البريد الإلكتروني الصالحة، وأسماء النطاقات المؤهلة بالكامل ("FQDN")، وعناوين IP، و/أو عناوين URL الخاصة بـ webhook)
`description`	لا	خيط	وصف الاسم المستعار
`labels`	لا	سلسلة أو مصفوفة	قائمة العلامات (يجب أن تكون مفصولة بفاصل سطر/مسافة/فاصلة في سلسلة أو مصفوفة)
`has_recipient_verification`	لا	منطقي	مطالبة المستلمين بالنقر فوق رابط التحقق من البريد الإلكتروني لتدفق رسائل البريد الإلكتروني (يتم تعيينه افتراضيًا على إعداد المجال إذا لم يتم تعيينه صراحةً في نص الطلب)
`is_enabled`	لا	منطقي	هل سيتم تفعيل هذا الاسم المستعار أم تعطيله (في حال تعطيله، لن يتم توجيه رسائل البريد الإلكتروني إلى أي مكان، بل ستعرض رموز حالة ناجحة). عند تمرير قيمة، يتم تحويلها إلى قيمة منطقية باستخدام منطقي)
`error_code_if_disabled`	لا	الرقم (إما `250`, `421`، أو `550`)	سيتم رفض البريد الإلكتروني الوارد إلى هذا الاسم المستعار إذا `is_enabled` يكون `false` مع أي منهما `250` (لا يتم التسليم بهدوء في أي مكان، على سبيل المثال ثقب أسود أو `/dev/null`), `421` (رفض مؤقت؛ وإعادة المحاولة لمدة تصل إلى حوالي 5 أيام) أو `550` الفشل الدائم والرفض. الافتراضي هو `250`.
`has_imap`	لا	منطقي	ما إذا كان سيتم تمكين أو تعطيل تخزين IMAP لهذا الاسم المستعار (إذا تم تعطيله، فلن يتم تخزين رسائل البريد الإلكتروني الواردة المستلمة تخزين IMAP. إذا تم تمرير قيمة، يتم تحويلها إلى قيمة منطقية باستخدام منطقي)
`has_pgp`	لا	منطقي	سواء لتمكين أو تعطيل تشفير OpenPGP ل تخزين البريد الإلكتروني المشفر باستخدام IMAP/POP3/CalDAV/CardDAV باستخدام الاسم المستعار `public_key`.
`public_key`	لا	خيط	مفتاح OpenPGP العام بتنسيق ASCII Armor (انقر هنا لمشاهدة مثال؛ على سبيل المثال مفتاح GPG لـ `[email protected]`). هذا ينطبق فقط إذا كان لديك `has_pgp` تم ضبطه على `true`. تعرف على المزيد حول التشفير الشامل في قسم الأسئلة الشائعة.
`max_quota`	لا	خيط	الحد الأقصى لحصة التخزين لهذا الاسم المستعار. اتركه فارغًا لإعادة ضبط الحد الأقصى لحصة النطاق الحالية، أو أدخل قيمة مثل "1 غيغابايت" التي سيتم تحليلها بواسطة بايتات. لا يمكن تعديل هذه القيمة إلا بواسطة مسؤولي المجال.
`vacation_responder_is_enabled`	لا	منطقي	ما إذا كان سيتم تمكين أو تعطيل الرد التلقائي على الإجازة.
`vacation_responder_start_date`	لا	خيط	تاريخ بدء الاستجابة للعطلة (إذا تم تمكينه ولم يتم تحديد تاريخ بدء هنا، فإنه يفترض أنه بدأ بالفعل). نحن ندعم تنسيقات التاريخ مثل `MM/DD/YYYY`, `YYYY-MM-DD`، وتنسيقات التاريخ الأخرى عبر التحليل الذكي باستخدام `dayjs`.
`vacation_responder_end_date`	لا	خيط	تاريخ انتهاء صلاحية المستجيب المؤقت (إذا تم تمكينه ولم يتم تحديد تاريخ انتهاء صلاحية هنا، فإنه يفترض أنه لن ينتهي أبدًا ويستجيب إلى الأبد). نحن ندعم تنسيقات التاريخ مثل `MM/DD/YYYY`, `YYYY-MM-DD`، وتنسيقات التاريخ الأخرى عبر التحليل الذكي باستخدام `dayjs`.
`vacation_responder_subject`	لا	خيط	الموضوع في نص عادي للمستجيب التلقائي، على سبيل المثال "خارج المكتب". نستخدم `striptags` لإزالة كافة HTML هنا.
`vacation_responder_message`	لا	خيط	رسالة بنص عادي لمستجيب الإجازة، على سبيل المثال "سأكون خارج المكتب حتى فبراير". نستخدم `striptags` لإزالة كافة HTML هنا.

مثال على الطلب:

curl -X PUT https://api.forwardemail.net/v1/domains/example.com/aliases/:alias_id \
  -u API_TOKEN:

حذف اسم النطاق المستعار

DELETE /v1/domains/:domain_name/aliases/:alias_id

مثال على الطلب:

curl -X DELETE https://api.forwardemail.net/v1/domains/:domain_name/aliases/:alias_id \
  -u API_TOKEN:

تشفير

نسمح لك بتشفير السجلات حتى في الخطة المجانية دون أي تكلفة. الخصوصية ليست ميزة، بل يجب أن تكون جزءًا لا يتجزأ من جميع جوانب المنتج. كما هو مطلوب بشدة في مناقشة أدلة الخصوصية وعلى مشاكلنا على GitHub لقد أضفنا هذا.

تشفير سجل TXT

POST /v1/encrypt

معلمة الجسم	مطلوب	يكتب	وصف
`input`	نعم	خيط	أي سجل نص عادي صالح للبريد الإلكتروني المعاد توجيهه

مثال على الطلب:

curl -X POST https://api.forwardemail.net/v1/encrypt \
  -d "[email protected]"