MailSlurpDomainControllerApi

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

MethodHTTP requestDescription
AddDomainWildcardCatchAllPost /domains/{id}/wildcardAdd catch all wild card inbox to domain
CreateDomainPost /domainsCreate Domain
DeleteDomainDelete /domains/{id}Delete a domain
GetDomainGet /domains/{id}Get a domain
GetDomainsGet /domainsGet domains
UpdateDomainPut /domains/{id}Update a domain

AddDomainWildcardCatchAll

DomainDto AddDomainWildcardCatchAll(ctx, 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

Required Parameters

NameTypeDescriptionNotes
ctxcontext.Contextcontext for authentication, logging, cancellation, deadlines, tracing, etc.
idstringid

Return type

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 ]

CreateDomain

DomainDto CreateDomain(ctx, domainOptions)

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.

Required Parameters

NameTypeDescriptionNotes
ctxcontext.Contextcontext for authentication, logging, cancellation, deadlines, tracing, etc.
domainOptionsCreateDomainOptionsdomainOptions

Return type

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 ]

DeleteDomain

[]string DeleteDomain(ctx, id)

Delete a domain

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

Required Parameters

NameTypeDescriptionNotes
ctxcontext.Contextcontext for authentication, logging, cancellation, deadlines, tracing, etc.
idstringid

Return type

[]string

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 ]

GetDomain

DomainDto GetDomain(ctx, id)

Get a domain

Returns domain verification status and tokens for a given domain

Required Parameters

NameTypeDescriptionNotes
ctxcontext.Contextcontext for authentication, logging, cancellation, deadlines, tracing, etc.
idstringid

Return type

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 ]

GetDomains

[]DomainPreview GetDomains(ctx, )

Get domains

List all custom domains you have created

Required Parameters

This endpoint does not need any parameter.

Return type

**[]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 ]

UpdateDomain

DomainDto UpdateDomain(ctx, id, updateDomainDto)

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.

Required Parameters

NameTypeDescriptionNotes
ctxcontext.Contextcontext for authentication, logging, cancellation, deadlines, tracing, etc.
idstringid
updateDomainDtoUpdateDomainOptionsupdateDomainDto

Return type

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 ]