Enable inbound email for a domain

Enables inbound receiving for a verified domain and returns the recipient addresses it accepts.

POST
/v1/email/domains/{id}/enable-receiving

Enables inbound receiving for a verified domain and returns the recipient addresses it accepts. Set catchAll to accept every address on the domain. No destination is required to enable receiving. With no webhook endpoint, mail reaches matching forwarding rules and active mailboxes; unknown addresses reach unknownRecipientMailboxId when configured, otherwise they are dropped without a bounce.

Authorization

apiKey
headerx-api-key<token>

Path Parameters

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

Request Body

application/json
  1. body
domain*string
catchAll?boolean|null
endpointId?|null
addresses?array<string>|null

Response Body

Success

application/json
  1. response
success*true
Value intrue
recipients*array<string>
Example Request
import { createClient } from "samva";const samva = createClient({ apiKey: process.env.SAMVA_API_KEY! });const result = await samva.email.enableReceiving({  "id": "example",  "domain": "example"});
Example Response
{  "success": true,  "recipients": [    "string"  ]}

Related documentation