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  $domain, \ElasticEmailEnums\TrackingType  $trackingType = \ElasticEmailEnums\TrackingType::Http) 

Add new domain to account

Parameters

string $domain

Name of selected domain.

\ElasticEmailEnums\TrackingType $trackingType

EEDelete()

EEDelete(string  $domain) 

Deletes configured domain from account

Parameters

string $domain

Name of selected domain.

EEList()

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

Lists all domains configured for this account.

Returns

\ElasticEmailApi\Array<\ElasticEmailEnums\DomainDetail>

SetDefault()

SetDefault(string  $domain) 

Verification of email addres set for domain.

Parameters

string $domain

Default email sender, example: mail@yourdomain.com

VerifyDkim()

VerifyDkim(string  $domain) : string

Verification of DKIM record for domain

Parameters

string $domain

Name of selected domain.

Returns

string

VerifyMX()

VerifyMX(string  $domain) : string

Verification of MX record for domain

Parameters

string $domain

Name of selected domain.

Returns

string

VerifySpf()

VerifySpf(string  $domain) : string

Verification of SPF record for domain

Parameters

string $domain

Name of selected domain.

Returns

string

VerifyTracking()

VerifyTracking(string  $domain, \ElasticEmailEnums\TrackingType  $trackingType = \ElasticEmailEnums\TrackingType::Http) : string

Verification of tracking CNAME record for domain

Parameters

string $domain

Name of selected domain.

\ElasticEmailEnums\TrackingType $trackingType

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