メールボックス

メールボックスを作成

POSThttps://api.temporam.com/v3/mailboxes

フィールド型必須説明
domainstringはいドメイン API が返したドメイン
local_partstringいいえ省略すると自動生成されるローカルパート
  1. 1curl -X POST https://api.temporam.com/v3/mailboxes \
  2. 2 -H "Authorization: Bearer YOUR_API_KEY" \
  3. 3 -H "Content-Type: application/json" \
  4. 4 -d '{"domain":"temporam.com","local_part":"demo"}'
レスポンスフィールド型説明
data.idstringメールボックス ID
data.addressstring完全なメールアドレス
data.local_partstringアドレスのローカルパート
data.domainstringアドレスのドメイン
data.statusstringメールボックスの状態
data.created_atstring作成時刻
meta.remaininginteger利用可能な場合の関連クォータ残量

メールボックス一覧

GEThttps://api.temporam.com/v3/mailboxes

パラメーター場所型必須既定値説明
pagequeryintegerいいえ1ページ番号
limitqueryintegerいいえ201 ページの件数
レスポンスフィールド型説明
dataarray上記のフィールドを持つメールボックス一覧
meta.totalintegerメールボックス総数
meta.pageinteger現在のページ
meta.limitinteger1 ページの件数
meta.remaininginteger利用可能な場合の関連クォータ残量

メールボックスを取得

GEThttps://api.temporam.com/v3/mailboxes/{id}

パラメーター場所型必須説明
idpathstringはいメールボックス ID
レスポンスフィールド型説明
dataobject上記のフィールドを持つメールボックス詳細
meta.remaininginteger利用可能な場合の関連クォータ残量

メールボックスを削除

DELETEhttps://api.temporam.com/v3/mailboxes/{id}

パラメーター場所型必須説明
idpathstringはいメールボックス ID
レスポンスフィールド型説明
data.deletedboolean削除成功時は常に true
meta.remaininginteger利用可能な場合の関連クォータ残量