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