ממשק API של דוא"ל

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

שָׂפָה סִפְרִיָה
אוֹדֶם Faraday
פִּיתוֹן requests
ג'אווה OkHttp
PHP guzzle
ג'אווהסקריפט superagent (אנחנו מתחזקים)
Node.js superagent (אנחנו מתחזקים)
לָלֶכֶת net/http
.NET RestSharp

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

כל נקודות הקצה דורשות ש-מפתח API יוגדר כערך "שם משתמש" של כותרת הרשאה בסיסית של הבקשה (למעט אנשי קשר חלופיים, לוחות שנה חלופיים ו-תיבות דואר חלופיות המשתמשים ב-שם משתמש וסיסמה כינויים שנוצרו).

אל דאגה - דוגמאות ניתנות למטה עבורך אם אינך בטוח מה זה.

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

קוד שֵׁם
200 OK
400 בקשה שגויה
401 לא מורשה
403 אָסוּר
404 לא נמצא
429 יותר מדי בקשות
500 שגיאת שרת פנימית
501 לא יושם
502 שער רע
503 השירות אינו זמין
504 פסק זמן של שער הגישה

Tip

אם קיבלתם קוד סטטוס 5xx (מה שלא אמור לקרות), אנא צרו איתנו קשר בכתובת api@forwardemail.net ונעזור לכם לפתור את הבעיה באופן מיידי.

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

Note

החל מ-1 בנובמבר 2024, נקודות הקצה של ה-API עבור רשימת דומיינים ו-רשימת כינויי דומיין יעמדו כברירת מחדל על מספר תוצאות מקסימלי של 1000 לעמוד. אם ברצונך להצטרף להתנהגות זו מוקדם, תוכל להעביר את ?paginate=true כפרמטר שאילתה נוסף לכתובת האתר עבור שאילתת נקודת הקצה.

חלוקת עימודים נתמכת על ידי כל נקודות הקצה של ה-API המציגות תוצאות.

פשוט ספקו את מאפייני מחרוזת השאילתה page (ואופציונלי limit).

המאפיין page צריך להיות מספר גדול או שווה ל-1. אם תספק limit (גם הוא מספר), אז הערך המינימלי הוא 10 והמקסימום הוא 50 (אלא אם כן צוין אחרת).

פרמטרים של מחרוזת שאילתה דָרוּשׁ סוּג תֵאוּר
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 והתוצאות בפועל שהוחזרו).
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" אנו מספקים כותרת תגובת HTTP Link שניתן לנתח כפי שמוצג בדוגמה. זהו similar to GitHub (לדוגמה, לא כל הערכים יסופקו אם הם אינם רלוונטיים או זמינים, לדוגמה, "next" לא יסופק אם אין דף נוסף).

בקשה לדוגמה:

curl https://api.forwardemail.net/v1/domains/example.com/aliases?page=2&pagination=true \
  -u API_TOKEN:

אחזור יומני רישום

ה-API שלנו מאפשר לך להוריד יומני רישום עבור חשבונך באופן תכנותי. הגשת בקשה לנקודת קצה זו תעבד את כל היומנים עבור חשבונך ותשלח אותם אליך בדוא"ל כקובץ מצורף (קובץ גיליון אלקטרוני ג'י-זיפס דחוס) לאחר השלמתה.

זה מאפשר לך ליצור משימות רקע עם עבודת קרון או להשתמש ב-תוכנת תזמון משימות Node.js ב-Bree שלנו כדי לקבל יומני רישום בכל עת שתרצה. שים לב שנקודת קצה זו מוגבלת ל-10 בקשות ביום.

הקובץ המצורף הוא באותיות קטנות של email-deliverability-logs-YYYY-MM-DD-h-mm-A-z.csv.gz והאימייל עצמו מכיל סיכום קצר של היומנים שאוחזרו. ניתן גם להוריד יומנים בכל עת מ-החשבון שלי → יומנים.

GET /v1/logs/download

