メールAPI

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

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

すべてのエンドポイントで APIキー リクエストの「ユーザー名」値として設定されます 基本認証 ヘッダ。心配しないでください。これが何かわからない場合は、以下に例を示します。

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

当社のサービスは 25 を超える言語に翻訳されています。すべての API 応答メッセージは、API 要求を行ったユーザーで最後に検出されたロケールに変換されます。カスタムを渡すことでこれをオーバーライドできます Accept-Language ヘッダ。このページの下部にある言語ドロップダウンを使用して、お気軽にお試しください。

ページネーションが利用可能になったときに通知を受け取りたい場合は、メールでお問い合わせください api@forwardemail.net.

ログの取得

弊社の API を使用すると、プログラムでアカウントのログをダウンロードできます。このエンドポイントにリクエストを送信すると、アカウントのすべてのログが処理され、添付ファイルとして電子メールで送信されます (Gzip 圧縮された CSV スプレッドシート ファイル) が完了したら。

これにより、バックグラウンド ジョブを作成できるようになります。 クロンジョブ または弊社の Node.js ジョブ スケジューリング ソフトウェア Bree いつでもログを受信できます。このエンドポイントは以下に限定されることに注意してください。 10 1日あたりのリクエスト。

添付ファイルは小文字形式です 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 0 * * * /usr/bin/curl https://api.forwardemail.net/v1/logs/download -u API_TOKEN: &>/dev/null

などのサービスが利用できるので注意してください。 Crontab.guru cron ジョブ式の構文を検証します。

Cron ジョブの例 (毎日午前 0 時) 前日のログ付き):

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"

ドメインの設定手順に従っていることを確認してください。これらの手順は次の場所にあります。 「マイアカウント」→「ドメイン」→「設定」→「アウトバウンドSMTP構成」。ドメインでアウトバウンド SMTP を送信するには、DKIM、Return-Path、および DMARC がセットアップされていることを確認する必要があります。

メールの一覧表示

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

これらのプロパティとその値を返すには、 電子メールを取得する 電子メール ID を持つエンドポイント。

このエンドポイントは最大でも戻ります 50 一度に結果が得られます。複数のページをクエリする場合は、 ?page=NUMBER どこ NUMBER は整数です。例: ?page=1.

GET /v1/emails

リクエストの例：

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

メールの作成

電子メールを作成するための API は、Nodemailer のメッセージ オプション構成からインスピレーションを受け、活用しています。までお待ちください。 ノードメーラーのメッセージ構成 以下のすべてのボディパラメータについて。

例外として注意してください。 envelope と dkim (これらは自動的に設定されるため)、すべての Nodemailer オプションがサポートされています。自動で設定します disableFileAccess と disableUrlAccess のオプション true セキュリティ目的のため。

次の単一オプションを渡す必要があります。 raw ヘッダーを含む生の完全なメール または 以下の個々の本体パラメーター オプションを渡します。

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`"

電子メールを取得する

GET /v1/emails/:id

リクエストの例：

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

メールを削除する

電子メールを削除すると、ステータスが次のように設定されます。 "rejected" 現在のステータスが次のいずれかの場合にのみ (その後キュー内で処理されません) "pending", "queued"、 また "deferred"。電子メールは、作成および/または送信されてから 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:

ドメインを更新

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:

ドメインエイリアスを一覧表示する

GET /v1/domains/example.com/aliases

リクエストの例：

curl https://api.forwardemail.net/v1/domains/example.com/aliases \
  -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: