メールAPI

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

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

すべてのエンドポイントで APIキー リクエストの「ユーザー名」値として設定されます 基本認証 ヘッダー（ エイリアス連絡先, エイリアスカレンダー、 と エイリアスメールボックス 使用する 生成されたエイリアスのユーザー名とパスワード)..

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

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

[!TIP] 5xx ステータス コード (発生しないはずの) が表示された場合は、 api@forwardemail.net すぐに問題を解決するお手伝いをいたします。

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

[!NOTE] 2024年11月1日現在、 ドメインの一覧表示 と ドメインエイリアスを一覧表示する デフォルトは 1000 1ページあたり最大結果数。この動作を早期にオプトインしたい場合は、 ?paginate=true エンドポイント クエリの URL への追加のクエリ文字列パラメータとして。

ページネーションは、結果をリストするすべての 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 を使用すると、プログラムでアカウントのログをダウンロードできます。このエンドポイントにリクエストを送信すると、アカウントのすべてのログが処理され、添付ファイルとして電子メールで送信されます (ジップ 圧縮された 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"

[!NOTE] 他のAPIエンドポイントとは異なり、これらには 認証 「username」はエイリアスのユーザー名に等しく、「password」は基本認証ヘッダーとしてエイリアスで生成されたパスワードに等しくなります。

[!警告] このエンドポイント セクションは現在開発中であり、2024 年にリリースされる予定です (うまくいけば)。それまでの間、当社の Web サイトのナビゲーションにある [アプリ] ドロップダウンから IMAP クライアントを使用してください。

[!NOTE] CardDAVのサポートはまだ利用できません。最新情報についてはGitHubのこのディスカッションを参照してください。.

連絡先を一覧表示する

GET /v1/contacts

近日公開

連絡先を作成

POST /v1/contacts

近日公開

連絡先を取得

GET /v1/contacts/:id

近日公開

連絡先を更新

PUT /v1/contacts/:id

近日公開

連絡先を削除

DELETE /v1/contacts/:id

近日公開

[!NOTE] 他のAPIエンドポイントとは異なり、これらには 認証 「username」はエイリアスのユーザー名に等しく、「password」は基本認証ヘッダーとしてエイリアスで生成されたパスワードに等しくなります。

[!警告] このエンドポイント セクションは現在開発中であり、2024 年にリリースされる予定です (うまくいけば)。それまでの間、当社の Web サイトのナビゲーションにある [アプリ] ドロップダウンから IMAP クライアントを使用してください。

カレンダーを一覧表示する

GET /v1/calendars

近日公開

カレンダーを作成

POST /v1/calendars

近日公開

カレンダーを取得

GET /v1/calendars/:id

近日公開

カレンダーを更新

PUT /v1/calendars/:id

近日公開

カレンダーを削除

DELETE /v1/calendars/:id

近日公開

[!NOTE] 他のAPIエンドポイントとは異なり、これらには 認証 「username」はエイリアスのユーザー名に等しく、「password」は基本認証ヘッダーとしてエイリアスで生成されたパスワードに等しくなります。

[!警告] このエンドポイント セクションは現在開発中であり、2024 年にリリースされる予定です (うまくいけば)。それまでの間、当社の Web サイトのナビゲーションにある [アプリ] ドロップダウンから IMAP クライアントを使用してください。

ドメインのセットアップ手順に従っていることを確認してください。

これらの手順はFAQセクションに記載されています。 IMAP によるメールの受信をサポートしていますか?.

メッセージの一覧と検索

GET /v1/messages

近日公開

メッセージを作成

[!NOTE] これにより NOT メールを送信する – 単にメッセージをメールボックスフォルダに追加するだけです（これはIMAPに似ています）。 APPEND コマンドを使用します。メールを送信したい場合は、 送信SMTPメールを作成する 以下を参照してください。送信 SMTP メールを作成したら、このエンドポイントを使用してそのコピーをエイリアスのメールボックスに追加し、保存することができます。

POST /v1/messages

近日公開

メッセージを取得

GET /v1/messages/:id

近日公開

メッセージを更新

PUT /v1/messages/:id

近日公開

メッセージを削除

DELETE /v1/messages:id

近日公開

[!TIP] フォルダのパスを持つフォルダ エンドポイント /v1/folders/:path エンドポイントはフォルダのIDと交換可能である :idつまり、フォルダを path または id 価値。

[!警告] このエンドポイント セクションは現在開発中であり、2024 年にリリースされる予定です (うまくいけば)。それまでの間、当社の Web サイトのナビゲーションにある [アプリ] ドロップダウンから IMAP クライアントを使用してください。

フォルダの一覧

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メールの制限を取得する

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

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 のメッセージ オプション構成からインスピレーションを受け、活用しています。までお待ちください。 ノードメーラーのメッセージ構成 以下のすべてのボディパラメータについて。

例外として注意してください。 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メールを削除する

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

DELETE /v1/emails/:id

リクエストの例：

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

[!TIP] ドメイン名を持つドメイン エンドポイント /v1/domains/:domain_name エンドポイントはドメインのIDと交換可能であるため :domain_id.これは、ドメインを次のいずれかで参照できることを意味します。 name または id 価値。

ドメインの一覧表示

[!NOTE] 2024年11月1日現在、 ドメインの一覧表示 と ドメインエイリアスを一覧表示する デフォルトは 1000 1ページあたり最大結果数。この動作を早期にオプトインしたい場合は、 ?paginate=true エンドポイントクエリのURLに追加のクエリ文字列パラメータとして指定します。 ページネーション より多くの洞察を得るために。

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:

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

指示をメールで送信しない場合、ユーザー名とパスワードは成功したリクエストのJSONレスポンス本文に次の形式で含まれます。 { username: 'alias@yourdomain.com', password: 'some-generated-password' }.

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:

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

[!NOTE] 2024年11月1日現在、 ドメインの一覧表示 と ドメインエイリアスを一覧表示する デフォルトは 1000 1ページあたり最大結果数。この動作を早期にオプトインしたい場合は、 ?paginate=true エンドポイントクエリのURLに追加のクエリ文字列パラメータとして指定します。 ページネーション より多くの洞察を得るために。

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"