API Documentation
\
ElasticEmailApi
ElasticEmailClient
ElasticEmailEnums

\ElasticEmailApiChannel

Summary

Methods
Properties
Constants
__construct()
setHttpClient()
getHttpClient()
setConfiguration()
getConfiguration()
Add()
EEDelete()
ExportCsv()
ExportJson()
ExportXml()
EEList()
Update()
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

Add()

Add(string  $name) : string

Manually add a channel to your account to group email

Parameters

string $name

Descriptive name of the channel

Returns

string

EEDelete()

EEDelete(string  $name)

Delete the channel.

Parameters

string $name

The name of the channel to delete.

ExportCsv()

ExportCsv(\ElasticEmailApi\array<string>  $channelNames, \ElasticEmailEnums\CompressionFormat  $compressionFormat = \ElasticEmailEnums\CompressionFormat::None, string  $fileName = null) : \ElasticEmailApi\File

Export channels in CSV file format.

Parameters

\ElasticEmailApi\array $channelNames

List of channel names used for processing
\ElasticEmailEnums\CompressionFormat $compressionFormat

FileResponse compression format. None or Zip.
string $fileName

Name of your file.

Returns

\ElasticEmailApi\File

ExportJson()

ExportJson(\ElasticEmailApi\array<string>  $channelNames, \ElasticEmailEnums\CompressionFormat  $compressionFormat = \ElasticEmailEnums\CompressionFormat::None, string  $fileName = null) : \ElasticEmailApi\File

Export channels in JSON file format.

Parameters

\ElasticEmailApi\array $channelNames

List of channel names used for processing
\ElasticEmailEnums\CompressionFormat $compressionFormat

FileResponse compression format. None or Zip.
string $fileName

Name of your file.

Returns

\ElasticEmailApi\File

ExportXml()

ExportXml(\ElasticEmailApi\array<string>  $channelNames, \ElasticEmailEnums\CompressionFormat  $compressionFormat = \ElasticEmailEnums\CompressionFormat::None, string  $fileName = null) : \ElasticEmailApi\File

Export channels in XML file format.

Parameters

\ElasticEmailApi\array $channelNames

List of channel names used for processing
\ElasticEmailEnums\CompressionFormat $compressionFormat

FileResponse compression format. None or Zip.
string $fileName

Name of your file.

Returns

\ElasticEmailApi\File

EEList()

EEList() : \ElasticEmailApi\Array<\ElasticEmailEnums\Channel>

List all of your channels

Returns

\ElasticEmailApi\Array<\ElasticEmailEnums\Channel>

Update()

Update(string  $name, string  $newName) : string

Rename an existing channel.

Parameters

string $name

The name of the channel to update.
string $newName

The new name for the channel.

Returns

string

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