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

مكتبات

في الوقت الحالي لم نصدر أي أغلفة لواجهة برمجة التطبيقات ، لكننا نخطط للقيام بذلك في المستقبل القريب. إرسال بريد إلكتروني إلى 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 رأس. لا تتردد في تجربته باستخدام قائمة اللغة المنسدلة في أسفل هذه الصفحة.

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

إذا كنت ترغب في أن يتم إعلامك عندما يكون ترقيم الصفحات متاحًا ، فيرجى إرسال بريد إلكتروني api@forwardemail.net.

الحساب

إنشاء حساب

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 -X GET 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"

المجالات

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

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

GET /v1/domains

معلمة Querystring	مطلوب	نوع	وصف
`name`	لا	سلسلة (RegExp مدعومة)	ابحث عن المجالات بالاسم
`alias`	لا	سلسلة (RegExp مدعومة)	ابحث عن المجالات حسب الاسم المستعار
`recipient`	لا	سلسلة (RegExp مدعومة)	البحث عن المجالات حسب المستلم

طلب مثال:

curl -X GET 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`	لا	منطقي	النطاق الافتراضي العام لمطالبة مستلمي الاسم المستعار بالنقر فوق ارتباط التحقق من البريد الإلكتروني لتتدفق رسائل البريد الإلكتروني من خلاله

طلب مثال:

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 -X GET https://api.forwardemail.net/v1/domains/example.com \
  -u API_TOKEN:

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

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

طلب مثال:

curl -X GET 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`	لا	منطقي	النطاق الافتراضي العام لمطالبة مستلمي الاسم المستعار بالنقر فوق ارتباط التحقق من البريد الإلكتروني لتتدفق رسائل البريد الإلكتروني من خلاله

طلب مثال:

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 -X GET 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:

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

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

GET /v1/domains/example.com/aliases

معلمة Querystring	مطلوب	نوع	وصف
`name`	لا	سلسلة (RegExp مدعومة)	البحث عن الأسماء المستعارة في المجال بالاسم
`recipient`	لا	سلسلة (RegExp مدعومة)	البحث عن الأسماء المستعارة في المجال عن طريق المستلم

طلب مثال:

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

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

POST /v1/domains/example.com/aliases

معلمة الجسم	مطلوب	نوع	وصف
`name`	نعم	خيط	اسم مستعار
`recipients`	نعم	سلسلة أو صفيف	قائمة المستلمين (يجب أن تكون فاصل السطر / مسافة / سلسلة مفصولة بفواصل أو صفيف من عناوين البريد الإلكتروني الصالحة ، وأسماء النطاقات المؤهلة بالكامل ("FQDN") ، و / أو عناوين IP ، و / أو عناوين URL الخاصة بشبكة الويب)
`description`	لا	خيط	وصف الاسم المستعار
`labels`	لا	سلسلة أو صفيف	قائمة التسميات (يجب أن تكون فاصل السطر / مسافة / سلسلة مفصولة بفواصل أو صفيف)
`has_recipient_verification`	لا	منطقي	ما إذا كان سيتم تمكين مطالبة المستلمين بالنقر فوق ارتباط التحقق من البريد الإلكتروني حتى تتدفق رسائل البريد الإلكتروني من خلاله (يتم تعيين الإعدادات الافتراضية على النطاق إذا لم يتم تعيينها صراحة في نص الطلب)
`is_enabled`	لا	منطقي	ما إذا كان سيتم تمكين هذا الاسم المستعار (إذا تم تعطيله ، فلن يتم توجيه رسائل البريد الإلكتروني في أي مكان ولكن سيتم عرض رموز الحالة الناجحة)

طلب مثال:

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`	لا	منطقي	ما إذا كان سيتم تمكين هذا الاسم المستعار (إذا تم تعطيله ، فلن يتم توجيه رسائل البريد الإلكتروني في أي مكان ولكن سيتم عرض رموز الحالة الناجحة)

طلب مثال:

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: