$configuration
$configuration : \ElasticEmailClient\ApiConfiguration
Add(string $segmentName, string $rule) : \ElasticEmailEnums\Segment
Create new segment, based on specified RULE.
| string | $segmentName | Name of your segment. |
| string | $rule | Query used for filtering. |
EECopy(string $sourceSegmentName, string $newSegmentName = null, string $rule = null) : \ElasticEmailEnums\Segment
Copy your existing Segment with the optional new rule and custom name
| string | $sourceSegmentName | The name of the segment you want to copy |
| string | $newSegmentName | New name of your segment if you want to change it. |
| string | $rule | Query used for filtering. |
Export(string $segmentName, \ElasticEmailEnums\ExportFileFormats $fileFormat = \ElasticEmailEnums\ExportFileFormats::Csv, \ElasticEmailEnums\CompressionFormat $compressionFormat = \ElasticEmailEnums\CompressionFormat::None, string $fileName = null) : \ElasticEmailEnums\ExportLink
Exports all the contacts from the provided segment
| string | $segmentName | Name of your segment. |
| \ElasticEmailEnums\ExportFileFormats | $fileFormat | Format of the exported file |
| \ElasticEmailEnums\CompressionFormat | $compressionFormat | FileResponse compression format. None or Zip. |
| string | $fileName | Name of your file. |
EEList(boolean $includeHistory = false, \ElasticEmailApi\?DateTime $from = null, \ElasticEmailApi\?DateTime $to = null) : \ElasticEmailApi\Array<\ElasticEmailEnums\Segment>
Lists all your available Segments
| boolean | $includeHistory | True: Include history of last 30 days. Otherwise, false. |
| \ElasticEmailApi\?DateTime | $from | From what date should the segment history be shown. In YYYY-MM-DDThh:mm:ss format. |
| \ElasticEmailApi\?DateTime | $to | To what date should the segment history be shown. In YYYY-MM-DDThh:mm:ss format. |
LoadByName(\ElasticEmailApi\array<string> $segmentNames, boolean $includeHistory = false, \ElasticEmailApi\?DateTime $from = null, \ElasticEmailApi\?DateTime $to = null) : \ElasticEmailApi\Array<\ElasticEmailEnums\Segment>
Lists your available Segments using the provided names
| \ElasticEmailApi\array |
$segmentNames | Names of segments you want to load. Will load all contacts if left empty or the 'All Contacts' name has been provided |
| boolean | $includeHistory | True: Include history of last 30 days. Otherwise, false. |
| \ElasticEmailApi\?DateTime | $from | From what date should the segment history be shown. In YYYY-MM-DDThh:mm:ss format. |
| \ElasticEmailApi\?DateTime | $to | To what date should the segment history be shown. In YYYY-MM-DDThh:mm:ss format. |
Update(string $segmentName, string $newSegmentName = null, string $rule = null) : \ElasticEmailEnums\Segment
Rename or change RULE for your segment
| string | $segmentName | Name of your segment. |
| string | $newSegmentName | New name of your segment if you want to change it. |
| string | $rule | Query used for filtering. |