MailSlurpDomainControllerApiAll URIs are relative to https://api.mailslurp.comMethodHTTP requestDescriptionAddDomainWildcardCatchAllPost /domains/{id}/wildcardAdd catch all wild card inbox to domainCreateDomainPost /domainsCreate DomainDeleteDomainDelete /domains/{id}Delete a domainGetDomainGet /domains/{id}Get a domainGetDomainsGet /domainsGet domainsUpdateDomainPut /domains/{id}Update a domainAddDomainWildcardCatchAllDomainDto AddDomainWildcardCatchAll(ctx, id)Add catch all wild card inbox to domainAdd 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 generatedRequired ParametersNameTypeDescriptionNotesctxcontext.Contextcontext for authentication, logging, cancellation, deadlines, tracing, etc.idstringidReturn typeDomainDtoAuthorizationAPI_KEYHTTP request headersContent-Type: Not definedAccept: application/json[Back to top] [Back to API list] [Back to Model list] [Back to ]CreateDomainDomainDto CreateDomain(ctx, domainOptions)Create DomainLink 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 ParametersNameTypeDescriptionNotesctxcontext.Contextcontext for authentication, logging, cancellation, deadlines, tracing, etc.domainOptionsCreateDomainOptionsdomainOptionsReturn typeDomainDtoAuthorizationAPI_KEYHTTP request headersContent-Type: application/jsonAccept: application/json[Back to top] [Back to API list] [Back to Model list] [Back to ]DeleteDomain[]string DeleteDomain(ctx, id)Delete a domainDelete a domain. This will disable any existing inboxes that use this domain.Required ParametersNameTypeDescriptionNotesctxcontext.Contextcontext for authentication, logging, cancellation, deadlines, tracing, etc.idstringidReturn type[]stringAuthorizationAPI_KEYHTTP request headersContent-Type: Not definedAccept: application/json[Back to top] [Back to API list] [Back to Model list] [Back to ]GetDomainDomainDto GetDomain(ctx, id)Get a domainReturns domain verification status and tokens for a given domainRequired ParametersNameTypeDescriptionNotesctxcontext.Contextcontext for authentication, logging, cancellation, deadlines, tracing, etc.idstringidReturn typeDomainDtoAuthorizationAPI_KEYHTTP request headersContent-Type: Not definedAccept: application/json[Back to top] [Back to API list] [Back to Model list] [Back to ]GetDomains[]DomainPreview GetDomains(ctx, )Get domainsList all custom domains you have createdRequired ParametersThis endpoint does not need any parameter.Return type**[]DomainPreview**AuthorizationAPI_KEYHTTP request headersContent-Type: Not definedAccept: application/json[Back to top] [Back to API list] [Back to Model list] [Back to ]UpdateDomainDomainDto UpdateDomain(ctx, id, updateDomainDto)Update a domainUpdate 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 ParametersNameTypeDescriptionNotesctxcontext.Contextcontext for authentication, logging, cancellation, deadlines, tracing, etc.idstringidupdateDomainDtoUpdateDomainOptionsupdateDomainDtoReturn typeDomainDtoAuthorizationAPI_KEYHTTP request headersContent-Type: application/jsonAccept: application/json[Back to top] [Back to API list] [Back to Model list] [Back to ]
MailSlurp