פרמטרים של מחרוזת שאילתה דָרוּשׁ סוּג תֵאוּר
domain לֹא מחרוזת (FQDN) סנן יומנים לפי דומיין מלא ("FQDN"). אם לא תספק קוד זה, כל היומנים בכל הדומיינים יאוחזרו.
q לֹא חוּט חפש יומנים לפי דוא"ל, דומיין, שם כינוי, כתובת IP או תאריך (בפורמט M/Y, M/D/YY, M-D, M-D-YY או M.D.YY).
bounce_category לֹא חוּט חפש יומנים לפי קטגוריית יציאה ספציפית (למשל blocklist).
response_code לֹא מִספָּר חפש יומנים לפי קוד תגובת שגיאה ספציפי (למשל 421 או 550).

בקשה לדוגמה:

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

דוגמה לעבודת קרון (בחצות כל יום):

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

עבור לינוקס ואובונטו:

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"

Note

בניגוד לנקודות קצה אחרות של API, אלה דורשות אימות "שם משתמש" שווה לשם המשתמש הכינוי ו-"סיסמה" שווה לסיסמה שנוצרה על ידי הכינוי ככותרות הרשאה בסיסית.

Warning

מדור נקודת הקצה הזה נמצא בתהליך עבודה ויפורסם (בתקווה) בשנת 2024. בינתיים, אנא השתמשו בלקוח IMAP מהתפריט הנפתח "אפליקציות" בניווט באתר שלנו.

רשימת אנשי קשר

GET /v1/contacts

בקרוב

צור איש קשר

POST /v1/contacts

בקרוב

אחזר איש קשר

GET /v1/contacts/:id

בקרוב

עדכון איש קשר

PUT /v1/contacts/:id

בקרוב

מחק את איש הקשר

DELETE /v1/contacts/:id

בקרוב

Note

בניגוד לנקודות קצה אחרות של API, אלה דורשות אימות "שם משתמש" שווה לשם המשתמש הכינוי ו-"סיסמה" שווה לסיסמה שנוצרה על ידי הכינוי ככותרות הרשאה בסיסית.

Warning

מדור נקודת הקצה הזה נמצא בתהליך עבודה ויפורסם (בתקווה) בשנת 2024. בינתיים, אנא השתמשו בלקוח IMAP מהתפריט הנפתח "אפליקציות" בניווט באתר שלנו.

רשימת יומנים

GET /v1/calendars

בקרוב

צור לוח שנה

POST /v1/calendars

בקרוב

אחזר לוח שנה

GET /v1/calendars/:id

בקרוב

עדכון לוח שנה

PUT /v1/calendars/:id

בקרוב

מחיקת לוח שנה

DELETE /v1/calendars/:id

בקרוב

Note

בניגוד לנקודות קצה אחרות של API, אלה דורשות אימות "שם משתמש" שווה לשם המשתמש הכינוי ו-"סיסמה" שווה לסיסמה שנוצרה על ידי הכינוי ככותרות הרשאה בסיסית.

Warning

מדור נקודת הקצה הזה נמצא בתהליך עבודה ויפורסם (בתקווה) בשנת 2024. בינתיים, אנא השתמשו בלקוח IMAP מהתפריט הנפתח "אפליקציות" בניווט באתר שלנו.

אנא ודא שפעלת לפי הוראות ההתקנה עבור הדומיין שלך.

ניתן למצוא הוראות אלה בקטע השאלות הנפוצות שלנו האם אתם תומכים בקבלת דוא"ל באמצעות IMAP?.

הצג וחפש הודעות

GET /v1/messages

בקרוב

צור הודעה

Note

פעולה זו לא תשלח אימייל – היא פשוט תוסיף את ההודעה לתיקיית תיבת הדואר שלך (לדוגמה, זה דומה לפקודה IMAP APPEND). אם ברצונך לשלוח אימייל, עיין ב-צור דוא"ל SMTP יוצא להלן. לאחר יצירת אימייל ה-SMTP היוצא, תוכל לצרף עותק שלו באמצעות נקודת קצה זו לתיבת הדואר של הכינוי שלך למטרות אחסון.

POST /v1/messages

בקרוב

אחזר הודעה

GET /v1/messages/:id

בקרוב

עדכון הודעה

PUT /v1/messages/:id

בקרוב

מחק הודעה

DELETE /v1/messages:id

בקרוב

Tip

נקודות קצה של תיקיות עם נתיב /v1/folders/:path כנקודת הקצה שלהן ניתנות להחלפה עם מזהה של תיקייה :id. משמעות הדבר היא שניתן להתייחס לתיקייה לפי ערך path או id שלה.

Warning

מדור נקודת הקצה הזה נמצא בתהליך עבודה ויפורסם (בתקווה) בשנת 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

פרמטרים של מחרוזת שאילתה דָרוּשׁ סוּג תֵאוּר
q לֹא מחרוזת (נתמכת ב-RegExp) חיפוש הודעות דוא"ל לפי מטא-נתונים
domain לֹא מחרוזת (נתמכת ב-RegExp) חיפוש כתובות דוא"ל לפי שם דומיין
sort לֹא חוּט מיין לפי שדה ספציפי (יש להוסיף קידומת של מקף יחיד - כדי למיין בכיוון ההפוך של שדה זה). ברירת המחדל היא created_at אם לא מוגדר.
page לֹא מִספָּר ראה Pagination לקבלת תובנות נוספות
limit לֹא מִספָּר ראה Pagination לקבלת תובנות נוספות

בקשה לדוגמה:

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

צור דוא"ל SMTP יוצא

ה-API שלנו ליצירת אימייל מושפע וממנף את תצורת אפשרות ההודעה של Nodemailer. אנא התייחסו ל-תצורת הודעת Nodemailer עבור כל פרמטרי הגוף שלהלן.

שים לב שלמעט envelope ו-dkim (מכיוון שאנו מגדירים אותם באופן אוטומטי עבורך), אנו תומכים בכל אפשרויות Nodemailer. אנו מגדירים באופן אוטומטי את האפשרויות disableFileAccess ו-disableUrlAccess ל-true לצורכי אבטחה.

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

נקודת קצה זו של ה-API תקודד אוטומטית אימוג'ים עבורך אם הם נמצאים בכותרות (לדוגמה, שורת נושא של Subject: 🤓 Hello מומרת ל-Subject: =?UTF-8?Q?=F0=9F=A4=93?= Hello באופן אוטומטי). המטרה שלנו הייתה ליצור API דוא"ל ידידותי במיוחד למפתחים ועמיד בפני ניסויים.

POST /v1/emails

