Interface IExportControllerApiSync

Represents a collection of functions to interact with the API endpoints

Inherited Members

IApiAccessor.Configuration

IApiAccessor.GetBasePath()

IApiAccessor.ExceptionFactory

Namespace: mailslurp.Api

Assembly: mailslurp.dll

Syntax

public interface IExportControllerApiSync : IApiAccessor

Methods

ExportEntities(string, string, string, string, string, bool?, DateTime?, DateTime?, int)

Export inboxes link callable via browser

Declaration

byte[] ExportEntities(string exportType, string apiKey, string outputFormat, string filter = null, string listSeparatorToken = null, bool? excludePreviouslyExported = null, DateTime? createdEarliestTime = null, DateTime? createdOldestTime = null, int operationIndex = 0)

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.

Returns

Type	Description
byte[]	byte[]

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

ExportEntitiesWithHttpInfo(string, string, string, string, string, bool?, DateTime?, DateTime?, int)

Export inboxes link callable via browser

Declaration

ApiResponse<byte[]> ExportEntitiesWithHttpInfo(string exportType, string apiKey, string outputFormat, string filter = null, string listSeparatorToken = null, bool? excludePreviouslyExported = null, DateTime? createdEarliestTime = null, DateTime? createdOldestTime = null, int operationIndex = 0)

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.

Returns

Type	Description
ApiResponse<byte[]>	ApiResponse of byte[]

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

GetExportLink(string, ExportOptions, string, int)

Get export link

Declaration

ExportLink GetExportLink(string exportType, ExportOptions exportOptions, string apiKey = null, int operationIndex = 0)

Parameters

Type	Name	Description
string	exportType
ExportOptions	exportOptions
string	apiKey	(optional)
int	operationIndex	Index associated with the operation.

Returns

Type	Description
ExportLink	ExportLink

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

GetExportLinkWithHttpInfo(string, ExportOptions, string, int)

Get export link

Declaration

ApiResponse<ExportLink> GetExportLinkWithHttpInfo(string exportType, ExportOptions exportOptions, string apiKey = null, int operationIndex = 0)

Parameters

Type	Name	Description
string	exportType
ExportOptions	exportOptions
string	apiKey	(optional)
int	operationIndex	Index associated with the operation.

Returns

Type	Description
ApiResponse<ExportLink>	ApiResponse of ExportLink

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call