Interface IExportControllerApiAsync

Represents a collection of functions to interact with the API endpoints

Inherited Members
Namespace: mailslurp.Api
Assembly: mailslurp.dll
Syntax
public interface IExportControllerApiAsync : IApiAccessor

Methods

View Source

ExportEntitiesAsync(string, string, string, string, string, bool?, DateTime?, DateTime?, int, CancellationToken)

Export inboxes link callable via browser

Declaration
Task<byte[]> ExportEntitiesAsync(string exportType, string apiKey, string outputFormat, string filter = null, string listSeparatorToken = null, bool? excludePreviouslyExported = null, DateTime? createdEarliestTime = null, DateTime? createdOldestTime = null, int operationIndex = 0, CancellationToken cancellationToken = default)
Parameters
Type Name Description
string exportType
string apiKey
string outputFormat
string filter

(optional)
string listSeparatorToken

(optional)
bool? excludePreviouslyExported

(optional)
DateTime? createdEarliestTime

(optional)
DateTime? createdOldestTime

(optional)
int operationIndex

Index associated with the operation.
CancellationToken cancellationToken

Cancellation Token to cancel the request.
Returns
Type Description
Task<byte[]>

Task of byte[]
Exceptions
Type Condition
ApiException

Thrown when fails to make API call
View Source

ExportEntitiesWithHttpInfoAsync(string, string, string, string, string, bool?, DateTime?, DateTime?, int, CancellationToken)

Export inboxes link callable via browser

Declaration
Task<ApiResponse<byte[]>> ExportEntitiesWithHttpInfoAsync(string exportType, string apiKey, string outputFormat, string filter = null, string listSeparatorToken = null, bool? excludePreviouslyExported = null, DateTime? createdEarliestTime = null, DateTime? createdOldestTime = null, int operationIndex = 0, CancellationToken cancellationToken = default)
Parameters
Type Name Description
string exportType
string apiKey
string outputFormat
string filter

(optional)
string listSeparatorToken

(optional)
bool? excludePreviouslyExported

(optional)
DateTime? createdEarliestTime

(optional)
DateTime? createdOldestTime

(optional)
int operationIndex

Index associated with the operation.
CancellationToken cancellationToken

Cancellation Token to cancel the request.
Returns
Type Description
Task<ApiResponse<byte[]>>

Task of ApiResponse (byte[])
Exceptions
Type Condition
ApiException

Thrown when fails to make API call
View Source

GetExportLinkAsync(string, ExportOptions, string, int, CancellationToken)

Get export link

Declaration
Task<ExportLink> GetExportLinkAsync(string exportType, ExportOptions exportOptions, string apiKey = null, int operationIndex = 0, CancellationToken cancellationToken = default)
Parameters
Type Name Description
string exportType
ExportOptions exportOptions
string apiKey

(optional)
int operationIndex

Index associated with the operation.
CancellationToken cancellationToken

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

Task of ExportLink
Exceptions
Type Condition
ApiException

Thrown when fails to make API call
View Source

GetExportLinkWithHttpInfoAsync(string, ExportOptions, string, int, CancellationToken)

Get export link

Declaration
Task<ApiResponse<ExportLink>> GetExportLinkWithHttpInfoAsync(string exportType, ExportOptions exportOptions, string apiKey = null, int operationIndex = 0, CancellationToken cancellationToken = default)
Parameters
Type Name Description
string exportType
ExportOptions exportOptions
string apiKey

(optional)
int operationIndex

Index associated with the operation.
CancellationToken cancellationToken

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

Task of ApiResponse (ExportLink)
Exceptions
Type Condition
ApiException

Thrown when fails to make API call