import Inbound from 'inboundemail';
const client = new Inbound({
apiKey: process.env['INBOUND_API_KEY'], // This is the default and can be omitted
});
const domain = await client.domains.retrieve('id');
console.log(domain.id);{
"id": "<string>",
"domain": "<string>",
"status": "<string>",
"canReceiveEmails": true,
"hasMxRecords": true,
"domainProvider": "<string>",
"providerConfidence": "<string>",
"lastDnsCheck": "2023-11-07T05:31:56Z",
"lastSesCheck": "2023-11-07T05:31:56Z",
"isCatchAllEnabled": true,
"catchAllEndpointId": "<string>",
"mailFromDomain": "<string>",
"mailFromDomainStatus": "<string>",
"mailFromDomainVerifiedAt": "2023-11-07T05:31:56Z",
"receiveDmarcEmails": true,
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"userId": "<string>",
"stats": {
"totalEmailAddresses": 123,
"activeEmailAddresses": 123,
"emailsLast24h": 123,
"emailsLast7d": 123,
"emailsLast30d": 123
},
"dnsRecords": [
{
"id": "<string>",
"domainId": "<string>",
"recordType": "<string>",
"name": "<string>",
"value": "<string>",
"isRequired": true,
"isVerified": true,
"lastChecked": "2023-11-07T05:31:56Z",
"createdAt": "2023-11-07T05:31:56Z"
}
],
"catchAllEndpoint": {
"id": "<string>",
"name": "<string>",
"type": "<string>",
"isActive": true
},
"verificationCheck": {
"dnsRecords": [
{
"type": "<string>",
"name": "<string>",
"value": "<string>",
"isVerified": true,
"error": "<string>"
}
],
"sesStatus": "<string>",
"isFullyVerified": true,
"lastChecked": "2023-11-07T05:31:56Z",
"dkimStatus": "<string>",
"dkimVerified": true,
"dkimTokens": [
"<string>"
],
"mailFromDomain": "<string>",
"mailFromStatus": "<string>",
"mailFromVerified": true
},
"authRecommendations": {
"spf": {
"name": "<string>",
"value": "<string>",
"description": "<string>"
},
"dmarc": {
"name": "<string>",
"value": "<string>",
"description": "<string>"
}
},
"inheritsFromParent": true,
"parentDomain": "<string>"
}Get detailed information about a specific domain including DNS records. Use ?check=true for a live verification check.
import Inbound from 'inboundemail';
const client = new Inbound({
apiKey: process.env['INBOUND_API_KEY'], // This is the default and can be omitted
});
const domain = await client.domains.retrieve('id');
console.log(domain.id);{
"id": "<string>",
"domain": "<string>",
"status": "<string>",
"canReceiveEmails": true,
"hasMxRecords": true,
"domainProvider": "<string>",
"providerConfidence": "<string>",
"lastDnsCheck": "2023-11-07T05:31:56Z",
"lastSesCheck": "2023-11-07T05:31:56Z",
"isCatchAllEnabled": true,
"catchAllEndpointId": "<string>",
"mailFromDomain": "<string>",
"mailFromDomainStatus": "<string>",
"mailFromDomainVerifiedAt": "2023-11-07T05:31:56Z",
"receiveDmarcEmails": true,
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"userId": "<string>",
"stats": {
"totalEmailAddresses": 123,
"activeEmailAddresses": 123,
"emailsLast24h": 123,
"emailsLast7d": 123,
"emailsLast30d": 123
},
"dnsRecords": [
{
"id": "<string>",
"domainId": "<string>",
"recordType": "<string>",
"name": "<string>",
"value": "<string>",
"isRequired": true,
"isVerified": true,
"lastChecked": "2023-11-07T05:31:56Z",
"createdAt": "2023-11-07T05:31:56Z"
}
],
"catchAllEndpoint": {
"id": "<string>",
"name": "<string>",
"type": "<string>",
"isActive": true
},
"verificationCheck": {
"dnsRecords": [
{
"type": "<string>",
"name": "<string>",
"value": "<string>",
"isVerified": true,
"error": "<string>"
}
],
"sesStatus": "<string>",
"isFullyVerified": true,
"lastChecked": "2023-11-07T05:31:56Z",
"dkimStatus": "<string>",
"dkimVerified": true,
"dkimTokens": [
"<string>"
],
"mailFromDomain": "<string>",
"mailFromStatus": "<string>",
"mailFromVerified": true
},
"authRecommendations": {
"spf": {
"name": "<string>",
"value": "<string>",
"description": "<string>"
},
"dmarc": {
"name": "<string>",
"value": "<string>",
"description": "<string>"
}
},
"inheritsFromParent": true,
"parentDomain": "<string>"
}Your Inbound API key. Include it in the Authorization header as: Bearer
true Response for status 200
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Was this page helpful?