Skip to main content
GET
/
api
/
v2
/
email-addresses
/
{id}
import { Inbound } from '@inboundemail/sdk'

const inbound = new Inbound('YOUR_API_KEY')

const { data: emailAddress, error } = await inbound.email.address.get('email_addr_123')

if (error) {
  console.error('Error:', error)
} else {
  console.log('Email address:', emailAddress.address)
  console.log('Domain:', emailAddress.domain.name)
  console.log('Routing type:', emailAddress.routing.type)
}

{
  "id": "email_addr_123",
  "address": "hello@example.com",
  "domainId": "dom_abc123",
  "webhookId": null,
  "endpointId": "end_xyz789",
  "isActive": true,
  "isReceiptRuleConfigured": true,
  "receiptRuleName": "example.com-individual-rule",
  "createdAt": "2024-01-01T00:00:00Z",
  "updatedAt": "2024-01-15T10:30:00Z",
  "userId": "user_123",
  "domain": {
    "id": "dom_abc123",
    "name": "example.com",
    "status": "verified"
  },
  "routing": {
    "type": "endpoint",
    "id": "end_xyz789",
    "name": "Main Endpoint",
    "config": {
      "type": "webhook",
      "url": "https://api.yourapp.com/webhooks/email"
    },
    "isActive": true
  }
}

​
Overview

This endpoint retrieves comprehensive information about a specific email address, including its routing configuration, domain details, and AWS SES status.

​
Authentication

​
Authorization
string
required
Bearer token for API authentication. Format: Bearer YOUR_API_KEY

​
Parameters

​
id
string
required
The unique identifier of the email address to retrieve.

​
Response

​
id
string
required
Unique identifier for the email address.
​
address
string
required
The email address (e.g., “hello@example.com”).
​
domainId
string
required
ID of the domain this email address belongs to.
​
webhookId
string | null
ID of the webhook endpoint for routing emails (if using webhook routing).
​
endpointId
string | null
ID of the endpoint for routing emails (if using endpoint routing).
​
isActive
boolean
required
Whether this email address is active and can receive emails.
​
isReceiptRuleConfigured
boolean
required
Whether AWS SES receipt rule is configured for this email address.
​
receiptRuleName
string | null
Name of the AWS SES receipt rule for this email address.
​
createdAt
string
required
ISO 8601 timestamp when the email address was created.
​
updatedAt
string
required
ISO 8601 timestamp when the email address was last updated.
​
userId
string
required
ID of the user who owns this email address.
​
domain
object
required
Domain information for this email address.
​
routing
object
required
Email routing configuration.

​
Examples

​
Request

import { Inbound } from '@inboundemail/sdk'

const inbound = new Inbound('YOUR_API_KEY')

const { data: emailAddress, error } = await inbound.email.address.get('email_addr_123')

if (error) {
  console.error('Error:', error)
} else {
  console.log('Email address:', emailAddress.address)
  console.log('Domain:', emailAddress.domain.name)
  console.log('Routing type:', emailAddress.routing.type)
}

​
Response

{
  "id": "email_addr_123",
  "address": "hello@example.com",
  "domainId": "dom_abc123",
  "webhookId": null,
  "endpointId": "end_xyz789",
  "isActive": true,
  "isReceiptRuleConfigured": true,
  "receiptRuleName": "example.com-individual-rule",
  "createdAt": "2024-01-01T00:00:00Z",
  "updatedAt": "2024-01-15T10:30:00Z",
  "userId": "user_123",
  "domain": {
    "id": "dom_abc123",
    "name": "example.com",
    "status": "verified"
  },
  "routing": {
    "type": "endpoint",
    "id": "end_xyz789",
    "name": "Main Endpoint",
    "config": {
      "type": "webhook",
      "url": "https://api.yourapp.com/webhooks/email"
    },
    "isActive": true
  }
}

​
Response with Webhook Routing

{
  "id": "email_addr_456",
  "address": "support@example.com",
  "domainId": "dom_abc123",
  "webhookId": "webhook_789",
  "endpointId": null,
  "isActive": true,
  "isReceiptRuleConfigured": true,
  "receiptRuleName": "example.com-individual-rule",
  "createdAt": "2024-01-01T00:00:00Z",
  "updatedAt": "2024-01-15T10:30:00Z",
  "userId": "user_123",
  "domain": {
    "id": "dom_abc123",
    "name": "example.com",
    "status": "verified"
  },
  "routing": {
    "type": "webhook",
    "id": "webhook_789",
    "name": "Support Webhook",
    "config": {
      "url": "https://api.yourapp.com/webhooks/support"
    },
    "isActive": true
  }
}

​
Response with No Routing

{
  "id": "email_addr_789",
  "address": "noreply@example.com",
  "domainId": "dom_abc123",
  "webhookId": null,
  "endpointId": null,
  "isActive": true,
  "isReceiptRuleConfigured": false,
  "receiptRuleName": null,
  "createdAt": "2024-01-01T00:00:00Z",
  "updatedAt": "2024-01-15T10:30:00Z",
  "userId": "user_123",
  "domain": {
    "id": "dom_abc123",
    "name": "example.com",
    "status": "verified"
  },
  "routing": {
    "type": "none",
    "id": null,
    "name": null,
    "isActive": false
  }
}

​
Error Responses

{
  "error": "Email address not found"
}

​
Understanding the Response

​
Routing Types

The routing.type field indicates how emails are processed:
1

Endpoint Routing (routing.type: 'endpoint')

Emails are routed through a configured endpoint with additional processing options.
Endpoints provide more flexibility and can include multiple routing targets or transformations.
2

Webhook Routing (routing.type: 'webhook')

Emails are sent directly to a webhook URL via HTTP POST.
Webhook routing is simpler and more direct for basic email forwarding needs.
3

No Routing (routing.type: 'none')

Emails are received and stored but not forwarded anywhere.
Email addresses with no routing cannot forward emails and may not have SES receipt rules configured.

​
Status Indicators

  • isActive: Whether the email address can receive new emails
  • isReceiptRuleConfigured: Whether AWS SES is properly configured
  • domain.status: Whether the domain is verified for email receiving

​
Important Notes

Only email addresses with isActive: true and domain.status: "verified" can receive emails successfully.
Check the routing object to understand how emails will be processed and forwarded for this address.
If isReceiptRuleConfigured is false, the email address may not receive emails properly even if it’s active.
  • Update email address: PUT /api/v2/email-addresses/{id}
  • Delete email address: DELETE /api/v2/email-addresses/{id}
  • List all email addresses: GET /api/v2/email-addresses
  • View domain details: GET /api/v2/domains/{domainId}

​
Notes

  • Email addresses inherit email-receiving capability from their domain’s verification status
  • The routing configuration determines how incoming emails are processed
  • SES receipt rules are automatically managed based on the email address configuration
  • Both endpoint and webhook routing options provide reliable email delivery
  • Email addresses without routing can still receive emails but won’t forward them
1.0 - ✅