API Documentation
\
ElasticEmailApi
ElasticEmailClient
ElasticEmailEnums

\ElasticEmailApiFile

Summary

Methods
Properties
Constants
__construct()
setHttpClient()
getHttpClient()
setConfiguration()
getConfiguration()
EEDelete()
Download()
EEList()
ListAll()
Load()
Upload()
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

EEDelete()

EEDelete(\ElasticEmailApi\?int  $fileID = null, string  $filename = null)

Permanently deletes the file from your account

Parameters

\ElasticEmailApi\?int $fileID
string $filename

Name of your file.

Download()

Download(string  $filename = null, \ElasticEmailApi\?int  $fileID = null) : \ElasticEmailApi\File

Gets content of the chosen File

Parameters

string $filename

Name of your file.
\ElasticEmailApi\?int $fileID

Returns

\ElasticEmailApi\File

EEList()

EEList(string  $msgID) : \ElasticEmailApi\Array<\ElasticEmailEnums\File>

Lists your available Attachments in the given email

Parameters

string $msgID

ID number of selected message.

Returns

\ElasticEmailApi\Array<\ElasticEmailEnums\File>

ListAll()

ListAll() : \ElasticEmailApi\Array<\ElasticEmailEnums\File>

Lists all your available files

Returns

\ElasticEmailApi\Array<\ElasticEmailEnums\File>

Load()

Load(string  $filename) : \ElasticEmailEnums\File

Gets chosen File

Parameters

string $filename

Name of your file.

Returns

\ElasticEmailEnums\File

Upload()

Upload(\ElasticEmailApi\File  $file, string  $name = null, \ElasticEmailApi\?int  $expiresAfterDays = 35) : \ElasticEmailEnums\File

Uploads selected file to the server using http form upload format (MIME multipart/form-data) or PUT method.

Parameters

\ElasticEmailApi\File $file
string $name

Filename
\ElasticEmailApi\?int $expiresAfterDays

After how many days should the file be deleted.

Returns

\ElasticEmailEnums\File

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