Email API

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

เส้นทาง HTTP base URI ปัจจุบันคือ: https://fe.tiamati.email.

ทุก endpoint ต้องการการยืนยันตัวตนโดยใช้ Basic Authorization เรารองรับวิธีการยืนยันตัวตนสองแบบ:

API Token Authentication (แนะนำสำหรับ endpoint ส่วนใหญ่)

ตั้งค่า API key ของคุณเป็นค่า "username" โดยเว้นรหัสผ่านว่างไว้:

curl https://fe.tiamati.email/v1/account \
  -u API_TOKEN:

สังเกตเครื่องหมายโคลอน (:) หลัง API token – นี่แสดงถึงรหัสผ่านว่างในรูปแบบ Basic Auth

Alias Credentials Authentication (สำหรับอีเมลขาออก)

Create outbound SMTP email endpoint ยังรองรับการยืนยันตัวตนโดยใช้ที่อยู่อีเมล alias ของคุณและ รหัสผ่าน alias ที่สร้างขึ้น:

curl -X POST https://fe.tiamati.email/v1/emails \
  -u "alias@yourdomain.com:your_generated_password" \
  -d "to=recipient@example.com" \
  -d "subject=Hello" \
  -d "text=Test email"

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

Alias-Only Endpoints

Alias Contacts, Alias Calendars, Alias Messages, และ Alias Folders endpoint ต้องการข้อมูลรับรอง alias และไม่รองรับการยืนยันตัวตนด้วย API token

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

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

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

การแบ่งหน้า (Pagination) รองรับโดยทุก API endpoint ที่แสดงรายการผลลัพธ์

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

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

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

curl https://fe.tiamati.email/v1/domains/example.com/aliases?page=2&pagination=true \
  -u API_TOKEN:

ดึงบันทึก

API ของเราช่วยให้คุณดาวน์โหลดบันทึกสำหรับบัญชีของคุณได้โดยอัตโนมัติ การส่งคำขอไปยัง endpoint นี้จะประมวลผลบันทึกทั้งหมดสำหรับบัญชีของคุณและส่งอีเมลพร้อมไฟล์แนบ (Gzip บีบอัดไฟล์ CSV) เมื่อเสร็จสิ้น

สิ่งนี้ช่วยให้คุณสร้างงานเบื้องหลังด้วย Cron job หรือใช้ซอฟต์แวร์จัดตารางงาน Node.js Bree เพื่อรับบันทึกเมื่อใดก็ได้ตามต้องการ โปรดทราบว่า endpoint นี้จำกัดที่ 10 คำขอต่อวัน

ไฟล์แนบจะเป็นรูปแบบตัวพิมพ์เล็กของ email-deliverability-logs-YYYY-MM-DD-h-mm-A-z.csv.gz และอีเมลจะมีสรุปสั้น ๆ ของบันทึกที่ดึงมา คุณยังสามารถดาวน์โหลดบันทึกได้ทุกเวลาจาก บัญชีของฉัน → บันทึก

GET /v1/logs/download

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

curl https://fe.tiamati.email/v1/logs/download \
  -u API_TOKEN:

ตัวอย่าง Cron job (ทุกเที่ยงคืนทุกวัน):

0 0 * * * /usr/bin/curl https://fe.tiamati.email/v1/logs/download -u API_TOKEN: &>/dev/null

โปรดทราบว่าคุณสามารถใช้บริการเช่น Crontab.guru เพื่อตรวจสอบไวยากรณ์ของนิพจน์ cron job ของคุณ

ตัวอย่าง Cron job (ทุกเที่ยงคืนทุกวัน และดึงบันทึกของวันก่อนหน้า):

สำหรับ MacOS:

0 0 * * * /usr/bin/curl https://fe.tiamati.email/v1/logs/download?q=`date -v-1d -u "+%-m/%-d/%y"` -u API_TOKEN: &>/dev/null

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

0 0 * * * /usr/bin/curl https://fe.tiamati.email/v1/logs/download?q=`date --date "-1 days" -u "+%-m/%-d/%y"` -u API_TOKEN: &>/dev/null

