Class InboxReplierControllerApi

Represents a collection of functions to interact with the API endpoints

Inheritance

object

InboxReplierControllerApi

Implements

IInboxReplierControllerApi

IInboxReplierControllerApiSync

IInboxReplierControllerApiAsync

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 InboxReplierControllerApi : IInboxReplierControllerApi, IInboxReplierControllerApiSync, IInboxReplierControllerApiAsync, IApiAccessor

Constructors

View Source

InboxReplierControllerApi()

Initializes a new instance of the InboxReplierControllerApi class.

Declaration

public InboxReplierControllerApi()

View Source

InboxReplierControllerApi(Configuration)

Initializes a new instance of the InboxReplierControllerApi class using Configuration object

Declaration

public InboxReplierControllerApi(Configuration configuration)

Parameters

Type	Name	Description
Configuration	configuration	An instance of Configuration

View Source

InboxReplierControllerApi(ISynchronousClient, IAsynchronousClient, IReadableConfiguration)

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

Declaration

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

View Source

InboxReplierControllerApi(string)

Initializes a new instance of the InboxReplierControllerApi class.

Declaration

public InboxReplierControllerApi(string basePath)

Parameters

Type	Name	Description
string	basePath

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

CreateNewInboxReplier(CreateInboxReplierOptions, int)

Create an inbox replier Create a new inbox rule for reply toing, blocking, and allowing emails when sending and receiving

Declaration

public InboxReplierDto CreateNewInboxReplier(CreateInboxReplierOptions createInboxReplierOptions, int operationIndex = 0)

Parameters

Type	Name	Description
CreateInboxReplierOptions	createInboxReplierOptions
int	operationIndex	Index associated with the operation.

Returns

Type	Description
InboxReplierDto	InboxReplierDto

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

CreateNewInboxReplierAsync(CreateInboxReplierOptions, int, CancellationToken)

Create an inbox replier Create a new inbox rule for reply toing, blocking, and allowing emails when sending and receiving

Declaration

