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

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

プライバシーポリシー利用規約を読む

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

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

APIドキュメント

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

メール転送API

目次

図書館

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

言語 図書館
ルビー ファラデー
パイソン リクエスト
ジャワ OkHttp
PHP がたがた
JavaScript スーパーエージェント
Node.js スーパーエージェント
行く net / http
。ネット RestSharp

ベースURI

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

認証

すべてのエンドポイントには、API key to be set as the "username" value of the request's 基本認証 ヘッダ。心配しないでください–これが何であるかわからない場合は、以下に例を示します。

エラー

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

コード 名前
200 OK
400 要求の形式が正しくありません
401 無許可
403 禁じられた
404 見つかりません
429 リクエストが多すぎます
500 内部サーバーエラー
501 実装されていません
502 悪いゲートウェイ
503 サービスは利用できません
504 ゲートウェイのタイムアウト
Tip: If you receive a 5xx status code (which should not happen), then please contact us at api@forwardemail.net and we will help you to resolve your issue immediately.

ローカリゼーション

私たちのサービスは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"

ドメイン

Tip: Domain endpoints with a domain's name /v1/domains/:domain_name as their path are interchangeable with a domain's ID :domain_id. This means you can refer to the domain by either its name or id value.

ドメインの一覧表示

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" or the user's current paid plan if on one)
catchall 番号 文字列(区切られた電子メールアドレス)またはブール値 デフォルトのキャッチオールエイリアスを作成します。デフォルトはtrue (もしtrue APIユーザーのメールアドレスを受信者として使用します。false キャッチオールは作成されません)。文字列が渡された場合、それは受信者として使用する電子メールアドレスの区切りリストです(改行、スペース、またはコンマで区切られます)
has_adult_content_protection 番号 ブール Whether to enable Spam Scanner adult content protection on this domain
has_phishing_protection 番号 ブール Whether to enable Spam Scanner phishing protection on this domain
has_executable_protection 番号 ブール Whether to enable Spam Scanner executable protection on this domain
has_virus_protection 番号 ブール Whether to enable Spam Scanner virus protection on this domain
has_recipient_verification 番号 ブール Global domain default for whether to require alias recipients to click an email verification link for emails to flow through

リクエストの例:

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 番号 ブール Whether to enable Spam Scanner adult content protection on this domain
has_phishing_protection 番号 ブール Whether to enable Spam Scanner phishing protection on this domain
has_executable_protection 番号 ブール Whether to enable Spam Scanner executable protection on this domain
has_virus_protection 番号 ブール Whether to enable Spam Scanner virus protection on this domain
has_recipient_verification 番号 ブール Global domain default for whether to require alias recipients to click an email verification link for emails to flow through

リクエストの例:

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 番号 ブール Whether to enable to require recipients to click an email verification link for emails to flow through (defaults to the domain's setting if not explicitly set in the request body)
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 番号 ブール Whether to enable to require recipients to click an email verification link for emails to flow through (defaults to the domain's setting if not explicitly set in the request body)
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: