Skip to Content

List mailbox addresses

Lists up to 1000 distinct registered and observed email addresses in sorted order, retaining registered endpoints first when the bound applies.

GET
/v1/mailboxes/{id}/addresses

Lists up to 1000 distinct registered and observed email addresses in sorted order, retaining registered endpoints first when the bound applies. With recipient query parameters, resolves only those candidates as this mailbox’s own addresses, including plus fallback but excluding literal tagged endpoints owned by another mailbox. Use this candidate read for reply addressing.

Authorization

apiKey
headerx-api-key<token>

Path Parameters

id*string
Match^mbx_[0-9a-hjkmnp-tv-z]{16,24}$

Query Parameters

recipient?string|array<string>

Response Body

Success

application/json
  1. response
[index: integer]?string
Example Request
import { createClient } from "samva";

const samva = createClient({ apiKey: process.env.SAMVA_API_KEY! });

const result = await samva.mailboxes.listAddresses({
  "id": "example"
});
Example Response
[
  "string"
]

Related documentation