สร้างบัญชี

POST /v1/account

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

curl -X POST https://fe.tiamati.email/v1/account \
  -u API_TOKEN: \
  -d "email=user%40gmail.com"

ดึงข้อมูลบัญชี

GET /v1/account

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

curl https://fe.tiamati.email/v1/account \
  -u API_TOKEN:

อัปเดตบัญชี

PUT /v1/account

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

curl -X PUT https://fe.tiamati.email/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 ขาออก

นี่คือ endpoint ง่ายๆ ที่ส่งกลับวัตถุ JSON ซึ่งประกอบด้วย count และ limit สำหรับจำนวนข้อความ SMTP ขาออกรายวันในแต่ละบัญชี

GET /v1/emails/limit

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

curl https://fe.tiamati.email/v1/emails/limit \
  -u API_TOKEN:

รายการอีเมล SMTP ขาออก

โปรดทราบว่า endpoint นี้จะไม่ส่งค่าคุณสมบัติสำหรับ message, headers หรือ rejectedErrors ของอีเมลกลับมา

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

GET /v1/emails

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

curl https://fe.tiamati.email/v1/emails?limit=1 \
  -u API_TOKEN:

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

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

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

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

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

การยืนยันตัวตน: Endpoint นี้รองรับทั้ง API token authentication และ alias credentials authentication ดูรายละเอียดในส่วน Authentication ข้างต้น

POST /v1/emails

ตัวอย่างคำขอ (API Token):

curl -X POST https://fe.tiamati.email/v1/emails \
  -u API_TOKEN: \
  -d "from=alias@example.com" \
  -d "to=user%40gmail.com" \
  -d "subject=test" \
  -d "text=test"

ตัวอย่างคำขอ (ข้อมูลรับรอง Alias):

curl -X POST https://fe.tiamati.email/v1/emails \
  -u "alias@example.com:GENERATED_PASSWORD" \
  -d "from=alias@example.com" \
  -d "to=user%40gmail.com" \
  -d "subject=test" \
  -d "text=test"

ตัวอย่างคำขอ (อีเมลดิบ):

curl -X POST https://fe.tiamati.email/v1/emails \
  -u API_TOKEN: \
  -d "raw=`cat file.eml`"

ดึงอีเมล SMTP ขาออก

GET /v1/emails/:id

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

curl https://fe.tiamati.email/v1/emails/:id \
  -u API_TOKEN:

ลบอีเมล SMTP ขาออก

การลบอีเมลจะตั้งสถานะเป็น "rejected" (และจะไม่ประมวลผลในคิวต่อไป) ก็ต่อเมื่อสถานะปัจจุบันเป็นหนึ่งใน "pending", "queued", หรือ "deferred" เท่านั้น เราอาจลบอีเมลโดยอัตโนมัติหลังจาก 30 วันนับตั้งแต่สร้างและ/หรือส่งแล้ว – ดังนั้นคุณควรเก็บสำเนาอีเมล SMTP ขาออกไว้ในไคลเอนต์ ฐานข้อมูล หรือแอปพลิเคชันของคุณ คุณสามารถอ้างอิงค่า ID อีเมลของเราในฐานข้อมูลของคุณได้หากต้องการ – ค่านี้จะถูกส่งกลับจากทั้ง สร้างอีเมล และ ดึงอีเมล endpoints

DELETE /v1/emails/:id

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

curl -X DELETE https://fe.tiamati.email/v1/emails/:id \
  -u API_TOKEN:

รายการโดเมน

GET /v1/domains

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

curl https://fe.tiamati.email/v1/domains \
  -u API_TOKEN:

สร้างโดเมน

POST /v1/domains

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

curl -X POST https://fe.tiamati.email/v1/domains \
  -u API_TOKEN: \
  -d domain=example.com \
  -d plan=free

ดึงข้อมูลโดเมน

GET /v1/domains/example.com

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

