API של אימייל

ספריות

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

שפה	סִפְרִיָה
אוֹדֶם	פאראדיי
פִּיתוֹן	בקשות
Java	OkHttp
PHP	לִזלוֹל
JavaScript	סוכן על (אנחנו מתחזקים)
Node.js	סוכן על (אנחנו מתחזקים)
ללכת	net/http
.NET	RestSharp

URIs בסיסי

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

אימות

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

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

שגיאות

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

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

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

לוקליזציה

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

דִפּוּף

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

העידון נתמך על ידי כל נקודות הקצה של 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` פרמטרי querystring).
`X-Page-Size`	`X-Page-Size: 10`	המספר הכולל של התוצאות בדף שהוחזר (למשל, מבוסס על ביטול `limit` פרמטר querystring והתוצאות בפועל שהוחזרו).
`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"`	אנו מספקים א `Link` כותרת תגובת HTTP תוכל לנתח כפי שמוצג בדוגמה. זֶהוּ דומה ל-GitHub (לדוגמה, לא כל הערכים יסופקו אם הם לא רלוונטיים או זמינים, למשל. `"next"` לא יסופק אם אין דף נוסף).

בקשה לדוגמה:

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

יומנים

אחזר יומנים

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

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

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

0 0 * * * /usr/bin/curl https://api.forwardemail.net/v1/logs/download -u API_TOKEN: &>/dev/null

שים לב שאתה יכול להשתמש בשירותים כגון Crontab.guru כדי לאמת את תחביר ביטוי ה-cron job שלך.

דוגמה לעבודת 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`	לא	מחרוזת (כתובת אתר)	קישור לתמונת אווטאר

בקשה לדוגמה:

curl -X PUT https://api.forwardemail.net/v1/account \
  -u API_TOKEN: \
  -d "email=user%40gmail.com"

אנשי קשר כינוי (CardDAV)

[!פֶּתֶק] שלא כמו נקודות קצה אחרות של API, אלה דורשות אימות "שם משתמש" שווה לשם המשתמש הכינוי ו"סיסמה" שווה לסיסמה שנוצרה בכינוי ככותרות הרשאות בסיסיות.

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

[!NOTE] תמיכת CardDAV עדיין לא זמינה, עקוב אחר הדיון הזה ב-GitHub לקבלת עדכונים.

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

GET /v1/contacts

בקרוב

צור קשר

POST /v1/contacts

בקרוב

אחזר איש קשר

GET /v1/contacts/:id

בקרוב

עדכן איש קשר

PUT /v1/contacts/:id

בקרוב

מחק איש קשר

DELETE /v1/contacts/:id

בקרוב

יומני כינוי (CalDAV)

[!פֶּתֶק] שלא כמו נקודות קצה אחרות של API, אלה דורשות אימות "שם משתמש" שווה לשם המשתמש הכינוי ו"סיסמה" שווה לסיסמה שנוצרה בכינוי ככותרות הרשאות בסיסיות.

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

רשימת לוחות שנה

GET /v1/calendars

בקרוב

צור לוח שנה

POST /v1/calendars

בקרוב

אחזר לוח שנה

GET /v1/calendars/:id

בקרוב

עדכן לוח שנה

PUT /v1/calendars/:id

בקרוב

מחק לוח שנה

DELETE /v1/calendars/:id

בקרוב

הודעות כינוי (IMAP/POP3)

[!פֶּתֶק] שלא כמו נקודות קצה אחרות של API, אלה דורשות אימות "שם משתמש" שווה לשם המשתמש הכינוי ו"סיסמה" שווה לסיסמה שנוצרה בכינוי ככותרות הרשאות בסיסיות.

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

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

ניתן למצוא הוראות אלו בחלק השאלות הנפוצות שלנו האם אתה תומך בקבלת אימייל עם IMAP?.

רשום וחפש הודעות

GET /v1/messages

בקרוב

צור הודעה

[!פֶּתֶק] צוואה זו NOT שלח אימייל - זה פשוט יוסיף את ההודעה לתיקיית תיבת הדואר שלך (למשל, זה דומה ל-IMAP APPEND פְּקוּדָה). אם תרצה לשלוח מייל, ראה צור דוא"ל SMTP יוצא לְהַלָן. לאחר יצירת דוא"ל ה-SMTP היוצא, תוכל לצרף עותק שלו באמצעות נקודת קצה זו לתיבת הדואר של הכינוי שלך למטרות אחסון.

POST /v1/messages

בקרוב

אחזר הודעה

GET /v1/messages/:id

בקרוב

עדכון הודעה

PUT /v1/messages/:id

בקרוב

מחק הודעה

DELETE /v1/messages:id

בקרוב

תיקיות כינוי (IMAP/POP3)

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

[!אַזהָרָה] חלק זה של נקודות קצה הוא עבודה בתהליך והוא ישוחרר (בתקווה) בשנת 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`	לא	מספר	לִרְאוֹת דִפּוּף לתובנה נוספת
`limit`	לא	מספר	לִרְאוֹת דִפּוּף לתובנה נוספת

