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

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

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

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

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

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

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

استرداد السجلات

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

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

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

GET /v1/logs/download

طلب مثال:

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

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

For 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

For Linux and 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

طلب مثال:

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

طلب مثال:

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 ملكيات.

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

ستعود نقطة النهاية هذه على الأكثر 50 النتائج في وقت واحد. إذا كنت تريد الاستعلام عن صفحات متعددة، فقم بالإلحاق ?page=NUMBER أين NUMBER هو عدد صحيح، على سبيل المثال. ?page=1.

GET /v1/emails

طلب مثال:

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

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

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

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

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

POST /v1/emails

طلب مثال:

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:

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

GET /v1/domains

طلب مثال:

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

إنشاء مجال

POST /v1/domains

طلب مثال:

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

طلب مثال:

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

طلب مثال:

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

طلب مثال:

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

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

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

طلب مثال:

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

طلب مثال:

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

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

POST /v1/domains/example.com/aliases

طلب مثال:

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

طلب مثال:

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: