ElasticEmail\DomainsApi

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

Method	HTTP request	Description
domainsByDomainDelete()	DELETE /domains/{domain}	Delete Domain
domainsByDomainGet()	GET /domains/{domain}	Load Domain
domainsByDomainPut()	PUT /domains/{domain}	Update Domain
domainsByDomainRestrictedGet()	GET /domains/{domain}/restricted	Check for domain restriction
domainsByDomainVerificationPut()	PUT /domains/{domain}/verification	Verify Domain
domainsByEmailDefaultPatch()	PATCH /domains/{email}/default	Set Default
domainsGet()	GET /domains	Load Domains
domainsPost()	POST /domains	Add Domain

`domainsByDomainDelete()`

domainsByDomainDelete($domain)

Delete Domain

Deletes configured domain from Account. Required Access Level: ModifySettings

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\DomainsApi(
    // 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
);
$domain = 'domain_example'; // string | Name of the given domain

try {
    $apiInstance->domainsByDomainDelete($domain);
} catch (Exception $e) {
    echo 'Exception when calling DomainsApi->domainsByDomainDelete: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
domain	string	Name of the given domain

Return type

void (empty response body)

Authorization

apikey

HTTP request headers

Content-Type: Not defined
Accept: Not defined

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

`domainsByDomainGet()`

domainsByDomainGet($domain): \ElasticEmail\Model\DomainData

Load Domain

Retrieve a domain configured for this Account. Required Access Level: ViewSettings

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\DomainsApi(
    // 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
);
$domain = 'domain_example'; // string | Name of the given domain

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

Parameters

Name	Type	Description	Notes
domain	string	Name of the given domain

Return type

\ElasticEmail\Model\DomainData

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]

`domainsByDomainPut()`

domainsByDomainPut($domain, $domain_update_payload): \ElasticEmail\Model\DomainDetail

Update Domain

Updates the specified domain. Required Access Level: ModifySettings

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\DomainsApi(
    // 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
);
$domain = 'domain_example'; // string | Name of the given domain
$domain_update_payload = new \ElasticEmail\Model\DomainUpdatePayload(); // \ElasticEmail\Model\DomainUpdatePayload | Updated Domain resource

try {
    $result = $apiInstance->domainsByDomainPut($domain, $domain_update_payload);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DomainsApi->domainsByDomainPut: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
domain	string	Name of the given domain
domain_update_payload	\ElasticEmail\Model\DomainUpdatePayload	Updated Domain resource

Return type

\ElasticEmail\Model\DomainDetail

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]

`domainsByDomainRestrictedGet()`

domainsByDomainRestrictedGet($domain): bool

Check for domain restriction

Checking if domain is from free provider, or restricted. Required Access Level: ViewSettings

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\DomainsApi(
    // 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
);
$domain = 'domain_example'; // string | Name of the given domain

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

Parameters

Name	Type	Description	Notes
domain	string	Name of the given domain

Return type

bool

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]

`domainsByDomainVerificationPut()`

domainsByDomainVerificationPut($domain, $body): \ElasticEmail\Model\DomainData

Verify Domain

Verifies that required DNS records exist for specified domain. Required Access Level: ModifySettings

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\DomainsApi(
    // 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
);
$domain = 'domain_example'; // string | Name of the given domain
$body = 'body_example'; // string | Tracking type used in the Tracking verification

try {
    $result = $apiInstance->domainsByDomainVerificationPut($domain, $body);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DomainsApi->domainsByDomainVerificationPut: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
domain	string	Name of the given domain
body	string	Tracking type used in the Tracking verification

Return type

\ElasticEmail\Model\DomainData

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]

`domainsByEmailDefaultPatch()`

domainsByEmailDefaultPatch($email): \ElasticEmail\Model\DomainDetail

Set Default

Sets a verified email address as default sender. Required Access Level: ModifySettings

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\DomainsApi(
    // 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 = 'email_example'; // string | Default email sender, example: mail@yourdomain.com

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

Parameters

Name	Type	Description	Notes
email	string	Default email sender, example: mail@yourdomain.com

Return type

\ElasticEmail\Model\DomainDetail

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]

`domainsGet()`

domainsGet(): \ElasticEmail\Model\DomainDetail[]

Load Domains

Returns a list of all domains configured for this Account. Required Access Level: ViewSettings

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\DomainsApi(
    // 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
);

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

Parameters

This endpoint does not need any parameter.

Return type

\ElasticEmail\Model\DomainDetail[]

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]

`domainsPost()`

domainsPost($domain_payload): \ElasticEmail\Model\DomainDetail

Add Domain

Add new domain to Account. Required Access Level: ModifySettings

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\DomainsApi(
    // 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
);
$domain_payload = new \ElasticEmail\Model\DomainPayload(); // \ElasticEmail\Model\DomainPayload | Domain to add

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

Parameters

Name	Type	Description	Notes
domain_payload	\ElasticEmail\Model\DomainPayload	Domain to add

Return type

\ElasticEmail\Model\DomainDetail

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]

Files

DomainsApi.md

Latest commit

History

DomainsApi.md

File metadata and controls

ElasticEmail\DomainsApi

domainsByDomainDelete()

Example

Parameters

Return type

Authorization

HTTP request headers

domainsByDomainGet()

Example

Parameters

Return type

Authorization

HTTP request headers

domainsByDomainPut()

Example

Parameters

Return type

Authorization

HTTP request headers

domainsByDomainRestrictedGet()

Example

Parameters

Return type

Authorization

HTTP request headers

domainsByDomainVerificationPut()

Example

Parameters

Return type

Authorization

HTTP request headers

domainsByEmailDefaultPatch()

Example

Parameters

Return type

Authorization

HTTP request headers

domainsGet()

Example

Parameters

Return type

Authorization

HTTP request headers

domainsPost()

Example

Parameters

Return type

Authorization

HTTP request headers

`domainsByDomainDelete()`

`domainsByDomainGet()`

`domainsByDomainPut()`

`domainsByDomainRestrictedGet()`

`domainsByDomainVerificationPut()`

`domainsByEmailDefaultPatch()`

`domainsGet()`

`domainsPost()`