Class DomainControllerApi
Represents a collection of functions to interact with the API endpoints
Inherited Members
Namespace: mailslurp.Api
Assembly: mailslurp.dll
Syntax
public class DomainControllerApi : IDomainControllerApi, IDomainControllerApiSync, IDomainControllerApiAsync, IApiAccessor
Constructors
View SourceDomainControllerApi()
Initializes a new instance of the DomainControllerApi class.
Declaration
public DomainControllerApi()
DomainControllerApi(Configuration)
Initializes a new instance of the DomainControllerApi class using Configuration object
Declaration
public DomainControllerApi(Configuration configuration)
Parameters
Type | Name | Description |
---|---|---|
Configuration | configuration | An instance of Configuration |
DomainControllerApi(ISynchronousClient, IAsynchronousClient, IReadableConfiguration)
Initializes a new instance of the DomainControllerApi class using a Configuration object and client instance.
Declaration
public DomainControllerApi(ISynchronousClient client, IAsynchronousClient asyncClient, IReadableConfiguration configuration)
Parameters
Type | Name | Description |
---|---|---|
ISynchronousClient | client | The client interface for synchronous API access. |
IAsynchronousClient | asyncClient | The client interface for asynchronous API access. |
IReadableConfiguration | configuration | The configuration object. |
DomainControllerApi(string)
Initializes a new instance of the DomainControllerApi class.
Declaration
public DomainControllerApi(string basePath)
Parameters
Type | Name | Description |
---|---|---|
string | basePath |
Properties
View SourceAsynchronousClient
The client for accessing this underlying API asynchronously.
Declaration
public IAsynchronousClient AsynchronousClient { get; set; }
Property Value
Type | Description |
---|---|
IAsynchronousClient |
Client
The client for accessing this underlying API synchronously.
Declaration
public ISynchronousClient Client { get; set; }
Property Value
Type | Description |
---|---|
ISynchronousClient |
Configuration
Gets or sets the configuration object
Declaration
public IReadableConfiguration Configuration { get; set; }
Property Value
Type | Description |
---|---|
IReadableConfiguration | An instance of the Configuration |
ExceptionFactory
Provides a factory method hook for the creation of exceptions.
Declaration
public ExceptionFactory ExceptionFactory { get; set; }
Property Value
Type | Description |
---|---|
ExceptionFactory |
Methods
View SourceAddDomainWildcardCatchAll(Guid, int)
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
Declaration
public DomainDto AddDomainWildcardCatchAll(Guid id, int operationIndex = 0)
Parameters
Type | Name | Description |
---|---|---|
System.Guid | id | |
int | operationIndex | Index associated with the operation. |
Returns
Type | Description |
---|---|
DomainDto | DomainDto |
Exceptions
Type | Condition |
---|---|
ApiException | Thrown when fails to make API call |
AddDomainWildcardCatchAllAsync(Guid, int, CancellationToken)
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
Declaration
public 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 |
Exceptions
Type | Condition |
---|---|
ApiException | Thrown when fails to make API call |
AddDomainWildcardCatchAllWithHttpInfo(Guid, int)
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
Declaration
public ApiResponse<DomainDto> AddDomainWildcardCatchAllWithHttpInfo(Guid id, int operationIndex = 0)
Parameters
Type | Name | Description |
---|---|---|
System.Guid | id | |
int | operationIndex | Index associated with the operation. |
Returns
Type | Description |
---|---|
ApiResponse<DomainDto> | ApiResponse of DomainDto |
Exceptions
Type | Condition |
---|---|
ApiException | Thrown when fails to make API call |
AddDomainWildcardCatchAllWithHttpInfoAsync(Guid, int, CancellationToken)
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
Declaration
public 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) |
Exceptions
Type | Condition |
---|---|
ApiException | Thrown when fails to make API call |
CreateDomain(CreateDomainOptions, int)
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.
Declaration
public DomainDto CreateDomain(CreateDomainOptions createDomainOptions, int operationIndex = 0)
Parameters
Type | Name | Description |
---|---|---|
CreateDomainOptions | createDomainOptions | |
int | operationIndex | Index associated with the operation. |
Returns
Type | Description |
---|---|
DomainDto | DomainDto |
Exceptions
Type | Condition |
---|---|
ApiException | Thrown when fails to make API call |
CreateDomainAsync(CreateDomainOptions, int, CancellationToken)
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.
Declaration
public 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 |
Exceptions
Type | Condition |
---|---|
ApiException | Thrown when fails to make API call |
CreateDomainWithHttpInfo(CreateDomainOptions, int)
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.
Declaration
public ApiResponse<DomainDto> CreateDomainWithHttpInfo(CreateDomainOptions createDomainOptions, int operationIndex = 0)
Parameters
Type | Name | Description |
---|---|---|
CreateDomainOptions | createDomainOptions | |
int | operationIndex | Index associated with the operation. |
Returns
Type | Description |
---|---|
ApiResponse<DomainDto> | ApiResponse of DomainDto |
Exceptions
Type | Condition |
---|---|
ApiException | Thrown when fails to make API call |
CreateDomainWithHttpInfoAsync(CreateDomainOptions, int, CancellationToken)
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.
Declaration
public 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) |
Exceptions
Type | Condition |
---|---|
ApiException | Thrown when fails to make API call |
DeleteDomain(Guid, int)
Delete a domain Delete a domain. This will disable any existing inboxes that use this domain.
Declaration
public List<string> DeleteDomain(Guid id, int operationIndex = 0)
Parameters
Type | Name | Description |
---|---|---|
System.Guid | id | |
int | operationIndex | Index associated with the operation. |
Returns
Type | Description |
---|---|
System.Collections.Generic.List<T><string> | List<string> |
Exceptions
Type | Condition |
---|---|
ApiException | Thrown when fails to make API call |
DeleteDomainAsync(Guid, int, CancellationToken)
Delete a domain Delete a domain. This will disable any existing inboxes that use this domain.
Declaration
public 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> |
Exceptions
Type | Condition |
---|---|
ApiException | Thrown when fails to make API call |
DeleteDomainWithHttpInfo(Guid, int)
Delete a domain Delete a domain. This will disable any existing inboxes that use this domain.
Declaration
public ApiResponse<List<string>> DeleteDomainWithHttpInfo(Guid id, int operationIndex = 0)
Parameters
Type | Name | Description |
---|---|---|
System.Guid | id | |
int | operationIndex | Index associated with the operation. |
Returns
Type | Description |
---|---|
ApiResponse<System.Collections.Generic.List<T><string>> | ApiResponse of List<string> |
Exceptions
Type | Condition |
---|---|
ApiException | Thrown when fails to make API call |
DeleteDomainWithHttpInfoAsync(Guid, int, CancellationToken)
Delete a domain Delete a domain. This will disable any existing inboxes that use this domain.
Declaration
public 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>) |
Exceptions
Type | Condition |
---|---|
ApiException | Thrown when fails to make API call |
GetAvailableDomains(string, int)
Get all usable domains List all domains available for use with email address creation
Declaration
public DomainGroupsDto GetAvailableDomains(string inboxType = null, int operationIndex = 0)
Parameters
Type | Name | Description |
---|---|---|
string | inboxType | (optional) |
int | operationIndex | Index associated with the operation. |
Returns
Type | Description |
---|---|
DomainGroupsDto | DomainGroupsDto |
Exceptions
Type | Condition |
---|---|
ApiException | Thrown when fails to make API call |
GetAvailableDomainsAsync(string, int, CancellationToken)
Get all usable domains List all domains available for use with email address creation
Declaration
public 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 |
Exceptions
Type | Condition |
---|---|
ApiException | Thrown when fails to make API call |
GetAvailableDomainsWithHttpInfo(string, int)
Get all usable domains List all domains available for use with email address creation
Declaration
public ApiResponse<DomainGroupsDto> GetAvailableDomainsWithHttpInfo(string inboxType = null, int operationIndex = 0)
Parameters
Type | Name | Description |
---|---|---|
string | inboxType | (optional) |
int | operationIndex | Index associated with the operation. |
Returns
Type | Description |
---|---|
ApiResponse<DomainGroupsDto> | ApiResponse of DomainGroupsDto |
Exceptions
Type | Condition |
---|---|
ApiException | Thrown when fails to make API call |
GetAvailableDomainsWithHttpInfoAsync(string, int, CancellationToken)
Get all usable domains List all domains available for use with email address creation
Declaration
public 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) |
Exceptions
Type | Condition |
---|---|
ApiException | Thrown when fails to make API call |
GetBasePath()
Gets the base path of the API client.
Declaration
public string GetBasePath()
Returns
Type | Description |
---|---|
string | The base path |
GetDomain(Guid, bool?, int)
Get a domain Returns domain verification status and tokens for a given domain
Declaration
public DomainDto GetDomain(Guid id, bool? checkForErrors = null, int operationIndex = 0)
Parameters
Type | Name | Description |
---|---|---|
System.Guid | id | |
bool? | checkForErrors | (optional) |
int | operationIndex | Index associated with the operation. |
Returns
Type | Description |
---|---|
DomainDto | DomainDto |
Exceptions
Type | Condition |
---|---|
ApiException | Thrown when fails to make API call |
GetDomainAsync(Guid, bool?, int, CancellationToken)
Get a domain Returns domain verification status and tokens for a given domain
Declaration
public 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 |
Exceptions
Type | Condition |
---|---|
ApiException | Thrown when fails to make API call |
GetDomainIssues(int)
Get domain issues List domain issues for domains you have created
Declaration
public DomainIssuesDto GetDomainIssues(int operationIndex = 0)
Parameters
Type | Name | Description |
---|---|---|
int | operationIndex | Index associated with the operation. |
Returns
Type | Description |
---|---|
DomainIssuesDto | DomainIssuesDto |
Exceptions
Type | Condition |
---|---|
ApiException | Thrown when fails to make API call |
GetDomainIssuesAsync(int, CancellationToken)
Get domain issues List domain issues for domains you have created
Declaration
public 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 |
Exceptions
Type | Condition |
---|---|
ApiException | Thrown when fails to make API call |
GetDomainIssuesWithHttpInfo(int)
Get domain issues List domain issues for domains you have created
Declaration
public ApiResponse<DomainIssuesDto> GetDomainIssuesWithHttpInfo(int operationIndex = 0)
Parameters
Type | Name | Description |
---|---|---|
int | operationIndex | Index associated with the operation. |
Returns
Type | Description |
---|---|
ApiResponse<DomainIssuesDto> | ApiResponse of DomainIssuesDto |
Exceptions
Type | Condition |
---|---|
ApiException | Thrown when fails to make API call |
GetDomainIssuesWithHttpInfoAsync(int, CancellationToken)
Get domain issues List domain issues for domains you have created
Declaration
public 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) |
Exceptions
Type | Condition |
---|---|
ApiException | Thrown when fails to make API call |
GetDomains(int)
Get domains List all custom domains you have created
Declaration
public List<DomainPreview> GetDomains(int operationIndex = 0)
Parameters
Type | Name | Description |
---|---|---|
int | operationIndex | Index associated with the operation. |
Returns
Type | Description |
---|---|
System.Collections.Generic.List<T><DomainPreview> | List<DomainPreview> |
Exceptions
Type | Condition |
---|---|
ApiException | Thrown when fails to make API call |
GetDomainsAsync(int, CancellationToken)
Get domains List all custom domains you have created
Declaration
public 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> |
Exceptions
Type | Condition |
---|---|
ApiException | Thrown when fails to make API call |
GetDomainsWithHttpInfo(int)
Get domains List all custom domains you have created
Declaration
public ApiResponse<List<DomainPreview>> GetDomainsWithHttpInfo(int operationIndex = 0)
Parameters
Type | Name | Description |
---|---|---|
int | operationIndex | Index associated with the operation. |
Returns
Type | Description |
---|---|
ApiResponse<System.Collections.Generic.List<T><DomainPreview>> | ApiResponse of List<DomainPreview> |
Exceptions
Type | Condition |
---|---|
ApiException | Thrown when fails to make API call |
GetDomainsWithHttpInfoAsync(int, CancellationToken)
Get domains List all custom domains you have created
Declaration
public 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>) |
Exceptions
Type | Condition |
---|---|
ApiException | Thrown when fails to make API call |
GetDomainWildcardCatchAllInbox(Guid, int)
Get catch all wild card inbox for domain Get the catch all inbox for a domain for missed emails
Declaration
public InboxDto GetDomainWildcardCatchAllInbox(Guid id, int operationIndex = 0)
Parameters
Type | Name | Description |
---|---|---|
System.Guid | id | |
int | operationIndex | Index associated with the operation. |
Returns
Type | Description |
---|---|
InboxDto | InboxDto |
Exceptions
Type | Condition |
---|---|
ApiException | Thrown when fails to make API call |
GetDomainWildcardCatchAllInboxAsync(Guid, int, CancellationToken)
Get catch all wild card inbox for domain Get the catch all inbox for a domain for missed emails
Declaration
public 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 |
Exceptions
Type | Condition |
---|---|
ApiException | Thrown when fails to make API call |
GetDomainWildcardCatchAllInboxWithHttpInfo(Guid, int)
Get catch all wild card inbox for domain Get the catch all inbox for a domain for missed emails
Declaration
public ApiResponse<InboxDto> GetDomainWildcardCatchAllInboxWithHttpInfo(Guid id, int operationIndex = 0)
Parameters
Type | Name | Description |
---|---|---|
System.Guid | id | |
int | operationIndex | Index associated with the operation. |
Returns
Type | Description |
---|---|
ApiResponse<InboxDto> | ApiResponse of InboxDto |
Exceptions
Type | Condition |
---|---|
ApiException | Thrown when fails to make API call |
GetDomainWildcardCatchAllInboxWithHttpInfoAsync(Guid, int, CancellationToken)
Get catch all wild card inbox for domain Get the catch all inbox for a domain for missed emails
Declaration
public 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) |
Exceptions
Type | Condition |
---|---|
ApiException | Thrown when fails to make API call |
GetDomainWithHttpInfo(Guid, bool?, int)
Get a domain Returns domain verification status and tokens for a given domain
Declaration
public ApiResponse<DomainDto> GetDomainWithHttpInfo(Guid id, bool? checkForErrors = null, int operationIndex = 0)
Parameters
Type | Name | Description |
---|---|---|
System.Guid | id | |
bool? | checkForErrors | (optional) |
int | operationIndex | Index associated with the operation. |
Returns
Type | Description |
---|---|
ApiResponse<DomainDto> | ApiResponse of DomainDto |
Exceptions
Type | Condition |
---|---|
ApiException | Thrown when fails to make API call |
GetDomainWithHttpInfoAsync(Guid, bool?, int, CancellationToken)
Get a domain Returns domain verification status and tokens for a given domain
Declaration
public 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) |
Exceptions
Type | Condition |
---|---|
ApiException | Thrown when fails to make API call |
GetMailSlurpDomains(string, int)
Get MailSlurp domains List all MailSlurp domains used with non-custom email addresses
Declaration
public DomainGroupsDto GetMailSlurpDomains(string inboxType = null, int operationIndex = 0)
Parameters
Type | Name | Description |
---|---|---|
string | inboxType | (optional) |
int | operationIndex | Index associated with the operation. |
Returns
Type | Description |
---|---|
DomainGroupsDto | DomainGroupsDto |
Exceptions
Type | Condition |
---|---|
ApiException | Thrown when fails to make API call |
GetMailSlurpDomainsAsync(string, int, CancellationToken)
Get MailSlurp domains List all MailSlurp domains used with non-custom email addresses
Declaration
public 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 |
Exceptions
Type | Condition |
---|---|
ApiException | Thrown when fails to make API call |
GetMailSlurpDomainsWithHttpInfo(string, int)
Get MailSlurp domains List all MailSlurp domains used with non-custom email addresses
Declaration
public ApiResponse<DomainGroupsDto> GetMailSlurpDomainsWithHttpInfo(string inboxType = null, int operationIndex = 0)
Parameters
Type | Name | Description |
---|---|---|
string | inboxType | (optional) |
int | operationIndex | Index associated with the operation. |
Returns
Type | Description |
---|---|
ApiResponse<DomainGroupsDto> | ApiResponse of DomainGroupsDto |
Exceptions
Type | Condition |
---|---|
ApiException | Thrown when fails to make API call |
GetMailSlurpDomainsWithHttpInfoAsync(string, int, CancellationToken)
Get MailSlurp domains List all MailSlurp domains used with non-custom email addresses
Declaration
public 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) |
Exceptions
Type | Condition |
---|---|
ApiException | Thrown when fails to make API call |
UpdateDomain(Guid, UpdateDomainOptions, int)
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.
Declaration
public DomainDto UpdateDomain(Guid id, UpdateDomainOptions updateDomainOptions, int operationIndex = 0)
Parameters
Type | Name | Description |
---|---|---|
System.Guid | id | |
UpdateDomainOptions | updateDomainOptions | |
int | operationIndex | Index associated with the operation. |
Returns
Type | Description |
---|---|
DomainDto | DomainDto |
Exceptions
Type | Condition |
---|---|
ApiException | Thrown when fails to make API call |
UpdateDomainAsync(Guid, UpdateDomainOptions, int, CancellationToken)
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.
Declaration
public 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 |
Exceptions
Type | Condition |
---|---|
ApiException | Thrown when fails to make API call |
UpdateDomainWithHttpInfo(Guid, UpdateDomainOptions, int)
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.
Declaration
public ApiResponse<DomainDto> UpdateDomainWithHttpInfo(Guid id, UpdateDomainOptions updateDomainOptions, int operationIndex = 0)
Parameters
Type | Name | Description |
---|---|---|
System.Guid | id | |
UpdateDomainOptions | updateDomainOptions | |
int | operationIndex | Index associated with the operation. |
Returns
Type | Description |
---|---|
ApiResponse<DomainDto> | ApiResponse of DomainDto |
Exceptions
Type | Condition |
---|---|
ApiException | Thrown when fails to make API call |
UpdateDomainWithHttpInfoAsync(Guid, UpdateDomainOptions, int, CancellationToken)
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.
Declaration
public 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) |
Exceptions
Type | Condition |
---|---|
ApiException | Thrown when fails to make API call |