DomainControllerApi

All URIs are relative to https://api.mailslurp.com

MethodHTTP requestDescription
add_domain_wildcard_catch_allpost /domains/{id}/wildcardAdd catch all wild card inbox to domain
create_domainpost /domainsCreate Domain
delete_domaindelete /domains/{id}Delete a domain
get_domainget /domains/{id}Get a domain
get_domainsget /domainsGet domains
update_domainput /domains/{id}Update a domain

add_domain_wildcard_catch_all

crate::models::DomainDto add_domain_wildcard_catch_all(id) Add catch all wild card inbox to domain

Add a catch all inbox to a domain so that any emails sent to it that cannot be matched will be sent to the catch all inbox generated

Parameters

NameTypeDescriptionRequiredNotes
idStringid[required]

Return type

crate::models::DomainDto

Authorization

API_KEY

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to ]

create_domain

crate::models::DomainDto create_domain(domain_options) Create Domain

Link a domain that you own with MailSlurp so you can create email addresses using it. Endpoint returns DNS records used for validation. You must add these verification records to your host provider’s DNS setup to verify the domain.

Parameters

NameTypeDescriptionRequiredNotes
domain_optionsCreateDomainOptionsdomainOptions[required]

Return type

crate::models::DomainDto

Authorization

API_KEY

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to ]

delete_domain

Vec delete_domain(id) Delete a domain

Delete a domain. This will disable any existing inboxes that use this domain.

Parameters

NameTypeDescriptionRequiredNotes
idStringid[required]

Return type

Vec

Authorization

API_KEY

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to ]

get_domain

crate::models::DomainDto get_domain(id) Get a domain

Returns domain verification status and tokens for a given domain

Parameters

NameTypeDescriptionRequiredNotes
idStringid[required]

Return type

crate::models::DomainDto

Authorization

API_KEY

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to ]

get_domains

Veccrate::models::DomainPreview get_domains() Get domains

List all custom domains you have created

Parameters

This endpoint does not need any parameter.

Return type

Veccrate::models::DomainPreview

Authorization

API_KEY

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to ]

update_domain

crate::models::DomainDto update_domain(id, update_domain_dto) Update a domain

Update values on a domain. Note you cannot change the domain name as it is immutable. Recreate the domain if you need to alter this.

Parameters

NameTypeDescriptionRequiredNotes
idStringid[required]
update_domain_dtoUpdateDomainOptionsupdateDomainDto[required]

Return type

crate::models::DomainDto

Authorization

API_KEY

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to ]