public Task<InboxReplierDto> CreateNewInboxReplierAsync(CreateInboxReplierOptions createInboxReplierOptions, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

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

Returns

Type	Description
Task<InboxReplierDto>	Task of InboxReplierDto

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

CreateNewInboxReplierWithHttpInfo(CreateInboxReplierOptions, int)

Create an inbox replier Create a new inbox rule for reply toing, blocking, and allowing emails when sending and receiving

Declaration

public ApiResponse<InboxReplierDto> CreateNewInboxReplierWithHttpInfo(CreateInboxReplierOptions createInboxReplierOptions, int operationIndex = 0)

Parameters

Type	Name	Description
CreateInboxReplierOptions	createInboxReplierOptions
int	operationIndex	Index associated with the operation.

Returns

Type	Description
ApiResponse<InboxReplierDto>	ApiResponse of InboxReplierDto

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

CreateNewInboxReplierWithHttpInfoAsync(CreateInboxReplierOptions, int, CancellationToken)

Create an inbox replier Create a new inbox rule for reply toing, blocking, and allowing emails when sending and receiving

Declaration

public Task<ApiResponse<InboxReplierDto>> CreateNewInboxReplierWithHttpInfoAsync(CreateInboxReplierOptions createInboxReplierOptions, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

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

Returns

Type	Description
Task<ApiResponse<InboxReplierDto>>	Task of ApiResponse (InboxReplierDto)

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

DeleteInboxReplier(Guid, int)

Delete an inbox replier Delete inbox replier

Declaration

public void DeleteInboxReplier(Guid id, int operationIndex = 0)

Parameters

Type	Name	Description
System.Guid	id	ID of inbox replier
int	operationIndex	Index associated with the operation.

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

DeleteInboxReplierAsync(Guid, int, CancellationToken)

Delete an inbox replier Delete inbox replier

Declaration

public Task DeleteInboxReplierAsync(Guid id, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
System.Guid	id	ID of inbox replier
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

DeleteInboxRepliers(Guid?, int)

Delete inbox repliers Delete inbox repliers. Accepts optional inboxId filter.

Declaration

public void DeleteInboxRepliers(Guid? inboxId = null, int operationIndex = 0)

Parameters

Type	Name	Description
System.Guid?	inboxId	Optional inbox id to attach replier to (optional)
int	operationIndex	Index associated with the operation.

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

DeleteInboxRepliersAsync(Guid?, int, CancellationToken)

Delete inbox repliers Delete inbox repliers. Accepts optional inboxId filter.

Declaration

public Task DeleteInboxRepliersAsync(Guid? inboxId = null, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
System.Guid?	inboxId	Optional inbox id to attach replier to (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

DeleteInboxRepliersWithHttpInfo(Guid?, int)

Delete inbox repliers Delete inbox repliers. Accepts optional inboxId filter.

Declaration

public ApiResponse<object> DeleteInboxRepliersWithHttpInfo(Guid? inboxId = null, int operationIndex = 0)

Parameters

Type	Name	Description
System.Guid?	inboxId	Optional inbox id to attach replier to (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

DeleteInboxRepliersWithHttpInfoAsync(Guid?, int, CancellationToken)

Delete inbox repliers Delete inbox repliers. Accepts optional inboxId filter.

Declaration

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

Parameters

Type	Name	Description
System.Guid?	inboxId	Optional inbox id to attach replier to (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

DeleteInboxReplierWithHttpInfo(Guid, int)

Delete an inbox replier Delete inbox replier

Declaration

public ApiResponse<object> DeleteInboxReplierWithHttpInfo(Guid id, int operationIndex = 0)

Parameters

Type	Name	Description
System.Guid	id	ID of inbox replier
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

DeleteInboxReplierWithHttpInfoAsync(Guid, int, CancellationToken)

Delete an inbox replier Delete inbox replier

Declaration

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

Parameters

Type	Name	Description
System.Guid	id	ID of inbox replier
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

GetInboxReplier(Guid, int)

Get an inbox replier Get inbox ruleset

Declaration

public InboxReplierDto GetInboxReplier(Guid id, int operationIndex = 0)

Parameters

Type	Name	Description
System.Guid	id	ID of inbox replier
int	operationIndex	Index associated with the operation.

Returns

Type	Description
InboxReplierDto	InboxReplierDto

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

GetInboxReplierAsync(Guid, int, CancellationToken)

Get an inbox replier Get inbox ruleset

Declaration

public Task<InboxReplierDto> GetInboxReplierAsync(Guid id, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

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

Returns

Type	Description
Task<InboxReplierDto>	Task of InboxReplierDto

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

GetInboxReplierEvents(Guid, int?, int?, string, int)

Get an inbox replier event list Get inbox ruleset events

Declaration

public PageInboxReplierEvents GetInboxReplierEvents(Guid id, int? page = null, int? size = null, string sort = null, int operationIndex = 0)

Parameters

Type	Name	Description
System.Guid	id	ID of inbox replier
int?	page	Optional page index in inbox replier event list pagination (optional, default to 0)
int?	size	Optional page size in inbox replier event list pagination (optional, default to 20)
string	sort	Optional createdAt sort direction ASC or DESC (optional, default to ASC)
int	operationIndex	Index associated with the operation.

Returns

Type	Description
PageInboxReplierEvents	PageInboxReplierEvents

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

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

Get an inbox replier event list Get inbox ruleset events

Declaration

public Task<PageInboxReplierEvents> GetInboxReplierEventsAsync(Guid id, int? page = null, int? size = null, string sort = null, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
System.Guid	id	ID of inbox replier
int?	page	Optional page index in inbox replier event list pagination (optional, default to 0)
int?	size	Optional page size in inbox replier event list pagination (optional, default to 20)
string	sort	Optional createdAt sort direction ASC or DESC (optional, default to ASC)
int	operationIndex	Index associated with the operation.
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
Task<PageInboxReplierEvents>	Task of PageInboxReplierEvents

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

GetInboxReplierEventsWithHttpInfo(Guid, int?, int?, string, int)

Get an inbox replier event list Get inbox ruleset events

Declaration

public ApiResponse<PageInboxReplierEvents> GetInboxReplierEventsWithHttpInfo(Guid id, int? page = null, int? size = null, string sort = null, int operationIndex = 0)

Parameters

Type	Name	Description
System.Guid	id	ID of inbox replier
int?	page	Optional page index in inbox replier event list pagination (optional, default to 0)
int?	size	Optional page size in inbox replier event list pagination (optional, default to 20)
string	sort	Optional createdAt sort direction ASC or DESC (optional, default to ASC)
int	operationIndex	Index associated with the operation.

Returns

Type	Description
ApiResponse<PageInboxReplierEvents>	ApiResponse of PageInboxReplierEvents

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

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

Get an inbox replier event list Get inbox ruleset events

Declaration

public Task<ApiResponse<PageInboxReplierEvents>> GetInboxReplierEventsWithHttpInfoAsync(Guid id, int? page = null, int? size = null, string sort = null, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
System.Guid	id	ID of inbox replier
int?	page	Optional page index in inbox replier event list pagination (optional, default to 0)
int?	size	Optional page size in inbox replier event list pagination (optional, default to 20)
string	sort	Optional createdAt sort direction ASC or DESC (optional, default to ASC)
int	operationIndex	Index associated with the operation.
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
Task<ApiResponse<PageInboxReplierEvents>>	Task of ApiResponse (PageInboxReplierEvents)

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

GetInboxRepliers(Guid?, int?, int?, string, DateTime?, DateTime?, int)

List inbox repliers List all repliers attached to an inbox

Declaration

public PageInboxReplierDto GetInboxRepliers(Guid? inboxId = null, int? page = null, int? size = null, string sort = null, DateTime? since = null, DateTime? before = null, int operationIndex = 0)

Parameters

Type	Name	Description
System.Guid?	inboxId	Optional inbox id to get repliers from (optional)
int?	page	Optional page index in inbox replier list pagination (optional, default to 0)
int?	size	Optional page size in inbox replier list pagination (optional, default to 20)
string	sort	Optional createdAt sort direction ASC or DESC (optional, default to ASC)
DateTime?	since	Filter by created at after the given timestamp (optional)
DateTime?	before	Filter by created at before the given timestamp (optional)
int	operationIndex	Index associated with the operation.

Returns

Type	Description
PageInboxReplierDto	PageInboxReplierDto

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

GetInboxRepliersAsync(Guid?, int?, int?, string, DateTime?, DateTime?, int, CancellationToken)

List inbox repliers List all repliers attached to an inbox

Declaration

public Task<PageInboxReplierDto> GetInboxRepliersAsync(Guid? inboxId = null, int? page = null, int? size = null, string sort = null, DateTime? since = null, DateTime? before = null, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
System.Guid?	inboxId	Optional inbox id to get repliers from (optional)
int?	page	Optional page index in inbox replier list pagination (optional, default to 0)
int?	size	Optional page size in inbox replier list pagination (optional, default to 20)
string	sort	Optional createdAt sort direction ASC or DESC (optional, default to ASC)
DateTime?	since	Filter by created at after the given timestamp (optional)
DateTime?	before	Filter by created at before the given timestamp (optional)
int	operationIndex	Index associated with the operation.
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
Task<PageInboxReplierDto>	Task of PageInboxReplierDto

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

GetInboxRepliersWithHttpInfo(Guid?, int?, int?, string, DateTime?, DateTime?, int)

List inbox repliers List all repliers attached to an inbox

Declaration

public ApiResponse<PageInboxReplierDto> GetInboxRepliersWithHttpInfo(Guid? inboxId = null, int? page = null, int? size = null, string sort = null, DateTime? since = null, DateTime? before = null, int operationIndex = 0)

Parameters

Type	Name	Description
System.Guid?	inboxId	Optional inbox id to get repliers from (optional)
int?	page	Optional page index in inbox replier list pagination (optional, default to 0)
int?	size	Optional page size in inbox replier list pagination (optional, default to 20)
string	sort	Optional createdAt sort direction ASC or DESC (optional, default to ASC)
DateTime?	since	Filter by created at after the given timestamp (optional)
DateTime?	before	Filter by created at before the given timestamp (optional)
int	operationIndex	Index associated with the operation.

Returns

Type	Description
ApiResponse<PageInboxReplierDto>	ApiResponse of PageInboxReplierDto

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

GetInboxRepliersWithHttpInfoAsync(Guid?, int?, int?, string, DateTime?, DateTime?, int, CancellationToken)

List inbox repliers List all repliers attached to an inbox

Declaration

public Task<ApiResponse<PageInboxReplierDto>> GetInboxRepliersWithHttpInfoAsync(Guid? inboxId = null, int? page = null, int? size = null, string sort = null, DateTime? since = null, DateTime? before = null, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
System.Guid?	inboxId	Optional inbox id to get repliers from (optional)
int?	page	Optional page index in inbox replier list pagination (optional, default to 0)
int?	size	Optional page size in inbox replier list pagination (optional, default to 20)
string	sort	Optional createdAt sort direction ASC or DESC (optional, default to ASC)
DateTime?	since	Filter by created at after the given timestamp (optional)
DateTime?	before	Filter by created at before the given timestamp (optional)
int	operationIndex	Index associated with the operation.
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
Task<ApiResponse<PageInboxReplierDto>>	Task of ApiResponse (PageInboxReplierDto)

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

GetInboxReplierWithHttpInfo(Guid, int)

Get an inbox replier Get inbox ruleset

Declaration

public ApiResponse<InboxReplierDto> GetInboxReplierWithHttpInfo(Guid id, int operationIndex = 0)

Parameters

Type	Name	Description
System.Guid	id	ID of inbox replier
int	operationIndex	Index associated with the operation.

Returns

Type	Description
ApiResponse<InboxReplierDto>	ApiResponse of InboxReplierDto

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

GetInboxReplierWithHttpInfoAsync(Guid, int, CancellationToken)

Get an inbox replier Get inbox ruleset

Declaration

public Task<ApiResponse<InboxReplierDto>> GetInboxReplierWithHttpInfoAsync(Guid id, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

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

Returns

Type	Description
Task<ApiResponse<InboxReplierDto>>	Task of ApiResponse (InboxReplierDto)

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

UpdateInboxReplier(Guid, UpdateInboxReplierOptions, int)

Update an inbox replier Update inbox ruleset

Declaration

public InboxReplierDto UpdateInboxReplier(Guid id, UpdateInboxReplierOptions updateInboxReplierOptions, int operationIndex = 0)

Parameters

Type	Name	Description
System.Guid	id	ID of inbox replier
UpdateInboxReplierOptions	updateInboxReplierOptions
int	operationIndex	Index associated with the operation.

Returns

Type	Description
InboxReplierDto	InboxReplierDto

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

UpdateInboxReplierAsync(Guid, UpdateInboxReplierOptions, int, CancellationToken)

Update an inbox replier Update inbox ruleset

Declaration

public Task<InboxReplierDto> UpdateInboxReplierAsync(Guid id, UpdateInboxReplierOptions updateInboxReplierOptions, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
System.Guid	id	ID of inbox replier
UpdateInboxReplierOptions	updateInboxReplierOptions
int	operationIndex	Index associated with the operation.
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
Task<InboxReplierDto>	Task of InboxReplierDto

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

UpdateInboxReplierWithHttpInfo(Guid, UpdateInboxReplierOptions, int)

Update an inbox replier Update inbox ruleset

Declaration

public ApiResponse<InboxReplierDto> UpdateInboxReplierWithHttpInfo(Guid id, UpdateInboxReplierOptions updateInboxReplierOptions, int operationIndex = 0)

Parameters

Type	Name	Description
System.Guid	id	ID of inbox replier
UpdateInboxReplierOptions	updateInboxReplierOptions
int	operationIndex	Index associated with the operation.

Returns

Type	Description
ApiResponse<InboxReplierDto>	ApiResponse of InboxReplierDto

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

UpdateInboxReplierWithHttpInfoAsync(Guid, UpdateInboxReplierOptions, int, CancellationToken)

Update an inbox replier Update inbox ruleset

Declaration

public Task<ApiResponse<InboxReplierDto>> UpdateInboxReplierWithHttpInfoAsync(Guid id, UpdateInboxReplierOptions updateInboxReplierOptions, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
System.Guid	id	ID of inbox replier
UpdateInboxReplierOptions	updateInboxReplierOptions
int	operationIndex	Index associated with the operation.
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
Task<ApiResponse<InboxReplierDto>>	Task of ApiResponse (InboxReplierDto)

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

Implements

IInboxReplierControllerApi

IInboxReplierControllerApiSync

IInboxReplierControllerApiAsync

IApiAccessor