メールAPI

現在、APIラッパーはまだリリースしていませんが、近い将来リリースする予定です。特定のプログラミング言語のAPIラッパーがリリースされた際に通知を受け取りたい場合は、api@forwardemail.netまでメールでご連絡ください。それまでの間、アプリケーションではこれらの推奨HTTPリクエストライブラリをご利用いただくか、以下の例のようにカールをご使用ください。

現在の HTTP ベース URI パスは https://api.forwardemail.net です。

すべてのエンドポイントでは、APIキー をリクエストの 基本認証 ヘッダーの「ユーザー名」値として設定する必要があります (生成されたエイリアスのユーザー名とパスワード を使用する エイリアス連絡先、エイリアスカレンダー、および エイリアスメールボックス を除く)。

心配しないでください。これが何なのかわからない場合は、以下に例を示します。

エラーが発生した場合、API リクエストの応答本文に詳細なエラー メッセージが含まれます。

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

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

クエリ文字列プロパティ page (およびオプションで limit) を指定するだけです。

プロパティpageは、1以上の数値である必要があります。limit（数値）を指定した場合、最小値は10、最大値は50となります（特に記載がない限り）。

さらに結果があるかどうかを判断するために、次の HTTP 応答ヘッダーを提供します (これを解析してプログラムでページ分割できます)。

リクエスト例:

curl https://api.forwardemail.net/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

リクエスト例:

curl https://api.forwardemail.net/v1/logs/download \
  -u API_TOKEN:

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

0 0 * * * /usr/bin/curl https://api.forwardemail.net/v1/logs/download -u API_TOKEN: &>/dev/null

Crontab.guru などのサービスを使用して、cron ジョブ式の構文を検証できることに注意してください。

Cron ジョブの例 (毎日深夜に実行、前日のログも含む):

MacOSの場合:

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

Linux および Ubuntu の場合:

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

アカウントを作成

POST /v1/account

リクエスト例:

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

アカウントを取得

GET /v1/account

リクエスト例:

curl https://api.forwardemail.net/v1/account \
  -u API_TOKEN:

アカウントを更新

PUT /v1/account

リクエスト例:

curl -X PUT https://api.forwardemail.net/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メールの制限を取得する

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

GET /v1/emails/limit

リクエスト例:

curl https://api.forwardemail.net/v1/emails/limit \
  -u API_TOKEN:

送信SMTPメールの一覧表示

このエンドポイントは、電子メールの message、headers、または rejectedErrors のプロパティ値を返さないことに注意してください。

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

GET /v1/emails

リクエスト例:

curl https://api.forwardemail.net/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を作ることでした。

POST /v1/emails

リクエスト例:

curl -X POST https://api.forwardemail.net/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://api.forwardemail.net/v1/emails \
  -u API_TOKEN: \
  -d "raw=`cat file.eml`"

送信SMTPメールを取得する

GET /v1/emails/:id

リクエスト例:

curl https://api.forwardemail.net/v1/emails/:id \
  -u API_TOKEN:

送信SMTPメールを削除します

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

DELETE /v1/emails/:id

リクエスト例:

curl -X DELETE https://api.forwardemail.net/v1/emails/:id \
  -u API_TOKEN:

ドメインの一覧

GET /v1/domains

リクエスト例:

curl https://api.forwardemail.net/v1/domains \
  -u API_TOKEN:

ドメインを作成

POST /v1/domains

リクエスト例:

curl -X POST https://api.forwardemail.net/v1/domains \
  -u API_TOKEN: \
  -d domain=example.com \
  -d plan=free

ドメインを取得

GET /v1/domains/example.com

リクエスト例:

curl https://api.forwardemail.net/v1/domains/example.com \
  -u API_TOKEN:

ドメインレコードを確認する

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

リクエスト例:

curl https://api.forwardemail.net/v1/domains/example.com/verify-records \
  -u API_TOKEN:

ドメインSMTPレコードを確認する

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

リクエスト例:

curl https://api.forwardemail.net/v1/domains/example.com/verify-smtp \
  -u API_TOKEN:

ドメイン全体のキャッチオールパスワードを一覧表示します

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

リクエスト例:

curl https://api.forwardemail.net/v1/domains/example.com/catch-all-passwords \
  -u API_TOKEN:

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

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

リクエスト例:

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

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

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

リクエスト例:

curl -X DELETE https://api.forwardemail.net/v1/domains/:domain_name/catch-all-passwords/:token_id \
  -u API_TOKEN:

ドメインを更新

PUT /v1/domains/example.com

リクエスト例:

curl -X PUT https://api.forwardemail.net/v1/domains/example.com \
  -u API_TOKEN:

ドメインを削除

DELETE /v1/domains/:domain_name

リクエスト例:

curl -X DELETE https://api.forwardemail.net/v1/domains/:domain_name \
  -u API_TOKEN:

ドメイン招待を承認

GET /v1/domains/:domain_name/invites

リクエスト例:

curl https://api.forwardemail.net/v1/domains/:domain_name/invites \
  -u API_TOKEN:

ドメイン招待を作成

POST /v1/domains/example.com/invites

リクエスト例:

curl -X POST https://api.forwardemail.net/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://api.forwardemail.net/v1/domains/:domain_name/invites \
  -u API_TOKEN:

ドメインメンバーを更新

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

リクエスト例:

curl -X PUT https://api.forwardemail.net/v1/domains/example.com/members/:member_id \
  -u API_TOKEN:

ドメインメンバーを削除

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

リクエスト例:

curl -X DELETE https://api.forwardemail.net/v1/domains/:domain_name/members/:member_id \
  -u API_TOKEN:

エイリアスパスワードを生成する

手順を電子メールで送信しない場合は、ユーザー名とパスワードが、{ username: 'alias@yourdomain.com', password: 'some-generated-password' } の形式で成功したリクエストの JSON 応答本文に含まれることに注意してください。

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

リクエスト例:

curl -X POST https://api.forwardemail.net/v1/domains/example.com/aliases/:alias_id/generate-password \
  -u API_TOKEN:

ドメインエイリアスの一覧

GET /v1/domains/example.com/aliases

リクエスト例:

curl https://api.forwardemail.net/v1/domains/example.com/aliases?pagination=true \
  -u API_TOKEN:

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

POST /v1/domains/example.com/aliases

リクエスト例:

curl -X POST https://api.forwardemail.net/v1/domains/example.com/aliases \
  -u API_TOKEN:

ドメインエイリアスを取得

ドメイン エイリアスは、id または name 値のいずれかで取得できます。

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

リクエスト例:

curl https://api.forwardemail.net/v1/domains/:domain_name/aliases/:alias_id \
  -u API_TOKEN:

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

リクエスト例:

curl https://api.forwardemail.net/v1/domains/:domain_name/aliases/:alias_name \
  -u API_TOKEN:

ドメインエイリアスを更新

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

リクエスト例:

curl -X PUT https://api.forwardemail.net/v1/domains/example.com/aliases/:alias_id \
  -u API_TOKEN:

ドメインエイリアスを削除

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

リクエスト例:

curl -X DELETE https://api.forwardemail.net/v1/domains/:domain_name/aliases/:alias_id \
  -u API_TOKEN:

無料プランでもレコードの暗号化を無料でご利用いただけます。プライバシーは機能ではなく、製品のあらゆる側面に本質的に組み込まれているべきです。プライバシーガイドの議論 と GitHubの問題 で多くのご要望をいただいたため、この機能を追加しました。

TXTレコードを暗号化

POST /v1/encrypt

リクエスト例:

curl -X POST https://api.forwardemail.net/v1/encrypt \
  -d "input=user@gmail.com"