Interface IDomainControllerApiSync

Represents a collection of functions to interact with the API endpoints

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

Methods

View Source

AddDomainWildcardCatchAll(Guid, int)

Add catch all wild card inbox to domain

Declaration
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
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

AddDomainWildcardCatchAllWithHttpInfo(Guid, int)

Add catch all wild card inbox to domain

Declaration
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
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

CreateDomain(CreateDomainOptions, int)

Create Domain

Declaration
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
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

CreateDomainWithHttpInfo(CreateDomainOptions, int)

Create Domain

Declaration
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
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

DeleteDomain(Guid, int)

Delete a domain

Declaration
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>
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

DeleteDomainWithHttpInfo(Guid, int)

Delete a domain

Declaration
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>
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

GetAvailableDomains(string, int)

Get all usable domains

Declaration
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
Remarks

List all domains available for use with email address creation

Exceptions
Type Condition
ApiException

Thrown when fails to make API call
View Source

GetAvailableDomainsWithHttpInfo(string, int)

Get all usable domains

Declaration
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
Remarks

List all domains available for use with email address creation

Exceptions
Type Condition
ApiException

Thrown when fails to make API call
View Source

GetDomain(Guid, bool?, int)

Get a domain

Declaration
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
Remarks

Returns domain verification status and tokens for a given domain

Exceptions
Type Condition
ApiException

Thrown when fails to make API call
View Source

GetDomainIssues(int)

Get domain issues

Declaration
DomainIssuesDto GetDomainIssues(int operationIndex = 0)
Parameters
Type Name Description
int operationIndex

Index associated with the operation.
Returns
Type Description
DomainIssuesDto

DomainIssuesDto
Remarks

List domain issues for domains you have created

Exceptions
Type Condition
ApiException

Thrown when fails to make API call
View Source

GetDomainIssuesWithHttpInfo(int)

Get domain issues

Declaration
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
Remarks

List domain issues for domains you have created

Exceptions
Type Condition
ApiException

Thrown when fails to make API call
View Source

GetDomains(int)

Get domains

Declaration
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>
Remarks

List all custom domains you have created

Exceptions
Type Condition
ApiException

Thrown when fails to make API call
View Source

GetDomainsWithHttpInfo(int)

Get domains

Declaration
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>
Remarks

List all custom domains you have created

Exceptions
Type Condition
ApiException

Thrown when fails to make API call
View Source

GetDomainWildcardCatchAllInbox(Guid, int)

Get catch all wild card inbox for domain

Declaration
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
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

GetDomainWildcardCatchAllInboxWithHttpInfo(Guid, int)

Get catch all wild card inbox for domain

Declaration
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
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

GetDomainWithHttpInfo(Guid, bool?, int)

Get a domain

Declaration
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
Remarks

Returns domain verification status and tokens for a given domain

Exceptions
Type Condition
ApiException

Thrown when fails to make API call
View Source

GetMailSlurpDomains(string, int)

Get MailSlurp domains

Declaration
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
Remarks

List all MailSlurp domains used with non-custom email addresses

Exceptions
Type Condition
ApiException

Thrown when fails to make API call
View Source

GetMailSlurpDomainsWithHttpInfo(string, int)

Get MailSlurp domains

Declaration
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
Remarks

List all MailSlurp domains used with non-custom email addresses

Exceptions
Type Condition
ApiException

Thrown when fails to make API call
View Source

UpdateDomain(Guid, UpdateDomainOptions, int)

Update a domain

Declaration
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
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

UpdateDomainWithHttpInfo(Guid, UpdateDomainOptions, int)

Update a domain

Declaration
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
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