בקשה לדוגמה:

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`	לא	מחרוזת או מערך	רשימה מופרדת בפסיקים או מערך של נמענים עבור הכותרת "עותק".
`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`	לא	חוּט	ערך Message-ID אופציונלי עבור הכותרת "Message-ID" (ערך ברירת מחדל ייווצר אוטומטית אם לא מוגדר - שימו לב שהערך צריך היצמד למפרט 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`"

אחזר דוא"ל 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:

דומיינים

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

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

[!פֶּתֶק] החל מ-1 בנובמבר 2024, נקודות הקצה של ה-API עבור רשימת דומיינים ו רשום כינויים של דומיינים יהיה ברירת המחדל ל 1000 מקסימום תוצאות לכל עמוד. אם תרצה להצטרף להתנהגות זו מוקדם, תוכל לעבור ?paginate=true כפרמטר querystring נוסף לכתובת ה-URL עבור שאילתת נקודת הקצה. לִרְאוֹת דִפּוּף לתובנה נוספת.

GET /v1/domains

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

בקשה לדוגמה:

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`	לא	מחרוזת (כתובות אימייל מופרדות) או בוליאנית	צור כינוי תוסף ברירת מחדל, ברירת המחדל היא `true` (אם `true` הוא ישתמש בכתובת הדוא"ל של משתמש ה-API כנמען, ואם `false` לא ייווצר תכלס). אם מחרוזת עוברת, זוהי רשימה מופרדת של כתובות דוא"ל לשימוש כנמענים (מופרדות על ידי מעבר שורה, רווח ו/או פסיק)
`has_adult_content_protection`	לא	בוליאנית	האם להפעיל הגנה על תוכן למבוגרים בדומיין זה
`has_phishing_protection`	לא	בוליאנית	האם להפעיל הגנת דיוג של סורק דואר זבל בדומיין זה
`has_executable_protection`	לא	בוליאנית	האם להפעיל הגנת הפעלה של סורק דואר זבל בדומיין זה
`has_virus_protection`	לא	בוליאנית	האם להפעיל הגנה מפני וירוסים של סורק דואר זבל בדומיין זה
`has_recipient_verification`	לא	בוליאנית	ברירת המחדל של הדומיין הגלובלי אם לדרוש ממקבלי הכינוי ללחוץ על קישור לאימות דוא"ל כדי שהודעות הדוא"ל יזרום
`ignore_mx_check`	לא	בוליאנית	האם להתעלם מבדיקת רשומת ה-MX בדומיין לצורך אימות. זה מיועד בעיקר למשתמשים שיש להם כללי תצורה מתקדמים של MX Exchange וצריכים לשמור על בורסת ה-MX הקיימת שלהם ולהעביר למרכזינו.
`retention_days`	לא	מספר	מספר שלם בין `0` ו `30` שמתאים למספר ימי השמירה לאחסון הודעות דוא"ל SMTP יוצאות לאחר מסירה מוצלחת או שגיאה קבועה. ברירת מחדל ל `0`, מה שאומר שהודעות דוא"ל SMTP יוצאות נמחקות ומבוטלות מיד למען אבטחתך.
`bounce_webhook`	לא	מחרוזת (כתובת אתר) או בוליאנית (שקר)	ה `http://` אוֹ `https://` כתובת האתר של webhook לבחירתך כדי לשלוח אליה Hooks webhook. אנו נגיש א `POST` בקש לכתובת אתר זו עם מידע על כשלי SMTP יוצאים (למשל כשלים רכים או קשים - כך שתוכל לנהל את המנויים שלך ולנהל באופן פרוגרמטי את הדוא"ל היוצא שלך).
`max_quota_per_alias`	לא	חוּט	מכסת אחסון מקסימלית עבור כינויים בשם הדומיין הזה. הזן ערך כגון "1 GB" שינתח על ידי בתים.

