Interface IInboxReplierControllerApiAsync

Represents a collection of functions to interact with the API endpoints

Inherited Members

Namespace: mailslurp.Api

Assembly: mailslurp.dll

Syntax

public interface IInboxReplierControllerApiAsync : IApiAccessor

Methods

View Source

CreateNewInboxReplierAsync(CreateInboxReplierOptions, int, CancellationToken)

Create an inbox replier

Declaration

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

Remarks

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

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

CreateNewInboxReplierWithHttpInfoAsync(CreateInboxReplierOptions, int, CancellationToken)

Create an inbox replier

Declaration

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)

Remarks

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

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

DeleteInboxReplierAsync(Guid, int, CancellationToken)

Delete an inbox replier

Declaration

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

Parameters

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

Remarks

Delete inbox replier

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

DeleteInboxReplierWithHttpInfoAsync(Guid, int, CancellationToken)

Delete an inbox replier

Declaration

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

Parameters

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

Remarks

Delete inbox replier

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

DeleteInboxRepliersAsync(Guid?, int, CancellationToken)

Delete inbox repliers

Declaration

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

Parameters

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

Remarks

Delete inbox repliers. Accepts optional inboxId filter.

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

DeleteInboxRepliersWithHttpInfoAsync(Guid?, int, CancellationToken)

Delete inbox repliers

Declaration

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

Parameters

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

Remarks

Delete inbox repliers. Accepts optional inboxId filter.

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

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

Get inbox replier event list

Declaration

Task<PageInboxReplierEvents> GetAllInboxReplierEventsAsync(Guid? inboxReplierId = null, Guid? inboxId = null, Guid? emailId = null, Guid? sentId = null, int? page = null, int? size = null, string sort = null, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
Guid?	inboxReplierId	ID of inbox replier (optional)
Guid?	inboxId	ID of inbox (optional)
Guid?	emailId	ID of email (optional)
Guid?	sentId	ID of sent (optional)
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

Remarks

Get all inbox ruleset events

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

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

Get inbox replier event list

Declaration

Task<ApiResponse<PageInboxReplierEvents>> GetAllInboxReplierEventsWithHttpInfoAsync(Guid? inboxReplierId = null, Guid? inboxId = null, Guid? emailId = null, Guid? sentId = null, int? page = null, int? size = null, string sort = null, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
Guid?	inboxReplierId	ID of inbox replier (optional)
Guid?	inboxId	ID of inbox (optional)
Guid?	emailId	ID of email (optional)
Guid?	sentId	ID of sent (optional)
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)

Remarks

Get all inbox ruleset events

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

GetInboxReplierAsync(Guid, int, CancellationToken)

Get an inbox replier

Declaration

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

Parameters

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

Remarks

Get inbox ruleset

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

Declaration

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

Parameters

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

Remarks

Get inbox ruleset events

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

Declaration

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
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)

Remarks

Get inbox ruleset events

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

GetInboxReplierWithHttpInfoAsync(Guid, int, CancellationToken)

Get an inbox replier

Declaration

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

Parameters

Type	Name	Description
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)

Remarks

Get inbox ruleset

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

Declaration

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
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

Remarks

List all repliers attached to an inbox

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

Declaration

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
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)

Remarks

List all repliers attached to an inbox

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

UpdateInboxReplierAsync(Guid, UpdateInboxReplierOptions, int, CancellationToken)

Update an inbox replier

Declaration

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

Parameters

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

Remarks

Update inbox ruleset

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

UpdateInboxReplierWithHttpInfoAsync(Guid, UpdateInboxReplierOptions, int, CancellationToken)

Update an inbox replier

Declaration

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

Parameters

Type	Name	Description
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)

Remarks

Update inbox ruleset

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call