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

Add()

Add(\ElasticEmailEnums\Campaign  $campaign) : integer

Adds a campaign to the queue for processing based on the configuration

Parameters

\ElasticEmailEnums\Campaign $campaign

Json representation of a campaign

Returns

integer

EECopy()

EECopy(integer  $channelID) : integer

Copy selected campaign

Parameters

integer $channelID

ID number of selected Channel.

Returns

integer

EEDelete()

EEDelete(integer  $channelID) 

Delete selected campaign

Parameters

integer $channelID

ID number of selected Channel.

Export()

Export(\ElasticEmailApi\array<int>  $channelIDs = array(), \ElasticEmailEnums\ExportFileFormats  $fileFormat = \ElasticEmailEnums\ExportFileFormats::Csv, \ElasticEmailEnums\CompressionFormat  $compressionFormat = \ElasticEmailEnums\CompressionFormat::None, string  $fileName = null) : \ElasticEmailEnums\ExportLink

Export selected campaigns to chosen file format.

Parameters

\ElasticEmailApi\array $channelIDs

List of campaign IDs used for processing

\ElasticEmailEnums\ExportFileFormats $fileFormat

Format of the exported file

\ElasticEmailEnums\CompressionFormat $compressionFormat

FileResponse compression format. None or Zip.

string $fileName

Name of your file.

Returns

\ElasticEmailEnums\ExportLink

EEList()

EEList(string  $search = null, integer  $offset, integer  $limit) : \ElasticEmailApi\Array<\ElasticEmailEnums\CampaignChannel>

List all of your campaigns

Parameters

string $search

Text fragment used for searching.

integer $offset

How many items should be loaded ahead.

integer $limit

Maximum of loaded items.

Returns

\ElasticEmailApi\Array<\ElasticEmailEnums\CampaignChannel>

Update()

Update(\ElasticEmailEnums\Campaign  $campaign) : integer

Updates a previously added campaign. Only Active and Paused campaigns can be updated.

Parameters

\ElasticEmailEnums\Campaign $campaign

Json representation of a campaign

Returns

integer

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