DEVELOPER API

APIドキュメント

Dc Mails の公開APIを使うと、メールアドレスの作成・受信確認・削除をプログラムから行えます。設定ページでAPIキーを発行してください。

認証

全てのAPIリクエストに、発行したAPIキーを X-Api-Key ヘッダーで付与してください。

curl https://dcmails.dpdns.org/api/v1/mailboxes \
  -H "X-Api-Key: dcm_live_xxxxxxxxxxxxxxxxxxxxxxxx"

POST/api/v1/mailboxes

新しい使い捨てメールアドレスを作成します。

curl -X POST https://dcmails.dpdns.org/api/v1/mailboxes \
  -H "X-Api-Key: dcm_live_xxxxxxxxxxxxxxxxxxxxxxxx"

# レスポンス
{
  "id": "xxxx-xxxx-xxxx",
  "address": "k3x9mzq2p7@dcmails.dpdns.org",
  "created_at": 1733740800000
}

GET/api/v1/mailboxes

作成済みのメールアドレス一覧を取得します。

curl https://dcmails.dpdns.org/api/v1/mailboxes \
  -H "X-Api-Key: dcm_live_xxxxxxxxxxxxxxxxxxxxxxxx"

# レスポンス
{
  "mailboxes": [
    { "id": "...", "address": "k3x9mzq2p7@dcmails.dpdns.org", "created_at": 1733740800000, "email_count": 3 }
  ]
}

GET/api/v1/mailboxes/:address/emails

指定したアドレスの受信メール一覧を取得します(最大100件、新しい順)。

curl https://dcmails.dpdns.org/api/v1/mailboxes/k3x9mzq2p7@dcmails.dpdns.org/emails \
  -H "X-Api-Key: dcm_live_xxxxxxxxxxxxxxxxxxxxxxxx"

# レスポンス
{
  "address": "k3x9mzq2p7@dcmails.dpdns.org",
  "emails": [
    {
      "id": "...", "from_address": "noreply@example.com", "subject": "確認コード",
      "received_at": 1733740900000, "is_read": 0,
      "is_verification_code": 1, "detected_code": "482913"
    }
  ]
}

GET/api/v1/mailboxes/:address/emails/:emailId

メール本文を含む詳細を取得します。

curl https://dcmails.dpdns.org/api/v1/mailboxes/k3x9mzq2p7@dcmails.dpdns.org/emails/EMAIL_ID \
  -H "X-Api-Key: dcm_live_xxxxxxxxxxxxxxxxxxxxxxxx"

DELETE/api/v1/mailboxes/:address

メールアドレスを削除します。

curl -X DELETE https://dcmails.dpdns.org/api/v1/mailboxes/k3x9mzq2p7@dcmails.dpdns.org \
  -H "X-Api-Key: dcm_live_xxxxxxxxxxxxxxxxxxxxxxxx"

DELETE/api/v1/mailboxes/:address/emails/:emailId

個別のメールを削除します。

curl -X DELETE https://dcmails.dpdns.org/api/v1/mailboxes/k3x9mzq2p7@dcmails.dpdns.org/emails/EMAIL_ID \
  -H "X-Api-Key: dcm_live_xxxxxxxxxxxxxxxxxxxxxxxx"