Resend.Domains (resend v0.4.0)
Manage domains in Resend.
Link to this section Summary
Functions
Creates a new domain.
Gets a domain given an ID.
Lists all domains.
Removes a domain. Caution: This can't be undone!
Begins the verification process for a domain.
Link to this section Functions
Link to this function
create(client \\ Resend.client(), opts)
@spec create(Resend.Client.t(), Keyword.t()) :: Resend.Client.response(Resend.Domains.Domain.t())
Creates a new domain.
Parameter options:
:name
- The domain name (required):region
- Region to deliver emails from, on of:["us-east-1", "eu-west-1", "sa-east-1"]
Link to this function
get(client \\ Resend.client(), domain_id)
@spec get(Resend.Client.t(), String.t()) :: Resend.Client.response(Resend.Domains.Domain.t())
Gets a domain given an ID.
Link to this function
list(client \\ Resend.client())
@spec list(Resend.Client.t()) :: Resend.Client.response(Resend.List.t(Resend.Domains.Domain.t()))
Lists all domains.
Link to this function
remove(client \\ Resend.client(), domain_id)
@spec remove(Resend.Client.t(), String.t()) :: Resend.Client.response(Resend.Domains.Domain.t())
Removes a domain. Caution: This can't be undone!
Link to this function
verify(client \\ Resend.client(), domain_id)
@spec verify(Resend.Client.t(), String.t()) :: Resend.Client.response(Resend.Domains.Domain.t())
Begins the verification process for a domain.