Email API

現時点ではAPIラッパーはまだリリースしていませんが、近い将来リリースする予定です。特定のプログラミング言語のAPIラッパーがリリースされた際に通知を希望される場合は、api@forwardemail.net にメールを送ってください。その間は、以下の推奨HTTPリクエストライブラリをアプリケーションで使用するか、下記の例のように単にcurlを使用できます。

現在のHTTPベースURIパスは次のとおりです：https://fe.tiamati.email。

すべてのエンドポイントはBasic Authorizationを使用した認証が必要です。認証方法は2つあります：

API Token Authentication (ほとんどのエンドポイントに推奨)

APIキーを「ユーザー名」値として設定し、パスワードは空にします：

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

APIトークンの後のコロン（:）に注意してください。これはBasic認証形式でパスワードが空であることを示します。

Alias Credentials Authentication (送信メール用)

送信SMTPメール作成エンドポイントは、エイリアスメールアドレスと生成されたエイリアスパスワードを使用した認証もサポートしています：

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エンドポイントはエイリアス認証情報が必要で、APIトークン認証はサポートしていません。

ご心配なく — 何かわからない場合は以下に例を示しています。

エラーが発生した場合、APIリクエストのレスポンスボディに詳細なエラーメッセージが含まれます。

当サービスは25以上の言語に翻訳されています。すべてのAPIレスポンスメッセージは、APIリクエストを行うユーザーの最後に検出されたロケールに翻訳されます。カスタムのAccept-Languageヘッダーを渡すことでこれを上書きできます。このページ下部の言語ドロップダウンでぜひお試しください。

ページネーションは結果を一覧表示するすべてのAPIエンドポイントでサポートされています。

クエリ文字列のpage（および任意でlimit）を指定してください。

pageは1以上の数値である必要があります。limitを指定する場合（これも数値）は、最小値が10、最大値が50です（特に記載がない限り）。

Example Request:

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

ログの取得

当社のAPIは、アカウントのログをプログラム的にダウンロードすることを可能にします。このエンドポイントにリクエストを送信すると、アカウントのすべてのログが処理され、完了後に添付ファイル（Gzip圧縮されたCSVスプレッドシートファイル）としてメールで送信されます。

これにより、Cronジョブや当社のNode.jsジョブスケジューリングソフトウェアBreeを使用してバックグラウンドジョブを作成し、必要なときにログを受け取ることができます。なお、このエンドポイントは1日あたり10リクエストに制限されています。

添付ファイル名は小文字のemail-deliverability-logs-YYYY-MM-DD-h-mm-A-z.csv.gz形式で、メール本文には取得したログの簡単な概要が含まれています。また、マイアカウント → ログからいつでもログをダウンロードできます。

GET /v1/logs/download

Example Request:

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

Cronジョブの例（毎日深夜）:

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

Cronジョブの式の構文を検証するには、Crontab.guruなどのサービスを利用できます。

Cronジョブの例（毎日深夜、前日のログ付き）:

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

Example Request:

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

アカウントの取得

GET /v1/account

Example Request:

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

アカウントの更新

PUT /v1/account

Example Request:

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

近日公開予定

ドメインのセットアップ手順を必ずご確認ください。

これらの手順はFAQセクションの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設定に記載されています。送信SMTPでドメインを使用するには、DKIM、Return-Path、DMARCの設定が必要です。

アウトバウンドSMTPメールの制限取得

これは、アカウントごとの1日あたりのSMTPアウトバウンドメッセージ数の count と limit を含むJSONオブジェクトを返すシンプルなエンドポイントです。

GET /v1/emails/limit

リクエスト例:

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

アウトバウンドSMTPメール一覧

このエンドポイントは、メールの message、headers、および rejectedErrors のプロパティ値を返しません。

それらのプロパティと値を取得するには、メールIDを使って メール取得 エンドポイントを使用してください。

GET /v1/emails

リクエスト例:

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

アウトバウンドSMTPメール作成

メール作成用APIは Nodemailer のメッセージオプション設定に触発されており、それを活用しています。以下の本文パラメータについては Nodemailer メッセージ設定 を参照してください。

envelope と dkim（自動設定されるため）を除き、すべての Nodemailer オプションをサポートしています。セキュリティのために disableFileAccess と disableUrlAccess オプションは自動的に true に設定されます。

ヘッダーを含む生の完全なメールを raw オプションで渡すか、以下の個別の本文パラメータを渡してください。

このAPIはヘッダー内に絵文字があれば自動的にエンコードします（例：Subject: 🤓 Hello は自動的に Subject: =?UTF-8?Q?=F0=9F=A4=93?= Hello に変換されます）。開発者に優しく、ミスを防ぐメールAPIを目指しています。

認証: このエンドポイントは APIトークン認証 と エイリアス認証 の両方をサポートしています。詳細は上記の 認証 セクションを参照してください。

POST /v1/emails

例リクエスト（APIトークン）:

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"

例リクエスト（エイリアスクレデンシャル）:

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"

例リクエスト（Rawメール）:

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メールの削除

メールの削除は、現在のステータスが "pending"、"queued"、または "deferred" のいずれかの場合に限り、ステータスを "rejected" に設定し（その後キューで処理されません）、実行されます。メールは作成または送信後30日経過すると自動的に削除される場合があります。そのため、クライアント、データベース、またはアプリケーションにアウトバウンドSMTPメールのコピーを保持することを推奨します。必要に応じて、Create email および Retrieve email エンドポイントの両方から返されるメールID値をデータベースで参照できます。

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

Example Request:

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

ドメインの取得

GET /v1/domains/example.com

Example Request:

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

ドメインレコードの検証

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

Example Request:

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

ドメインのSMTPレコードの検証

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

Example Request:

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

ドメイン全体のキャッチオールパスワード一覧

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

Example Request:

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

ドメイン全体のキャッチオールパスワードの作成

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

Example Request:

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

ドメイン全体のキャッチオールパスワードの削除

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

Example Request:

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

Example Request:

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

Example Request:

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

新しいドメインエイリアスを作成

POST /v1/domains/example.com/aliases

Example Request:

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

Example Request:

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

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

Example Request:

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"