Email API

Hiện tại chúng tôi chưa phát hành bất kỳ thư viện API nào, nhưng chúng tôi dự định sẽ làm điều đó trong tương lai gần. Gửi email đến api@forwardemail.net nếu bạn muốn được thông báo khi thư viện API cho một ngôn ngữ lập trình cụ thể được phát hành. Trong khi đó, bạn có thể sử dụng các thư viện HTTP request được khuyến nghị dưới đây trong ứng dụng của mình, hoặc đơn giản sử dụng curl như trong các ví dụ bên dưới.

Đường dẫn cơ sở HTTP hiện tại là: https://fe.tiamati.email.

Tất cả các điểm cuối yêu cầu xác thực bằng Basic Authorization. Chúng tôi hỗ trợ hai phương thức xác thực:

Xác thực API Token (Khuyến nghị cho hầu hết các điểm cuối)

Đặt API key của bạn làm giá trị "username" với mật khẩu để trống:

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

Lưu ý dấu hai chấm (:) sau API token – điều này biểu thị mật khẩu trống trong định dạng Basic Auth.

Xác thực Thông tin đăng nhập Alias (Cho email gửi đi)

Điểm cuối Tạo email SMTP gửi đi cũng hỗ trợ xác thực bằng địa chỉ email alias của bạn và mật khẩu alias được tạo:

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"

Phương thức này hữu ích khi gửi email từ các ứng dụng đã sử dụng thông tin đăng nhập SMTP và giúp việc chuyển đổi từ SMTP sang API của chúng tôi trở nên liền mạch.

Các điểm cuối chỉ dùng Alias

Các điểm cuối Alias Contacts, Alias Calendars, Alias Messages, và Alias Folders yêu cầu thông tin đăng nhập alias và không hỗ trợ xác thực bằng API token.

Đừng lo – các ví dụ được cung cấp bên dưới nếu bạn chưa rõ đây là gì.

Nếu có lỗi xảy ra, phần thân phản hồi của yêu cầu API sẽ chứa thông báo lỗi chi tiết.

Dịch vụ của chúng tôi được dịch sang hơn 25 ngôn ngữ khác nhau. Tất cả các thông báo phản hồi API được dịch theo ngôn ngữ cuối cùng được phát hiện của người dùng thực hiện yêu cầu API. Bạn có thể ghi đè điều này bằng cách truyền header Accept-Language tùy chỉnh. Hãy thử sử dụng menu chọn ngôn ngữ ở cuối trang này.

Phân trang được hỗ trợ bởi tất cả các điểm cuối API liệt kê kết quả.

Chỉ cần cung cấp các thuộc tính truy vấn page (và tùy chọn limit).

Thuộc tính page phải là số lớn hơn hoặc bằng 1. Nếu bạn cung cấp limit (cũng là số), thì giá trị tối thiểu là 10 và tối đa là 50 (trừ khi có ghi chú khác).

Ví dụ Yêu cầu:

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

Lấy nhật ký

API của chúng tôi cho phép bạn tải xuống nhật ký cho tài khoản của bạn một cách lập trình. Gửi yêu cầu đến điểm cuối này sẽ xử lý tất cả nhật ký cho tài khoản của bạn và gửi email cho bạn dưới dạng tệp đính kèm (Gzip nén CSV) khi hoàn tất.

Điều này cho phép bạn tạo các công việc nền với một Cron job hoặc sử dụng phần mềm lập lịch công việc Node.js Bree của chúng tôi để nhận nhật ký bất cứ khi nào bạn muốn. Lưu ý rằng điểm cuối này giới hạn 10 yêu cầu mỗi ngày.

Tệp đính kèm có dạng chữ thường của email-deliverability-logs-YYYY-MM-DD-h-mm-A-z.csv.gz và email chứa một bản tóm tắt ngắn gọn về các nhật ký đã lấy. Bạn cũng có thể tải xuống nhật ký bất cứ lúc nào từ Tài khoản của tôi → Nhật ký

GET /v1/logs/download

Ví dụ Yêu cầu:

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

Ví dụ Cron job (vào nửa đêm mỗi ngày):

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

Lưu ý bạn có thể sử dụng các dịch vụ như Crontab.guru để kiểm tra cú pháp biểu thức cron job của bạn.

Ví dụ Cron job (vào nửa đêm mỗi ngày và với nhật ký của ngày trước đó):

Dành cho 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

Dành cho Linux và 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

Tạo tài khoản

POST /v1/account

Ví dụ Yêu cầu:

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

