API อีเมล

ขณะนี้ เรายังไม่ได้เปิดตัว wrapper API ใดๆ แต่เราวางแผนที่จะดำเนินการดังกล่าวในอนาคตอันใกล้ ส่งอีเมล์ถึง api@forwardemail.net หากคุณต้องการได้รับแจ้งเมื่อมีการเผยแพร่ wrapper API ของภาษาโปรแกรมเฉพาะ ในระหว่างนี้ คุณสามารถใช้ไลบรารีคำขอ HTTP ที่แนะนำเหล่านี้ในแอปพลิเคชันของคุณ หรือเพียงแค่ใช้ ขด ดังตัวอย่างด้านล่าง

ภาษาห้องสมุด
ทับทิมฟาราเดย์
หลามการร้องขอ
ชวาตกลงHttp
PHPล่อ
จาวาสคริปต์ซุปเปอร์เอเจนต์ (เราเป็นผู้ดูแล)
โหนด jsซุปเปอร์เอเจนต์ (เราเป็นผู้ดูแล)
ไปสุทธิ / http
.NETเรสชาร์ป

เส้นทาง URI ฐาน HTTP ปัจจุบันคือ: https://api.forwardemail.net.

ปลายทางทั้งหมดต้องการของคุณ คีย์ API ที่จะกำหนดเป็นค่า "ชื่อผู้ใช้" ของคำขอของ การอนุญาตขั้นพื้นฐาน หัวข้อ. ไม่ต้องกังวล ตัวอย่างมีให้ด้านล่างหากคุณไม่แน่ใจว่านี่คืออะไร

หากมีข้อผิดพลาดเกิดขึ้นเนื้อหาการตอบกลับของคำขอ API จะมีข้อความแสดงข้อผิดพลาดโดยละเอียด

รหัสชื่อ
200OK
400คำขอไม่ถูกต้อง
401ไม่มีสิทธิ
403พระราชวังต้องห้าม
404ไม่พบ
429คำขอมากเกินไป
500ข้อผิดพลาดเซิร์ฟเวอร์ภายใน
501ไม่ได้ดำเนินการ
502เกตเวย์ไม่ดี
503ไม่สามารถให้บริการได้
504เกตเวย์หมดเวลา
เคล็ดลับ: หากคุณได้รับรหัสสถานะ 5xx (ซึ่งไม่ควรเกิดขึ้น) โปรดติดต่อเราที่ api@forwardemail.net และเราจะช่วยคุณแก้ไขปัญหาของคุณทันที

บริการของเราได้รับการแปลเป็นภาษาต่างๆ มากกว่า 25 ภาษา ข้อความตอบกลับ API ทั้งหมดได้รับการแปลเป็นภาษาท้องถิ่นล่าสุดที่ตรวจพบของผู้ใช้ที่ส่งคำขอ API คุณสามารถแทนที่สิ่งนี้ได้โดยส่งค่ากำหนดเอง Accept-Language หัวข้อ. ลองใช้ภาษาแบบเลื่อนลงที่ด้านล่างของหน้านี้ได้ตามสบาย

หากคุณต้องการได้รับแจ้งเมื่อมีการแบ่งหน้า โปรดส่งอีเมลถึง api@forwardemail.net.

ดึงข้อมูลบันทึก

API ของเราอนุญาตให้คุณดาวน์โหลดบันทึกสำหรับบัญชีของคุณโดยทางโปรแกรม การส่งคำขอไปยังตำแหน่งข้อมูลนี้จะประมวลผลบันทึกทั้งหมดสำหรับบัญชีของคุณและส่งอีเมลถึงคุณเป็นไฟล์แนบ (จีซิป บีบอัด 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 รูปแบบ).

ตัวอย่างคำขอ:

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 ของคุณ

ตัวอย่างงาน 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

สำหรับ Linux และ Ubuntu:

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"

โปรดตรวจสอบว่าคุณได้ทำตามคำแนะนำในการตั้งค่าสำหรับโดเมนของคุณ ดูคำแนะนำเหล่านี้ได้ที่ บัญชีของฉัน → โดเมน → การตั้งค่า → การกำหนดค่า SMTP ขาออก. คุณต้องแน่ใจว่าได้ตั้งค่า DKIM, Return-Path และ DMARC เพื่อส่ง SMTP ขาออกด้วยโดเมนของคุณ

รับขีดจำกัดอีเมล

นี่เป็นจุดสิ้นสุดแบบธรรมดาที่ส่งคืนออบเจ็กต์ JSON ที่มี count และ limit สำหรับจำนวนข้อความขาออก SMTP รายวันในแต่ละบัญชี

GET /v1/emails/limit

ตัวอย่างคำขอ:

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

