Get catch-all configuration
Returns the catch-all receiving configuration for a domain, including its webhook endpoint, unknown-address mailbox (null means drop), and email counts.
GET
Returns the catch-all receiving configuration for a domain, including its webhook endpoint, unknown-address mailbox (null means drop), and email counts.
apiKeyheader
x-api-key<token>domainId*stringMatch
^dom_[0-9a-hjkmnp-tv-z]{16,24}$Success
application/json- response
unknownRecipientMailboxId*|The active mailbox on this domain that receives unknown addresses when catch-all has no webhook endpoint, or null to drop them without a bounce.
enabled*booleanendpointId*|nullemailCount*integerRange
0 <= value <= 9007199254740991lastEmailAt*string|nullimport { createClient } from "samva";const samva = createClient({ apiKey: process.env.SAMVA_API_KEY! });const result = await samva.email.getCatchAllConfig({ "domainId": "example"});Example Response
{ "unknownRecipientMailboxId": "string", "enabled": true, "endpointId": "string", "emailCount": 0, "lastEmailAt": "string"}