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

مكتبات

في الوقت الحالي لم نصدر أي أغلفة لواجهة برمجة التطبيقات ، لكننا نخطط للقيام بذلك في المستقبل القريب. إرسال بريد إلكتروني إلى api@forwardemail.net إذا كنت ترغب في أن يتم إعلامك عندما يتم تحرير غلاف API الخاص بلغة برمجة معينة. في غضون ذلك ، يمكنك استخدام مكتبات طلبات HTTP الموصى بها في تطبيقك ، أو ببساطة استخدام لفة كما في الأمثلة أدناه.

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

URI الأساسي

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

المصادقة

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

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

أخطاء

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

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

تلميح: إذا تلقيت رمز الحالة 5xx (والذي لا ينبغي أن يحدث) ، فيرجى الاتصال بنا على api@forwardemail.net وسنساعدك على حل مشكلتك على الفور.

الموقع

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

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

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

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

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

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

معلمة Querystring	مطلوب	نوع	وصف
`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` معلمة querystring والنتائج الفعلية التي تم إرجاعها).
`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

معلمة Querystring	مطلوب	نوع	وصف
`domain`	لا	سلسلة (FQDN)	تصفية السجلات حسب المجال المؤهل بالكامل ("FQDN"). إذا لم تقم بتوفير ذلك، فسيتم استرداد جميع السجلات عبر جميع النطاقات.
`q`	لا	خيط	ابحث عن السجلات حسب البريد الإلكتروني أو المجال أو الاسم المستعار أو عنوان IP أو التاريخ (`M/Y`, `M/D/YY`, `M-D`, `M-D-YY`، أو `M.D.YY` شكل).

طلب مثال:

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 الخاص بك.

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

لنظام التشغيل 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)

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

WIP: يعد قسم نقطة النهاية هذا عملاً قيد التقدم وسيتم إصداره (نأمل ذلك) في عام 2024. وفي غضون ذلك، يُرجى استخدام عميل IMAP من القائمة المنسدلة "التطبيقات" في شريط التنقل بموقعنا على الويب.

NOTE: لم يتوفر دعم CardDAV بعد، تابع هذه المناقشة على GitHub للحصول على التحديثات.

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

GET /v1/contacts

قريبا

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

POST /v1/contacts

قريبا

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

GET /v1/contacts/:id

قريبا

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

PUT /v1/contacts/:id

قريبا

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

DELETE /v1/contacts/:id

قريبا

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

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

WIP: يعد قسم نقطة النهاية هذا عملاً قيد التقدم وسيتم إصداره (نأمل ذلك) في عام 2024. وفي غضون ذلك، يُرجى استخدام عميل IMAP من القائمة المنسدلة "التطبيقات" في شريط التنقل بموقعنا على الويب.

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

GET /v1/calendars

قريبا

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

POST /v1/calendars

قريبا

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

GET /v1/calendars/:id

قريبا

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

PUT /v1/calendars/:id

قريبا

حذف التقويم

DELETE /v1/calendars/:id

قريبا

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

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

WIP: يعد قسم نقطة النهاية هذا عملاً قيد التقدم وسيتم إصداره (نأمل ذلك) في عام 2024. وفي غضون ذلك، يُرجى استخدام عميل IMAP من القائمة المنسدلة "التطبيقات" في شريط التنقل بموقعنا على الويب.

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

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

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

GET /v1/messages

قريبا

إنشاء رسالة

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

POST /v1/messages

قريبا

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

GET /v1/messages/:id

قريبا

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

PUT /v1/messages/:id

قريبا

حذف الرسالة

DELETE /v1/messages:id

قريبا

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

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

WIP: يعد قسم نقطة النهاية هذا عملاً قيد التقدم وسيتم إصداره (نأمل ذلك) في عام 2024. وفي غضون ذلك، يُرجى استخدام عميل 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

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

طلب مثال:

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

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

واجهة برمجة التطبيقات الخاصة بنا لإنشاء بريد إلكتروني مستوحاة من تكوين خيار رسالة 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`	لا	سلسلة أو صفيف	قائمة مفصولة بفواصل أو صفيف من المستلمين لرأس "نسخة".
`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 "from=alias@example.com" \
  -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:

المجالات

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

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

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

GET /v1/domains

معلمة Querystring	مطلوب	نوع	وصف
`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
`plan`	لا	السلسلة (قابلة للتعداد)	نوع الخطة (يجب أن يكون `"free"`, `"enhanced_protection"`، أو `"team"`، الافتراضيات إلى `"free"` أو الخطة المدفوعة الحالية للمستخدم إذا كانت واحدة)
`catchall`	لا	سلسلة (عناوين بريد إلكتروني محددة) أو منطقية	أنشئ اسمًا مستعارًا افتراضيًا شاملاً ، وافتراضيًا إلى `true` (إذا `true` سيستخدم عنوان البريد الإلكتروني لمستخدم واجهة برمجة التطبيقات كمستلم ، وإذا كان `false` لن يتم إنشاء كل شيء). إذا تم تمرير سلسلة ، فهي قائمة محددة من عناوين البريد الإلكتروني لاستخدامها كمستلمين (مفصولة بفاصل أسطر و / أو مسافة و / أو فاصلة)
`has_adult_content_protection`	لا	منطقي	ما إذا كان سيتم تمكين حماية محتوى البالغين من الماسح الضوئي للبريد العشوائي في هذا المجال
`has_phishing_protection`	لا	منطقي	ما إذا كان سيتم تمكين الحماية من التصيد الاحتيالي لماسح البريد العشوائي في هذا المجال أم لا
`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://` عنوان URL لخطاف الويب الذي تختاره لإرسال خطافات الويب المرتدة إليه. سوف نرسل `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:

تحديث المجال

PUT /v1/domains/example.com

معلمة الجسم	مطلوب	نوع	وصف
`smtp_port`	لا	سلسلة أو رقم	منفذ مخصص للتهيئة لإعادة توجيه SMTP (الافتراضي هو `"25"`)
`has_adult_content_protection`	لا	منطقي	ما إذا كان سيتم تمكين حماية محتوى البالغين من الماسح الضوئي للبريد العشوائي في هذا المجال
`has_phishing_protection`	لا	منطقي	ما إذا كان سيتم تمكين الحماية من التصيد الاحتيالي لماسح البريد العشوائي في هذا المجال أم لا
`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://` عنوان URL لخطاف الويب الذي تختاره لإرسال خطافات الويب المرتدة إليه. سوف نرسل `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: 'alias@yourdomain.com', password: 'some-generated-password' }.

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

معلمة الجسم	مطلوب	نوع	وصف
`new_password`	لا	خيط	كلمة المرور الجديدة المخصصة لاستخدامها في الاسم المستعار. لاحظ أنه يمكنك ترك هذا فارغًا أو مفقودًا تمامًا من نص طلب واجهة برمجة التطبيقات (API) الخاص بك إذا كنت ترغب في الحصول على كلمة مرور قوية تم إنشاؤها عشوائيًا.
`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:

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

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

GET /v1/domains/example.com/aliases

معلمة Querystring	مطلوب	نوع	وصف
`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 باستخدام الاسم المستعار `public_key`.
`public_key`	لا	خيط	المفتاح العام OpenPGP بتنسيق ASCII Armor (انقر هنا لعرض مثال; على سبيل المثال مفتاح GPG ل `support@forwardemail.net`). وهذا ينطبق فقط إذا كان لديك `has_pgp` ضبط ل `true`. تعرف على المزيد حول التشفير الشامل في الأسئلة الشائعة.
`max_quota`	لا	خيط	الحد الأقصى لحصة التخزين لهذا الاسم المستعار. اتركه فارغًا لإعادة تعيين الحد الأقصى لحصة المجال الحالية أو أدخل قيمة مثل "1 جيجابايت" التي سيتم تحليلها بواسطة بايتاتلا يمكن تعديل هذه القيمة إلا بواسطة مسؤولي المجال.

طلب مثال:

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 الخاصة بشبكة الويب)
`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 باستخدام الاسم المستعار `public_key`.
`public_key`	لا	خيط	المفتاح العام OpenPGP بتنسيق ASCII Armor (انقر هنا لعرض مثال; على سبيل المثال مفتاح GPG ل `support@forwardemail.net`). وهذا ينطبق فقط إذا كان لديك `has_pgp` ضبط ل `true`. تعرف على المزيد حول التشفير الشامل في الأسئلة الشائعة.
`max_quota`	لا	خيط	الحد الأقصى لحصة التخزين لهذا الاسم المستعار. اتركه فارغًا لإعادة تعيين الحد الأقصى لحصة المجال الحالية أو أدخل قيمة مثل "1 جيجابايت" التي سيتم تحليلها بواسطة بايتاتلا يمكن تعديل هذه القيمة إلا بواسطة مسؤولي المجال.

طلب مثال:

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:

تشفير

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

تشفير سجل TXT

POST /v1/encrypt

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

طلب مثال:

curl -X POST https://api.forwardemail.net/v1/encrypt \
  -d "input=user@gmail.com"