รายชื่ออีเมล

โปรดทราบว่าปลายทางนี้จะไม่ส่งคืนอีเมลที่สร้างไว้แล้ว message, headers, accepted, ก็ไม่เช่นกัน rejectedErrors คุณสมบัติ.

หากต้องการส่งคืนคุณสมบัติและค่าเหล่านั้น โปรดใช้ ดึงอีเมล ปลายทางด้วย ID อีเมล

ตำแหน่งข้อมูลนี้จะกลับมามากที่สุด 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 ขาออกไว้ในไคลเอนต์ ฐานข้อมูล หรือแอปพลิเคชันของคุณ คุณสามารถอ้างอิงค่า ID อีเมลของเราในฐานข้อมูลของคุณได้หากต้องการ ค่านี้จะถูกส่งคืนจากทั้งสองค่า สร้างอีเมล และ ดึงอีเมล จุดสิ้นสุด

DELETE /v1/emails/:id

ตัวอย่างคำขอ:

curl -X DELETE https://api.forwardemail.net/v1/emails/:id \
  -u API_TOKEN:

เคล็ดลับ: ปลายทางโดเมนที่มีชื่อโดเมน /v1/domains/:domain_name เนื่องจากเส้นทางของพวกเขาสามารถใช้แทนกันได้กับ ID ของโดเมน :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 จะไม่มีการสร้าง catch-all) หากส่งสตริง จะเป็นรายการที่อยู่อีเมลที่คั่นด้วยเพื่อใช้เป็นผู้รับ (คั่นด้วยตัวแบ่งบรรทัด เว้นวรรค และ/หรือเครื่องหมายจุลภาค)
has_adult_content_protectionไม่บูลีนจะเปิดใช้งานการป้องกันเนื้อหาสำหรับผู้ใหญ่ของ Spam Scanner ในโดเมนนี้หรือไม่
has_phishing_protectionไม่บูลีนจะเปิดใช้งานการป้องกันฟิชชิ่งของ Spam Scanner ในโดเมนนี้หรือไม่
has_executable_protectionไม่บูลีนจะเปิดใช้งานการป้องกันที่เรียกใช้งานได้ของ Spam Scanner ในโดเมนนี้หรือไม่
has_virus_protectionไม่บูลีนเปิดใช้งานการป้องกันไวรัส Spam Scanner ในโดเมนนี้หรือไม่
has_recipient_verificationไม่บูลีนค่าเริ่มต้นของโดเมนสากลสำหรับการกำหนดให้ผู้รับนามแฝงคลิกลิงก์ยืนยันอีเมลเพื่อให้อีเมลส่งผ่านหรือไม่
retention_daysไม่ตัวเลขจำนวนเต็มระหว่าง 0 และ 30 ที่สอดคล้องกับจำนวนวันเก็บรักษาเพื่อจัดเก็บอีเมล SMTP ขาออกเมื่อส่งสำเร็จหรือเกิดข้อผิดพลาดถาวร ค่าเริ่มต้นเป็น 0ซึ่งหมายความว่าอีเมล SMTP ขาออกจะถูกล้างและแก้ไขทันทีเพื่อความปลอดภัยของคุณ

ตัวอย่างคำขอ:

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ไม่บูลีนจะเปิดใช้งานการป้องกันเนื้อหาสำหรับผู้ใหญ่ของ Spam Scanner ในโดเมนนี้หรือไม่
has_phishing_protectionไม่บูลีนจะเปิดใช้งานการป้องกันฟิชชิ่งของ Spam Scanner ในโดเมนนี้หรือไม่
has_executable_protectionไม่บูลีนจะเปิดใช้งานการป้องกันที่เรียกใช้งานได้ของ Spam Scanner ในโดเมนนี้หรือไม่
has_virus_protectionไม่บูลีนเปิดใช้งานการป้องกันไวรัส Spam Scanner ในโดเมนนี้หรือไม่
has_recipient_verificationไม่บูลีนค่าเริ่มต้นของโดเมนสากลสำหรับการกำหนดให้ผู้รับนามแฝงคลิกลิงก์ยืนยันอีเมลเพื่อให้อีเมลส่งผ่านหรือไม่
retention_daysไม่ตัวเลขจำนวนเต็มระหว่าง 0 และ 30 ที่สอดคล้องกับจำนวนวันเก็บรักษาเพื่อจัดเก็บอีเมล SMTP ขาออกเมื่อส่งสำเร็จหรือเกิดข้อผิดพลาดถาวร ค่าเริ่มต้นเป็น 0ซึ่งหมายความว่าอีเมล SMTP ขาออกจะถูกล้างและแก้ไขทันทีเพื่อความปลอดภัยของคุณ

