Interface IDomainControllerApiAsync

Represents a collection of functions to interact with the API endpoints

Inherited Members
Namespace: mailslurp.Api
Assembly: mailslurp.dll
Syntax
public interface IDomainControllerApiAsync : IApiAccessor

Methods

View Source

AddDomainWildcardCatchAllAsync(Guid, int, CancellationToken)

Add catch all wild card inbox to domain

Declaration
Task<DomainDto> AddDomainWildcardCatchAllAsync(Guid id, int operationIndex = 0, CancellationToken cancellationToken = default)
Parameters
Type Name Description
System.Guid id
int operationIndex

Index associated with the operation.
CancellationToken cancellationToken

Cancellation Token to cancel the request.
Returns
Type Description
Task<DomainDto>

Task of DomainDto
Remarks

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

Exceptions
Type Condition
ApiException

Thrown when fails to make API call
View Source

AddDomainWildcardCatchAllWithHttpInfoAsync(Guid, int, CancellationToken)

Add catch all wild card inbox to domain

Declaration
Task<ApiResponse<DomainDto>> AddDomainWildcardCatchAllWithHttpInfoAsync(Guid id, int operationIndex = 0, CancellationToken cancellationToken = default)
Parameters
Type Name Description
System.Guid id
int operationIndex

Index associated with the operation.
CancellationToken cancellationToken

Cancellation Token to cancel the request.
Returns
Type Description
Task<ApiResponse<DomainDto>>

Task of ApiResponse (DomainDto)
Remarks

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

Exceptions
Type Condition
ApiException

Thrown when fails to make API call
View Source

CreateDomainAsync(CreateDomainOptions, int, CancellationToken)

Create Domain

Declaration
Task<DomainDto> CreateDomainAsync(CreateDomainOptions createDomainOptions, int operationIndex = 0, CancellationToken cancellationToken = default)
Parameters
Type Name Description
CreateDomainOptions createDomainOptions
int operationIndex

Index associated with the operation.
CancellationToken cancellationToken

Cancellation Token to cancel the request.
Returns
Type Description
Task<DomainDto>

Task of DomainDto
Remarks

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.

Exceptions
Type Condition
ApiException

Thrown when fails to make API call
View Source

CreateDomainWithHttpInfoAsync(CreateDomainOptions, int, CancellationToken)

Create Domain

Declaration
Task<ApiResponse<DomainDto>> CreateDomainWithHttpInfoAsync(CreateDomainOptions createDomainOptions, int operationIndex = 0, CancellationToken cancellationToken = default)
Parameters
Type Name Description
CreateDomainOptions createDomainOptions
int operationIndex

Index associated with the operation.
CancellationToken cancellationToken

Cancellation Token to cancel the request.
Returns
Type Description
Task<ApiResponse<DomainDto>>

Task of ApiResponse (DomainDto)
Remarks

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.

Exceptions
Type Condition
ApiException

Thrown when fails to make API call
View Source

DeleteDomainAsync(Guid, int, CancellationToken)

Delete a domain

Declaration
Task<List<string>> DeleteDomainAsync(Guid id, int operationIndex = 0, CancellationToken cancellationToken = default)
Parameters
Type Name Description
System.Guid id
int operationIndex

Index associated with the operation.
CancellationToken cancellationToken

Cancellation Token to cancel the request.
Returns
Type Description
Task<System.Collections.Generic.List<T><string>>

Task of List<string>
Remarks

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

Exceptions
Type Condition
ApiException

Thrown when fails to make API call
View Source

DeleteDomainWithHttpInfoAsync(Guid, int, CancellationToken)

Delete a domain

Declaration
Task<ApiResponse<List<string>>> DeleteDomainWithHttpInfoAsync(Guid id, int operationIndex = 0, CancellationToken cancellationToken = default)
Parameters
Type Name Description
System.Guid id
int operationIndex

Index associated with the operation.
CancellationToken cancellationToken

Cancellation Token to cancel the request.
Returns
Type Description
Task<ApiResponse<System.Collections.Generic.List<T><string>>>

Task of ApiResponse (List<string>)
Remarks

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

Exceptions
Type Condition
ApiException

Thrown when fails to make API call
View Source

GetAvailableDomainsAsync(string, int, CancellationToken)

Get all usable domains

Declaration
Task<DomainGroupsDto> GetAvailableDomainsAsync(string inboxType = null, int operationIndex = 0, CancellationToken cancellationToken = default)
Parameters
Type Name Description
string inboxType

(optional)
int operationIndex

Index associated with the operation.
CancellationToken cancellationToken

Cancellation Token to cancel the request.
Returns
Type Description
Task<DomainGroupsDto>

Task of DomainGroupsDto
Remarks

List all domains available for use with email address creation

Exceptions
Type Condition
ApiException

Thrown when fails to make API call
View Source

GetAvailableDomainsWithHttpInfoAsync(string, int, CancellationToken)

Get all usable domains

Declaration
Task<ApiResponse<DomainGroupsDto>> GetAvailableDomainsWithHttpInfoAsync(string inboxType = null, int operationIndex = 0, CancellationToken cancellationToken = default)
Parameters
Type Name Description
string inboxType

(optional)
int operationIndex

Index associated with the operation.
CancellationToken cancellationToken

Cancellation Token to cancel the request.
Returns
Type Description
Task<ApiResponse<DomainGroupsDto>>

Task of ApiResponse (DomainGroupsDto)
Remarks

List all domains available for use with email address creation

Exceptions
Type Condition
ApiException

Thrown when fails to make API call
View Source

GetDomainAsync(Guid, bool?, int, CancellationToken)

Get a domain

Declaration
Task<DomainDto> GetDomainAsync(Guid id, bool? checkForErrors = null, int operationIndex = 0, CancellationToken cancellationToken = default)
Parameters
Type Name Description
System.Guid id
bool? checkForErrors

(optional)
int operationIndex

Index associated with the operation.
CancellationToken cancellationToken

Cancellation Token to cancel the request.
Returns
Type Description
Task<DomainDto>

Task of DomainDto
Remarks

Returns domain verification status and tokens for a given domain

Exceptions
Type Condition
ApiException

Thrown when fails to make API call
View Source

GetDomainIssuesAsync(int, CancellationToken)

Get domain issues

Declaration
Task<DomainIssuesDto> GetDomainIssuesAsync(int operationIndex = 0, CancellationToken cancellationToken = default)
Parameters
Type Name Description
int operationIndex

Index associated with the operation.
CancellationToken cancellationToken

Cancellation Token to cancel the request.
Returns
Type Description
Task<DomainIssuesDto>

Task of DomainIssuesDto
Remarks

List domain issues for domains you have created

Exceptions
Type Condition
ApiException

Thrown when fails to make API call
View Source

GetDomainIssuesWithHttpInfoAsync(int, CancellationToken)

Get domain issues

Declaration
Task<ApiResponse<DomainIssuesDto>> GetDomainIssuesWithHttpInfoAsync(int operationIndex = 0, CancellationToken cancellationToken = default)
Parameters
Type Name Description
int operationIndex

Index associated with the operation.
CancellationToken cancellationToken

Cancellation Token to cancel the request.
Returns
Type Description
Task<ApiResponse<DomainIssuesDto>>

Task of ApiResponse (DomainIssuesDto)
Remarks

List domain issues for domains you have created

Exceptions
Type Condition
ApiException

Thrown when fails to make API call
View Source

GetDomainsAsync(int, CancellationToken)

Get domains

Declaration
Task<List<DomainPreview>> GetDomainsAsync(int operationIndex = 0, CancellationToken cancellationToken = default)
Parameters
Type Name Description
int operationIndex

Index associated with the operation.
CancellationToken cancellationToken

Cancellation Token to cancel the request.
Returns
Type Description
Task<System.Collections.Generic.List<T><DomainPreview>>

Task of List<DomainPreview>
Remarks

List all custom domains you have created

Exceptions
Type Condition
ApiException

Thrown when fails to make API call
View Source

GetDomainsWithHttpInfoAsync(int, CancellationToken)

Get domains

Declaration
Task<ApiResponse<List<DomainPreview>>> GetDomainsWithHttpInfoAsync(int operationIndex = 0, CancellationToken cancellationToken = default)
Parameters
Type Name Description
int operationIndex

Index associated with the operation.
CancellationToken cancellationToken

Cancellation Token to cancel the request.
Returns
Type Description
Task<ApiResponse<System.Collections.Generic.List<T><DomainPreview>>>

Task of ApiResponse (List<DomainPreview>)
Remarks

List all custom domains you have created

Exceptions
Type Condition
ApiException

Thrown when fails to make API call
View Source

GetDomainWildcardCatchAllInboxAsync(Guid, int, CancellationToken)

Get catch all wild card inbox for domain

Declaration
Task<InboxDto> GetDomainWildcardCatchAllInboxAsync(Guid id, int operationIndex = 0, CancellationToken cancellationToken = default)
Parameters
Type Name Description
System.Guid id
int operationIndex

Index associated with the operation.
CancellationToken cancellationToken

Cancellation Token to cancel the request.
Returns
Type Description
Task<InboxDto>

Task of InboxDto
Remarks

Get the catch all inbox for a domain for missed emails

Exceptions
Type Condition
ApiException

Thrown when fails to make API call
View Source

GetDomainWildcardCatchAllInboxWithHttpInfoAsync(Guid, int, CancellationToken)

Get catch all wild card inbox for domain

Declaration
Task<ApiResponse<InboxDto>> GetDomainWildcardCatchAllInboxWithHttpInfoAsync(Guid id, int operationIndex = 0, CancellationToken cancellationToken = default)
Parameters
Type Name Description
System.Guid id
int operationIndex

Index associated with the operation.
CancellationToken cancellationToken

Cancellation Token to cancel the request.
Returns
Type Description
Task<ApiResponse<InboxDto>>

Task of ApiResponse (InboxDto)
Remarks

Get the catch all inbox for a domain for missed emails

Exceptions
Type Condition
ApiException

Thrown when fails to make API call
View Source

GetDomainWithHttpInfoAsync(Guid, bool?, int, CancellationToken)

Get a domain

Declaration
Task<ApiResponse<DomainDto>> GetDomainWithHttpInfoAsync(Guid id, bool? checkForErrors = null, int operationIndex = 0, CancellationToken cancellationToken = default)
Parameters
Type Name Description
System.Guid id
bool? checkForErrors

(optional)
int operationIndex

Index associated with the operation.
CancellationToken cancellationToken

Cancellation Token to cancel the request.
Returns
Type Description
Task<ApiResponse<DomainDto>>

Task of ApiResponse (DomainDto)
Remarks

Returns domain verification status and tokens for a given domain

Exceptions
Type Condition
ApiException

Thrown when fails to make API call
View Source

GetMailSlurpDomainsAsync(string, int, CancellationToken)

Get MailSlurp domains

Declaration
Task<DomainGroupsDto> GetMailSlurpDomainsAsync(string inboxType = null, int operationIndex = 0, CancellationToken cancellationToken = default)
Parameters
Type Name Description
string inboxType

(optional)
int operationIndex

Index associated with the operation.
CancellationToken cancellationToken

Cancellation Token to cancel the request.
Returns
Type Description
Task<DomainGroupsDto>

Task of DomainGroupsDto
Remarks

List all MailSlurp domains used with non-custom email addresses

Exceptions
Type Condition
ApiException

Thrown when fails to make API call
View Source

GetMailSlurpDomainsWithHttpInfoAsync(string, int, CancellationToken)

Get MailSlurp domains

Declaration
Task<ApiResponse<DomainGroupsDto>> GetMailSlurpDomainsWithHttpInfoAsync(string inboxType = null, int operationIndex = 0, CancellationToken cancellationToken = default)
Parameters
Type Name Description
string inboxType

(optional)
int operationIndex

Index associated with the operation.
CancellationToken cancellationToken

Cancellation Token to cancel the request.
Returns
Type Description
Task<ApiResponse<DomainGroupsDto>>

Task of ApiResponse (DomainGroupsDto)
Remarks

List all MailSlurp domains used with non-custom email addresses

Exceptions
Type Condition
ApiException

Thrown when fails to make API call
View Source

UpdateDomainAsync(Guid, UpdateDomainOptions, int, CancellationToken)

Update a domain

Declaration
Task<DomainDto> UpdateDomainAsync(Guid id, UpdateDomainOptions updateDomainOptions, int operationIndex = 0, CancellationToken cancellationToken = default)
Parameters
Type Name Description
System.Guid id
UpdateDomainOptions updateDomainOptions
int operationIndex

Index associated with the operation.
CancellationToken cancellationToken

Cancellation Token to cancel the request.
Returns
Type Description
Task<DomainDto>

Task of DomainDto
Remarks

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.

Exceptions
Type Condition
ApiException

Thrown when fails to make API call
View Source

UpdateDomainWithHttpInfoAsync(Guid, UpdateDomainOptions, int, CancellationToken)

Update a domain

Declaration
Task<ApiResponse<DomainDto>> UpdateDomainWithHttpInfoAsync(Guid id, UpdateDomainOptions updateDomainOptions, int operationIndex = 0, CancellationToken cancellationToken = default)
Parameters
Type Name Description
System.Guid id
UpdateDomainOptions updateDomainOptions
int operationIndex

Index associated with the operation.
CancellationToken cancellationToken

Cancellation Token to cancel the request.
Returns
Type Description
Task<ApiResponse<DomainDto>>

Task of ApiResponse (DomainDto)
Remarks

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.

Exceptions
Type Condition
ApiException

Thrown when fails to make API call