public class CommonActionsControllerApi : ICommonActionsControllerApi, ICommonActionsControllerApiSync, ICommonActionsControllerApiAsync, IApiAccessor

Constructors

View Source

CommonActionsControllerApi()

Initializes a new instance of the CommonActionsControllerApi class.

Declaration

public CommonActionsControllerApi()

View Source

CommonActionsControllerApi(string)

Initializes a new instance of the CommonActionsControllerApi class.

Declaration

public CommonActionsControllerApi(string basePath)

Parameters

Type	Name	Description
string	basePath

View Source

CommonActionsControllerApi(Configuration)

Initializes a new instance of the CommonActionsControllerApi class using Configuration object

Declaration

public CommonActionsControllerApi(Configuration configuration)

Parameters

Type	Name	Description
Configuration	configuration	An instance of Configuration

View Source

CommonActionsControllerApi(ISynchronousClient, IAsynchronousClient, IReadableConfiguration)

Initializes a new instance of the CommonActionsControllerApi class using a Configuration object and client instance.

Declaration

public CommonActionsControllerApi(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.

Properties

View Source

AsynchronousClient

The client for accessing this underlying API asynchronously.

Declaration

public IAsynchronousClient AsynchronousClient { get; set; }

Property Value

Type	Description
IAsynchronousClient

View Source

Client

The client for accessing this underlying API synchronously.

Declaration

public ISynchronousClient Client { get; set; }

Property Value

Type	Description
ISynchronousClient

View Source

Configuration

Gets or sets the configuration object

Declaration

public IReadableConfiguration Configuration { get; set; }

Property Value

Type	Description
IReadableConfiguration	An instance of the Configuration

View Source

ExceptionFactory

Provides a factory method hook for the creation of exceptions.

Declaration

public ExceptionFactory ExceptionFactory { get; set; }

Property Value

Type	Description
ExceptionFactory

Methods

View Source

CreateNewEmailAddress(bool?, bool?, DateTime?, long?, string, string, string, string, List<string>, bool?, bool?, bool?, string, Guid?, string, int)

Create new random inbox Returns an Inbox with an id and an emailAddress

Declaration

public InboxDto CreateNewEmailAddress(bool? allowTeamAccess = null, bool? useDomainPool = null, DateTime? expiresAt = null, long? expiresIn = null, string emailAddress = null, string inboxType = null, string description = null, string name = null, List<string> tags = null, bool? favourite = null, bool? virtualInbox = null, bool? useShortAddress = null, string domainName = null, Guid? domainId = null, string prefix = null, int operationIndex = 0)

Parameters

Type	Name	Description
bool?	allowTeamAccess	(optional)
bool?	useDomainPool	(optional)
DateTime?	expiresAt	(optional)
long?	expiresIn	(optional)
string	emailAddress	(optional)
string	inboxType	(optional)
string	description	(optional)
string	name	(optional)
List<string>	tags	(optional)
bool?	favourite	(optional)
bool?	virtualInbox	(optional)
bool?	useShortAddress	(optional)
string	domainName	(optional)
Guid?	domainId	(optional)
string	prefix	(optional)
int	operationIndex	Index associated with the operation.

Returns

Type	Description
InboxDto	InboxDto

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

CreateNewEmailAddressAsync(bool?, bool?, DateTime?, long?, string, string, string, string, List<string>, bool?, bool?, bool?, string, Guid?, string, int, CancellationToken)

Create new random inbox Returns an Inbox with an id and an emailAddress

Declaration

public Task<InboxDto> CreateNewEmailAddressAsync(bool? allowTeamAccess = null, bool? useDomainPool = null, DateTime? expiresAt = null, long? expiresIn = null, string emailAddress = null, string inboxType = null, string description = null, string name = null, List<string> tags = null, bool? favourite = null, bool? virtualInbox = null, bool? useShortAddress = null, string domainName = null, Guid? domainId = null, string prefix = null, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
bool?	allowTeamAccess	(optional)
bool?	useDomainPool	(optional)
DateTime?	expiresAt	(optional)
long?	expiresIn	(optional)
string	emailAddress	(optional)
string	inboxType	(optional)
string	description	(optional)
string	name	(optional)
List<string>	tags	(optional)
bool?	favourite	(optional)
bool?	virtualInbox	(optional)
bool?	useShortAddress	(optional)
string	domainName	(optional)
Guid?	domainId	(optional)
string	prefix	(optional)
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

View Source

CreateNewEmailAddressWithHttpInfo(bool?, bool?, DateTime?, long?, string, string, string, string, List<string>, bool?, bool?, bool?, string, Guid?, string, int)

Create new random inbox Returns an Inbox with an id and an emailAddress

Declaration

public ApiResponse<InboxDto> CreateNewEmailAddressWithHttpInfo(bool? allowTeamAccess = null, bool? useDomainPool = null, DateTime? expiresAt = null, long? expiresIn = null, string emailAddress = null, string inboxType = null, string description = null, string name = null, List<string> tags = null, bool? favourite = null, bool? virtualInbox = null, bool? useShortAddress = null, string domainName = null, Guid? domainId = null, string prefix = null, int operationIndex = 0)

Parameters

Type	Name	Description
bool?	allowTeamAccess	(optional)
bool?	useDomainPool	(optional)
DateTime?	expiresAt	(optional)
long?	expiresIn	(optional)
string	emailAddress	(optional)
string	inboxType	(optional)
string	description	(optional)
string	name	(optional)
List<string>	tags	(optional)
bool?	favourite	(optional)
bool?	virtualInbox	(optional)
bool?	useShortAddress	(optional)
string	domainName	(optional)
Guid?	domainId	(optional)
string	prefix	(optional)
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

View Source

CreateNewEmailAddressWithHttpInfoAsync(bool?, bool?, DateTime?, long?, string, string, string, string, List<string>, bool?, bool?, bool?, string, Guid?, string, int, CancellationToken)

Create new random inbox Returns an Inbox with an id and an emailAddress

Declaration

public Task<ApiResponse<InboxDto>> CreateNewEmailAddressWithHttpInfoAsync(bool? allowTeamAccess = null, bool? useDomainPool = null, DateTime? expiresAt = null, long? expiresIn = null, string emailAddress = null, string inboxType = null, string description = null, string name = null, List<string> tags = null, bool? favourite = null, bool? virtualInbox = null, bool? useShortAddress = null, string domainName = null, Guid? domainId = null, string prefix = null, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
bool?	allowTeamAccess	(optional)
bool?	useDomainPool	(optional)
DateTime?	expiresAt	(optional)
long?	expiresIn	(optional)
string	emailAddress	(optional)
string	inboxType	(optional)
string	description	(optional)
string	name	(optional)
List<string>	tags	(optional)
bool?	favourite	(optional)
bool?	virtualInbox	(optional)
bool?	useShortAddress	(optional)
string	domainName	(optional)
Guid?	domainId	(optional)
string	prefix	(optional)
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

View Source

CreateRandomInbox(bool?, bool?, DateTime?, long?, string, string, string, string, List<string>, bool?, bool?, bool?, string, Guid?, string, int)

Create new random inbox Returns an Inbox with an id and an emailAddress

Declaration

public InboxDto CreateRandomInbox(bool? allowTeamAccess = null, bool? useDomainPool = null, DateTime? expiresAt = null, long? expiresIn = null, string emailAddress = null, string inboxType = null, string description = null, string name = null, List<string> tags = null, bool? favourite = null, bool? virtualInbox = null, bool? useShortAddress = null, string domainName = null, Guid? domainId = null, string prefix = null, int operationIndex = 0)

Parameters

Type	Name	Description
bool?	allowTeamAccess	(optional)
bool?	useDomainPool	(optional)
DateTime?	expiresAt	(optional)
long?	expiresIn	(optional)
string	emailAddress	(optional)
string	inboxType	(optional)
string	description	(optional)
string	name	(optional)
List<string>	tags	(optional)
bool?	favourite	(optional)
bool?	virtualInbox	(optional)
bool?	useShortAddress	(optional)
string	domainName	(optional)
Guid?	domainId	(optional)
string	prefix	(optional)
int	operationIndex	Index associated with the operation.

Returns

Type	Description
InboxDto	InboxDto

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

CreateRandomInboxAsync(bool?, bool?, DateTime?, long?, string, string, string, string, List<string>, bool?, bool?, bool?, string, Guid?, string, int, CancellationToken)

Create new random inbox Returns an Inbox with an id and an emailAddress

Declaration

public Task<InboxDto> CreateRandomInboxAsync(bool? allowTeamAccess = null, bool? useDomainPool = null, DateTime? expiresAt = null, long? expiresIn = null, string emailAddress = null, string inboxType = null, string description = null, string name = null, List<string> tags = null, bool? favourite = null, bool? virtualInbox = null, bool? useShortAddress = null, string domainName = null, Guid? domainId = null, string prefix = null, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
bool?	allowTeamAccess	(optional)
bool?	useDomainPool	(optional)
DateTime?	expiresAt	(optional)
long?	expiresIn	(optional)
string	emailAddress	(optional)
string	inboxType	(optional)
string	description	(optional)
string	name	(optional)
List<string>	tags	(optional)
bool?	favourite	(optional)
bool?	virtualInbox	(optional)
bool?	useShortAddress	(optional)
string	domainName	(optional)
Guid?	domainId	(optional)
string	prefix	(optional)
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

View Source

CreateRandomInboxWithHttpInfo(bool?, bool?, DateTime?, long?, string, string, string, string, List<string>, bool?, bool?, bool?, string, Guid?, string, int)

Create new random inbox Returns an Inbox with an id and an emailAddress

Declaration

public ApiResponse<InboxDto> CreateRandomInboxWithHttpInfo(bool? allowTeamAccess = null, bool? useDomainPool = null, DateTime? expiresAt = null, long? expiresIn = null, string emailAddress = null, string inboxType = null, string description = null, string name = null, List<string> tags = null, bool? favourite = null, bool? virtualInbox = null, bool? useShortAddress = null, string domainName = null, Guid? domainId = null, string prefix = null, int operationIndex = 0)

Parameters

Type	Name	Description
bool?	allowTeamAccess	(optional)
bool?	useDomainPool	(optional)
DateTime?	expiresAt	(optional)
long?	expiresIn	(optional)
string	emailAddress	(optional)
string	inboxType	(optional)
string	description	(optional)
string	name	(optional)
List<string>	tags	(optional)
bool?	favourite	(optional)
bool?	virtualInbox	(optional)
bool?	useShortAddress	(optional)
string	domainName	(optional)
Guid?	domainId	(optional)
string	prefix	(optional)
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

View Source

CreateRandomInboxWithHttpInfoAsync(bool?, bool?, DateTime?, long?, string, string, string, string, List<string>, bool?, bool?, bool?, string, Guid?, string, int, CancellationToken)

Create new random inbox Returns an Inbox with an id and an emailAddress

Declaration

public Task<ApiResponse<InboxDto>> CreateRandomInboxWithHttpInfoAsync(bool? allowTeamAccess = null, bool? useDomainPool = null, DateTime? expiresAt = null, long? expiresIn = null, string emailAddress = null, string inboxType = null, string description = null, string name = null, List<string> tags = null, bool? favourite = null, bool? virtualInbox = null, bool? useShortAddress = null, string domainName = null, Guid? domainId = null, string prefix = null, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
bool?	allowTeamAccess	(optional)
bool?	useDomainPool	(optional)
DateTime?	expiresAt	(optional)
long?	expiresIn	(optional)
string	emailAddress	(optional)
string	inboxType	(optional)
string	description	(optional)
string	name	(optional)
List<string>	tags	(optional)
bool?	favourite	(optional)
bool?	virtualInbox	(optional)
bool?	useShortAddress	(optional)
string	domainName	(optional)
Guid?	domainId	(optional)
string	prefix	(optional)
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

View Source

DeleteEmailAddress(Guid, int)

Delete inbox email address by inbox id Deletes inbox email address

Declaration

public void DeleteEmailAddress(Guid inboxId, int operationIndex = 0)

Parameters

Type	Name	Description
Guid	inboxId	ID of inbox to delete
int	operationIndex	Index associated with the operation.

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

DeleteEmailAddressAsync(Guid, int, CancellationToken)

Delete inbox email address by inbox id Deletes inbox email address

Declaration

public Task DeleteEmailAddressAsync(Guid inboxId, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
Guid	inboxId	ID of inbox to delete
int	operationIndex	Index associated with the operation.
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
Task	Task of void

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

DeleteEmailAddressWithHttpInfo(Guid, int)

Delete inbox email address by inbox id Deletes inbox email address

Declaration

public ApiResponse<object> DeleteEmailAddressWithHttpInfo(Guid inboxId, int operationIndex = 0)

Parameters

Type	Name	Description
Guid	inboxId	ID of inbox to delete
int	operationIndex	Index associated with the operation.

Returns

Type	Description
ApiResponse<object>	ApiResponse of Object(void)

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

DeleteEmailAddressWithHttpInfoAsync(Guid, int, CancellationToken)

Delete inbox email address by inbox id Deletes inbox email address

Declaration

public Task<ApiResponse<object>> DeleteEmailAddressWithHttpInfoAsync(Guid inboxId, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
Guid	inboxId	ID of inbox to delete
int	operationIndex	Index associated with the operation.
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
Task<ApiResponse<object>>	Task of ApiResponse

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

EmptyInbox(Guid, int)

Delete all emails in an inbox Deletes all emails

Declaration

public void EmptyInbox(Guid inboxId, int operationIndex = 0)

Parameters

Type	Name	Description
Guid	inboxId	ID of inbox to empty
int	operationIndex	Index associated with the operation.

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

EmptyInboxAsync(Guid, int, CancellationToken)

Delete all emails in an inbox Deletes all emails

Declaration

public Task EmptyInboxAsync(Guid inboxId, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
Guid	inboxId	ID of inbox to empty
int	operationIndex	Index associated with the operation.
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
Task	Task of void

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

EmptyInboxWithHttpInfo(Guid, int)

Delete all emails in an inbox Deletes all emails

Declaration

public ApiResponse<object> EmptyInboxWithHttpInfo(Guid inboxId, int operationIndex = 0)

Parameters

Type	Name	Description
Guid	inboxId	ID of inbox to empty
int	operationIndex	Index associated with the operation.

Returns

Type	Description
ApiResponse<object>	ApiResponse of Object(void)

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

EmptyInboxWithHttpInfoAsync(Guid, int, CancellationToken)

Delete all emails in an inbox Deletes all emails

Declaration

public Task<ApiResponse<object>> EmptyInboxWithHttpInfoAsync(Guid inboxId, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
Guid	inboxId	ID of inbox to empty
int	operationIndex	Index associated with the operation.
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
Task<ApiResponse<object>>	Task of ApiResponse

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

GetBasePath()

Gets the base path of the API client.

Declaration

public string GetBasePath()

Returns

Type	Description
string	The base path

View Source

SendEmailQuery(string, Guid?, string, string, int)

Send an email using query parameters If no senderId or inboxId provided a random email address will be used to send from. Ensure your parameters are URL encoded.

Declaration

public void SendEmailQuery(string to, Guid? senderId = null, string body = null, string subject = null, int operationIndex = 0)

Parameters

Type	Name	Description
string	to	Email address to send to
Guid?	senderId	ID of inbox to send from. If null an inbox will be created for sending (optional)
string	body	Body of the email message. Supports HTML (optional)
string	subject	Subject line of the email (optional)
int	operationIndex	Index associated with the operation.

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

SendEmailQueryAsync(string, Guid?, string, string, int, CancellationToken)

Send an email using query parameters If no senderId or inboxId provided a random email address will be used to send from. Ensure your parameters are URL encoded.

Declaration

public Task SendEmailQueryAsync(string to, Guid? senderId = null, string body = null, string subject = null, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
string	to	Email address to send to
Guid?	senderId	ID of inbox to send from. If null an inbox will be created for sending (optional)
string	body	Body of the email message. Supports HTML (optional)
string	subject	Subject line of the email (optional)
int	operationIndex	Index associated with the operation.
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
Task	Task of void

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

SendEmailQueryWithHttpInfo(string, Guid?, string, string, int)

Send an email using query parameters If no senderId or inboxId provided a random email address will be used to send from. Ensure your parameters are URL encoded.

Declaration

public ApiResponse<object> SendEmailQueryWithHttpInfo(string to, Guid? senderId = null, string body = null, string subject = null, int operationIndex = 0)

Parameters

Type	Name	Description
string	to	Email address to send to
Guid?	senderId	ID of inbox to send from. If null an inbox will be created for sending (optional)
string	body	Body of the email message. Supports HTML (optional)
string	subject	Subject line of the email (optional)
int	operationIndex	Index associated with the operation.

Returns

Type	Description
ApiResponse<object>	ApiResponse of Object(void)

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

SendEmailQueryWithHttpInfoAsync(string, Guid?, string, string, int, CancellationToken)

Send an email using query parameters If no senderId or inboxId provided a random email address will be used to send from. Ensure your parameters are URL encoded.

Declaration

public Task<ApiResponse<object>> SendEmailQueryWithHttpInfoAsync(string to, Guid? senderId = null, string body = null, string subject = null, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
string	to	Email address to send to
Guid?	senderId	ID of inbox to send from. If null an inbox will be created for sending (optional)
string	body	Body of the email message. Supports HTML (optional)
string	subject	Subject line of the email (optional)
int	operationIndex	Index associated with the operation.
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
Task<ApiResponse<object>>	Task of ApiResponse

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

SendEmailSimple(SimpleSendEmailOptions, int)

Send an email If no senderId or inboxId provided a random email address will be used to send from.

Declaration

public void SendEmailSimple(SimpleSendEmailOptions simpleSendEmailOptions, int operationIndex = 0)

Parameters

Type	Name	Description
SimpleSendEmailOptions	simpleSendEmailOptions
int	operationIndex	Index associated with the operation.

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

SendEmailSimpleAsync(SimpleSendEmailOptions, int, CancellationToken)

Send an email If no senderId or inboxId provided a random email address will be used to send from.

Declaration

public Task SendEmailSimpleAsync(SimpleSendEmailOptions simpleSendEmailOptions, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
SimpleSendEmailOptions	simpleSendEmailOptions
int	operationIndex	Index associated with the operation.
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
Task	Task of void

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

SendEmailSimpleWithHttpInfo(SimpleSendEmailOptions, int)

Send an email If no senderId or inboxId provided a random email address will be used to send from.

Declaration

public ApiResponse<object> SendEmailSimpleWithHttpInfo(SimpleSendEmailOptions simpleSendEmailOptions, int operationIndex = 0)

Parameters

Type	Name	Description
SimpleSendEmailOptions	simpleSendEmailOptions
int	operationIndex	Index associated with the operation.

Returns

Type	Description
ApiResponse<object>	ApiResponse of Object(void)

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

SendEmailSimpleWithHttpInfoAsync(SimpleSendEmailOptions, int, CancellationToken)

Send an email If no senderId or inboxId provided a random email address will be used to send from.

Declaration

public Task<ApiResponse<object>> SendEmailSimpleWithHttpInfoAsync(SimpleSendEmailOptions simpleSendEmailOptions, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
SimpleSendEmailOptions	simpleSendEmailOptions
int	operationIndex	Index associated with the operation.
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
Task<ApiResponse<object>>	Task of ApiResponse

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

Implements

ICommonActionsControllerApi

ICommonActionsControllerApiSync

ICommonActionsControllerApiAsync

IApiAccessor