Class BulkActionsControllerApi

Represents a collection of functions to interact with the API endpoints

Inheritance

object

BulkActionsControllerApi

Implements

IBulkActionsControllerApi

IBulkActionsControllerApiSync

IBulkActionsControllerApiAsync

IApiAccessor

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: mailslurp.Api

Assembly: mailslurp.dll

Syntax

public class BulkActionsControllerApi : IBulkActionsControllerApi, IBulkActionsControllerApiSync, IBulkActionsControllerApiAsync, IApiAccessor

Constructors

View Source

BulkActionsControllerApi()

Initializes a new instance of the BulkActionsControllerApi class.

Declaration

public BulkActionsControllerApi()

View Source

BulkActionsControllerApi(string)

Initializes a new instance of the BulkActionsControllerApi class.

Declaration

public BulkActionsControllerApi(string basePath)

Parameters

Type	Name	Description
string	basePath

View Source

BulkActionsControllerApi(Configuration)

Initializes a new instance of the BulkActionsControllerApi class using Configuration object

Declaration

public BulkActionsControllerApi(Configuration configuration)

Parameters

Type	Name	Description
Configuration	configuration	An instance of Configuration

View Source

BulkActionsControllerApi(ISynchronousClient, IAsynchronousClient, IReadableConfiguration)

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

Declaration

public BulkActionsControllerApi(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

BulkCreateInboxes(int, int)

Bulk create Inboxes (email addresses)

Declaration

public List<InboxDto> BulkCreateInboxes(int count, int operationIndex = 0)

Parameters

Type	Name	Description
int	count	Number of inboxes to be created in bulk
int	operationIndex	Index associated with the operation.

Returns

Type	Description
List<InboxDto>	List<InboxDto>

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

BulkCreateInboxesAsync(int, int, CancellationToken)

Bulk create Inboxes (email addresses)

Declaration

public 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

BulkCreateInboxesWithHttpInfo(int, int)

Bulk create Inboxes (email addresses)

Declaration

public ApiResponse<List<InboxDto>> BulkCreateInboxesWithHttpInfo(int count, int operationIndex = 0)

Parameters

Type	Name	Description
int	count	Number of inboxes to be created in bulk
int	operationIndex	Index associated with the operation.

Returns

Type	Description
ApiResponse<List<InboxDto>>	ApiResponse 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

public 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

BulkDeleteInboxes(List<Guid>, int)

Bulk Delete Inboxes

Declaration

public void BulkDeleteInboxes(List<Guid> requestBody, int operationIndex = 0)

Parameters

Type	Name	Description
List<Guid>	requestBody
int	operationIndex	Index associated with the operation.

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

BulkDeleteInboxesAsync(List<Guid>, int, CancellationToken)

Bulk Delete Inboxes

Declaration

public 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

BulkDeleteInboxesWithHttpInfo(List<Guid>, int)

Bulk Delete Inboxes

Declaration

public ApiResponse<object> BulkDeleteInboxesWithHttpInfo(List<Guid> requestBody, int operationIndex = 0)

Parameters

Type	Name	Description
List<Guid>	requestBody
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

BulkDeleteInboxesWithHttpInfoAsync(List<Guid>, int, CancellationToken)

Bulk Delete Inboxes

Declaration

public 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

BulkSendEmails(BulkSendEmailOptions, int)

Bulk Send Emails

Declaration

public void BulkSendEmails(BulkSendEmailOptions bulkSendEmailOptions, int operationIndex = 0)

Parameters

Type	Name	Description
BulkSendEmailOptions	bulkSendEmailOptions
int	operationIndex	Index associated with the operation.

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

BulkSendEmailsAsync(BulkSendEmailOptions, int, CancellationToken)

Bulk Send Emails

Declaration

public 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

BulkSendEmailsWithHttpInfo(BulkSendEmailOptions, int)

Bulk Send Emails

Declaration

public ApiResponse<object> BulkSendEmailsWithHttpInfo(BulkSendEmailOptions bulkSendEmailOptions, int operationIndex = 0)

Parameters

Type	Name	Description
BulkSendEmailOptions	bulkSendEmailOptions
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

BulkSendEmailsWithHttpInfoAsync(BulkSendEmailOptions, int, CancellationToken)

Bulk Send Emails

Declaration

public 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

View Source

GetBasePath()

Gets the base path of the API client.

Declaration

public string GetBasePath()

Returns

Type	Description
string	The base path

Implements

IBulkActionsControllerApi

IBulkActionsControllerApiSync

IBulkActionsControllerApiAsync

IApiAccessor