API דואר אלקטרוני

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

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

כל נקודות הקצה דורשות אימות באמצעות Basic Authorization. אנו תומכים בשתי שיטות אימות:

API Token Authentication (מומלץ לרוב נקודות הקצה)

הגדר את מפתח ה-API שלך כערך "username" עם סיסמה ריקה:

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

שים לב לנקודתיים (:) אחרי אסימון ה-API – זה מציין סיסמה ריקה בפורמט Basic Auth.

Alias Credentials Authentication (לדואר יוצא)

נקודת הקצה Create outbound SMTP email תומכת גם באימות באמצעות כתובת הדואר האלקטרוני של הכינוי שלך וסיסמת כינוי שנוצרה:

curl -X POST https://api.forwardemail.net/v1/emails \
  -u "alias@yourdomain.com:your_generated_password" \
  -d "to=recipient@example.com" \
  -d "subject=Hello" \
  -d "text=Test email"

שיטה זו שימושית כאשר שולחים מיילים מיישומים שכבר משתמשים באישורי SMTP ומאפשרת מעבר חלק מ-SMTP ל-API שלנו.

Alias-Only Endpoints

נקודות הקצה Alias Contacts, Alias Calendars, Alias Messages, ו-Alias Folders דורשות אישורי כינוי ואינן תומכות באימות באמצעות אסימון API.

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

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

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

דפדוף (Pagination) נתמך בכל נקודות הקצה שמציגות רשימות תוצאות.

פשוט ספק את מאפייני ה-querystring page (ואופציונלית limit).

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

בקשת דוגמה:

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

שליפת יומנים

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

זה מאפשר לך ליצור עבודות רקע עם Cron job או באמצעות תוכנת תזמון עבודות שלנו Bree ל-Node.js כדי לקבל יומנים מתי שתרצה. שים לב שנקודת קצה זו מוגבלת ל-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 job (בחצות כל יום):

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

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

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

ל-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

ל-Linux ואובונטו:

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"

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

GET /v1/contacts

בקרוב

יצירת איש קשר

POST /v1/contacts

בקרוב

שליפת איש קשר

GET /v1/contacts/:id

בקרוב

עדכון איש קשר

PUT /v1/contacts/:id

בקרוב

מחיקת איש קשר

DELETE /v1/contacts/:id

בקרוב

רשימת יומנים

GET /v1/calendars

בקרוב

יצירת יומן

POST /v1/calendars

בקרוב

שליפת יומן

GET /v1/calendars/:id

בקרוב

עדכון יומן

PUT /v1/calendars/:id

בקרוב

מחיקת יומן

DELETE /v1/calendars/:id

בקרוב

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

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

רשימה וחיפוש הודעות

GET /v1/messages

בקרוב

יצירת הודעה

POST /v1/messages

בקרוב

שליפת הודעה

GET /v1/messages/:id

בקרוב

עדכון הודעה

PUT /v1/messages/:id

בקרוב

מחיקת הודעה

DELETE /v1/messages:id

בקרוב

רשימת תיקיות

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 של דוא"ל.

כדי להחזיר את אותם נכסים וערכיהם, אנא השתמשו בנקודת הקצה Retrieve email עם מזהה הדוא"ל.

GET /v1/emails

דוגמת בקשה:

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

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

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

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

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

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

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

POST /v1/emails

בקשת דוגמה (אסימון API):

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 "alias@example.com:GENERATED_PASSWORD" \
  -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 יוצאים בלקוח, במסד הנתונים או באפליקציה שלך. ניתן להתייחס לערך מזהה האימייל שלנו במסד הנתונים שלך אם תרצה – ערך זה מוחזר משני נקודות הקצה Create email ו-Retrieve email.

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:

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

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

בקשת דוגמה:

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

רשום סיסמאות catch-all כלליות לדומיין

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

בקשת דוגמה:

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

צור סיסמת catch-all כללית לדומיין

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

בקשת דוגמה:

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

הסר סיסמת catch-all כללית לדומיין

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

בקשת דוגמה:

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:

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

שים לב שאם אינך שולח הוראות באימייל, שם המשתמש והסיסמה יופיעו בגוף התגובה בפורמט JSON של בקשה מוצלחת כך: { username: 'alias@yourdomain.com', password: 'some-generated-password' }.

POST /v1/domains/example.com/aliases/:alias_id/generate-password

בקשת דוגמה:

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

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

GET /v1/domains/example.com/aliases

בקשת דוגמה:

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

יצירת כינוי חדש לדומיין

POST /v1/domains/example.com/aliases

Example Request:

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

Example Request:

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

GET /v1/domains/:domain_name/aliases/:alias_name

Example Request:

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:

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

הצפנת רשומת TXT

POST /v1/encrypt

בקשת דוגמה:

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