API של אימייל

כרגע עדיין לא שחררנו עטיפות API, אבל אנחנו מתכננים לעשות זאת בעתיד הקרוב. שלח דואר אלקטרוני ל api@forwardemail.net אם ברצונך לקבל הודעה כאשר שוחרר מעטפת ה-API של שפת תכנות מסוימת. בינתיים, אתה יכול להשתמש בספריות בקשות HTTP המומלצות ביישום שלך, או פשוט להשתמש תלתל כמו בדוגמאות שלהלן.

נתיב ה-URI הבסיסי של HTTP הוא: https://api.forwardemail.net.

כל נקודות הקצה דורשות שלך מפתח API להיות מוגדר כערך "שם משתמש" של הבקשה אישור בסיסי כּוֹתֶרֶת. אל תדאג - דוגמאות מסופקות להלן עבורך אם אינך בטוח מה זה.

אם מתרחשות שגיאות, גוף התגובה של בקשת ה- API יכיל הודעת שגיאה מפורטת.

השירות שלנו מתורגם ליותר מ-25 שפות שונות. כל הודעות התגובה של ה-API מתורגמות למקום האחרון שזוהה של המשתמש שמבצע את בקשת ה-API. אתה יכול לעקוף זאת על ידי העברת מנהג Accept-Language כּוֹתֶרֶת. אל תהסס לנסות זאת באמצעות התפריט הנפתח של השפה בתחתית עמוד זה.

אם ברצונך לקבל הודעה כאשר העימוד זמין, אנא שלח דוא"ל api@forwardemail.net.

צור חשבון

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:

צור אימייל

ה-API שלנו ליצירת אימייל נוצר בהשראת וממנף את תצורת אפשרות ההודעות של 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: