# MailSlurp\DomainControllerApi
All URIs are relative to https://api.mailslurp.com
| Method | HTTP request | Description |
|---|---|---|
| AddDomainWildcardCatchAll | Post /domains/{id}/wildcard | Add catch all wild card inbox to domain |
| CreateDomain | Post /domains | Create Domain |
| DeleteDomain | Delete /domains/{id} | Delete a domain |
| GetDomain | Get /domains/{id} | Get a domain |
| GetDomains | Get /domains | Get domains |
| UpdateDomain | Put /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
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| id | string | id |
# Return type
# Authorization
# HTTP request headers
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
# 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
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| domainOptions | CreateDomainOptions | domainOptions |
# Return type
# Authorization
# HTTP request headers
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
# DeleteDomain
[]string DeleteDomain(ctx, id)
Delete a domain
Delete a domain. This will disable any existing inboxes that use this domain.
# Required Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| id | string | id |
# Return type
[]string
# Authorization
# HTTP request headers
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
# GetDomain
DomainDto GetDomain(ctx, id)
Get a domain
Returns domain verification status and tokens for a given domain
# Required Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| id | string | id |
# Return type
# Authorization
# HTTP request headers
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
# GetDomains
[]DomainPreview GetDomains(ctx, )
Get domains
List all custom domains you have created
# Required Parameters
This endpoint does not need any parameter.
# Return type
# Authorization
# HTTP request headers
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
# 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
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| id | string | id | |
| updateDomainDto | UpdateDomainOptions | updateDomainDto |
# Return type
# Authorization
# HTTP request headers
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
