実際のデータとキーを含むドキュメントが必要ですか?

サインアップまたはログインするだけで、APIキーと実際のアカウントデータが以下に入力されます。

あなたは私たちのプライバシーポリシー条件に同意します。

興味がない?読み続けるにはここをクリック

目次

ドメイン、エイリアスなどにプログラムでアクセスするためのAPIを作成しました。

APIドキュメント

プログラムによるデータへのアクセス

メール転送API

目次

図書館

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

言語図書館
ルビーファラデー
パイソンリクエスト
ジャワOKHttp
PHPがたがた
JavaScriptスーパーエージェント
Node.jsスーパーエージェント
行くnet / http
.NETレストシャープ

ベースURI

現在の HTTP ベース URI パスは次のとおりです。 https://api.forwardemail.net.の従来の HTTP ベース URI パス https://forwardemail.net:4000 は 2021 年 1 月 1 日に非推奨になりました。

認証

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

エラー

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

コード名前
200OK
400要求の形式が正しくありません
401無許可
403禁じられた
404見つかりません
429リクエストが多すぎます
500内部サーバーエラー
501実装されていません
502悪いゲートウェイ
503サービスは利用できません
504ゲートウェイのタイムアウト
ヒント: 5xx ステータス コードを受け取った場合 (これは発生しないはずです)、次のアドレスまでご連絡ください。 api@forwardemail.net すぐに問題を解決するお手伝いをいたします。

ローカリゼーション

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

ページネーション

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

アカウント

アカウントを作成する

POST /v1/account

ボディパラメータ必須タイプ説明
emailはい文字列(メール)電子メールアドレス
passwordはいストリングパスワード

リクエストの例:

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

アカウントを取得する

GET /v1/account

リクエストの例:

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

アカウントを更新する

PUT /v1/account

ボディパラメータ必須タイプ説明
email番号文字列(メール)電子メールアドレス
given_name番号ストリングファーストネーム
family_name番号ストリング苗字
avatar_url番号文字列(URL)アバター画像へのリンク

リクエストの例:

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

ドメイン

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

ドメインの一覧表示

GET /v1/domains

クエリ文字列パラメーター必須タイプ説明
name番号文字列(RegExpをサポート)名前でドメインを検索
alias番号文字列(RegExpをサポート)エイリアス名でドメインを検索する
recipient番号文字列(RegExpをサポート)受信者でドメインを検索する

リクエストの例:

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

ドメインを作成

POST /v1/domains

ボディパラメータ必須タイプ説明
domainはい文字列(FQDNまたはIP)完全修飾ドメイン名(「FQDN」)またはIPアドレス
plan番号文字列(列挙可能)プラン タイプ ( "free", "enhanced_protection"、 また "team"、デフォルトは "free" またはユーザーの現在の有料プランの場合)
catchall番号文字列(区切られた電子メールアドレス)またはブール値デフォルトのキャッチオール エイリアスを作成します。デフォルトは true (もしも true API ユーザーのメールアドレスを受信者として使用します。 false キャッチオールは作成されません)。文字列が渡された場合、それは受信者として使用する電子メール アドレスの区切りリストです (改行、スペース、および/またはコンマで区切られています)。
has_adult_content_protection番号ブールこのドメインでスパムスキャナーのアダルトコンテンツ保護を有効にするかどうか
has_phishing_protection番号ブールこのドメインでスパムスキャナーのフィッシング保護を有効にするかどうか
has_executable_protection番号ブールこのドメインでスパムスキャナーの実行可能保護を有効にするかどうか
has_virus_protection番号ブールこのドメインでスパムスキャナーウイルス保護を有効にするかどうか
has_recipient_verification番号ブールメールが流れるためにエイリアス受信者にメール確認リンクをクリックするように要求するかどうかのグローバルドメインのデフォルト

リクエストの例:

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 -X GET https://api.forwardemail.net/v1/domains/example.com \
  -u API_TOKEN:

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

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

リクエストの例:

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

ドメインを更新

PUT /v1/domains/example.com

ボディパラメータ必須タイプ説明
smtp_port番号文字列または数値SMTP 転送用に構成するカスタム ポート (デフォルトは "25")
has_adult_content_protection番号ブールこのドメインでスパムスキャナーのアダルトコンテンツ保護を有効にするかどうか
has_phishing_protection番号ブールこのドメインでスパムスキャナーのフィッシング保護を有効にするかどうか
has_executable_protection番号ブールこのドメインでスパムスキャナーの実行可能保護を有効にするかどうか
has_virus_protection番号ブールこのドメインでスパムスキャナーウイルス保護を有効にするかどうか
has_recipient_verification番号ブールメールが流れるためにエイリアス受信者にメール確認リンクをクリックするように要求するかどうかのグローバルドメインのデフォルト

リクエストの例:

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

ドメイン招待を作成

POST /v1/domains/example.com/invites

ボディパラメータ必須タイプ説明
emailはい文字列(メール)ドメインメンバーリストに招待するメールアドレス
groupはい文字列(列挙可能)ユーザーをドメイン メンバーシップに追加するグループ (次のいずれかにすることができます) "admin" または "user")

リクエストの例:

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

ボディパラメータ必須タイプ説明
emailはい文字列(メール)ドメインメンバーリストから削除するメールアドレス

リクエストの例:

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

会員

ドメインメンバーを更新する

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

ボディパラメータ必須タイプ説明
groupはい文字列(列挙可能)ユーザーをドメイン メンバーシップに更新するためのグループ (次のいずれかにすることができます) "admin" または "user")

リクエストの例:

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

クエリ文字列パラメーター必須タイプ説明
name番号文字列(RegExpをサポート)ドメイン内のエイリアスを名前で検索する
recipient番号文字列(RegExpをサポート)受信者によるドメイン内のエイリアスの検索

リクエストの例:

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

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

POST /v1/domains/example.com/aliases

ボディパラメータ必須タイプ説明
nameはいストリングエイリアス名
recipientsはい文字列または配列受信者のリスト(改行/スペース/カンマ区切りの有効な電子メールアドレスの文字列または配列、完全修飾ドメイン名(「FQDN」)、IPアドレス、Webhook URL、またはその両方である必要があります)
description番号ストリングエイリアスの説明
labels番号文字列または配列ラベルのリスト(改行/スペース/カンマ区切りの文字列または配列である必要があります)
has_recipient_verification番号ブール受信者が電子メールを通過させるために電子メール確認リンクをクリックすることを要求できるようにするかどうか(リクエスト本文で明示的に設定されていない場合、デフォルトでドメインの設定になります)
is_enabled番号ブールこのエイリアスを無効にするかどうか(無効にすると、メールはどこにもルーティングされませんが、正常なステータスコードが返されます)

リクエストの例:

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

ボディパラメータ必須タイプ説明
name番号ストリングエイリアス名
recipientsはい文字列または配列受信者のリスト(改行/スペース/カンマ区切りの有効な電子メールアドレスの文字列または配列、完全修飾ドメイン名(「FQDN」)、IPアドレス、Webhook URL、またはその両方である必要があります)
description番号ストリングエイリアスの説明
labels番号文字列または配列ラベルのリスト(改行/スペース/カンマ区切りの文字列または配列である必要があります)
has_recipient_verification番号ブール受信者が電子メールを通過させるために電子メール確認リンクをクリックすることを要求できるようにするかどうか(リクエスト本文で明示的に設定されていない場合、デフォルトでドメインの設定になります)
is_enabled番号ブールこのエイリアスを無効にするかどうか(無効にすると、メールはどこにもルーティングされませんが、正常なステータスコードが返されます)

リクエストの例:

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: