API Documentation
\
ElasticEmailApi
ElasticEmailClient
ElasticEmailEnums

\ElasticEmailApiExport

Summary

Methods
Properties
Constants
__construct()
setHttpClient()
getHttpClient()
setConfiguration()
getConfiguration()
CheckStatus()
CountByType()
EEDelete()
EEList()
No public properties found
No constants found
sendRequest()
$configuration
N/A
parseMultipart()
$httpClient
N/A

Properties

$configuration

$configuration : \ElasticEmailClient\ApiConfiguration

Type

\ElasticEmailClient\ApiConfiguration — ApiConfiguration

$httpClient

$httpClient : \GuzzleHttp\ClientInterface

Type

\GuzzleHttp\ClientInterface

Methods

__construct()

__construct(\ElasticEmailClient\ApiConfiguration  $apiConfiguration)

Parameters

\ElasticEmailClient\ApiConfiguration $apiConfiguration

setHttpClient()

setHttpClient(  $client)

Parameters

$client

getHttpClient()

getHttpClient() : \GuzzleHttp\ClientInterface

Returns

\GuzzleHttp\ClientInterface

setConfiguration()

setConfiguration(\ElasticEmailClient\ApiConfiguration  $config) : $this

Parameters

\ElasticEmailClient\ApiConfiguration $config

Returns

$this

getConfiguration()

getConfiguration() : \ElasticEmailClient\ApiConfiguration

Returns

\ElasticEmailClient\ApiConfiguration

CheckStatus()

CheckStatus(\ElasticEmailApi\Guid  $publicExportID) : \ElasticEmailEnums\ExportStatus

Check the current status of the export.

Parameters

\ElasticEmailApi\Guid $publicExportID

Returns

\ElasticEmailEnums\ExportStatus

EEDelete()

EEDelete(\ElasticEmailApi\Guid  $publicExportID)

Delete the specified export.

Parameters

\ElasticEmailApi\Guid $publicExportID

EEList()

EEList(integer  $limit, integer  $offset) : \ElasticEmailApi\Array<\ElasticEmailEnums\Export>

Returns a list of all exported data.

Parameters

integer $limit

Maximum of loaded items.
integer $offset

How many items should be loaded ahead.

Returns

\ElasticEmailApi\Array<\ElasticEmailEnums\Export>

sendRequest()

sendRequest(string  $url, array  $data = array(), string  $method = 'POST', array  $attachments = array()) : \Psr\Http\Message\ResponseInterface

Parameters

string $url
array $data
string $method
array $attachments

Throws

\Exception

Returns

\Psr\Http\Message\ResponseInterface

parseMultipart()

parseMultipart(array  $attachments, array  $params) : array

Parameters

array $attachments
array $params

Returns

array