בקשה לדוגמה:

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`	לא	בוליאנית	האם להפעיל הגנת הפעלה של סורק דואר זבל בדומיין זה
`has_virus_protection`	לא	בוליאנית	האם להפעיל הגנה מפני וירוסים של סורק דואר זבל בדומיין זה
`has_recipient_verification`	לא	בוליאנית	ברירת המחדל של הדומיין הגלובלי אם לדרוש ממקבלי הכינוי ללחוץ על קישור לאימות דוא"ל כדי שהודעות הדוא"ל יזרום
`ignore_mx_check`	לא	בוליאנית	האם להתעלם מבדיקת רשומת ה-MX בדומיין לצורך אימות. זה מיועד בעיקר למשתמשים שיש להם כללי תצורה מתקדמים של MX Exchange וצריכים לשמור על בורסת ה-MX הקיימת שלהם ולהעביר למרכזינו.
`retention_days`	לא	מספר	מספר שלם בין `0` ו `30` שמתאים למספר ימי השמירה לאחסון הודעות דוא"ל SMTP יוצאות לאחר מסירה מוצלחת או שגיאה קבועה. ברירת מחדל ל `0`, מה שאומר שהודעות דוא"ל SMTP יוצאות נמחקות ומבוטלות מיד למען אבטחתך.
`bounce_webhook`	לא	מחרוזת (כתובת אתר) או בוליאנית (שקר)	ה `http://` אוֹ `https://` כתובת האתר של webhook לבחירתך כדי לשלוח אליה Hooks webhook. אנו נגיש א `POST` בקש לכתובת אתר זו עם מידע על כשלי SMTP יוצאים (למשל כשלים רכים או קשים - כך שתוכל לנהל את המנויים שלך ולנהל באופן פרוגרמטי את הדוא"ל היוצא שלך).
`max_quota_per_alias`	לא	חוּט	מכסת אחסון מקסימלית עבור כינויים בשם הדומיין הזה. הזן ערך כגון "1 GB" שינתח על ידי בתים.

בקשה לדוגמה:

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:

כינויים

צור סיסמה כינוי

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

בקשה לדוגמה:

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

רשום כינויים של דומיינים

[!פֶּתֶק] החל מ-1 בנובמבר 2024, נקודות הקצה של ה-API עבור רשימת דומיינים ו רשום כינויים של דומיינים יהיה ברירת המחדל ל 1000 מקסימום תוצאות לכל עמוד. אם תרצה להצטרף להתנהגות זו מוקדם, תוכל לעבור ?paginate=true כפרמטר querystring נוסף לכתובת ה-URL עבור שאילתת נקודת הקצה. לִרְאוֹת דִפּוּף לתובנה נוספת.

GET /v1/domains/example.com/aliases

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

בקשה לדוגמה:

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`	לא	בוליאנית	האם להפעיל או להשבית את הכינוי הזה (אם מושבת, הודעות דוא"ל לא ינותבו לשום מקום אלא יחזירו קודי סטטוס מוצלחים). אם ערך מועבר, הוא מומר לערך בוליאני באמצעות בוליאני)
`error_code_if_disabled`	לא	מספר (או `250`, `421`, או `550`)	אימייל נכנס לכינוי זה ידחה אם `is_enabled` הוא `false` עם אחד מהם `250` (לספק בשקט לשום מקום, למשל blackhole או `/dev/null`), `421` (דחייה רכה; ונסה שוב למשך עד ~5 ימים) או `550` כישלון ודחייה קבועים. ברירת מחדל ל `250`.
`has_imap`	לא	בוליאנית	האם להפעיל או להשבית אחסון IMAP עבור הכינוי הזה (אם מושבת, אזי אימיילים נכנסים שהתקבלו לא יאוחסנו ב אחסון IMAP. אם ערך מועבר, הוא מומר לערך בוליאני באמצעות בוליאני)
`has_pgp`	לא	בוליאנית	האם להפעיל או להשבית הצפנת OpenPGP ל אחסון דוא"ל מוצפן IMAP/POP3/CalDAV באמצעות הכינוי `public_key`.
`public_key`	לא	חוּט	מפתח ציבורי OpenPGP בפורמט ASCII Armor (לחץ כאן לצפייה בדוגמה; לְמָשָׁל מפתח GPG עבור `support@forwardemail.net`). זה חל רק אם יש לך `has_pgp` מכוון ל `true`. למידע נוסף על הצפנה מקצה לקצה בשאלות הנפוצות שלנו.
`max_quota`	לא	חוּט	מכסת אחסון מקסימלית עבור הכינוי הזה. השאר ריק כדי לאפס למכסה המקסימלית הנוכחית של הדומיין או הזן ערך כגון "1 GB" שינתח על ידי בתים. ערך זה יכול להיות מותאם רק על ידי מנהלי דומיין.
`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`	לא	בוליאנית	האם להפעיל או להשבית את הכינוי הזה (אם מושבת, הודעות דוא"ל לא ינותבו לשום מקום אלא יחזירו קודי סטטוס מוצלחים). אם ערך מועבר, הוא מומר לערך בוליאני באמצעות בוליאני)
`error_code_if_disabled`	לא	מספר (או `250`, `421`, או `550`)	אימייל נכנס לכינוי זה ידחה אם `is_enabled` הוא `false` עם אחד מהם `250` (לספק בשקט לשום מקום, למשל blackhole או `/dev/null`), `421` (דחייה רכה; ונסה שוב למשך עד ~5 ימים) או `550` כישלון ודחייה קבועים. ברירת מחדל ל `250`.
`has_imap`	לא	בוליאנית	האם להפעיל או להשבית אחסון IMAP עבור הכינוי הזה (אם מושבת, אזי אימיילים נכנסים שהתקבלו לא יאוחסנו ב אחסון IMAP. אם ערך מועבר, הוא מומר לערך בוליאני באמצעות בוליאני)
`has_pgp`	לא	בוליאנית	האם להפעיל או להשבית הצפנת OpenPGP ל אחסון דוא"ל מוצפן IMAP/POP3/CalDAV באמצעות הכינוי `public_key`.
`public_key`	לא	חוּט	מפתח ציבורי OpenPGP בפורמט ASCII Armor (לחץ כאן לצפייה בדוגמה; לְמָשָׁל מפתח GPG עבור `support@forwardemail.net`). זה חל רק אם יש לך `has_pgp` מכוון ל `true`. למידע נוסף על הצפנה מקצה לקצה בשאלות הנפוצות שלנו.
`max_quota`	לא	חוּט	מכסת אחסון מקסימלית עבור הכינוי הזה. השאר ריק כדי לאפס למכסה המקסימלית הנוכחית של הדומיין או הזן ערך כגון "1 GB" שינתח על ידי בתים. ערך זה יכול להיות מותאם רק על ידי מנהלי דומיין.
`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:

הצפין

אנו מאפשרים לך להצפין רשומות גם בתוכנית החינמית ללא עלות. פרטיות לא צריכה להיות תכונה, היא צריכה להיות מובנית מטבעה בכל ההיבטים של המוצר. כפי שהתבקש מאוד ב-a דיון במדריכי פרטיות והלאה בעיות GitHub שלנו הוספנו את זה.

הצפנת רשומת TXT

POST /v1/encrypt

פרמטר גוף	נדרש	סוּג	תיאור
`input`	כן	חוּט	כל רשומת TXT חוקית של העבר אימייל רגיל

בקשה לדוגמה:

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