curl https://fe.tiamati.email/v1/domains/example.com \
  -u API_TOKEN:

ตรวจสอบระเบียนโดเมน

GET /v1/domains/example.com/verify-records

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

curl https://fe.tiamati.email/v1/domains/example.com/verify-records \
  -u API_TOKEN:

ตรวจสอบระเบียน SMTP ของโดเมน

GET /v1/domains/example.com/verify-smtp

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

curl https://fe.tiamati.email/v1/domains/example.com/verify-smtp \
  -u API_TOKEN:

รายการรหัสผ่าน catch-all ทั่วโดเมน

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

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

curl https://fe.tiamati.email/v1/domains/example.com/catch-all-passwords \
  -u API_TOKEN:

สร้างรหัสผ่าน catch-all ทั่วโดเมน

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

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

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

ลบรหัสผ่าน catch-all ทั่วโดเมน

DELETE /v1/domains/example.com/catch-all-passwords/:token_id

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

curl -X DELETE https://fe.tiamati.email/v1/domains/:domain_name/catch-all-passwords/:token_id \
  -u API_TOKEN:

อัปเดตโดเมน

PUT /v1/domains/example.com

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

curl -X PUT https://fe.tiamati.email/v1/domains/example.com \
  -u API_TOKEN:

ลบโดเมน

DELETE /v1/domains/:domain_name

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

curl -X DELETE https://fe.tiamati.email/v1/domains/:domain_name \
  -u API_TOKEN:

ยอมรับคำเชิญโดเมน

GET /v1/domains/:domain_name/invites

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

curl https://fe.tiamati.email/v1/domains/:domain_name/invites \
  -u API_TOKEN:

สร้างคำเชิญโดเมน

POST /v1/domains/example.com/invites

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

curl -X POST https://fe.tiamati.email/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://fe.tiamati.email/v1/domains/:domain_name/invites \
  -u API_TOKEN:

อัปเดตสมาชิกโดเมน

PUT /v1/domains/example.com/members/:member_id

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

curl -X PUT https://fe.tiamati.email/v1/domains/example.com/members/:member_id \
  -u API_TOKEN:

ลบสมาชิกโดเมน

DELETE /v1/domains/:domain_name/members/:member_id

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

curl -X DELETE https://fe.tiamati.email/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://fe.tiamati.email/v1/domains/example.com/aliases/:alias_id/generate-password \
  -u API_TOKEN:

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

GET /v1/domains/example.com/aliases

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

curl https://fe.tiamati.email/v1/domains/example.com/aliases?pagination=true \
  -u API_TOKEN:

สร้างชื่อโดเมนแฝงใหม่

POST /v1/domains/example.com/aliases

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

curl -X POST https://fe.tiamati.email/v1/domains/example.com/aliases \
  -u API_TOKEN:

ดึงข้อมูลโดเมนอาลิอัส

คุณสามารถดึงข้อมูลโดเมนอาลิอัสได้โดยใช้ค่า id หรือ name

GET /v1/domains/:domain_name/aliases/:alias_id

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

curl https://fe.tiamati.email/v1/domains/:domain_name/aliases/:alias_id \
  -u API_TOKEN:

GET /v1/domains/:domain_name/aliases/:alias_name

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

curl https://fe.tiamati.email/v1/domains/:domain_name/aliases/:alias_name \
  -u API_TOKEN:

อัปเดตโดเมนอาลิอัส

PUT /v1/domains/example.com/aliases/:alias_id

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

curl -X PUT https://fe.tiamati.email/v1/domains/example.com/aliases/:alias_id \
  -u API_TOKEN:

ลบโดเมนอาลิอัส

DELETE /v1/domains/:domain_name/aliases/:alias_id

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

curl -X DELETE https://fe.tiamati.email/v1/domains/:domain_name/aliases/:alias_id \
  -u API_TOKEN:

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

เข้ารหัสระเบียน TXT

POST /v1/encrypt

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

curl -X POST https://fe.tiamati.email/v1/encrypt \
  -d "input=user@gmail.com"