เอกสารอ้างอิง API
ส่งอีเมล
Send transactional mail only from your verified custom domains over HTTPS — password resets, receipts, alerts, and similar event-driven messages. Not for newsletters or marketing bulk. One endpoint, domain-scoped API keys, delivery through AWS SES.
ภาพรวม
สร้างคีย์ใน บัญชี → โดเมน → โดเมนของคุณ → API หลังจากตรวจสอบ DNS เสร็จสมบูรณ์ คีย์ลับทั้งหมดจะแสดงครั้งเดียว — เก็บไว้อย่างปลอดภัย ข้อมูลรับรอง SMTP ที่อยู่ในแผงโดเมนเดียวกันก็ใช้กฎธุรกรรมเท่านั้นเช่นกัน
อีเมลธุรกรรมเท่านั้น
Unbox HTTP API (POST /v1/email) and optional SMTP submission are for transactional mail only — messages tied to an account action, purchase, or operational event. They are not a newsletter or marketing broadcast service.
การใช้งานที่ได้รับอนุญาต
- การยืนยันบัญชี การรีเซ็ตรหัสผ่าน และการแจ้งเตือนด้านความปลอดภัย
- การยืนยันคำสั่งซื้อ ใบเสร็จ อัปเดตการจัดส่ง และการแจ้งเตือนการชำระเงิน
- การแจ้งเตือนที่เกิดจากเหตุการณ์ของผู้ใช้หรือระบบเฉพาะ
- ข้อความในทีมและพื้นที่ทำงาน (คำเชิญ การมอบหมาย การแจ้งเตือนภายใน)
การใช้งานที่ถูกห้าม
- จดหมายข่าว แคมเปญส่งเสริมการขาย หรือการตลาดแบบกระจาย
- การติดต่อแบบเย็นหรือการส่งอีเมลไปยังรายชื่อที่ซื้อมา ขูดมา หรือไม่ได้รับความยินยอม
- สแปมแบบพันธมิตร ฟิชชิ่ง หรือเนื้อหาที่หลอกลวง
- ความพยายามใดๆ ที่จะหลีกเลี่ยงขีดจำกัดผู้รับ ข้อจำกัดอัตรา หรือโควต้าแผน
ข้อจำกัดด้านอัตราและผู้รับ
เพื่อปกป้องผู้รับและความสามารถในการส่ง อีเมลขาออกผ่าน API และ SMTP จะอยู่ภายใต้ข้อจำกัดด้านล่างนี้ (นอกเหนือจากโควต้าการส่งขาออกรายเดือนของแผนของคุณ) การบังคับใช้มีผลกับ Web Composer, HTTP API และการส่งผ่าน SMTP โดย Web Composer จะแจ้งเตือนเมื่อมีผู้รับเกิน 25 รายต่อข้อความ และจะบล็อกการส่งหากเกิน 50 ราย
| ข้อจำกัด | ค่า |
|---|---|
| ผู้รับต่อข้อความ | สูงสุด 50 รายรวม (รวมถึง, CC, BCC) |
| ผู้รับที่ไม่ซ้ำต่อวัน | สูงสุด 1,000 รายต่อพื้นที่ทำงาน |
| อัตราการส่งคำขอ | สูงสุด 10 การส่ง API หรือ SMTP ต่อนาทีต่อโดเมน |
| โควต้าการส่งขาออกของแผน | ขีดจำกัดการส่งรายเดือนตามการสมัครใช้งานของคุณยังคงมีผล |
กฎเหล่านี้เป็นส่วนหนึ่งของนโยบายการใช้งานที่ยอมรับได้ การบังคับใช้อัตโนมัติมีผลกับ Web Composer, HTTP API และการส่งผ่าน SMTP บัญชีที่ส่งอีเมลการตลาดหรืออีเมลจำนวนมาก หรือใช้ระบบส่งข้อความในทางที่ผิด อาจถูกจำกัดความเร็ว ระงับหรือยกเลิก
เราติดตามสัญญาณความสามารถในการส่ง อัตราการตีกลับที่สูงกว่า 3% อย่างต่อเนื่องหรืออัตราการร้องเรียนที่สูงกว่า 0.1% อาจทำให้เกิดการหยุดส่งชั่วคราวหรือการตรวจสอบด้วยตนเอง
ดู ข้อกำหนดในการให้บริการ, นโยบายความเป็นส่วนตัว และ คำชี้แจง GDPR สำหรับรายละเอียดนโยบายทั้งหมด
การยืนยันตัวตน
ส่งคีย์ API ของโดเมนของคุณในทุกคำขอ:
Authorization: Bearer ubk_live_xxxxxxxxxxxxxxxxxxxxxxxxอีกทางเลือกหนึ่ง ใช้ X-Api-Key: ubk_live_… คีย์จะถูกจัดเก็บแบบแฮช; สามารถเพิกถอนหรือหมุนเวียนได้จากแดชบอร์ดโดเมน
เนื้อหาคำขอ
JSON ที่มีชื่อฟิลด์แบบ PascalCase (From, To, …) ชื่อเล่นแบบ camelCase ก็รองรับเช่นกัน
| ฟิลด์ | จำเป็น | คำอธิบาย |
|---|---|---|
From | ใช่ | ผู้ส่ง — กล่องจดหมายส่วนตัวของคุณบนโดเมนของคีย์ (หลักหรือนามแฝง) คิวที่แชร์ไม่สามารถเป็นผู้ส่งที่ถูกต้อง |
To | ใช่ | ผู้รับ — สตริง, สตริงที่คั่นด้วยจุลภาค, หรืออาร์เรย์ |
Subject | ใช่ | หัวเรื่อง |
TextBody | หนึ่งใน TextBody / HtmlBody | เนื้อหาข้อความธรรมดา |
HtmlBody | หนึ่งใน TextBody / HtmlBody | เนื้อหา HTML |
Cc | ไม่ | ผู้รับสำเนา |
Bcc | ไม่ | ผู้รับสำเนาลับ |
ReplyTo | ไม่ | ที่อยู่ตอบกลับ |
Tag | ไม่ | แท็กข้อมูลเมตาแบบไม่บังคับ (จัดเก็บพร้อมกับการส่ง) |
ตัวอย่าง
{
"From": "you@yourdomain.com",
"To": "user@example.com",
"Subject": "Welcome",
"TextBody": "Thanks for signing up.",
"HtmlBody": "<p>Thanks for signing up.</p>",
"ReplyTo": "you@yourdomain.com",
"Tag": "welcome"
}การตอบกลับที่สำเร็จ
HTTP 200 พร้อม JSON:
{
"ErrorCode": 0,
"Message": "OK",
"MessageID": "0100018…-000000-…",
"SubmittedAt": "2026-06-23T12:00:00.000Z",
"To": "user@example.com"
}การตอบกลับข้อผิดพลาด
ข้อผิดพลาดจะส่งคืน 4xx (หรือ 500 สำหรับความล้มเหลวที่ไม่คาดคิด) พร้อม JSON:
{
"ErrorCode": 300,
"Message": "TextBody or HtmlBody is required."
}| รหัสข้อผิดพลาด | ความหมาย |
|---|---|
0 | สำเร็จ |
10 | ไม่มีคีย์ API |
11 | คีย์ไม่ถูกต้องหรือถูกเพิกถอน หรือโดเมนไม่ได้รับการยืนยันสำหรับการส่ง |
300 | ข้อผิดพลาดการตรวจสอบ (ฟิลด์ที่ขาดหาย, JSON ไม่ถูกต้อง ฯลฯ) |
403 | ที่อยู่ผู้ส่งไม่ได้รับอนุญาต — ต้องเป็นกล่องจดหมายส่วนตัวของคุณบนโดเมนของคีย์ |
406 | SES ปฏิเสธข้อความ |
ตัวอย่าง
แทนที่ you@yourdomain.com ด้วยกล่องจดหมายส่วนตัวของคุณบนโดเมน และใช้คีย์ API ของคุณเอง
curl "https://api.unbox.im/v1/email" \
-H "Authorization: Bearer ubk_live_your_api_key_here" \
-H "Content-Type: application/json" \
-d '{
"From": "you@yourdomain.com",
"To": "user@example.com",
"Subject": "Welcome",
"TextBody": "Thanks for signing up.",
"HtmlBody": "<p>Thanks for signing up.</p>",
"ReplyTo": "you@yourdomain.com",
"Tag": "welcome"
}'เริ่มต้นใช้งาน
- สร้างบัญชี Unbox และเพิ่มโดเมนที่กำหนดเองของคุณ
- ดำเนินการขั้นตอนการยืนยัน DNS ทั้งหมดในส่วนโดเมน
- เปิดโดเมน → โดเมนของคุณ → API และสร้างคีย์โดเมน
- ส่งข้อความแรกของคุณด้วยตัวอย่างด้านบน