פרמטר גוף דָרוּשׁ סוּג תֵאוּר
from לֹא מחרוזת (דוא"ל) כתובת הדוא"ל של השולח (חייבת להתקיים ככינוי של הדומיין).
to לֹא מחרוזת או מערך רשימה מופרדת בפסיקים או מערך של נמענים עבור כותרת "אל".
cc לֹא מחרוזת או מערך רשימה מופרדת בפסיקים או מערך של נמענים עבור כותרת "Cc".
bcc לֹא מחרוזת או מערך רשימה מופרדת בפסיקים או מערך של נמענים עבור כותרת "עותק מוסתר".
subject לֹא חוּט נושא האימייל.
text לֹא מחרוזת או מאגר גרסת הטקסט הרגיל של ההודעה.
html לֹא מחרוזת או מאגר גרסת ה-HTML של ההודעה.
attachments לֹא מַעֲרָך מערך של אובייקטים מצורפים (ראה Nodemailer's common fields).
sender לֹא חוּט כתובת הדוא"ל עבור כותרת "שולח" (ראה Nodemailer's more advanced fields).
replyTo לֹא חוּט כתובת הדוא"ל עבור כותרת "השב אל".
inReplyTo לֹא חוּט מזהה ההודעה שאליו ההודעה היא בתגובה.
references לֹא מחרוזת או מערך רשימה מופרדת ברווחים או מערך של מזהי הודעות.
attachDataUrls לֹא בוליאני אם true אז data: ממיר תמונות בתוכן ה-HTML של ההודעה לקבצים מצורפים מוטמעים.
watchHtml לֹא חוּט גרסת HTML ספציפית לשעון אפל של ההודעה (according to the Nodemailer docs, השעונים החדשים ביותר אינם דורשים הגדרה זו).
amp לֹא חוּט גרסת HTML ספציפית ל-AMP4EMAIL של ההודעה (ראה Nodemailer's example).
icalEvent לֹא לְהִתְנַגֵד אירוע iCalendar לשימוש כתוכן חלופי להודעה (ראה Nodemailer's calendar events).
alternatives לֹא מַעֲרָך מערך של תוכן הודעה חלופי (ראה Nodemailer's alternative content).
encoding לֹא חוּט קידוד עבור טקסט ומחרוזות HTML (ברירת המחדל היא "utf-8", אך תומך גם בערכי קידוד "hex" ו-"base64").
raw לֹא מחרוזת או מאגר הודעה בפורמט RFC822 שנוצרה בהתאמה אישית לשימוש (במקום הודעה שנוצרת על ידי Nodemailer – ראה Nodemailer's custom source).
textEncoding לֹא חוּט קידוד שנאלץ לשמש עבור ערכי טקסט ("quoted-printable" או "base64"). ערך ברירת המחדל הוא הערך הקרוב ביותר שזוהה (עבור ASCII יש להשתמש ב-"quoted-printable").
priority לֹא חוּט רמת עדיפות עבור האימייל (יכולה להיות "high", "normal" (ברירת מחדל), או "low"). שים לב שערך של "normal" אינו מגדיר כותרת עדיפות (זוהי התנהגות ברירת המחדל). אם מוגדר ערך של "high" או "low", אז הכותרות X-Priority, X-MSMail-Priority ו-Importance הן will be set accordingly.
headers לֹא אובייקט או מערך אובייקט או מערך של שדות כותרת נוספים להגדרה (ראה Nodemailer's custom headers).
messageId לֹא חוּט ערך אופציונלי של מזהה הודעה עבור כותרת "מזהה הודעה" (ערך ברירת מחדל ייווצר אוטומטית אם לא יוגדר – שים לב שהערך צריך להיות adhere to the RFC2822 specification).
date לֹא מחרוזת או תאריך ערך תאריך אופציונלי שישמש אם כותרת התאריך חסרה לאחר הניתוח, אחרת מחרוזת UTC הנוכחית תיעשה בשימוש אם לא תוגדר. כותרת התאריך לא יכולה להיות יותר מ-30 יום לפני השעה הנוכחית.
list לֹא לְהִתְנַגֵד אובייקט אופציונלי של כותרות List-* (ראה Nodemailer's list headers).

בקשה לדוגמה:

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:

Tip

נקודות קצה של דומיין עם שם הדומיין /v1/domains/:domain_name כנקודת הקצה שלהן ניתנות להחלפה עם מזהה הדומיין :domain_id. משמעות הדבר היא שניתן להתייחס לדומיין לפי ערך name או id שלו.

רשימת דומיינים

Note

החל מ-1 בנובמבר 2024, נקודות הקצה של ה-API עבור רשימת דומיינים ו-רשימת כינויי דומיין יקבלו כברירת מחדל 1000 תוצאות לכל עמוד. אם ברצונך להצטרף להתנהגות זו מוקדם, תוכל להעביר את ?paginate=true כפרמטר שאילתה נוסף לכתובת האתר עבור שאילתת נקודת הקצה. ראה דִפּוּף לקבלת תובנות נוספות.

GET /v1/domains

פרמטרים של מחרוזת שאילתה דָרוּשׁ סוּג תֵאוּר
q לֹא מחרוזת (נתמכת ב-RegExp) חיפוש דומיינים לפי שם
name לֹא מחרוזת (נתמכת ב-RegExp) חיפוש דומיינים לפי שם
sort לֹא חוּט מיין לפי שדה ספציפי (יש להוסיף קידומת של מקף יחיד - כדי למיין בכיוון ההפוך של שדה זה). ברירת המחדל היא created_at אם לא מוגדר.
page לֹא מִספָּר ראה Pagination לקבלת תובנות נוספות
limit לֹא מִספָּר ראה Pagination לקבלת תובנות נוספות

בקשה לדוגמה:

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

צור דומיין

POST /v1/domains

פרמטר גוף דָרוּשׁ סוּג תֵאוּר
domain כֵּן מחרוזת (FQDN או IP) שם מתחם מלא ("FQDN") או כתובת IP
team_domain לֹא מחרוזת (מזהה דומיין או שם דומיין; FQDN) הקצה אוטומטית דומיין זה לאותו צוות מדומיין אחר. משמעות הדבר היא שכל החברים מדומיין זה יוקצו כחברי צוות, וגם ה-plan יוגדר אוטומטית ל-team. ניתן להגדיר זאת ל-"none" במידת הצורך כדי להשבית זאת במפורש, אך אין זה הכרחי.
plan לֹא מחרוזת (ניתנת לספירה) סוג תוכנית (חייב להיות "free", "enhanced_protection", או "team", ברירת המחדל היא "free" או התוכנית בתשלום הנוכחית של המשתמש אם יש כזו)
catchall לֹא מחרוזת (כתובות דוא"ל מופרדות) או מחרוזת בוליאנית צור כינוי ברירת מחדל של "alias catch-all", ברירת המחדל היא true (אם true הוא ישתמש בכתובת הדוא"ל של משתמש ה-API כנמען, ואם false לא ייווצר כינוי "alias catch-all"). אם מועברת מחרוזת, זוהי רשימה מופרדת של כתובות דוא"ל לשימוש כנמענים (מופרדות באמצעות מעבר שורה, רווח ו/או פסיק).
has_adult_content_protection לֹא בוליאני האם להפעיל הגנה על תוכן למבוגרים באמצעות סורק ספאם בדומיין זה
has_phishing_protection לֹא בוליאני האם להפעיל הגנה מפני פישינג באמצעות סורק ספאם בדומיין זה
has_executable_protection לֹא בוליאני האם להפעיל הגנה על קובץ ההפעלה של סורק ספאם בדומיין זה
has_virus_protection לֹא בוליאני האם להפעיל את הגנה מפני וירוסים של Spam Scanner בדומיין זה
has_recipient_verification לֹא בוליאני ברירת מחדל של דומיין גלובלי לשאלה האם לדרוש מנמעני כינוי ללחוץ על קישור אימות דוא"ל כדי שאימיילים יעברו דרכם
ignore_mx_check לֹא בוליאני האם להתעלם מבדיקת רשומת ה-MX בדומיין לצורך אימות. זה מיועד בעיקר למשתמשים שיש להם כללי תצורה מתקדמים של בורסת MX וצריכים לשמור את בורסת ה-MX הקיימת שלהם ולהעביר אותה לבורסת שלנו.
retention_days לֹא מִספָּר מספר שלם בין 0 ל-30 התואם למספר ימי השמירה לאחסון הודעות דוא"ל SMTP יוצאות לאחר שנמסרו בהצלחה או שגיאותיהן קבועות. ברירת המחדל היא 0, מה שאומר שהודעות דוא"ל SMTP יוצאות נמחקות ונמחקות באופן מיידי למען אבטחתך.
bounce_webhook לֹא מחרוזת (URL) או ערך בוליאני (false) כתובת האתר http:// או https:// לבחירתך לשליחת webhooks חוזרים. נשלח בקשת POST לכתובת האתר הזו עם מידע על כשלים יוצאים ב-SMTP (למשל, כשלים רכים או קשים - כך שתוכל לנהל את המנויים שלך ולנהל באופן תכנותי את הדוא"ל היוצא שלך).
max_quota_per_alias לֹא חוּט מכסת אחסון מקסימלית עבור כינויים בשם דומיין זה. הזן ערך כגון "1 ג'יגה-בייט" שנותח על ידי bytes.

בקשה לדוגמה:

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:

אימות רשומות SMTP של הדומיין

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

בקשה לדוגמה:

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

רשימת סיסמאות כלל-קבוצתיות

GET /v1/domains/example.com/catch-all-passwords

בקשה לדוגמה:

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

צור סיסמה כוללת לכל הדומיין

POST /v1/domains/example.com/catch-all-passwords

פרמטר גוף דָרוּשׁ סוּג תֵאוּר
new_password לֹא חוּט סיסמה חדשה מותאמת אישית לשימוש עבור סיסמת הכלל לכל הדומיין. שים לב שתוכל להשאיר שדה זה ריק או חסר לחלוטין מגוף בקשת ה-API שלך אם ברצונך לקבל סיסמה חזקה שנוצרה באופן אקראי.
description לֹא חוּט תיאור למטרות ארגון בלבד.

בקשה לדוגמה:

curl BASE_URL/v1/domains/example.com/catch-all-passwords \
  -u API_TOKEN:

הסר את הסיסמה הכוללת של הדומיין

DELETE /v1/domains/example.com/catch-all-passwords/:token_id

בקשה לדוגמה:

curl -X DELETE https://api.forwardemail.net/v1/domains/:domain_name/catch-all-passwords/:token_id \
  -u API_TOKEN:

עדכון דומיין

PUT /v1/domains/example.com

פרמטר גוף דָרוּשׁ סוּג תֵאוּר
smtp_port לֹא מחרוזת או מספר פורט מותאם אישית להגדרה עבור העברת SMTP (ברירת המחדל היא "25")
has_adult_content_protection לֹא בוליאני האם להפעיל הגנה על תוכן למבוגרים באמצעות סורק ספאם בדומיין זה
has_phishing_protection לֹא בוליאני האם להפעיל הגנה מפני פישינג באמצעות סורק ספאם בדומיין זה
has_executable_protection לֹא בוליאני האם להפעיל הגנה על קובץ ההפעלה של סורק ספאם בדומיין זה
has_virus_protection לֹא בוליאני האם להפעיל את הגנה מפני וירוסים של Spam Scanner בדומיין זה
has_recipient_verification לֹא בוליאני ברירת מחדל של דומיין גלובלי לשאלה האם לדרוש מנמעני כינוי ללחוץ על קישור אימות דוא"ל כדי שאימיילים יעברו דרכם
ignore_mx_check לֹא בוליאני האם להתעלם מבדיקת רשומת ה-MX בדומיין לצורך אימות. זה מיועד בעיקר למשתמשים שיש להם כללי תצורה מתקדמים של בורסת MX וצריכים לשמור את בורסת ה-MX הקיימת שלהם ולהעביר אותה לבורסת שלנו.
retention_days לֹא מִספָּר מספר שלם בין 0 ל-30 התואם למספר ימי השמירה לאחסון הודעות דוא"ל SMTP יוצאות לאחר שנמסרו בהצלחה או שגיאותיהן קבועות. ברירת המחדל היא 0, מה שאומר שהודעות דוא"ל SMTP יוצאות נמחקות ונמחקות באופן מיידי למען אבטחתך.
bounce_webhook לֹא מחרוזת (URL) או ערך בוליאני (false) כתובת האתר http:// או https:// לבחירתך לשליחת webhooks חוזרים. נשלח בקשת POST לכתובת האתר הזו עם מידע על כשלים יוצאים ב-SMTP (למשל, כשלים רכים או קשים - כך שתוכל לנהל את המנויים שלך ולנהל באופן תכנותי את הדוא"ל היוצא שלך).
max_quota_per_alias לֹא חוּט מכסת אחסון מקסימלית עבור כינויים בשם דומיין זה. הזן ערך כגון "1 ג'יגה-בייט" שנותח על ידי bytes.

בקשה לדוגמה:

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

Important

אם המשתמש המוזמן כבר חבר מקובל בדומיינים אחרים שהמנהל המזמין אותו חבר בהם, הוא יקבל את ההזמנה באופן אוטומטי ולא ישלח אימייל.

הסר הזמנה לדומיין

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 לֹא בוליאני יש להשתמש בזהירות: פעולה זו תעקוף לחלוטין את סיסמת הכינוי ואת מסד הנתונים הקיימים, ותמחק לצמיתות את אחסון ה-IMAP הקיים ותאפס לחלוטין את מסד הנתונים של הדוא"ל של הכינוי. אנא בצע גיבוי במידת האפשר אם יש לך תיבת דואר קיימת המצורפת לכינוי זה.
emailed_instructions לֹא חוּט כתובת דוא"ל לשליחת סיסמת הכינוי והוראות הגדרה אליה.

בקשה לדוגמה:

curl -X POST https://api.forwardemail.net/v1/domains/example.com/aliases/:alias_id/generate-password \
  -u API_TOKEN:

רשימת כינויי דומיין

Note

החל מ-1 בנובמבר 2024, נקודות הקצה של ה-API עבור רשימת דומיינים ו-רשימת כינויי דומיין יקבלו כברירת מחדל 1000 תוצאות לכל עמוד. אם ברצונך להצטרף להתנהגות זו מוקדם, תוכל להעביר את ?paginate=true כפרמטר שאילתה נוסף לכתובת האתר עבור שאילתת נקודת הקצה. ראה דִפּוּף לקבלת תובנות נוספות.

GET /v1/domains/example.com/aliases

פרמטרים של מחרוזת שאילתה דָרוּשׁ סוּג תֵאוּר
q לֹא מחרוזת (נתמכת ב-RegExp) חיפוש כינויים בדומיין לפי שם, תווית או נמען
name לֹא מחרוזת (נתמכת ב-RegExp) חיפוש כינויים בדומיין לפי שם
recipient לֹא מחרוזת (נתמכת ב-RegExp) חיפוש כינויים בדומיין לפי נמען
sort לֹא חוּט מיין לפי שדה ספציפי (יש להוסיף קידומת של מקף יחיד - כדי למיין בכיוון ההפוך של שדה זה). ברירת המחדל היא created_at אם לא מוגדר.
page לֹא מִספָּר ראה Pagination לקבלת תובנות נוספות
limit לֹא מִספָּר ראה Pagination לקבלת תובנות נוספות

בקשה לדוגמה:

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 של webhook – ואם לא סופקו או שמדובר במערך ריק, כתובת הדוא"ל של המשתמש שמבצע את בקשת ה-API תוגדר כנמען)
description לֹא חוּט תיאור כינוי
labels לֹא מחרוזת או מערך רשימת תוויות (חייבת להיות מופרדת באמצעות מעבר שורה/רווח/פסיק, מחרוזת או מערך)
has_recipient_verification לֹא בוליאני דרוש מהנמענים ללחוץ על קישור אימות דוא"ל כדי שאימיילים יעברו דרכם (ברירת המחדל היא הגדרת הדומיין אם לא מוגדרת במפורש בגוף הבקשה)
is_enabled לֹא בוליאני האם להפעיל או להשבית כינוי זה (אם הוא מושבת, הודעות דוא"ל לא ינותבו לשום מקום אלא יחזירו קודי סטטוס מוצלחים). אם ערך מועבר, הוא מומר לערך בוליאני באמצעות boolean)
error_code_if_disabled לֹא מספר (250, 421, או 550) אימייל נכנס לכתובת הכינוי הזו יידחה אם is_enabled הוא false עם 250 (לשלוח בשקט לשום מקום, למשל חור שחור או /dev/null), 421 (דחייה רכה; וניסיון חוזר עד כ-5 ימים) או 550 כישלון ודחייה קבועים. ברירת המחדל היא 250.
has_imap לֹא בוליאני האם להפעיל או להשבית אחסון IMAP עבור כינוי זה (אם מושבת, הודעות דוא"ל נכנסות שהתקבלו לא יאוחסנו ב-IMAP storage. אם מועבר ערך, הוא מומר לערך בוליאני באמצעות boolean)
has_pgp לֹא בוליאני האם להפעיל או להשבית את OpenPGP encryption עבור IMAP/POP3/CalDAV/CardDAV encrypted email storage באמצעות הכינוי public_key.
public_key לֹא חוּט מפתח ציבורי של OpenPGP בפורמט ASCII Armor ‏(click here to view an example; לדוגמה, מפתח GPG עבור support@forwardemail.net). זה חל רק אם has_pgp מוגדר כ-true. Learn more about end-to-end encryption in our FAQ.
max_quota לֹא חוּט מכסת אחסון מקסימלית עבור כינוי זה. השאר ריק כדי לאפס למכסת הדומיין המקסימלית הנוכחית או הזן ערך כגון "1 ג'יגה-בייט" שנותח על ידי bytes. ערך זה ניתן להתאמה רק על ידי מנהלי דומיין.
vacation_responder_is_enabled לֹא בוליאני האם להפעיל או להשבית הודעת חופשה אוטומטית.
vacation_responder_start_date לֹא חוּט תאריך התחלה עבור משיב חופשה (אם מופעל ולא הוגדר כאן תאריך התחלה, ההנחה היא שהוא כבר התחיל). אנו תומכים בתבניות תאריך כגון MM/DD/YYYY, YYYY-MM-DD, ובתבניות תאריך אחרות באמצעות ניתוח חכם באמצעות dayjs.
vacation_responder_end_date לֹא חוּט תאריך סיום עבור משיב חופשה (אם מופעל ולא מוגדר כאן תאריך סיום, התוצאה היא שהיא לעולם לא מסתיימת ומגיבה לנצח). אנו תומכים בתבניות תאריך כגון MM/DD/YYYY, YYYY-MM-DD, ובתבניות תאריך אחרות באמצעות ניתוח חכם באמצעות dayjs.
vacation_responder_subject לֹא חוּט נושא בטקסט רגיל עבור משיב החופשה, לדוגמה "מחוץ למשרד". אנו משתמשים ב-striptags כדי להסיר את כל ה-HTML כאן.
vacation_responder_message לֹא חוּט הודעה בטקסט רגיל עבור משיב החופשה, לדוגמה "אהיה מחוץ למשרד עד פברואר". אנו משתמשים ב-striptags כדי להסיר את כל ה-HTML כאן.

בקשה לדוגמה:

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 של webhook)
description לֹא חוּט תיאור כינוי
labels לֹא מחרוזת או מערך רשימת תוויות (חייבת להיות מופרדת באמצעות מעבר שורה/רווח/פסיק, מחרוזת או מערך)
has_recipient_verification לֹא בוליאני דרוש מהנמענים ללחוץ על קישור אימות דוא"ל כדי שאימיילים יעברו דרכם (ברירת המחדל היא הגדרת הדומיין אם לא מוגדרת במפורש בגוף הבקשה)
is_enabled לֹא בוליאני האם להפעיל או להשבית כינוי זה (אם הוא מושבת, הודעות דוא"ל לא ינותבו לשום מקום אלא יחזירו קודי סטטוס מוצלחים). אם ערך מועבר, הוא מומר לערך בוליאני באמצעות boolean)
error_code_if_disabled לֹא מספר (250, 421, או 550) אימייל נכנס לכתובת הכינוי הזו יידחה אם is_enabled הוא false עם 250 (לשלוח בשקט לשום מקום, למשל חור שחור או /dev/null), 421 (דחייה רכה; וניסיון חוזר עד כ-5 ימים) או 550 כישלון ודחייה קבועים. ברירת המחדל היא 250.
has_imap לֹא בוליאני האם להפעיל או להשבית אחסון IMAP עבור כינוי זה (אם מושבת, הודעות דוא"ל נכנסות שהתקבלו לא יאוחסנו ב-IMAP storage. אם מועבר ערך, הוא מומר לערך בוליאני באמצעות boolean)
has_pgp לֹא בוליאני האם להפעיל או להשבית את OpenPGP encryption עבור IMAP/POP3/CalDAV/CardDAV encrypted email storage באמצעות הכינוי public_key.
public_key לֹא חוּט מפתח ציבורי של OpenPGP בפורמט ASCII Armor ‏(click here to view an example; לדוגמה, מפתח GPG עבור support@forwardemail.net). זה חל רק אם has_pgp מוגדר כ-true. Learn more about end-to-end encryption in our FAQ.
max_quota לֹא חוּט מכסת אחסון מקסימלית עבור כינוי זה. השאר ריק כדי לאפס למכסת הדומיין המקסימלית הנוכחית או הזן ערך כגון "1 ג'יגה-בייט" שנותח על ידי bytes. ערך זה ניתן להתאמה רק על ידי מנהלי דומיין.
vacation_responder_is_enabled לֹא בוליאני האם להפעיל או להשבית הודעת חופשה אוטומטית.
vacation_responder_start_date לֹא חוּט תאריך התחלה עבור משיב חופשה (אם מופעל ולא הוגדר כאן תאריך התחלה, ההנחה היא שהוא כבר התחיל). אנו תומכים בתבניות תאריך כגון MM/DD/YYYY, YYYY-MM-DD, ובתבניות תאריך אחרות באמצעות ניתוח חכם באמצעות dayjs.
vacation_responder_end_date לֹא חוּט תאריך סיום עבור משיב חופשה (אם מופעל ולא מוגדר כאן תאריך סיום, התוצאה היא שהיא לעולם לא מסתיימת ומגיבה לנצח). אנו תומכים בתבניות תאריך כגון MM/DD/YYYY, YYYY-MM-DD, ובתבניות תאריך אחרות באמצעות ניתוח חכם באמצעות dayjs.
vacation_responder_subject לֹא חוּט נושא בטקסט רגיל עבור משיב החופשה, לדוגמה "מחוץ למשרד". אנו משתמשים ב-striptags כדי להסיר את כל ה-HTML כאן.
vacation_responder_message לֹא חוּט הודעה בטקסט רגיל עבור משיב החופשה, לדוגמה "אהיה מחוץ למשרד עד פברואר". אנו משתמשים ב-striptags כדי להסיר את כל ה-HTML כאן.

בקשה לדוגמה:

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 כֵּן חוּט כל רשומת טקסט טקסט רגיל תקפה להעברת דוא"ל

בקשה לדוגמה:

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