Lấy tài khoản

GET /v1/account

Ví dụ Yêu cầu:

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

Cập nhật tài khoản

PUT /v1/account

Ví dụ Yêu cầu:

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

Liệt kê liên hệ

GET /v1/contacts

Sắp ra mắt

Tạo liên hệ

POST /v1/contacts

Sắp ra mắt

Lấy thông tin liên hệ

GET /v1/contacts/:id

Sắp ra mắt

Cập nhật liên hệ

PUT /v1/contacts/:id

Sắp ra mắt

Xóa liên hệ

DELETE /v1/contacts/:id

Sắp ra mắt

Liệt kê lịch

GET /v1/calendars

Sắp ra mắt

Tạo lịch

POST /v1/calendars

Sắp ra mắt

Lấy thông tin lịch

GET /v1/calendars/:id

Sắp ra mắt

Cập nhật lịch

PUT /v1/calendars/:id

Sắp ra mắt

Xóa lịch

DELETE /v1/calendars/:id

Sắp ra mắt

Vui lòng đảm bảo bạn đã làm theo hướng dẫn thiết lập cho tên miền của mình.

Các hướng dẫn này có thể được tìm thấy trong phần Câu hỏi thường gặp của chúng tôi Bạn có hỗ trợ nhận email qua IMAP không?.

Liệt kê và tìm kiếm tin nhắn

GET /v1/messages

Sắp ra mắt

Tạo tin nhắn

POST /v1/messages

Sắp ra mắt

Lấy tin nhắn

GET /v1/messages/:id

Sắp ra mắt

Cập nhật tin nhắn

PUT /v1/messages/:id

Sắp ra mắt

Xóa tin nhắn

DELETE /v1/messages:id

Sắp ra mắt

Liệt kê thư mục

GET /v1/folders

Sắp ra mắt

Tạo thư mục

POST /v1/folders

Sắp ra mắt

Lấy thư mục

GET /v1/folders/:id

Sắp ra mắt

Cập nhật thư mục

PUT /v1/folders/:id

Sắp ra mắt

Xóa thư mục

DELETE /v1/folders/:id

Sắp ra mắt

Sao chép thư mục

POST /v1/folders/:id/copy

Sắp ra mắt

Vui lòng đảm bảo bạn đã làm theo hướng dẫn thiết lập cho tên miền của mình.

Các hướng dẫn này có thể được tìm thấy tại Tài khoản của tôi → Tên miền → Cài đặt → Cấu hình SMTP gửi đi. Bạn cần đảm bảo thiết lập DKIM, Return-Path và DMARC để gửi SMTP đi với tên miền của bạn.

Lấy giới hạn email SMTP gửi đi

Đây là một endpoint đơn giản trả về một đối tượng JSON chứa count và limit cho số lượng tin nhắn SMTP gửi đi hàng ngày trên cơ sở từng tài khoản.

GET /v1/emails/limit

Ví dụ yêu cầu:

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

Liệt kê email SMTP gửi đi

Lưu ý rằng endpoint này không trả về giá trị thuộc tính cho message, headers, cũng như rejectedErrors của một email.

Để trả về các thuộc tính và giá trị đó, vui lòng sử dụng endpoint Lấy email với ID email.

GET /v1/emails

Ví dụ yêu cầu:

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

Tạo email SMTP gửi đi

API của chúng tôi để tạo email được lấy cảm hứng và tận dụng cấu hình tùy chọn message của Nodemailer. Vui lòng tham khảo Cấu hình message của Nodemailer cho tất cả các tham số thân dưới đây.

Lưu ý rằng ngoại trừ envelope và dkim (vì chúng tôi tự động thiết lập cho bạn), chúng tôi hỗ trợ tất cả các tùy chọn của Nodemailer. Chúng tôi tự động đặt các tùy chọn disableFileAccess và disableUrlAccess thành true vì lý do bảo mật.

Bạn nên truyền một tùy chọn duy nhất raw với email thô đầy đủ của bạn bao gồm cả headers hoặc truyền các tùy chọn tham số thân riêng lẻ dưới đây.

Endpoint API này sẽ tự động mã hóa emoji cho bạn nếu chúng được tìm thấy trong headers (ví dụ: dòng chủ đề Subject: 🤓 Hello sẽ được chuyển thành Subject: =?UTF-8?Q?=F0=9F=A4=93?= Hello một cách tự động). Mục tiêu của chúng tôi là tạo ra một API email cực kỳ thân thiện với nhà phát triển và dễ sử dụng.

Xác thực: Endpoint này hỗ trợ cả xác thực token API và xác thực thông tin đăng nhập bí danh. Xem phần Xác thực phía trên để biết chi tiết.

POST /v1/emails

Yêu cầu ví dụ (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"

Yêu cầu ví dụ (Thông tin đăng nhập 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"

Yêu cầu ví dụ (Email thô):

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

Lấy email SMTP gửi đi

GET /v1/emails/:id

Yêu cầu ví dụ:

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

Xóa email SMTP gửi đi

Việc xóa email sẽ đặt trạng thái thành "rejected" (và sau đó không xử lý trong hàng đợi) nếu và chỉ nếu trạng thái hiện tại là một trong các trạng thái "pending", "queued", hoặc "deferred". Chúng tôi có thể tự động xóa email sau 30 ngày kể từ khi chúng được tạo và/hoặc gửi – do đó bạn nên giữ một bản sao email SMTP gửi đi trong client, cơ sở dữ liệu hoặc ứng dụng của bạn. Bạn có thể tham chiếu giá trị ID email của chúng tôi trong cơ sở dữ liệu nếu muốn – giá trị này được trả về từ cả hai điểm cuối Tạo email và Lấy email.

DELETE /v1/emails/:id

Yêu cầu ví dụ:

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

Liệt kê tên miền

GET /v1/domains

Yêu cầu ví dụ:

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

Tạo tên miền

POST /v1/domains

Ví dụ Yêu cầu:

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

Lấy thông tin domain

GET /v1/domains/example.com

Ví dụ Yêu cầu:

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

Xác minh bản ghi domain

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

Ví dụ Yêu cầu:

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

Xác minh bản ghi SMTP domain

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

Ví dụ Yêu cầu:

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

Liệt kê mật khẩu catch-all toàn domain

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

Ví dụ Yêu cầu:

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

Tạo mật khẩu catch-all toàn domain

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

Ví dụ Yêu cầu:

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

Xóa mật khẩu catch-all toàn domain

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

Ví dụ Yêu cầu:

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

Cập nhật domain

PUT /v1/domains/example.com

Ví dụ Yêu cầu:

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

Xóa domain

DELETE /v1/domains/:domain_name

Ví dụ Yêu cầu:

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

Chấp nhận lời mời domain

GET /v1/domains/:domain_name/invites

Ví dụ Yêu cầu:

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

Tạo lời mời domain

POST /v1/domains/example.com/invites

Ví dụ Yêu cầu:

curl -X POST https://fe.tiamati.email/v1/domains/example.com/invites \
  -u API_TOKEN: \
  -d "email=user%40gmail.com" \
  -d group=admin

Xóa lời mời domain

DELETE /v1/domains/:domain_name/invites

Ví dụ Yêu cầu:

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

Cập nhật thành viên domain

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

Ví dụ Yêu cầu:

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

Xóa thành viên domain

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

Ví dụ Yêu cầu:

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

Tạo mật khẩu bí danh

Lưu ý rằng nếu bạn không gửi email hướng dẫn, thì tên người dùng và mật khẩu sẽ có trong phần thân phản hồi JSON của yêu cầu thành công với định dạng { username: 'alias@yourdomain.com', password: 'some-generated-password' }.

POST /v1/domains/example.com/aliases/:alias_id/generate-password

Ví dụ Yêu cầu:

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

Liệt kê bí danh miền

GET /v1/domains/example.com/aliases

Ví dụ Yêu cầu:

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

Tạo bí danh miền mới

POST /v1/domains/example.com/aliases

Ví dụ Yêu cầu:

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

Lấy alias miền

Bạn có thể lấy alias miền bằng id hoặc giá trị name của nó.

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

Ví dụ Yêu cầu:

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

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

Ví dụ Yêu cầu:

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

Cập nhật alias miền

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

Ví dụ Yêu cầu:

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

Xóa bí danh miền

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

Ví dụ Yêu cầu:

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

Chúng tôi cho phép bạn mã hóa các bản ghi ngay cả trên gói miễn phí mà không mất phí. Quyền riêng tư không nên là một tính năng, mà nên được tích hợp sẵn trong tất cả các khía cạnh của sản phẩm. Như đã được yêu cầu nhiều trong một thảo luận Privacy Guides và trên các vấn đề GitHub của chúng tôi, chúng tôi đã thêm tính năng này.

Mã hóa bản ghi TXT

POST /v1/encrypt

Ví dụ Yêu cầu:

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