Cấu hình cửa hàng
Gửi email thử
Gửi một email thử bằng cấu hình email đã lưu của cửa hàng tới email của người đang đăng nhập
Endpoint
POST /v1/emails/test
Dùng sau khi lưu cấu hình email để kiểm tra cấu hình gửi email (SMTP riêng nếu bật email_custom_enable, ngược lại là email hệ thống). Email được gửi tới địa chỉ email của chính người dùng đang đăng nhập, không chọn được người nhận.
- Yêu cầu đăng nhập bằng JWT của người dùng và quyền
company.setting. - Luôn đọc cấu hình mới nhất đã lưu (không cần chờ cache).
- Giới hạn: tối đa 5 lần mỗi 10 phút cho mỗi cửa hàng.
Request Body
Không có tham số. Gửi body rỗng {}.
Response Schema
HTTP 201 - Created
| Trường | Kiểu | Mô tả |
|---|---|---|
to_email | string | Email người nhận (email của người đang đăng nhập) |
from_email | string | Địa chỉ người gửi thực tế |
from_name | string | Tên người gửi thực tế |
replyto_email | string | Địa chỉ Reply-To (rỗng nếu không đặt) |
source | string | Nguồn cấu hình đã dùng: company (SMTP riêng của cửa hàng) hoặc system (email hệ thống) |
{
"to_email": "[email protected]",
"from_email": "[email protected]",
"from_name": "Shop ABC",
"replyto_email": "[email protected]",
"source": "company"
}Error Codes
| HTTP | Mã lỗi | Mô tả |
|---|---|---|
| 403 | error_role_not_available | Không có quyền company.setting (kèm detail.role) |
| 403 | error_user_required | Request không gắn với người dùng / công ty (vd gọi không bằng JWT của người dùng) |
| 422 | error_toemail_invalid | Email của người dùng đang đăng nhập không hợp lệ |
| 422 | error_fromemail_required | Không xác định được địa chỉ người gửi |
| 422 | error_smtp_host_invalid | (Hubport SaaS) Máy chủ SMTP đã lưu không hợp lệ |
| 422 | error_smtp_port_not_allowed | (Hubport SaaS) Cổng SMTP không thuộc 25, 465, 587, 2525 |
| 422 | error_url_private_address | (Hubport SaaS) Máy chủ SMTP trỏ tới địa chỉ nội bộ |
| 422 | error_url_host_unresolvable | (Hubport SaaS) Không phân giải được tên máy chủ SMTP |
| 429 | error_rate_limit | Vượt giới hạn 5 lần gửi thử / 10 phút |
| 500 | (xem bên dưới) | Gửi email thất bại |
Khi gửi thất bại, response HTTP 500 có dạng:
{
"error": ["SMTP Error: Could not authenticate."],
"source": "company"
}source = company:errorchứa thông báo lỗi chi tiết từ máy chủ SMTP của cửa hàng để bạn tự kiểm tra lại cấu hình (tài khoản, mật khẩu, cổng, SSL/TLS...).source = system:errorluôn là["error_send"](không trả chi tiết hạ tầng của hệ thống).
Ví dụ
curl -X POST "https://api.hubport.vn/v1/emails/test" \
-H "Authorization: <JWT>" \
-H "Content-Type: application/json" \
-d '{}'