\ElasticEmailApiLog

Summary

Methods

Properties

Constants

__construct()
setHttpClient()
getHttpClient()
setConfiguration()
getConfiguration()
CancelInProgress()
Export()
ExportLinkTracking()
LinkTracking()
Load()
LoadNotifications()
RetryNow()
Summary()

No public properties found

No constants found

sendRequest()

$configuration

N/A

parseMultipart()

$httpClient

N/A

File: ElasticEmailApi/Log.php
Package: Default
Class hierarchy: \ElasticEmailClient\ElasticRequest

\ElasticEmailApi\Log

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

CancelInProgress()

CancelInProgress(string  $channelName = null, string  $transactionID = null)

Cancels emails that are waiting to be sent.

Parameters

string	$channelName	Name of selected channel.
string	$transactionID	ID number of transaction

Export()

Export(\ElasticEmailApi\array<\ElasticEmailEnums\LogJobStatus>  $statuses, \ElasticEmailEnums\ExportFileFormats  $fileFormat = \ElasticEmailEnums\ExportFileFormats::Csv, \ElasticEmailApi\?DateTime  $from = null, \ElasticEmailApi\?DateTime  $to = null, string  $channelName = null, boolean  $includeEmail = true, boolean  $includeSms = true, \ElasticEmailApi\array<\ElasticEmailEnums\MessageCategory>  $messageCategory = array(), \ElasticEmailEnums\CompressionFormat  $compressionFormat = \ElasticEmailEnums\CompressionFormat::None, string  $fileName = null, string  $email = null) : \ElasticEmailEnums\ExportLink

Export email log information to the specified file format.

Parameters

\ElasticEmailApi\array<\ElasticEmailEnums\LogJobStatus>	$statuses	List of comma separated message statuses: 0 for all, 1 for ReadyToSend, 2 for InProgress, 4 for Bounced, 5 for Sent, 6 for Opened, 7 for Clicked, 8 for Unsubscribed, 9 for Abuse Report
\ElasticEmailEnums\ExportFileFormats	$fileFormat	Format of the exported file
\ElasticEmailApi\?DateTime	$from	Start date.
\ElasticEmailApi\?DateTime	$to	End date.
string	$channelName	Name of selected channel.
boolean	$includeEmail	True: Search includes emails. Otherwise, false.
boolean	$includeSms	True: Search includes SMS. Otherwise, false.
\ElasticEmailApi\array<\ElasticEmailEnums\MessageCategory>	$messageCategory	ID of message category
\ElasticEmailEnums\CompressionFormat	$compressionFormat	FileResponse compression format. None or Zip.
string	$fileName	Name of your file.
string	$email	Proper email address.

Returns

\ElasticEmailEnums\ExportLink

ExportLinkTracking()

ExportLinkTracking(\ElasticEmailApi\?DateTime  $from, \ElasticEmailApi\?DateTime  $to, string  $channelName = null, \ElasticEmailEnums\ExportFileFormats  $fileFormat = \ElasticEmailEnums\ExportFileFormats::Csv, integer  $limit, integer  $offset, \ElasticEmailEnums\CompressionFormat  $compressionFormat = \ElasticEmailEnums\CompressionFormat::None, string  $fileName = null) : \ElasticEmailEnums\ExportLink

Export detailed link tracking information to the specified file format.

Parameters

\ElasticEmailApi\?DateTime	$from	Starting date for search in YYYY-MM-DDThh:mm:ss format.
\ElasticEmailApi\?DateTime	$to	Ending date for search in YYYY-MM-DDThh:mm:ss format.
string	$channelName	Name of selected channel.
\ElasticEmailEnums\ExportFileFormats	$fileFormat	Format of the exported file
integer	$limit	Maximum of loaded items.
integer	$offset	How many items should be loaded ahead.
\ElasticEmailEnums\CompressionFormat	$compressionFormat	FileResponse compression format. None or Zip.
string	$fileName	Name of your file.

Returns

\ElasticEmailEnums\ExportLink

LinkTracking()

LinkTracking(\ElasticEmailApi\?DateTime  $from = null, \ElasticEmailApi\?DateTime  $to = null, integer  $limit, integer  $offset, string  $channelName = null) : \ElasticEmailEnums\LinkTrackingDetails

Track link clicks

Parameters

\ElasticEmailApi\?DateTime	$from	Starting date for search in YYYY-MM-DDThh:mm:ss format.
\ElasticEmailApi\?DateTime	$to	Ending date for search in YYYY-MM-DDThh:mm:ss format.
integer	$limit	Maximum of loaded items.
integer	$offset	How many items should be loaded ahead.
string	$channelName	Name of selected channel.

