ExportControllerApi
All URIs are relative to https://api.mailslurp.com
Method | HTTP request | Description |
---|---|---|
exportEntities | GET /export | Export inboxes link callable via browser |
getExportLink | POST /export | Get export link |
List
exportEntities(exportType, apiKey, outputFormat, filter, listSeparatorToken, excludePreviouslyExported, createdEarliestTime, createdOldestTime)
Export inboxes link callable via browser
Example
// Import classes:
import com.mailslurp.clients.ApiClient;
import com.mailslurp.clients.ApiException;
import com.mailslurp.clients.Configuration;
import com.mailslurp.clients.auth.*;
import com.mailslurp.clients.models.*;
import com.mailslurp.apis.ExportControllerApi;
public class Example {
public static void main(String[] args) {
ApiClient defaultClient = Configuration.getDefaultApiClient();
defaultClient.setBasePath("https://api.mailslurp.com");
// Configure API key authorization: API_KEY
ApiKeyAuth API_KEY = (ApiKeyAuth) defaultClient.getAuthentication("API_KEY");
API_KEY.setApiKey("YOUR API KEY");
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//API_KEY.setApiKeyPrefix("Token");
ExportControllerApi apiInstance = new ExportControllerApi(defaultClient);
String exportType = "exportType_example"; // String |
String apiKey = "apiKey_example"; // String |
String outputFormat = "outputFormat_example"; // String |
String filter = "filter_example"; // String |
String listSeparatorToken = "listSeparatorToken_example"; // String |
Boolean excludePreviouslyExported = true; // Boolean |
OffsetDateTime createdEarliestTime = new OffsetDateTime(); // OffsetDateTime |
OffsetDateTime createdOldestTime = new OffsetDateTime(); // OffsetDateTime |
try {
List<byte[]> result = apiInstance.exportEntities(exportType, apiKey, outputFormat, filter, listSeparatorToken, excludePreviouslyExported, createdEarliestTime, createdOldestTime);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling ExportControllerApi#exportEntities");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}
Parameters
Name | Type | Description | Notes |
---|---|---|---|
exportType | String | [enum: INBOXES, CONTACTS, ATTACHMENTS, EMAILS] | |
apiKey | String | ||
outputFormat | String | [enum: CSV_DEFAULT, CSV_EXCEL] | |
filter | String | [optional] | |
listSeparatorToken | String | [optional] | |
excludePreviouslyExported | Boolean | [optional] | |
createdEarliestTime | OffsetDateTime | [optional] | |
createdOldestTime | OffsetDateTime | [optional] |
Return type
List
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: /
HTTP response details
Status code | Description | Response headers |
---|---|---|
200 | OK | - |
ExportLink getExportLink(exportType, exportOptions, apiKey)
Get export link
Example
// Import classes:
import com.mailslurp.clients.ApiClient;
import com.mailslurp.clients.ApiException;
import com.mailslurp.clients.Configuration;
import com.mailslurp.clients.auth.*;
import com.mailslurp.clients.models.*;
import com.mailslurp.apis.ExportControllerApi;
public class Example {
public static void main(String[] args) {
ApiClient defaultClient = Configuration.getDefaultApiClient();
defaultClient.setBasePath("https://api.mailslurp.com");
// Configure API key authorization: API_KEY
ApiKeyAuth API_KEY = (ApiKeyAuth) defaultClient.getAuthentication("API_KEY");
API_KEY.setApiKey("YOUR API KEY");
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//API_KEY.setApiKeyPrefix("Token");
ExportControllerApi apiInstance = new ExportControllerApi(defaultClient);
String exportType = "exportType_example"; // String |
ExportOptions exportOptions = new ExportOptions(); // ExportOptions |
String apiKey = "apiKey_example"; // String |
try {
ExportLink result = apiInstance.getExportLink(exportType, exportOptions, apiKey);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling ExportControllerApi#getExportLink");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}
Parameters
Name | Type | Description | Notes |
---|---|---|---|
exportType | String | [enum: INBOXES, CONTACTS, ATTACHMENTS, EMAILS] | |
exportOptions | ExportOptions | ||
apiKey | String | [optional] |
Return type
Authorization
HTTP request headers
- Content-Type: application/json
- Accept: /
HTTP response details
Status code | Description | Response headers |
---|---|---|
200 | OK | - |