อีเมล API

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

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

จุดสิ้นสุดทั้งหมดต้องการให้ รหัส API ถูกตั้งค่าเป็นค่า "ชื่อผู้ใช้" ของส่วนหัว การอนุญาตขั้นพื้นฐาน ของคำขอ (ยกเว้น รายชื่อผู้ติดต่อนามแฝง, ปฏิทินนามแฝง และ กล่องจดหมายนามแฝง ซึ่งใช้ สร้างชื่อผู้ใช้และรหัสผ่านนามแฝง)

ไม่ต้องกังวล เรามีตัวอย่างให้ด้านล่างนี้หากคุณไม่แน่ใจว่านี่คืออะไร

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

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

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

เพียงระบุคุณสมบัติของ querystring page (และ limit (ไม่บังคับ)

คุณสมบัติ page ควรเป็นตัวเลขที่มากกว่าหรือเท่ากับ 1 หากคุณระบุ limit (ซึ่งเป็นตัวเลขเช่นกัน) ค่าต่ำสุดคือ 10 และค่าสูงสุดคือ 50 (เว้นแต่จะระบุไว้เป็นอย่างอื่น)

เพื่อพิจารณาว่ามีผลลัพธ์เพิ่มเติมหรือไม่ เราจึงจัดเตรียมส่วนหัวการตอบสนอง HTTP เหล่านี้ (ซึ่งคุณสามารถแยกวิเคราะห์เพื่อแบ่งหน้าด้วยโปรแกรมได้):

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

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

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

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

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

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 ของอีเมล

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

GET /v1/emails

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

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

สร้างอีเมล SMTP ขาออก

API สำหรับการสร้างอีเมลของเราได้รับแรงบันดาลใจและใช้ประโยชน์จากการกำหนดค่าตัวเลือกข้อความของ Nodemailer โปรดดู การกำหนดค่าข้อความ Nodemailer สำหรับพารามิเตอร์เนื้อหาทั้งหมดด้านล่าง

โปรดทราบว่าเรารองรับตัวเลือก Nodemailer ทั้งหมด ยกเว้น envelope และ dkim (เนื่องจากเราตั้งค่าให้คุณโดยอัตโนมัติ) เราตั้งค่าตัวเลือก disableFileAccess และ disableUrlAccess เป็น true โดยอัตโนมัติเพื่อความปลอดภัย

คุณควรส่งตัวเลือกเดี่ยวของ raw พร้อมกับอีเมลแบบเต็มแบบดิบรวมทั้งส่วนหัว หรือ ส่งตัวเลือกพารามิเตอร์เนื้อหาแต่ละรายการด้านล่าง

จุดสิ้นสุด API นี้จะเข้ารหัสอิโมจิให้คุณโดยอัตโนมัติหากพบในส่วนหัว (เช่น บรรทัดหัวเรื่อง Subject: 🤓 Hello จะถูกแปลงเป็น Subject: =?UTF-8?Q?=F0=9F=A4=93?= Hello โดยอัตโนมัติ) เป้าหมายของเราคือการสร้าง API อีเมลที่เป็นมิตรกับนักพัฒนาและป้องกันข้อผิดพลาดแบบดัมมีอย่างยิ่ง

POST /v1/emails

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

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

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:

รายชื่อรหัสผ่านที่ครอบคลุมทั่วทั้งโดเมน

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

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

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

สร้างรหัสผ่านแบบครอบคลุมทั้งโดเมน

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

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

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

ลบรหัสผ่านที่ครอบคลุมทั่วทั้งโดเมน

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

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

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

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

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

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

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