وثائق API
وصول آلي إلى بياناتك

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

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

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

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

تتطلب جميع نقاط النهاية الخاصة بك مفتاح API ليتم تعيينها كقيمة "اسم المستخدم" للطلب التفويض الأساسي رأس. لا تقلق - يتم توفير أمثلة أدناه لك إذا لم تكن متأكدًا من ماهية ذلك.

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

الشفرةاسم
200OK
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 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"

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

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

لاحظ أن نقطة النهاية هذه لا تُرجع بريدًا إلكترونيًا تم إنشاؤه بالفعل message, headers, accepted، ولا rejectedErrors ملكيات.

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

GET /v1/emails

معلمة Querystringمطلوبنوعوصف
qلاسلسلة (RegExp مدعومة)البحث عن رسائل البريد الإلكتروني عن طريق البيانات الوصفية
domainلاسلسلة (RegExp مدعومة)ابحث عن رسائل البريد الإلكتروني حسب اسم المجال

طلب مثال:

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

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

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

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

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

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`"

استرجاع البريد الإلكتروني

GET /v1/emails/:id

طلب مثال:

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

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

سيؤدي حذف البريد الإلكتروني إلى تعيين الحالة إلى "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 القيمة.

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

GET /v1/domains

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

طلب مثال:

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

طلب مثال:

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

طلب مثال:

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:

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

GET /v1/domains/example.com/aliases

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

طلب مثال:

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

طلب مثال:

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: