メールボックス
メールボックスを作成
POSThttps://api.temporam.com/v3/mailboxes
| フィールド | 型 | 必須 | 説明 |
|---|
| domain | string | はい | ドメイン API が返したドメイン |
| local_part | string | いいえ | 省略すると自動生成されるローカルパート |
- 1curl -X POST https://api.temporam.com/v3/mailboxes \
- 2 -H "Authorization: Bearer YOUR_API_KEY" \
- 3 -H "Content-Type: application/json" \
- 4 -d '{"domain":"temporam.com","local_part":"demo"}'
| レスポンスフィールド | 型 | 説明 |
|---|
| data.id | string | メールボックス ID |
| data.address | string | 完全なメールアドレス |
| data.local_part | string | アドレスのローカルパート |
| data.domain | string | アドレスのドメイン |
| data.status | string | メールボックスの状態 |
| data.created_at | string | 作成時刻 |
| meta.remaining | integer | 利用可能な場合の関連クォータ残量 |
メールボックス一覧
GEThttps://api.temporam.com/v3/mailboxes
| パラメーター | 場所 | 型 | 必須 | 既定値 | 説明 |
|---|
| page | query | integer | いいえ | 1 | ページ番号 |
| limit | query | integer | いいえ | 20 | 1 ページの件数 |
| レスポンスフィールド | 型 | 説明 |
|---|
| data | array | 上記のフィールドを持つメールボックス一覧 |
| meta.total | integer | メールボックス総数 |
| meta.page | integer | 現在のページ |
| meta.limit | integer | 1 ページの件数 |
| meta.remaining | integer | 利用可能な場合の関連クォータ残量 |
メールボックスを取得
GEThttps://api.temporam.com/v3/mailboxes/{id}
| パラメーター | 場所 | 型 | 必須 | 説明 |
|---|
| id | path | string | はい | メールボックス ID |
| レスポンスフィールド | 型 | 説明 |
|---|
| data | object | 上記のフィールドを持つメールボックス詳細 |
| meta.remaining | integer | 利用可能な場合の関連クォータ残量 |
メールボックスを削除
DELETEhttps://api.temporam.com/v3/mailboxes/{id}
| パラメーター | 場所 | 型 | 必須 | 説明 |
|---|
| id | path | string | はい | メールボックス ID |
| レスポンスフィールド | 型 | 説明 |
|---|
| data.deleted | boolean | 削除成功時は常に true |
| meta.remaining | integer | 利用可能な場合の関連クォータ残量 |