Interface IBulkActionsControllerApiAsync

Represents a collection of functions to interact with the API endpoints

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

Methods

View Source

BulkCreateInboxesAsync(int, int, CancellationToken)

Bulk create Inboxes (email addresses)

Declaration
Task<List<InboxDto>> BulkCreateInboxesAsync(int count, int operationIndex = 0, CancellationToken cancellationToken = default)
Parameters
Type Name Description
int count

Number of inboxes to be created in bulk
int operationIndex

Index associated with the operation.
CancellationToken cancellationToken

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

Task of List<InboxDto>
Exceptions
Type Condition
ApiException

Thrown when fails to make API call
View Source

BulkCreateInboxesWithHttpInfoAsync(int, int, CancellationToken)

Bulk create Inboxes (email addresses)

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

Number of inboxes to be created in bulk
int operationIndex

Index associated with the operation.
CancellationToken cancellationToken

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

Task of ApiResponse (List<InboxDto>)
Exceptions
Type Condition
ApiException

Thrown when fails to make API call
View Source

BulkDeleteInboxesAsync(List<Guid>, int, CancellationToken)

Bulk Delete Inboxes

Declaration
Task BulkDeleteInboxesAsync(List<Guid> requestBody, int operationIndex = 0, CancellationToken cancellationToken = default)
Parameters
Type Name Description
List<Guid> requestBody
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

BulkDeleteInboxesWithHttpInfoAsync(List<Guid>, int, CancellationToken)

Bulk Delete Inboxes

Declaration
Task<ApiResponse<object>> BulkDeleteInboxesWithHttpInfoAsync(List<Guid> requestBody, int operationIndex = 0, CancellationToken cancellationToken = default)
Parameters
Type Name Description
List<Guid> requestBody
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

BulkSendEmailsAsync(BulkSendEmailOptions, int, CancellationToken)

Bulk Send Emails

Declaration
Task BulkSendEmailsAsync(BulkSendEmailOptions bulkSendEmailOptions, int operationIndex = 0, CancellationToken cancellationToken = default)
Parameters
Type Name Description
BulkSendEmailOptions bulkSendEmailOptions
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

BulkSendEmailsWithHttpInfoAsync(BulkSendEmailOptions, int, CancellationToken)

Bulk Send Emails

Declaration
Task<ApiResponse<object>> BulkSendEmailsWithHttpInfoAsync(BulkSendEmailOptions bulkSendEmailOptions, int operationIndex = 0, CancellationToken cancellationToken = default)
Parameters
Type Name Description
BulkSendEmailOptions bulkSendEmailOptions
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