ElasticEmail\EmailsApi

All URIs are relative to https://api.elasticemail.com/v4, except if the operation defines another base path.

Method	HTTP request	Description
emailsByMsgidViewGet()	GET /emails/{msgid}/view	View Email
emailsByTransactionidStatusGet()	GET /emails/{transactionid}/status	Get Status
emailsMergefilePost()	POST /emails/mergefile	Send Bulk Emails CSV
emailsPost()	POST /emails	Send Bulk Emails
emailsTransactionalPost()	POST /emails/transactional	Send Transactional Email

`emailsByMsgidViewGet()`

emailsByMsgidViewGet($msgid): \ElasticEmail\Model\EmailData

View Email

Returns email details for viewing or rendering. Required Access Level: None

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure API key authorization: apikey
$config = ElasticEmail\Configuration::getDefaultConfiguration()->setApiKey('X-ElasticEmail-ApiKey', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = ElasticEmail\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-ElasticEmail-ApiKey', 'Bearer');


$apiInstance = new ElasticEmail\Api\EmailsApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$msgid = 'msgid_example'; // string | Message identifier

try {
    $result = $apiInstance->emailsByMsgidViewGet($msgid);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling EmailsApi->emailsByMsgidViewGet: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
msgid	string	Message identifier

Return type

\ElasticEmail\Model\EmailData

Authorization

apikey

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

`emailsByTransactionidStatusGet()`

emailsByTransactionidStatusGet($transactionid, $show_failed, $show_sent, $show_delivered, $show_pending, $show_opened, $show_clicked, $show_abuse, $show_unsubscribed, $show_errors, $show_message_ids): \ElasticEmail\Model\EmailJobStatus

Get Status

Get status details of an email transaction. Required Access Level: ViewReports

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure API key authorization: apikey
$config = ElasticEmail\Configuration::getDefaultConfiguration()->setApiKey('X-ElasticEmail-ApiKey', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = ElasticEmail\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-ElasticEmail-ApiKey', 'Bearer');


$apiInstance = new ElasticEmail\Api\EmailsApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$transactionid = 'transactionid_example'; // string | Transaction identifier
$show_failed = false; // bool | Include Bounced email addresses.
$show_sent = false; // bool | Include Sent email addresses.
$show_delivered = false; // bool | Include all delivered email addresses.
$show_pending = false; // bool | Include Ready to send email addresses.
$show_opened = false; // bool | Include Opened email addresses.
$show_clicked = false; // bool | Include Clicked email addresses.
$show_abuse = false; // bool | Include Reported as abuse email addresses.
$show_unsubscribed = false; // bool | Include Unsubscribed email addresses.
$show_errors = false; // bool | Include error messages for bounced emails.
$show_message_ids = false; // bool | Include all MessageIDs for this transaction

try {
    $result = $apiInstance->emailsByTransactionidStatusGet($transactionid, $show_failed, $show_sent, $show_delivered, $show_pending, $show_opened, $show_clicked, $show_abuse, $show_unsubscribed, $show_errors, $show_message_ids);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling EmailsApi->emailsByTransactionidStatusGet: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
transactionid	string	Transaction identifier
show_failed	bool	Include Bounced email addresses.	[optional] [default to false]
show_sent	bool	Include Sent email addresses.	[optional] [default to false]
show_delivered	bool	Include all delivered email addresses.	[optional] [default to false]
show_pending	bool	Include Ready to send email addresses.	[optional] [default to false]
show_opened	bool	Include Opened email addresses.	[optional] [default to false]
show_clicked	bool	Include Clicked email addresses.	[optional] [default to false]
show_abuse	bool	Include Reported as abuse email addresses.	[optional] [default to false]
show_unsubscribed	bool	Include Unsubscribed email addresses.	[optional] [default to false]
show_errors	bool	Include error messages for bounced emails.	[optional] [default to false]
show_message_ids	bool	Include all MessageIDs for this transaction	[optional] [default to false]

Return type

\ElasticEmail\Model\EmailJobStatus

Authorization

apikey

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

`emailsMergefilePost()`

emailsMergefilePost($merge_email_payload): \ElasticEmail\Model\EmailSend

Send Bulk Emails CSV

Send to a list of contacts submitted in a CSV data file. The first column in the CSV must be the email address and the CSV must contain a header row. Additional fields can be included with a named header row and can be merged with the template using {merge} tags in the content. Example CSV: email, firstname, lastname test1@gmail.com, michael, smith test2@gmail.com, janet, smith Merge file must not be empty. Required Access Level: SendHttp

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure API key authorization: apikey
$config = ElasticEmail\Configuration::getDefaultConfiguration()->setApiKey('X-ElasticEmail-ApiKey', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = ElasticEmail\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-ElasticEmail-ApiKey', 'Bearer');


$apiInstance = new ElasticEmail\Api\EmailsApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$merge_email_payload = new \ElasticEmail\Model\MergeEmailPayload(); // \ElasticEmail\Model\MergeEmailPayload | Email data

try {
    $result = $apiInstance->emailsMergefilePost($merge_email_payload);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling EmailsApi->emailsMergefilePost: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
merge_email_payload	\ElasticEmail\Model\MergeEmailPayload	Email data

Return type

\ElasticEmail\Model\EmailSend

Authorization

apikey

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

`emailsPost()`

emailsPost($email_message_data): \ElasticEmail\Model\EmailSend

Send Bulk Emails

Send bulk merge email. Required Access Level: SendHttp

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure API key authorization: apikey
$config = ElasticEmail\Configuration::getDefaultConfiguration()->setApiKey('X-ElasticEmail-ApiKey', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = ElasticEmail\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-ElasticEmail-ApiKey', 'Bearer');


$apiInstance = new ElasticEmail\Api\EmailsApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$email_message_data = new \ElasticEmail\Model\EmailMessageData(); // \ElasticEmail\Model\EmailMessageData | Email data

try {
    $result = $apiInstance->emailsPost($email_message_data);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling EmailsApi->emailsPost: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
email_message_data	\ElasticEmail\Model\EmailMessageData	Email data

Return type

\ElasticEmail\Model\EmailSend

Authorization

apikey

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

`emailsTransactionalPost()`

emailsTransactionalPost($email_transactional_message_data): \ElasticEmail\Model\EmailSend

Send Transactional Email

Send transactional emails (recipients will be known to each other). Required Access Level: SendHttp

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure API key authorization: apikey
$config = ElasticEmail\Configuration::getDefaultConfiguration()->setApiKey('X-ElasticEmail-ApiKey', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = ElasticEmail\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-ElasticEmail-ApiKey', 'Bearer');


$apiInstance = new ElasticEmail\Api\EmailsApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$email_transactional_message_data = new \ElasticEmail\Model\EmailTransactionalMessageData(); // \ElasticEmail\Model\EmailTransactionalMessageData | Email data

try {
    $result = $apiInstance->emailsTransactionalPost($email_transactional_message_data);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling EmailsApi->emailsTransactionalPost: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
email_transactional_message_data	\ElasticEmail\Model\EmailTransactionalMessageData	Email data

Return type

\ElasticEmail\Model\EmailSend

Authorization

apikey

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

EmailsApi.md

EmailsApi.md

ElasticEmail\EmailsApi

`emailsByMsgidViewGet()`

Example

Parameters

Return type

Authorization

HTTP request headers

`emailsByTransactionidStatusGet()`

Example

Parameters

Return type

Authorization

HTTP request headers

`emailsMergefilePost()`

Example

Parameters

Return type

Authorization

HTTP request headers

`emailsPost()`

Example

Parameters

Return type

Authorization

HTTP request headers

`emailsTransactionalPost()`

Example

Parameters

Return type

Authorization

HTTP request headers

Files

EmailsApi.md

Latest commit

History

EmailsApi.md

File metadata and controls

ElasticEmail\EmailsApi

emailsByMsgidViewGet()

Example

Parameters

Return type

Authorization

HTTP request headers

emailsByTransactionidStatusGet()

Example

Parameters

Return type

Authorization

HTTP request headers

emailsMergefilePost()

Example

Parameters

Return type

Authorization

HTTP request headers

emailsPost()

Example

Parameters

Return type

Authorization

HTTP request headers

emailsTransactionalPost()

Example

Parameters

Return type

Authorization

HTTP request headers

`emailsByMsgidViewGet()`

`emailsByTransactionidStatusGet()`

`emailsMergefilePost()`

`emailsPost()`

`emailsTransactionalPost()`