API อีเมล

ห้องสมุด

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

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

URI ฐาน

เส้นทาง 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 หัวข้อ. ลองใช้ภาษาแบบเลื่อนลงที่ด้านล่างของหน้านี้ได้ตามสบาย

การให้เลขหน้า

[!หมายเหตุ] ณ วันที่ 1 พฤศจิกายน 2024 จุดสิ้นสุดของ API สำหรับ รายการโดเมน และ แสดงรายการชื่อแทนโดเมน จะค่าเริ่มต้นเป็น 1000 ผลลัพธ์สูงสุดต่อหน้า หากคุณต้องการเลือกใช้พฤติกรรมนี้ก่อนกำหนด คุณสามารถผ่าน ?paginate=true เป็นพารามิเตอร์ querystring เพิ่มเติมให้กับ URL สำหรับการสอบถามจุดสิ้นสุด

รองรับการแบ่งหน้าโดยจุดสิ้นสุด API ทั้งหมดที่แสดงรายการผลลัพธ์

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

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

รายชื่อผู้ติดต่อนามแฝง (CardDAV)

[!NOTE] ไม่เหมือนกับจุดสิ้นสุด API อื่นๆ สิ่งเหล่านี้จำเป็นต้องใช้ การรับรอง “ชื่อผู้ใช้” จะเท่ากับชื่อผู้ใช้และ “รหัสผ่าน” จะเท่ากับรหัสผ่านที่สร้างขึ้นโดยใช้ชื่อแทนตามส่วนหัวการอนุญาตพื้นฐาน

[!WARNING] ส่วนปลายทางนี้อยู่ระหว่างดำเนินการและจะเปิดตัวในปี 2024 (หวังว่าจะเป็นเช่นนั้น) ในระหว่างนี้ โปรดใช้ไคลเอนต์ IMAP จากเมนูแบบดรอปดาวน์ "แอป" ในการนำทางของเว็บไซต์ของเรา

[!NOTE] ยังไม่มีการรองรับ CardDAV โปรดติดตามการสนทนานี้บน GitHub เพื่อรับข้อมูลอัปเดต.

รายชื่อผู้ติดต่อ

GET /v1/contacts

เร็ว ๆ นี้

สร้างการติดต่อ

POST /v1/contacts

เร็ว ๆ นี้

ดึงข้อมูลการติดต่อ

GET /v1/contacts/:id

เร็ว ๆ นี้

อัปเดตข้อมูลติดต่อ

PUT /v1/contacts/:id

เร็ว ๆ นี้

ลบข้อมูลติดต่อ

DELETE /v1/contacts/:id

เร็ว ๆ นี้

ปฏิทินนามแฝง (CalDAV)

[!NOTE] ไม่เหมือนกับจุดสิ้นสุด API อื่นๆ สิ่งเหล่านี้จำเป็นต้องใช้ การรับรอง “ชื่อผู้ใช้” จะเท่ากับชื่อผู้ใช้และ “รหัสผ่าน” จะเท่ากับรหัสผ่านที่สร้างขึ้นโดยใช้ชื่อแทนตามส่วนหัวการอนุญาตพื้นฐาน

[!WARNING] ส่วนปลายทางนี้อยู่ระหว่างดำเนินการและจะเปิดตัวในปี 2024 (หวังว่าจะเป็นเช่นนั้น) ในระหว่างนี้ โปรดใช้ไคลเอนต์ IMAP จากเมนูแบบดรอปดาวน์ "แอป" ในการนำทางของเว็บไซต์ของเรา

รายการปฏิทิน

GET /v1/calendars

เร็ว ๆ นี้

สร้างปฏิทิน

POST /v1/calendars

เร็ว ๆ นี้

ดึงข้อมูลปฏิทิน

GET /v1/calendars/:id

เร็ว ๆ นี้

อัปเดตปฏิทิน

PUT /v1/calendars/:id

เร็ว ๆ นี้

ลบปฏิทิน

DELETE /v1/calendars/:id

เร็ว ๆ นี้

ข้อความนามแฝง (IMAP/POP3)

[!NOTE] ไม่เหมือนกับจุดสิ้นสุด API อื่นๆ สิ่งเหล่านี้จำเป็นต้องใช้ การรับรอง “ชื่อผู้ใช้” จะเท่ากับชื่อผู้ใช้และ “รหัสผ่าน” จะเท่ากับรหัสผ่านที่สร้างขึ้นโดยใช้ชื่อแทนตามส่วนหัวการอนุญาตพื้นฐาน

[!WARNING] ส่วนปลายทางนี้อยู่ระหว่างดำเนินการและจะเปิดตัวในปี 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)