Returns

\ElasticEmailEnums\LinkTrackingDetails

Load()

Load(\ElasticEmailApi\array<\ElasticEmailEnums\LogJobStatus>  $statuses, \ElasticEmailApi\?DateTime  $from = null, \ElasticEmailApi\?DateTime  $to = null, string  $channelName = null, integer  $limit, integer  $offset, boolean  $includeEmail = true, boolean  $includeSms = true, \ElasticEmailApi\array<\ElasticEmailEnums\MessageCategory>  $messageCategory = array(), string  $email = null, boolean  $useStatusChangeDate = false) : \ElasticEmailEnums\Log

Returns logs filtered by specified parameters.

Parameters

\ElasticEmailApi\array<\ElasticEmailEnums\LogJobStatus>	$statuses	List of comma separated message statuses: 0 for all, 1 for ReadyToSend, 2 for InProgress, 4 for Bounced, 5 for Sent, 6 for Opened, 7 for Clicked, 8 for Unsubscribed, 9 for Abuse Report
\ElasticEmailApi\?DateTime	$from	Starting date for search in YYYY-MM-DDThh:mm:ss format.
\ElasticEmailApi\?DateTime	$to	Ending date for search in YYYY-MM-DDThh:mm:ss format.
string	$channelName	Name of selected channel.
integer	$limit	Maximum of loaded items.
integer	$offset	How many items should be loaded ahead.
boolean	$includeEmail	True: Search includes emails. Otherwise, false.
boolean	$includeSms	True: Search includes SMS. Otherwise, false.
\ElasticEmailApi\array<\ElasticEmailEnums\MessageCategory>	$messageCategory	ID of message category
string	$email	Proper email address.
boolean	$useStatusChangeDate	True, if 'from' and 'to' parameters should resolve to the Status Change date. To resolve to the creation date - false

Returns

\ElasticEmailEnums\Log

LoadNotifications()

LoadNotifications(\ElasticEmailApi\array<\ElasticEmailEnums\LogJobStatus>  $statuses, \ElasticEmailApi\?DateTime  $from = null, \ElasticEmailApi\?DateTime  $to = null, integer  $limit, integer  $offset, \ElasticEmailApi\array<\ElasticEmailEnums\MessageCategory>  $messageCategory = array(), boolean  $useStatusChangeDate = false, \ElasticEmailEnums\NotificationType  $notificationType = \ElasticEmailEnums\NotificationType::All) : \ElasticEmailEnums\Log

Returns notification logs filtered by specified parameters.

Parameters

\ElasticEmailApi\array<\ElasticEmailEnums\LogJobStatus>	$statuses	List of comma separated message statuses: 0 for all, 1 for ReadyToSend, 2 for InProgress, 4 for Bounced, 5 for Sent, 6 for Opened, 7 for Clicked, 8 for Unsubscribed, 9 for Abuse Report
\ElasticEmailApi\?DateTime	$from	Starting date for search in YYYY-MM-DDThh:mm:ss format.
\ElasticEmailApi\?DateTime	$to	Ending date for search in YYYY-MM-DDThh:mm:ss format.
integer	$limit	Maximum of loaded items.
integer	$offset	How many items should be loaded ahead.
\ElasticEmailApi\array<\ElasticEmailEnums\MessageCategory>	$messageCategory	ID of message category
boolean	$useStatusChangeDate	True, if 'from' and 'to' parameters should resolve to the Status Change date. To resolve to the creation date - false
\ElasticEmailEnums\NotificationType	$notificationType

Returns

\ElasticEmailEnums\Log

RetryNow()

RetryNow(string  $msgID)

Retry sending of temporarily not delivered message.

Parameters

string

$msgID

ID number of selected message.

Summary()

Summary(\ElasticEmailApi\DateTime  $from, \ElasticEmailApi\DateTime  $to, string  $channelName = null, \ElasticEmailEnums\IntervalType  $interval = \ElasticEmailEnums\IntervalType::Summary, string  $transactionID = null) : \ElasticEmailEnums\LogSummary

Loads summary information about activity in chosen date range.

Parameters

\ElasticEmailApi\DateTime	$from	Starting date for search in YYYY-MM-DDThh:mm:ss format.
\ElasticEmailApi\DateTime	$to	Ending date for search in YYYY-MM-DDThh:mm:ss format.
string	$channelName	Name of selected channel.
\ElasticEmailEnums\IntervalType	$interval	'Hourly' for detailed information, 'summary' for daily overview
string	$transactionID	ID number of transaction

Returns

\ElasticEmailEnums\LogSummary

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