import Inbound from 'inboundemail';
const client = new Inbound({
apiKey: process.env['INBOUND_API_KEY'], // This is the default and can be omitted
});
const emailAddresses = await client.emailAddresses.list();
console.log(emailAddresses.data);{
"data": [
{
"id": "<string>",
"address": "<string>",
"domainId": "<string>",
"webhookId": "<string>",
"endpointId": "<string>",
"isActive": true,
"isReceiptRuleConfigured": true,
"receiptRuleName": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"userId": "<string>",
"domain": {
"id": "<string>",
"name": "<string>",
"status": "<string>"
},
"routing": {
"type": "webhook",
"id": "<string>",
"name": "<string>",
"isActive": true,
"config": "<unknown>"
}
}
],
"pagination": {
"limit": 123,
"offset": 123,
"total": 123,
"hasMore": true
}
}Get paginated list of email addresses for authenticated user with optional filtering by domain, active status, and receipt rule configuration
import Inbound from 'inboundemail';
const client = new Inbound({
apiKey: process.env['INBOUND_API_KEY'], // This is the default and can be omitted
});
const emailAddresses = await client.emailAddresses.list();
console.log(emailAddresses.data);{
"data": [
{
"id": "<string>",
"address": "<string>",
"domainId": "<string>",
"webhookId": "<string>",
"endpointId": "<string>",
"isActive": true,
"isReceiptRuleConfigured": true,
"receiptRuleName": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"userId": "<string>",
"domain": {
"id": "<string>",
"name": "<string>",
"status": "<string>"
},
"routing": {
"type": "webhook",
"id": "<string>",
"name": "<string>",
"isActive": true,
"config": "<unknown>"
}
}
],
"pagination": {
"limit": 123,
"offset": 123,
"total": 123,
"hasMore": true
}
}Your Inbound API key. Include it in the Authorization header as: Bearer
1 <= x <= 100x >= 0true, false true, false Was this page helpful?