MimePost\Client\DomainsApi

All URIs are relative to https://api.mimepost.com/v1/

Method	HTTP request	Description
domainsGet	GET /domains/	Get a list of all the domains
domainsIdApprovePost	POST /domains/{id}/approve/	Submit request for the approval of a verified domain
domainsIdDelete	DELETE /domains/{id}	Remove a single domain
domainsIdGet	GET /domains/{id}	Get the details of a single domain
domainsIdVerifyDkimPost	POST /domains/{id}/verify_dkim/	Request for the verification of DKIM record for a single domain
domainsIdVerifySpfPost	POST /domains/{id}/verify_spf/	Request for the verification of SPF record for a single domain
domainsIdVerifyTrackingPost	POST /domains/{id}/verify_tracking/	Request for the verification of tracking record for a single domain
domainsPost	POST /domains/	Add single domain

domainsGet

\MimePost\Client\Model\ApiResponseDomainsList domainsGet()

Get a list of all the domains

Example

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

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

$apiInstance = new MimePost\Client\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

\MimePost\Client\Model\ApiResponseDomainsList

Authorization

api_key

HTTP request headers

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

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

domainsIdApprovePost

\MimePost\Client\Model\ApiResponse domainsIdApprovePost($id)

Submit request for the approval of a verified domain

Example

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

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

$apiInstance = new MimePost\Client\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
);
$id = 56; // int | 

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

Parameters

Name	Type	Description	Notes
id	int

Return type

\MimePost\Client\Model\ApiResponse

Authorization

api_key

HTTP request headers

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

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

domainsIdDelete

\MimePost\Client\Model\ApiResponse domainsIdDelete($id)

Remove a single domain

Example

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

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

$apiInstance = new MimePost\Client\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
);
$id = 56; // int | 

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

Parameters

Name	Type	Description	Notes
id	int

Return type

\MimePost\Client\Model\ApiResponse

Authorization

api_key

HTTP request headers

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

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

domainsIdGet

\MimePost\Client\Model\ApiResponseDomainsList domainsIdGet($id)

Get the details of a single domain

Example

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

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

$apiInstance = new MimePost\Client\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
);
$id = 56; // int | 

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

Parameters

Name	Type	Description	Notes
id	int

Return type

\MimePost\Client\Model\ApiResponseDomainsList

Authorization

api_key

HTTP request headers

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

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

domainsIdVerifyDkimPost

\MimePost\Client\Model\ApiResponse domainsIdVerifyDkimPost($id)

Request for the verification of DKIM record for a single domain

Example

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

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

$apiInstance = new MimePost\Client\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
);
$id = 56; // int | 

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

Parameters

Name	Type	Description	Notes
id	int

Return type

\MimePost\Client\Model\ApiResponse

Authorization

api_key

HTTP request headers

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

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

domainsIdVerifySpfPost

\MimePost\Client\Model\ApiResponse domainsIdVerifySpfPost($id)

Request for the verification of SPF record for a single domain

Example

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

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

$apiInstance = new MimePost\Client\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
);
$id = 56; // int | 

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

Parameters

Name	Type	Description	Notes
id	int

Return type

\MimePost\Client\Model\ApiResponse

Authorization

api_key

HTTP request headers

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

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

domainsIdVerifyTrackingPost

\MimePost\Client\Model\ApiResponse domainsIdVerifyTrackingPost($id)

Request for the verification of tracking record for a single domain

Example

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

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

$apiInstance = new MimePost\Client\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
);
$id = 56; // int | 

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

Parameters

Name	Type	Description	Notes
id	int

Return type

\MimePost\Client\Model\ApiResponse

Authorization

api_key

HTTP request headers

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

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

domainsPost

\MimePost\Client\Model\ApiResponse domainsPost($domain)

Add single domain

Example

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

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

$apiInstance = new MimePost\Client\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 = new \MimePost\Client\Model\Domain(); // \MimePost\Client\Model\Domain | The name of the domain name

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

Parameters

Name	Type	Description	Notes
domain	\MimePost\Client\Model\Domain	The name of the domain name	[optional]

Return type

\MimePost\Client\Model\ApiResponse

Authorization

api_key

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

MimePost\Client\DomainsApi

domainsGet

Example

Parameters

Return type

Authorization

HTTP request headers

domainsIdApprovePost

Example

Parameters

Return type

Authorization

HTTP request headers

domainsIdDelete

Example

Parameters

Return type

Authorization

HTTP request headers

domainsIdGet

Example

Parameters

Return type

Authorization

HTTP request headers

domainsIdVerifyDkimPost

Example

Parameters

Return type

Authorization

HTTP request headers

domainsIdVerifySpfPost

Example

Parameters

Return type

Authorization

HTTP request headers

domainsIdVerifyTrackingPost

Example

Parameters

Return type

Authorization

HTTP request headers

domainsPost

Example

Parameters

Return type

Authorization

HTTP request headers