Class InboxForwarderControllerApi

Represents a collection of functions to interact with the API endpoints

Inheritance
object
InboxForwarderControllerApi
Implements
Inherited Members
Namespace: mailslurp.Api
Assembly: mailslurp.dll
Syntax
public class InboxForwarderControllerApi : IInboxForwarderControllerApi, IInboxForwarderControllerApiSync, IInboxForwarderControllerApiAsync, IApiAccessor

Constructors

View Source

InboxForwarderControllerApi()

Initializes a new instance of the InboxForwarderControllerApi class.

Declaration
public InboxForwarderControllerApi()
View Source

InboxForwarderControllerApi(string)

Initializes a new instance of the InboxForwarderControllerApi class.

Declaration
public InboxForwarderControllerApi(string basePath)
Parameters
Type Name Description
string basePath
View Source

InboxForwarderControllerApi(Configuration)

Initializes a new instance of the InboxForwarderControllerApi class using Configuration object

Declaration
public InboxForwarderControllerApi(Configuration configuration)
Parameters
Type Name Description
Configuration configuration

An instance of Configuration
View Source

InboxForwarderControllerApi(ISynchronousClient, IAsynchronousClient, IReadableConfiguration)

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

Declaration
public InboxForwarderControllerApi(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

CreateNewInboxForwarder(CreateInboxForwarderOptions, Guid?, int)

Create an inbox forwarder Create a new inbox rule for forwarding, blocking, and allowing emails when sending and receiving

Declaration
public InboxForwarderDto CreateNewInboxForwarder(CreateInboxForwarderOptions createInboxForwarderOptions, Guid? inboxId = null, int operationIndex = 0)
Parameters
Type Name Description
CreateInboxForwarderOptions createInboxForwarderOptions
Guid? inboxId

Inbox id to attach forwarder to (optional)
int operationIndex

Index associated with the operation.
Returns
Type Description
InboxForwarderDto

InboxForwarderDto
Exceptions
Type Condition
ApiException

Thrown when fails to make API call
View Source

CreateNewInboxForwarderAsync(CreateInboxForwarderOptions, Guid?, int, CancellationToken)

Create an inbox forwarder Create a new inbox rule for forwarding, blocking, and allowing emails when sending and receiving

Declaration
public Task<InboxForwarderDto> CreateNewInboxForwarderAsync(CreateInboxForwarderOptions createInboxForwarderOptions, Guid? inboxId = null, int operationIndex = 0, CancellationToken cancellationToken = default)
Parameters
Type Name Description
CreateInboxForwarderOptions createInboxForwarderOptions
Guid? inboxId

Inbox id to attach forwarder to (optional)
int operationIndex

Index associated with the operation.
CancellationToken cancellationToken

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

Task of InboxForwarderDto
Exceptions
Type Condition
ApiException

Thrown when fails to make API call
View Source

CreateNewInboxForwarderWithHttpInfo(CreateInboxForwarderOptions, Guid?, int)

Create an inbox forwarder Create a new inbox rule for forwarding, blocking, and allowing emails when sending and receiving

Declaration
public ApiResponse<InboxForwarderDto> CreateNewInboxForwarderWithHttpInfo(CreateInboxForwarderOptions createInboxForwarderOptions, Guid? inboxId = null, int operationIndex = 0)
Parameters
Type Name Description
CreateInboxForwarderOptions createInboxForwarderOptions
Guid? inboxId

Inbox id to attach forwarder to (optional)
int operationIndex

Index associated with the operation.
Returns
Type Description
ApiResponse<InboxForwarderDto>

ApiResponse of InboxForwarderDto
Exceptions
Type Condition
ApiException

Thrown when fails to make API call
View Source

CreateNewInboxForwarderWithHttpInfoAsync(CreateInboxForwarderOptions, Guid?, int, CancellationToken)

Create an inbox forwarder Create a new inbox rule for forwarding, blocking, and allowing emails when sending and receiving

Declaration
public Task<ApiResponse<InboxForwarderDto>> CreateNewInboxForwarderWithHttpInfoAsync(CreateInboxForwarderOptions createInboxForwarderOptions, Guid? inboxId = null, int operationIndex = 0, CancellationToken cancellationToken = default)
Parameters
Type Name Description
CreateInboxForwarderOptions createInboxForwarderOptions
Guid? inboxId

Inbox id to attach forwarder to (optional)
int operationIndex

Index associated with the operation.
CancellationToken cancellationToken

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

Task of ApiResponse (InboxForwarderDto)
Exceptions
Type Condition
ApiException

Thrown when fails to make API call
View Source

DeleteInboxForwarder(Guid, int)

Delete an inbox forwarder Delete inbox forwarder

Declaration
public void DeleteInboxForwarder(Guid id, int operationIndex = 0)
Parameters
Type Name Description
Guid id

ID of inbox forwarder
int operationIndex

Index associated with the operation.
Exceptions
Type Condition
ApiException

Thrown when fails to make API call
View Source

DeleteInboxForwarderAsync(Guid, int, CancellationToken)

Delete an inbox forwarder Delete inbox forwarder

Declaration
public Task DeleteInboxForwarderAsync(Guid id, int operationIndex = 0, CancellationToken cancellationToken = default)
Parameters
Type Name Description
Guid id

ID of inbox forwarder
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

DeleteInboxForwarderWithHttpInfo(Guid, int)

Delete an inbox forwarder Delete inbox forwarder

Declaration
public ApiResponse<object> DeleteInboxForwarderWithHttpInfo(Guid id, int operationIndex = 0)
Parameters
Type Name Description
Guid id

ID of inbox forwarder
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

DeleteInboxForwarderWithHttpInfoAsync(Guid, int, CancellationToken)

Delete an inbox forwarder Delete inbox forwarder

Declaration
public Task<ApiResponse<object>> DeleteInboxForwarderWithHttpInfoAsync(Guid id, int operationIndex = 0, CancellationToken cancellationToken = default)
Parameters
Type Name Description
Guid id

ID of inbox forwarder
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

DeleteInboxForwarders(Guid?, int)

Delete inbox forwarders Delete inbox forwarders. Accepts optional inboxId filter.

Declaration
public void DeleteInboxForwarders(Guid? inboxId = null, int operationIndex = 0)
Parameters
Type Name Description
Guid? inboxId

Optional inbox id to attach forwarder to (optional)
int operationIndex

Index associated with the operation.
Exceptions
Type Condition
ApiException

Thrown when fails to make API call
View Source

DeleteInboxForwardersAsync(Guid?, int, CancellationToken)

Delete inbox forwarders Delete inbox forwarders. Accepts optional inboxId filter.

Declaration
public Task DeleteInboxForwardersAsync(Guid? inboxId = null, int operationIndex = 0, CancellationToken cancellationToken = default)
Parameters
Type Name Description
Guid? inboxId

Optional inbox id to attach forwarder 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

DeleteInboxForwardersWithHttpInfo(Guid?, int)

Delete inbox forwarders Delete inbox forwarders. Accepts optional inboxId filter.

Declaration
public ApiResponse<object> DeleteInboxForwardersWithHttpInfo(Guid? inboxId = null, int operationIndex = 0)
Parameters
Type Name Description
Guid? inboxId

Optional inbox id to attach forwarder 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

DeleteInboxForwardersWithHttpInfoAsync(Guid?, int, CancellationToken)

Delete inbox forwarders Delete inbox forwarders. Accepts optional inboxId filter.

Declaration
public Task<ApiResponse<object>> DeleteInboxForwardersWithHttpInfoAsync(Guid? inboxId = null, int operationIndex = 0, CancellationToken cancellationToken = default)
Parameters
Type Name Description
Guid? inboxId

Optional inbox id to attach forwarder 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

GetAllInboxForwarderEvents(int?, int?, Guid?, Guid?, Guid?, string, int)

Get all inbox forwarder events Get all inbox forwarder events

Declaration
public PageInboxForwarderEvents GetAllInboxForwarderEvents(int? page = null, int? size = null, Guid? inboxId = null, Guid? emailId = null, Guid? sentId = null, string sort = null, int operationIndex = 0)
Parameters
Type Name Description
int? page

Optional page index in inbox forwarder event list pagination (optional, default to 0)
int? size

Optional page size in inbox forwarder event list pagination (optional, default to 20)
Guid? inboxId

Optional inbox ID to filter for (optional)
Guid? emailId

Optional email ID to filter for (optional)
Guid? sentId

Optional sent ID to filter for (optional)
string sort

Optional createdAt sort direction ASC or DESC (optional, default to ASC)
int operationIndex

Index associated with the operation.
Returns
Type Description
PageInboxForwarderEvents

PageInboxForwarderEvents
Exceptions
Type Condition
ApiException

Thrown when fails to make API call
View Source

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

Get all inbox forwarder events Get all inbox forwarder events

Declaration
public Task<PageInboxForwarderEvents> GetAllInboxForwarderEventsAsync(int? page = null, int? size = null, Guid? inboxId = null, Guid? emailId = null, Guid? sentId = null, string sort = null, int operationIndex = 0, CancellationToken cancellationToken = default)
Parameters
Type Name Description
int? page

Optional page index in inbox forwarder event list pagination (optional, default to 0)
int? size

Optional page size in inbox forwarder event list pagination (optional, default to 20)
Guid? inboxId

Optional inbox ID to filter for (optional)
Guid? emailId

Optional email ID to filter for (optional)
Guid? sentId

Optional sent ID to filter for (optional)
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<PageInboxForwarderEvents>

Task of PageInboxForwarderEvents
Exceptions
Type Condition
ApiException

Thrown when fails to make API call
View Source

GetAllInboxForwarderEventsWithHttpInfo(int?, int?, Guid?, Guid?, Guid?, string, int)

Get all inbox forwarder events Get all inbox forwarder events

Declaration
public ApiResponse<PageInboxForwarderEvents> GetAllInboxForwarderEventsWithHttpInfo(int? page = null, int? size = null, Guid? inboxId = null, Guid? emailId = null, Guid? sentId = null, string sort = null, int operationIndex = 0)
Parameters
Type Name Description
int? page

Optional page index in inbox forwarder event list pagination (optional, default to 0)
int? size

Optional page size in inbox forwarder event list pagination (optional, default to 20)
Guid? inboxId

Optional inbox ID to filter for (optional)
Guid? emailId

Optional email ID to filter for (optional)
Guid? sentId

Optional sent ID to filter for (optional)
string sort

Optional createdAt sort direction ASC or DESC (optional, default to ASC)
int operationIndex

Index associated with the operation.
Returns
Type Description
ApiResponse<PageInboxForwarderEvents>

ApiResponse of PageInboxForwarderEvents
Exceptions
Type Condition
ApiException

Thrown when fails to make API call
View Source

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

Get all inbox forwarder events Get all inbox forwarder events

Declaration
public Task<ApiResponse<PageInboxForwarderEvents>> GetAllInboxForwarderEventsWithHttpInfoAsync(int? page = null, int? size = null, Guid? inboxId = null, Guid? emailId = null, Guid? sentId = null, string sort = null, int operationIndex = 0, CancellationToken cancellationToken = default)
Parameters
Type Name Description
int? page

Optional page index in inbox forwarder event list pagination (optional, default to 0)
int? size

Optional page size in inbox forwarder event list pagination (optional, default to 20)
Guid? inboxId

Optional inbox ID to filter for (optional)
Guid? emailId

Optional email ID to filter for (optional)
Guid? sentId

Optional sent ID to filter for (optional)
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<PageInboxForwarderEvents>>

Task of ApiResponse (PageInboxForwarderEvents)
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

GetForwarderEvent(Guid, int)

Get a forwarder event Get forwarder event

Declaration
public InboxForwarderEventDto GetForwarderEvent(Guid eventId, int operationIndex = 0)
Parameters
Type Name Description
Guid eventId

ID of inbox forwarder event
int operationIndex

Index associated with the operation.
Returns
Type Description
InboxForwarderEventDto

InboxForwarderEventDto
Exceptions
Type Condition
ApiException

Thrown when fails to make API call
View Source

GetForwarderEventAsync(Guid, int, CancellationToken)

Get a forwarder event Get forwarder event

Declaration
public Task<InboxForwarderEventDto> GetForwarderEventAsync(Guid eventId, int operationIndex = 0, CancellationToken cancellationToken = default)
Parameters
Type Name Description
Guid eventId

ID of inbox forwarder event
int operationIndex

Index associated with the operation.
CancellationToken cancellationToken

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

Task of InboxForwarderEventDto
Exceptions
Type Condition
ApiException

Thrown when fails to make API call
View Source

GetForwarderEventWithHttpInfo(Guid, int)

Get a forwarder event Get forwarder event

Declaration
public ApiResponse<InboxForwarderEventDto> GetForwarderEventWithHttpInfo(Guid eventId, int operationIndex = 0)
Parameters
Type Name Description
Guid eventId

ID of inbox forwarder event
int operationIndex

Index associated with the operation.
Returns
Type Description
ApiResponse<InboxForwarderEventDto>

ApiResponse of InboxForwarderEventDto
Exceptions
Type Condition
ApiException

Thrown when fails to make API call
View Source

GetForwarderEventWithHttpInfoAsync(Guid, int, CancellationToken)

Get a forwarder event Get forwarder event

Declaration
public Task<ApiResponse<InboxForwarderEventDto>> GetForwarderEventWithHttpInfoAsync(Guid eventId, int operationIndex = 0, CancellationToken cancellationToken = default)
Parameters
Type Name Description
Guid eventId

ID of inbox forwarder event
int operationIndex

Index associated with the operation.
CancellationToken cancellationToken

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

Task of ApiResponse (InboxForwarderEventDto)
Exceptions
Type Condition
ApiException

Thrown when fails to make API call
View Source

GetInboxForwarder(Guid, int)

Get an inbox forwarder Get inbox forwarder

Declaration
public InboxForwarderDto GetInboxForwarder(Guid id, int operationIndex = 0)
Parameters
Type Name Description
Guid id

ID of inbox forwarder
int operationIndex

Index associated with the operation.
Returns
Type Description
InboxForwarderDto

InboxForwarderDto
Exceptions
Type Condition
ApiException

Thrown when fails to make API call
View Source

GetInboxForwarderAsync(Guid, int, CancellationToken)

Get an inbox forwarder Get inbox forwarder

Declaration
public Task<InboxForwarderDto> GetInboxForwarderAsync(Guid id, int operationIndex = 0, CancellationToken cancellationToken = default)
Parameters
Type Name Description
Guid id

ID of inbox forwarder
int operationIndex

Index associated with the operation.
CancellationToken cancellationToken

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

Task of InboxForwarderDto
Exceptions
Type Condition
ApiException

Thrown when fails to make API call
View Source

GetInboxForwarderEvent(Guid, Guid, int)

Get an inbox forwarder event Get inbox forwarder event

Declaration
public InboxForwarderEventDto GetInboxForwarderEvent(Guid id, Guid eventId, int operationIndex = 0)
Parameters
Type Name Description
Guid id

ID of inbox forwarder
Guid eventId

ID of inbox forwarder event
int operationIndex

Index associated with the operation.
Returns
Type Description
InboxForwarderEventDto

InboxForwarderEventDto
Exceptions
Type Condition
ApiException

Thrown when fails to make API call
View Source

GetInboxForwarderEventAsync(Guid, Guid, int, CancellationToken)

Get an inbox forwarder event Get inbox forwarder event

Declaration
public Task<InboxForwarderEventDto> GetInboxForwarderEventAsync(Guid id, Guid eventId, int operationIndex = 0, CancellationToken cancellationToken = default)
Parameters
Type Name Description
Guid id

ID of inbox forwarder
Guid eventId

ID of inbox forwarder event
int operationIndex

Index associated with the operation.
CancellationToken cancellationToken

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

Task of InboxForwarderEventDto
Exceptions
Type Condition
ApiException

Thrown when fails to make API call
View Source

GetInboxForwarderEventWithHttpInfo(Guid, Guid, int)

Get an inbox forwarder event Get inbox forwarder event

Declaration
public ApiResponse<InboxForwarderEventDto> GetInboxForwarderEventWithHttpInfo(Guid id, Guid eventId, int operationIndex = 0)
Parameters
Type Name Description
Guid id

ID of inbox forwarder
Guid eventId

ID of inbox forwarder event
int operationIndex

Index associated with the operation.
Returns
Type Description
ApiResponse<InboxForwarderEventDto>

ApiResponse of InboxForwarderEventDto
Exceptions
Type Condition
ApiException

Thrown when fails to make API call
View Source

GetInboxForwarderEventWithHttpInfoAsync(Guid, Guid, int, CancellationToken)

Get an inbox forwarder event Get inbox forwarder event

Declaration
public Task<ApiResponse<InboxForwarderEventDto>> GetInboxForwarderEventWithHttpInfoAsync(Guid id, Guid eventId, int operationIndex = 0, CancellationToken cancellationToken = default)
Parameters
Type Name Description
Guid id

ID of inbox forwarder
Guid eventId

ID of inbox forwarder event
int operationIndex

Index associated with the operation.
CancellationToken cancellationToken

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

Task of ApiResponse (InboxForwarderEventDto)
Exceptions
Type Condition
ApiException

Thrown when fails to make API call
View Source

GetInboxForwarderEvents(Guid, int?, int?, string, int)

Get an inbox forwarder event list Get inbox forwarder events

Declaration
public PageInboxForwarderEvents GetInboxForwarderEvents(Guid id, int? page = null, int? size = null, string sort = null, int operationIndex = 0)
Parameters
Type Name Description
Guid id

ID of inbox forwarder
int? page

Optional page index in inbox forwarder event list pagination (optional, default to 0)
int? size

Optional page size in inbox forwarder 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
PageInboxForwarderEvents

PageInboxForwarderEvents
Exceptions
Type Condition
ApiException

Thrown when fails to make API call
View Source

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

Get an inbox forwarder event list Get inbox forwarder events

Declaration
public Task<PageInboxForwarderEvents> GetInboxForwarderEventsAsync(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 forwarder
int? page

Optional page index in inbox forwarder event list pagination (optional, default to 0)
int? size

Optional page size in inbox forwarder 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<PageInboxForwarderEvents>

Task of PageInboxForwarderEvents
Exceptions
Type Condition
ApiException

Thrown when fails to make API call
View Source

GetInboxForwarderEventsWithHttpInfo(Guid, int?, int?, string, int)

Get an inbox forwarder event list Get inbox forwarder events

Declaration
public ApiResponse<PageInboxForwarderEvents> GetInboxForwarderEventsWithHttpInfo(Guid id, int? page = null, int? size = null, string sort = null, int operationIndex = 0)
Parameters
Type Name Description
Guid id

ID of inbox forwarder
int? page

Optional page index in inbox forwarder event list pagination (optional, default to 0)
int? size

Optional page size in inbox forwarder 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<PageInboxForwarderEvents>

ApiResponse of PageInboxForwarderEvents
Exceptions
Type Condition
ApiException

Thrown when fails to make API call
View Source

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

Get an inbox forwarder event list Get inbox forwarder events

Declaration
public Task<ApiResponse<PageInboxForwarderEvents>> GetInboxForwarderEventsWithHttpInfoAsync(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 forwarder
int? page

Optional page index in inbox forwarder event list pagination (optional, default to 0)
int? size

Optional page size in inbox forwarder 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<PageInboxForwarderEvents>>

Task of ApiResponse (PageInboxForwarderEvents)
Exceptions
Type Condition
ApiException

Thrown when fails to make API call
View Source

GetInboxForwarderWithHttpInfo(Guid, int)

Get an inbox forwarder Get inbox forwarder

Declaration
public ApiResponse<InboxForwarderDto> GetInboxForwarderWithHttpInfo(Guid id, int operationIndex = 0)
Parameters
Type Name Description
Guid id

ID of inbox forwarder
int operationIndex

Index associated with the operation.
Returns
Type Description
ApiResponse<InboxForwarderDto>

ApiResponse of InboxForwarderDto
Exceptions
Type Condition
ApiException

Thrown when fails to make API call
View Source

GetInboxForwarderWithHttpInfoAsync(Guid, int, CancellationToken)

Get an inbox forwarder Get inbox forwarder

Declaration
public Task<ApiResponse<InboxForwarderDto>> GetInboxForwarderWithHttpInfoAsync(Guid id, int operationIndex = 0, CancellationToken cancellationToken = default)
Parameters
Type Name Description
Guid id

ID of inbox forwarder
int operationIndex

Index associated with the operation.
CancellationToken cancellationToken

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

Task of ApiResponse (InboxForwarderDto)
Exceptions
Type Condition
ApiException

Thrown when fails to make API call
View Source

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

List inbox forwarders List all forwarders attached to an inbox

Declaration
public PageInboxForwarderDto GetInboxForwarders(Guid? inboxId = null, int? page = null, int? size = null, string sort = null, string searchFilter = null, DateTime? since = null, DateTime? before = null, int operationIndex = 0)
Parameters
Type Name Description
Guid? inboxId

Optional inbox id to get forwarders from (optional)
int? page

Optional page index in inbox forwarder list pagination (optional, default to 0)
int? size

Optional page size in inbox forwarder list pagination (optional, default to 20)
string sort

Optional createdAt sort direction ASC or DESC (optional, default to ASC)
string searchFilter

Optional search filter (optional)
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
PageInboxForwarderDto

PageInboxForwarderDto
Exceptions
Type Condition
ApiException

Thrown when fails to make API call
View Source

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

List inbox forwarders List all forwarders attached to an inbox

Declaration
public Task<PageInboxForwarderDto> GetInboxForwardersAsync(Guid? inboxId = null, int? page = null, int? size = null, string sort = null, string searchFilter = null, DateTime? since = null, DateTime? before = null, int operationIndex = 0, CancellationToken cancellationToken = default)
Parameters
Type Name Description
Guid? inboxId

Optional inbox id to get forwarders from (optional)
int? page

Optional page index in inbox forwarder list pagination (optional, default to 0)
int? size

Optional page size in inbox forwarder list pagination (optional, default to 20)
string sort

Optional createdAt sort direction ASC or DESC (optional, default to ASC)
string searchFilter

Optional search filter (optional)
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<PageInboxForwarderDto>

Task of PageInboxForwarderDto
Exceptions
Type Condition
ApiException

Thrown when fails to make API call
View Source

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

List inbox forwarders List all forwarders attached to an inbox

Declaration
public ApiResponse<PageInboxForwarderDto> GetInboxForwardersWithHttpInfo(Guid? inboxId = null, int? page = null, int? size = null, string sort = null, string searchFilter = null, DateTime? since = null, DateTime? before = null, int operationIndex = 0)
Parameters
Type Name Description
Guid? inboxId

Optional inbox id to get forwarders from (optional)
int? page

Optional page index in inbox forwarder list pagination (optional, default to 0)
int? size

Optional page size in inbox forwarder list pagination (optional, default to 20)
string sort

Optional createdAt sort direction ASC or DESC (optional, default to ASC)
string searchFilter

Optional search filter (optional)
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<PageInboxForwarderDto>

ApiResponse of PageInboxForwarderDto
Exceptions
Type Condition
ApiException

Thrown when fails to make API call
View Source

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

List inbox forwarders List all forwarders attached to an inbox

Declaration
public Task<ApiResponse<PageInboxForwarderDto>> GetInboxForwardersWithHttpInfoAsync(Guid? inboxId = null, int? page = null, int? size = null, string sort = null, string searchFilter = null, DateTime? since = null, DateTime? before = null, int operationIndex = 0, CancellationToken cancellationToken = default)
Parameters
Type Name Description
Guid? inboxId

Optional inbox id to get forwarders from (optional)
int? page

Optional page index in inbox forwarder list pagination (optional, default to 0)
int? size

Optional page size in inbox forwarder list pagination (optional, default to 20)
string sort

Optional createdAt sort direction ASC or DESC (optional, default to ASC)
string searchFilter

Optional search filter (optional)
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<PageInboxForwarderDto>>

Task of ApiResponse (PageInboxForwarderDto)
Exceptions
Type Condition
ApiException

Thrown when fails to make API call
View Source

TestInboxForwarder(Guid, InboxForwarderTestOptions, int)

Test an inbox forwarder Test an inbox forwarder

Declaration
public InboxForwarderTestResult TestInboxForwarder(Guid id, InboxForwarderTestOptions inboxForwarderTestOptions, int operationIndex = 0)
Parameters
Type Name Description
Guid id

ID of inbox forwarder
InboxForwarderTestOptions inboxForwarderTestOptions
int operationIndex

Index associated with the operation.
Returns
Type Description
InboxForwarderTestResult

InboxForwarderTestResult
Exceptions
Type Condition
ApiException

Thrown when fails to make API call
View Source

TestInboxForwarderAsync(Guid, InboxForwarderTestOptions, int, CancellationToken)

Test an inbox forwarder Test an inbox forwarder

Declaration
public Task<InboxForwarderTestResult> TestInboxForwarderAsync(Guid id, InboxForwarderTestOptions inboxForwarderTestOptions, int operationIndex = 0, CancellationToken cancellationToken = default)
Parameters
Type Name Description
Guid id

ID of inbox forwarder
InboxForwarderTestOptions inboxForwarderTestOptions
int operationIndex

Index associated with the operation.
CancellationToken cancellationToken

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

Task of InboxForwarderTestResult
Exceptions
Type Condition
ApiException

Thrown when fails to make API call
View Source

TestInboxForwarderWithHttpInfo(Guid, InboxForwarderTestOptions, int)

Test an inbox forwarder Test an inbox forwarder

Declaration
public ApiResponse<InboxForwarderTestResult> TestInboxForwarderWithHttpInfo(Guid id, InboxForwarderTestOptions inboxForwarderTestOptions, int operationIndex = 0)
Parameters
Type Name Description
Guid id

ID of inbox forwarder
InboxForwarderTestOptions inboxForwarderTestOptions
int operationIndex

Index associated with the operation.
Returns
Type Description
ApiResponse<InboxForwarderTestResult>

ApiResponse of InboxForwarderTestResult
Exceptions
Type Condition
ApiException

Thrown when fails to make API call
View Source

TestInboxForwarderWithHttpInfoAsync(Guid, InboxForwarderTestOptions, int, CancellationToken)

Test an inbox forwarder Test an inbox forwarder

Declaration
public Task<ApiResponse<InboxForwarderTestResult>> TestInboxForwarderWithHttpInfoAsync(Guid id, InboxForwarderTestOptions inboxForwarderTestOptions, int operationIndex = 0, CancellationToken cancellationToken = default)
Parameters
Type Name Description
Guid id

ID of inbox forwarder
InboxForwarderTestOptions inboxForwarderTestOptions
int operationIndex

Index associated with the operation.
CancellationToken cancellationToken

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

Task of ApiResponse (InboxForwarderTestResult)
Exceptions
Type Condition
ApiException

Thrown when fails to make API call
View Source

TestInboxForwardersForInbox(Guid, InboxForwarderTestOptions, int)

Test inbox forwarders for inbox Test inbox forwarders for inbox

Declaration
public InboxForwarderTestResult TestInboxForwardersForInbox(Guid inboxId, InboxForwarderTestOptions inboxForwarderTestOptions, int operationIndex = 0)
Parameters
Type Name Description
Guid inboxId

ID of inbox
InboxForwarderTestOptions inboxForwarderTestOptions
int operationIndex

Index associated with the operation.
Returns
Type Description
InboxForwarderTestResult

InboxForwarderTestResult
Exceptions
Type Condition
ApiException

Thrown when fails to make API call
View Source

TestInboxForwardersForInboxAsync(Guid, InboxForwarderTestOptions, int, CancellationToken)

Test inbox forwarders for inbox Test inbox forwarders for inbox

Declaration
public Task<InboxForwarderTestResult> TestInboxForwardersForInboxAsync(Guid inboxId, InboxForwarderTestOptions inboxForwarderTestOptions, int operationIndex = 0, CancellationToken cancellationToken = default)
Parameters
Type Name Description
Guid inboxId

ID of inbox
InboxForwarderTestOptions inboxForwarderTestOptions
int operationIndex

Index associated with the operation.
CancellationToken cancellationToken

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

Task of InboxForwarderTestResult
Exceptions
Type Condition
ApiException

Thrown when fails to make API call
View Source

TestInboxForwardersForInboxWithHttpInfo(Guid, InboxForwarderTestOptions, int)

Test inbox forwarders for inbox Test inbox forwarders for inbox

Declaration
public ApiResponse<InboxForwarderTestResult> TestInboxForwardersForInboxWithHttpInfo(Guid inboxId, InboxForwarderTestOptions inboxForwarderTestOptions, int operationIndex = 0)
Parameters
Type Name Description
Guid inboxId

ID of inbox
InboxForwarderTestOptions inboxForwarderTestOptions
int operationIndex

Index associated with the operation.
Returns
Type Description
ApiResponse<InboxForwarderTestResult>

ApiResponse of InboxForwarderTestResult
Exceptions
Type Condition
ApiException

Thrown when fails to make API call
View Source

TestInboxForwardersForInboxWithHttpInfoAsync(Guid, InboxForwarderTestOptions, int, CancellationToken)

Test inbox forwarders for inbox Test inbox forwarders for inbox

Declaration
public Task<ApiResponse<InboxForwarderTestResult>> TestInboxForwardersForInboxWithHttpInfoAsync(Guid inboxId, InboxForwarderTestOptions inboxForwarderTestOptions, int operationIndex = 0, CancellationToken cancellationToken = default)
Parameters
Type Name Description
Guid inboxId

ID of inbox
InboxForwarderTestOptions inboxForwarderTestOptions
int operationIndex

Index associated with the operation.
CancellationToken cancellationToken

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

Task of ApiResponse (InboxForwarderTestResult)
Exceptions
Type Condition
ApiException

Thrown when fails to make API call
View Source

TestNewInboxForwarder(TestNewInboxForwarderOptions, int)

Test new inbox forwarder Test new inbox forwarder

Declaration
public InboxForwarderTestResult TestNewInboxForwarder(TestNewInboxForwarderOptions testNewInboxForwarderOptions, int operationIndex = 0)
Parameters
Type Name Description
TestNewInboxForwarderOptions testNewInboxForwarderOptions
int operationIndex

Index associated with the operation.
Returns
Type Description
InboxForwarderTestResult

InboxForwarderTestResult
Exceptions
Type Condition
ApiException

Thrown when fails to make API call
View Source

TestNewInboxForwarderAsync(TestNewInboxForwarderOptions, int, CancellationToken)

Test new inbox forwarder Test new inbox forwarder

Declaration
public Task<InboxForwarderTestResult> TestNewInboxForwarderAsync(TestNewInboxForwarderOptions testNewInboxForwarderOptions, int operationIndex = 0, CancellationToken cancellationToken = default)
Parameters
Type Name Description
TestNewInboxForwarderOptions testNewInboxForwarderOptions
int operationIndex

Index associated with the operation.
CancellationToken cancellationToken

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

Task of InboxForwarderTestResult
Exceptions
Type Condition
ApiException

Thrown when fails to make API call
View Source

TestNewInboxForwarderWithHttpInfo(TestNewInboxForwarderOptions, int)

Test new inbox forwarder Test new inbox forwarder

Declaration
public ApiResponse<InboxForwarderTestResult> TestNewInboxForwarderWithHttpInfo(TestNewInboxForwarderOptions testNewInboxForwarderOptions, int operationIndex = 0)
Parameters
Type Name Description
TestNewInboxForwarderOptions testNewInboxForwarderOptions
int operationIndex

Index associated with the operation.
Returns
Type Description
ApiResponse<InboxForwarderTestResult>

ApiResponse of InboxForwarderTestResult
Exceptions
Type Condition
ApiException

Thrown when fails to make API call
View Source

TestNewInboxForwarderWithHttpInfoAsync(TestNewInboxForwarderOptions, int, CancellationToken)

Test new inbox forwarder Test new inbox forwarder

Declaration
public Task<ApiResponse<InboxForwarderTestResult>> TestNewInboxForwarderWithHttpInfoAsync(TestNewInboxForwarderOptions testNewInboxForwarderOptions, int operationIndex = 0, CancellationToken cancellationToken = default)
Parameters
Type Name Description
TestNewInboxForwarderOptions testNewInboxForwarderOptions
int operationIndex

Index associated with the operation.
CancellationToken cancellationToken

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

Task of ApiResponse (InboxForwarderTestResult)
Exceptions
Type Condition
ApiException

Thrown when fails to make API call
View Source

UpdateInboxForwarder(Guid, CreateInboxForwarderOptions, int)

Update an inbox forwarder Update inbox forwarder

Declaration
public InboxForwarderDto UpdateInboxForwarder(Guid id, CreateInboxForwarderOptions createInboxForwarderOptions, int operationIndex = 0)
Parameters
Type Name Description
Guid id

ID of inbox forwarder
CreateInboxForwarderOptions createInboxForwarderOptions
int operationIndex

Index associated with the operation.
Returns
Type Description
InboxForwarderDto

InboxForwarderDto
Exceptions
Type Condition
ApiException

Thrown when fails to make API call
View Source

UpdateInboxForwarderAsync(Guid, CreateInboxForwarderOptions, int, CancellationToken)

Update an inbox forwarder Update inbox forwarder

Declaration
public Task<InboxForwarderDto> UpdateInboxForwarderAsync(Guid id, CreateInboxForwarderOptions createInboxForwarderOptions, int operationIndex = 0, CancellationToken cancellationToken = default)
Parameters
Type Name Description
Guid id

ID of inbox forwarder
CreateInboxForwarderOptions createInboxForwarderOptions
int operationIndex

Index associated with the operation.
CancellationToken cancellationToken

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

Task of InboxForwarderDto
Exceptions
Type Condition
ApiException

Thrown when fails to make API call
View Source

UpdateInboxForwarderWithHttpInfo(Guid, CreateInboxForwarderOptions, int)

Update an inbox forwarder Update inbox forwarder

Declaration
public ApiResponse<InboxForwarderDto> UpdateInboxForwarderWithHttpInfo(Guid id, CreateInboxForwarderOptions createInboxForwarderOptions, int operationIndex = 0)
Parameters
Type Name Description
Guid id

ID of inbox forwarder
CreateInboxForwarderOptions createInboxForwarderOptions
int operationIndex

Index associated with the operation.
Returns
Type Description
ApiResponse<InboxForwarderDto>

ApiResponse of InboxForwarderDto
Exceptions
Type Condition
ApiException

Thrown when fails to make API call
View Source

UpdateInboxForwarderWithHttpInfoAsync(Guid, CreateInboxForwarderOptions, int, CancellationToken)

Update an inbox forwarder Update inbox forwarder

Declaration
public Task<ApiResponse<InboxForwarderDto>> UpdateInboxForwarderWithHttpInfoAsync(Guid id, CreateInboxForwarderOptions createInboxForwarderOptions, int operationIndex = 0, CancellationToken cancellationToken = default)
Parameters
Type Name Description
Guid id

ID of inbox forwarder
CreateInboxForwarderOptions createInboxForwarderOptions
int operationIndex

Index associated with the operation.
CancellationToken cancellationToken

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

Task of ApiResponse (InboxForwarderDto)
Exceptions
Type Condition
ApiException

Thrown when fails to make API call

Implements