Get a domain
Get /settings/domains/{sending}
URL parameters:
Name | Description | Type | Mandatory |
---|---|---|---|
sending | Domain name with extension | String | Yes |
Response:
Name | Description | Type |
---|---|---|
id | Domain id | String |
sending | Domain name | String |
tracking | Tracking domain name | String |
createdAt | Datetime on timestamp format | Int |
updatedAt | Datetime on timestamp format | Int |
verifiedDkim | If the DKIM is validated or not | Boolean |
verifiedSpf | If the SPF is validated or not | Boolean |
verifiedMx | If the MX record is validated or not | Boolean |
verifiedA | If the A record is validated or not | Boolean |
verifiedTracking | If the Tracking with CNAME record is validated or not | Boolean |
verifiedDomain | If the domain is verified with email confirmation | Boolean |
default | If the domain is used as default or not | Boolean |
Programming language:
Response exemple:
{ "sending": "example.com", "tracking": "link.example.com", "id": "5582ec34683235ce71e4b4e3", "createdAt": 1434643507, "updatedAt": 1435764352, "verifiedDkim": true, "verifiedMx": true, "verifiedA": true, "verifiedSpf": true, "verifiedTracking": true, "verifiedDomain": true, "default": true }
Code example:
curl -X GET -H "Content-Type: application/json" -H "X-Tipimail-ApiUser:YOUR_SMTP_USERNAME" -H "X-Tipimail-ApiKey:YOUR_SMTP_KEY" https://api.tipimail.com/v1/settings/domains/example.com
require 'vendor/autoload.php'; $tipimail = new Tipimail\Tipimail('YOUR_SMTP_USERNAME', 'YOUR_API_KEY'); try { $result = $tipimail->getSettingsService()->getDomainsService()->get('example.com'); var_dump($result); } catch(Tipimail\Exceptions\TipimailException $e) { echo 'Exception received :', $e->getMessage(), "\n"; }