[!TIP] จุดสิ้นสุดของโฟลเดอร์พร้อมเส้นทางของโฟลเดอร์ /v1/folders/:path เนื่องจากจุดสิ้นสุดสามารถใช้แทน ID ของโฟลเดอร์ได้ :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.

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

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

DELETE /v1/emails/:id

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

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

โดเมน

[!TIP] จุดสิ้นสุดโดเมนที่มีชื่อโดเมน /v1/domains/:domain_name เนื่องจากจุดสิ้นสุดสามารถใช้แทนกันได้กับ ID ของโดเมน :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`	ไม่	สตริง (ID โดเมนหรือชื่อโดเมน; FQDN)	กำหนดโดเมนนี้ให้กับทีมเดียวกันจากโดเมนอื่นโดยอัตโนมัติ ซึ่งหมายความว่าสมาชิกทั้งหมดจากโดเมนนี้จะถูกกำหนดให้เป็นสมาชิกในทีม และ `plan` จะถูกตั้งค่าให้อัตโนมัติ `team` เช่นกัน คุณสามารถตั้งค่านี้ให้เป็น `"none"` หากจำเป็นต้องปิดการใช้งานนี้โดยชัดเจน แต่ก็ไม่จำเป็น
`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`	ไม่	บูลีน	ค่าเริ่มต้นของโดเมนสากลสำหรับการกำหนดให้ผู้รับนามแฝงคลิกลิงก์ยืนยันอีเมลเพื่อให้อีเมลส่งผ่านหรือไม่
`ignore_mx_check`	ไม่	บูลีน	ว่าจะละเว้นการตรวจสอบระเบียน MX บนโดเมนเพื่อยืนยันหรือไม่ โดยหลักแล้วสำหรับผู้ใช้ที่มีกฎการกำหนดค่าการแลกเปลี่ยน MX ขั้นสูง และจำเป็นต้องเก็บการแลกเปลี่ยน MX ที่มีอยู่และส่งต่อไปยังของเรา
`retention_days`	ไม่	ตัวเลข	จำนวนเต็มระหว่าง `0` และ `30` ที่สอดคล้องกับจำนวนวันเก็บรักษาเพื่อจัดเก็บอีเมล SMTP ขาออกเมื่อส่งสำเร็จหรือเกิดข้อผิดพลาดถาวร ค่าเริ่มต้นเป็น `0`ซึ่งหมายความว่าอีเมล SMTP ขาออกจะถูกล้างและแก้ไขทันทีเพื่อความปลอดภัยของคุณ
`bounce_webhook`	ไม่	สตริง (URL) หรือ บูลีน (เท็จ)	ที่ `http://` หรือ `https://` URL เว็บฮุกที่คุณเลือกเพื่อส่งเว็บฮุกที่เด้งกลับ เราจะส่ง `POST` ร้องขอไปยัง URL นี้โดยมีข้อมูลเกี่ยวกับความล้มเหลวของ 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`	ไม่	บูลีน	จะเปิดใช้งานการป้องกันเนื้อหาสำหรับผู้ใหญ่ของ Spam Scanner ในโดเมนนี้หรือไม่
`has_phishing_protection`	ไม่	บูลีน	จะเปิดใช้งานการป้องกันฟิชชิ่งของ Spam Scanner ในโดเมนนี้หรือไม่
`has_executable_protection`	ไม่	บูลีน	จะเปิดใช้งานการป้องกันที่เรียกใช้งานได้ของ Spam Scanner ในโดเมนนี้หรือไม่
`has_virus_protection`	ไม่	บูลีน	เปิดใช้งานการป้องกันไวรัส Spam Scanner ในโดเมนนี้หรือไม่
`has_recipient_verification`	ไม่	บูลีน	ค่าเริ่มต้นของโดเมนสากลสำหรับการกำหนดให้ผู้รับนามแฝงคลิกลิงก์ยืนยันอีเมลเพื่อให้อีเมลส่งผ่านหรือไม่
`ignore_mx_check`	ไม่	บูลีน	ว่าจะละเว้นการตรวจสอบระเบียน MX บนโดเมนเพื่อยืนยันหรือไม่ โดยหลักแล้วสำหรับผู้ใช้ที่มีกฎการกำหนดค่าการแลกเปลี่ยน MX ขั้นสูง และจำเป็นต้องเก็บการแลกเปลี่ยน MX ที่มีอยู่และส่งต่อไปยังของเรา
`retention_days`	ไม่	ตัวเลข	จำนวนเต็มระหว่าง `0` และ `30` ที่สอดคล้องกับจำนวนวันเก็บรักษาเพื่อจัดเก็บอีเมล SMTP ขาออกเมื่อส่งสำเร็จหรือเกิดข้อผิดพลาดถาวร ค่าเริ่มต้นเป็น `0`ซึ่งหมายความว่าอีเมล SMTP ขาออกจะถูกล้างและแก้ไขทันทีเพื่อความปลอดภัยของคุณ
`bounce_webhook`	ไม่	สตริง (URL) หรือ บูลีน (เท็จ)	ที่ `http://` หรือ `https://` URL เว็บฮุกที่คุณเลือกเพื่อส่งเว็บฮุกที่เด้งกลับ เราจะส่ง `POST` ร้องขอไปยัง URL นี้โดยมีข้อมูลเกี่ยวกับความล้มเหลวของ 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

