- דף חיפוש
- תוכן עניינים
API של אימייל
ספריות
כרגע עדיין לא שחררנו עטיפות API, אבל אנחנו מתכננים לעשות זאת בעתיד הקרוב. שלח דואר אלקטרוני ל api@forwardemail.net אם ברצונך לקבל הודעה כאשר שוחרר מעטפת ה-API של שפת תכנות מסוימת. בינתיים, אתה יכול להשתמש בספריות בקשות HTTP המומלצות ביישום שלך, או פשוט להשתמש תלתל כמו בדוגמאות שלהלן.
שפה | ספריה |
---|---|
רובי | פאראדיי |
פייתון | בקשות |
ג'אווה | OkHttp |
PHP | לפטפט |
JavaScript | סופרגנט (אנחנו מתחזקים) |
Node.js | סופרגנט (אנחנו מתחזקים) |
ללכת | net / http |
.NET | RestSharp |
בסיס URI
נתיב ה-URI הבסיסי של HTTP הוא: https://api.forwardemail.net
.
אימות
כל נקודות הקצה דורשות שלך מפתח API להיות מוגדר כערך "שם משתמש" של הבקשה אישור בסיסי כּוֹתֶרֶת. אל תדאג - דוגמאות מסופקות להלן עבורך אם אינך בטוח מה זה.
שגיאות
אם מתרחשות שגיאות, גוף התגובה של בקשת ה- API יכיל הודעת שגיאה מפורטת.
קוד | שם |
---|---|
200 | OK |
400 | בקשה רעה |
401 | לא מורשה |
403 | אסור |
404 | לא נמצא |
429 | יותר מדי בקשות |
500 | שגיאת שרת פנימית |
501 | לא מיושם |
502 | שער רע |
503 | שירותים לא זמינים |
504 | פסק זמן של שער |
לוקליזציה
השירות שלנו מתורגם ליותר מ-25 שפות שונות. כל הודעות התגובה של ה-API מתורגמות למקום האחרון שזוהה של המשתמש שמבצע את בקשת ה-API. אתה יכול לעקוף זאת על ידי העברת מנהג Accept-Language
כּוֹתֶרֶת. אל תהסס לנסות זאת באמצעות התפריט הנפתח של השפה בתחתית עמוד זה.
עימוד
אם ברצונך לקבל הודעה כאשר העימוד זמין, אנא שלח דוא"ל api@forwardemail.net.
חשבון
צור חשבון
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"
אימיילים
אנא ודא שעקבת אחר הוראות ההגדרה עבור הדומיין שלך. ניתן למצוא הוראות אלו בכתובת החשבון שלי ← תחומים ← הגדרות ← תצורת SMTP יוצאת. עליך להבטיח הגדרה של DKIM, Return-Path ו-DMARC לשליחת SMTP יוצאת עם הדומיין שלך.
רשום מיילים
שים לב שנקודת קצה זו אינה מחזירה אימייל שכבר נוצר message
, headers
, accepted
, ולא rejectedErrors
נכסים.
כדי להחזיר את המאפיינים ואת הערכים שלהם, אנא השתמש ב- אחזר אימייל נקודת קצה עם מזהה דוא"ל.
נקודת קצה זו תחזור לכל היותר 50
תוצאות בכל פעם. אם ברצונך לבצע שאילתה עבור דפים מרובים, הוסף ?page=NUMBER
איפה NUMBER
הוא מספר שלם, למשל. ?page=1
.
GET /v1/emails
פרמטר מחרוזת קווריסט | נדרש | סוג | תיאור |
---|---|---|---|
q | לא | מחרוזת (RegExp נתמך) | חפש אימיילים לפי מטא נתונים |
domain | לא | מחרוזת (RegExp נתמך) | חפש אימיילים לפי שם דומיין |
page | לא | מספר | דף להחזרת התוצאות (ברירת המחדל היא 1 ) |
`גבול | לא | מספר | מספר התוצאות בכל דף להחזר (ברירת המחדל היא 50 - המקסימום הוא 50 והמינימום הוא 10 ) |
בקשת דוגמה:
curl https://api.forwardemail.net/v1/emails \
-u API_TOKEN:
צור אימייל
ה-API שלנו ליצירת אימייל נוצר בהשראת וממנף את תצורת אפשרות ההודעות של Nodemailer. נא לדחות את תצורת הודעת Nodemailer עבור כל הפרמטרים של הגוף למטה.
שימו לב שלמעט envelope
ו dkim
(מכיוון שאנו מגדירים אותם אוטומטית עבורך), אנו תומכים בכל האפשרויות של Nodemailer. אנחנו מגדירים באופן אוטומטי disableFileAccess
ו disableUrlAccess
אפשרויות ל true
למטרות אבטחה.
אתה צריך לעבור את האפשרות היחידה של raw
עם האימייל המלא הגולמי שלך כולל כותרות או להעביר את אפשרויות פרמטר גוף בודדות למטה.
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`"
אחזר אימייל
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:
דומיינים
/v1/domains/:domain_name
מכיוון שהנתיב שלהם ניתנים להחלפה עם מזהה דומיין :domain_id
. זה אומר שאתה יכול להתייחס לדומיין לפי אחד מהם name
או id
ערך.
רשימת תחומים
GET /v1/domains
פרמטר מחרוזת קווריסט | נדרש | סוג | תיאור |
---|---|---|---|
q | לא | מחרוזת (RegExp נתמך) | חפש דומיינים לפי שם |
name | לא | מחרוזת (RegExp נתמך) | חפש דומיינים לפי שם |
בקשת דוגמה:
curl https://api.forwardemail.net/v1/domains \
-u API_TOKEN:
צור דומיין
POST /v1/domains
פרמטר גוף | נדרש | סוג | תיאור |
---|---|---|---|
domain | כן | מחרוזת (FQDN או IP) | שם תחום מוסמך לחלוטין ("FQDN") או כתובת IP |
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 | לא | בוליאני | ברירת המחדל של הדומיין הגלובלי אם לדרוש ממקבלי הכינוי ללחוץ על קישור לאימות דוא"ל כדי שהודעות הדוא"ל יזרום |
בקשת דוגמה:
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 | לא | בוליאני | ברירת המחדל של הדומיין הגלובלי אם לדרוש ממקבלי הכינוי ללחוץ על קישור לאימות דוא"ל כדי שהודעות הדוא"ל יזרום |
בקשת דוגמה:
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:
כינויים
רשום כינויים של דומיינים
GET /v1/domains/example.com/aliases
פרמטר מחרוזת קווריסט | נדרש | סוג | תיאור |
---|---|---|---|
q | לא | מחרוזת (RegExp נתמך) | חפש כינויים בדומיין לפי שם, תווית או נמען |
name | לא | מחרוזת (RegExp נתמך) | חפש כינויים בדומיין לפי שם |
recipient | לא | מחרוזת (RegExp נתמך) | חפש כינויים בדומיין לפי נמען |
בקשת דוגמה:
curl https://api.forwardemail.net/v1/domains/example.com/aliases \
-u API_TOKEN:
צור כינוי דומיין חדש
POST /v1/domains/example.com/aliases
פרמטר גוף | נדרש | סוג | תיאור |
---|---|---|---|
name | לא | מחרוזת | שם כינוי (אם לא מסופק או אם ריק, נוצר כינוי אקראי) |
recipients | לא | מחרוזת או מערך | רשימת נמענים (חייבים להיות מופרדים במעבר שורה/רווח/פסיק מחרוזת או מערך של כתובות דוא"ל חוקיות, שמות דומיין מלאים ("FQDN"), כתובות IP ו/או כתובות URL של webhook - ואם לא מסופקים או ריק מערך, ואז האימייל של המשתמש שמבצע את בקשת ה-API יוגדר כנמען) |
description | לא | מחרוזת | תיאור הכינוי |
labels | לא | מחרוזת או מערך | רשימת התוויות (חייבת להיות מחרוזת או מערך מופרדים בפסקי שורות / רווח / פסיק) |
has_recipient_verification | לא | בוליאני | האם לאפשר לדרוש מהנמענים ללחוץ על קישור לאימות דוא"ל כדי שהודעות הדוא"ל יזרמו (ברירת מחדל היא הגדרת הדומיין אם לא מוגדרת במפורש בגוף הבקשה) |
is_enabled | לא | בוליאני | האם לאפשר להשבית את הכינוי הזה (אם מושבת, הודעות דוא"ל לא ינותבו לשום מקום אלא יחזירו קודי סטטוס מוצלחים). ברירת מחדל ל true , אבל אם ערך מועבר, הוא מומר לבוליאני באמצעות בוליאני) |
בקשת דוגמה:
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 של רשת האינטרנט) |
description | לא | מחרוזת | תיאור הכינוי |
labels | לא | מחרוזת או מערך | רשימת התוויות (חייבת להיות מחרוזת או מערך מופרדים בפסקי שורות / רווח / פסיק) |
has_recipient_verification | לא | בוליאני | האם לאפשר לדרוש מהנמענים ללחוץ על קישור לאימות דוא"ל כדי שהודעות הדוא"ל יזרמו (ברירת מחדל היא הגדרת הדומיין אם לא מוגדרת במפורש בגוף הבקשה) |
is_enabled | לא | בוליאני | האם לאפשר להשבית כינוי זה (אם מושבת, דוא"ל ינותב לשום מקום אלא יחזיר קודי סטטוס מוצלחים) |
בקשת דוגמה:
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: