Interface ICommonActionsControllerApiAsync

Represents a collection of functions to interact with the API endpoints

Inherited Members

Namespace: mailslurp.Api

Assembly: mailslurp.dll

Syntax

public interface ICommonActionsControllerApiAsync : IApiAccessor

Methods

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

Declaration

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

Remarks

Returns an Inbox with an id and an emailAddress

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

Declaration

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)

Remarks

Returns an Inbox with an id and an emailAddress

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

Declaration

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

Remarks

Returns an Inbox with an id and an emailAddress

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

Declaration

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)

Remarks

Returns an Inbox with an id and an emailAddress

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

DeleteEmailAddressAsync(Guid, int, CancellationToken)

Delete inbox email address by inbox id

Declaration

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

Remarks

Deletes inbox email address

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

DeleteEmailAddressWithHttpInfoAsync(Guid, int, CancellationToken)

Delete inbox email address by inbox id

Declaration

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

Remarks

Deletes inbox email address

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

EmptyInboxAsync(Guid, int, CancellationToken)

Delete all emails in an inbox

Declaration

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

Remarks

Deletes all emails

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

EmptyInboxWithHttpInfoAsync(Guid, int, CancellationToken)

Delete all emails in an inbox

Declaration

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

Remarks

Deletes all emails

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

Declaration

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

Remarks

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

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

Declaration

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

Remarks

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

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

SendEmailSimpleAsync(SimpleSendEmailOptions, int, CancellationToken)

Send an email

Declaration

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

Remarks

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

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

SendEmailSimpleWithHttpInfoAsync(SimpleSendEmailOptions, int, CancellationToken)

Send an email

Declaration

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

Remarks

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

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call