ตัวอย่างคำขอ:

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:

แสดงรายการชื่อแทนโดเมน

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 ของเว็บฮุค - และหากไม่ได้ระบุไว้หรือว่างเปล่า Array จากนั้นอีเมลของผู้ใช้ที่สร้างคำขอ API จะถูกตั้งค่าเป็นผู้รับ)
descriptionไม่เชือกคำอธิบายนามแฝง
labelsไม่สตริงหรืออาร์เรย์รายการป้ายกำกับ (ต้องเป็นตัวแบ่งบรรทัด / ช่องว่าง / คั่นด้วยเครื่องหมายจุลภาคหรืออาร์เรย์)
has_recipient_verificationไม่บูลีนกำหนดให้ผู้รับคลิกลิงก์การยืนยันอีเมลเพื่อให้อีเมลไหลผ่าน (ค่าเริ่มต้นคือการตั้งค่าของโดเมนหากไม่ได้ตั้งค่าไว้อย่างชัดเจนในเนื้อหาคำขอ)
is_enabledไม่บูลีนไม่ว่าจะเปิดใช้งานหรือปิดใช้งานนามแฝงนี้ (หากปิดใช้งาน อีเมลจะไม่ถูกกำหนดเส้นทางไปที่ใด แต่จะส่งคืนรหัสสถานะที่สำเร็จ) หากค่าถูกส่งผ่าน ค่านั้นจะถูกแปลงเป็นบูลีนโดยใช้ บูลีน)
has_imapไม่บูลีนไม่ว่าจะเปิดใช้งานหรือปิดใช้งานที่เก็บข้อมูล IMAP สำหรับนามแฝงนี้ (หากปิดใช้งาน อีเมลขาเข้าที่ได้รับจะไม่ถูกเก็บไว้ พื้นที่เก็บข้อมูลแบบ IMAP. หากค่าถูกส่งผ่าน ค่านั้นจะถูกแปลงเป็นบูลีนโดยใช้ บูลีน)
has_pgpไม่บูลีนว่าจะเปิดใช้งานหรือปิดใช้งาน การเข้ารหัส OpenPGP สำหรับ พื้นที่เก็บข้อมูลอีเมลที่เข้ารหัส IMAP/POP3 โดยใช้นามแฝง' public_key.
public_keyไม่เชือกรหัสสาธารณะ OpenPGP ในรูปแบบ ASCII Armor (คลิกที่นี่เพื่อดูตัวอย่าง; เช่น. กุญแจ GPG สำหรับ support@forwardemail.net). สิ่งนี้ใช้ได้เฉพาะในกรณีที่คุณมี has_pgp ตั้งค่าให้ true. เรียนรู้เพิ่มเติมเกี่ยวกับการเข้ารหัสจากต้นทางถึงปลายทางในคำถามที่พบบ่อยของเรา.

ตัวอย่างคำขอ:

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

เรียกชื่อแทนโดเมน

คุณสามารถเรียกชื่อแทนโดเมนโดย its 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ไม่บูลีนไม่ว่าจะเปิดใช้งานหรือปิดใช้งานนามแฝงนี้ (หากปิดใช้งาน อีเมลจะไม่ถูกส่งไปที่ใด แต่จะส่งคืนรหัสสถานะที่สำเร็จ)
has_imapไม่บูลีนไม่ว่าจะเปิดใช้งานหรือปิดใช้งานที่เก็บข้อมูล IMAP สำหรับนามแฝงนี้ (หากปิดใช้งาน อีเมลขาเข้าที่ได้รับจะไม่ถูกเก็บไว้ พื้นที่เก็บข้อมูลแบบ IMAP. หากค่าถูกส่งผ่าน ค่านั้นจะถูกแปลงเป็นบูลีนโดยใช้ บูลีน)
has_pgpไม่บูลีนว่าจะเปิดใช้งานหรือปิดใช้งาน การเข้ารหัส OpenPGP สำหรับ พื้นที่เก็บข้อมูลอีเมลที่เข้ารหัส IMAP/POP3 โดยใช้นามแฝง' public_key.
public_keyไม่เชือกรหัสสาธารณะ OpenPGP ในรูปแบบ ASCII Armor (คลิกที่นี่เพื่อดูตัวอย่าง; เช่น. กุญแจ GPG สำหรับ support@forwardemail.net). สิ่งนี้ใช้ได้เฉพาะในกรณีที่คุณมี has_pgp ตั้งค่าให้ true. เรียนรู้เพิ่มเติมเกี่ยวกับการเข้ารหัสจากต้นทางถึงปลายทางในคำถามที่พบบ่อยของเรา.

ตัวอย่างคำขอ:

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: