Class BulkActionsControllerApi
Represents a collection of functions to interact with the API endpoints
Implements
Inherited Members
Namespace: mailslurp.Api
Assembly: mailslurp.dll
Syntax
public class BulkActionsControllerApi : IBulkActionsControllerApi, IBulkActionsControllerApiSync, IBulkActionsControllerApiAsync, IApiAccessor
Constructors
View SourceBulkActionsControllerApi()
Initializes a new instance of the BulkActionsControllerApi class.
Declaration
public BulkActionsControllerApi()
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 |
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. |
BulkActionsControllerApi(string)
Initializes a new instance of the BulkActionsControllerApi class.
Declaration
public BulkActionsControllerApi(string basePath)
Parameters
Type | Name | Description |
---|---|---|
string | basePath |
Properties
View SourceAsynchronousClient
The client for accessing this underlying API asynchronously.
Declaration
public IAsynchronousClient AsynchronousClient { get; set; }
Property Value
Type | Description |
---|---|
IAsynchronousClient |
Client
The client for accessing this underlying API synchronously.
Declaration
public ISynchronousClient Client { get; set; }
Property Value
Type | Description |
---|---|
ISynchronousClient |
Configuration
Gets or sets the configuration object
Declaration
public IReadableConfiguration Configuration { get; set; }
Property Value
Type | Description |
---|---|
IReadableConfiguration | An instance of the Configuration |
ExceptionFactory
Provides a factory method hook for the creation of exceptions.
Declaration
public ExceptionFactory ExceptionFactory { get; set; }
Property Value
Type | Description |
---|---|
ExceptionFactory |
Methods
View SourceBulkCreateInboxes(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 |
---|---|
System.Collections.Generic.List<T><InboxDto> | List<InboxDto> |
Exceptions
Type | Condition |
---|---|
ApiException | Thrown when fails to make API call |
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<System.Collections.Generic.List<T><InboxDto>> | Task of List<InboxDto> |
Exceptions
Type | Condition |
---|---|
ApiException | Thrown when fails to make API call |
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<System.Collections.Generic.List<T><InboxDto>> | ApiResponse of List<InboxDto> |
Exceptions
Type | Condition |
---|---|
ApiException | Thrown when fails to make API call |
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<System.Collections.Generic.List<T><InboxDto>>> | Task of ApiResponse (List<InboxDto>) |
Exceptions
Type | Condition |
---|---|
ApiException | Thrown when fails to make API call |
BulkDeleteInboxes(List<Guid>, int)
Bulk Delete Inboxes
Declaration
public void BulkDeleteInboxes(List<Guid> requestBody, int operationIndex = 0)
Parameters
Type | Name | Description |
---|---|---|
System.Collections.Generic.List<T><System.Guid> | requestBody | |
int | operationIndex | Index associated with the operation. |
Exceptions
Type | Condition |
---|---|
ApiException | Thrown when fails to make API call |
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 |
---|---|---|
System.Collections.Generic.List<T><System.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 |
BulkDeleteInboxesWithHttpInfo(List<Guid>, int)
Bulk Delete Inboxes
Declaration
public ApiResponse<object> BulkDeleteInboxesWithHttpInfo(List<Guid> requestBody, int operationIndex = 0)
Parameters
Type | Name | Description |
---|---|---|
System.Collections.Generic.List<T><System.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 |
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 |
---|---|---|
System.Collections.Generic.List<T><System.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 |
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 |
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 |
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 |
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 |
GetBasePath()
Gets the base path of the API client.
Declaration
public string GetBasePath()
Returns
Type | Description |
---|---|
string | The base path |