[!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`	ไม่	บูลีน	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 ของเว็บฮุค - และหากไม่ได้ระบุไว้หรือว่างเปล่า Array จากนั้นอีเมลของผู้ใช้ที่สร้างคำขอ API จะถูกตั้งค่าเป็นผู้รับ)
`description`	ไม่	เชือก	คำอธิบายนามแฝง
`labels`	ไม่	สตริงหรืออาร์เรย์	รายการป้ายกำกับ (ต้องเป็นตัวแบ่งบรรทัด / ช่องว่าง / คั่นด้วยเครื่องหมายจุลภาคหรืออาร์เรย์)
`has_recipient_verification`	ไม่	บูลีน	กำหนดให้ผู้รับคลิกลิงก์การยืนยันอีเมลเพื่อให้อีเมลไหลผ่าน (ค่าเริ่มต้นคือการตั้งค่าของโดเมนหากไม่ได้ตั้งค่าไว้อย่างชัดเจนในเนื้อหาคำขอ)
`is_enabled`	ไม่	บูลีน	ไม่ว่าจะเปิดใช้งานหรือปิดใช้งานนามแฝงนี้ (หากปิดใช้งาน อีเมลจะไม่ถูกกำหนดเส้นทางไปที่ใด แต่จะส่งคืนรหัสสถานะที่สำเร็จ) หากค่าถูกส่งผ่าน ค่านั้นจะถูกแปลงเป็นบูลีนโดยใช้ บูลีน)
`error_code_if_disabled`	ไม่	เบอร์ (อย่างใดอย่างหนึ่ง `250`, `421`, หรือ `550`)	อีเมลขาเข้าที่ส่งถึงนามแฝงนี้จะถูกปฏิเสธหาก `is_enabled` เป็น `false` ด้วยอย่างใดอย่างหนึ่ง `250` (ส่งอย่างเงียบๆ ไม่มีที่ไหนเลย เช่น หลุมดำ หรือ `/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:

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

คุณสามารถเรียกชื่อแทนโดเมนโดย 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`	ไม่	บูลีน	ไม่ว่าจะเปิดใช้งานหรือปิดใช้งานนามแฝงนี้ (หากปิดใช้งาน อีเมลจะไม่ถูกกำหนดเส้นทางไปที่ใด แต่จะส่งคืนรหัสสถานะที่สำเร็จ) หากค่าถูกส่งผ่าน ค่านั้นจะถูกแปลงเป็นบูลีนโดยใช้ บูลีน)
`error_code_if_disabled`	ไม่	เบอร์ (อย่างใดอย่างหนึ่ง `250`, `421`, หรือ `550`)	อีเมลขาเข้าที่ส่งถึงนามแฝงนี้จะถูกปฏิเสธหาก `is_enabled` เป็น `false` ด้วยอย่างใดอย่างหนึ่ง `250` (ส่งอย่างเงียบๆ ไม่มีที่ไหนเลย เช่น หลุมดำ หรือ `/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:

เข้ารหัส

เราอนุญาตให้คุณเข้ารหัสบันทึกได้แม้ในแผนบริการฟรีโดยไม่มีค่าใช้จ่าย ความเป็นส่วนตัวไม่ควรเป็นคุณลักษณะ แต่ควรมีอยู่แล้วในทุกด้านของผลิตภัณฑ์ ตามที่ขอไว้อย่างสูงใน การอภิปรายเกี่ยวกับคำแนะนำความเป็นส่วนตัว และต่อไป ปัญหา GitHub ของเรา เราได้เพิ่มสิ่งนี้แล้ว

เข้ารหัสบันทึก TXT

POST /v1/encrypt

พารามิเตอร์ร่างกาย	จำเป็นต้องใช้	ชนิด	ลักษณะ
`input`	ใช่	เชือก	บันทึก TXT ข้อความธรรมดาสำหรับส่งต่ออีเมลที่ถูกต้อง

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

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