Domain Management
Relevant source files
The following files were used as context for generating this wiki page:
- src/main/java/com/resend/services/domains/Domains.java
- src/main/java/com/resend/services/domains/model/Domain.java
- src/main/java/com/resend/services/domains/model/AbstractDomain.java
- src/main/java/com/resend/services/domains/model/CreateDomainOptions.java
- src/main/java/com/resend/services/domains/model/UpdateDomainOptions.java
- src/main/java/com/resend/services/domains/model/ClaimDomainOptions.java
- src/main/java/com/resend/services/domains/DomainClaims.java
Domain Management provides the infrastructure to create, verify, update, and remove sending domains within the Resend platform. It manages DNS configurations, tracking preferences, and regional settings required for email delivery.
This module also supports domain claiming, which allows a team to take ownership of a domain already verified by another team. Sources: src/main/java/com/resend/services/domains/Domains.java, src/main/java/com/resend/services/domains/DomainClaims.java
Core Service Architecture
The Domains class serves as the primary interface for domain operations. It extends BaseService and utilizes an IHttpClient to communicate with the Resend API endpoints.
The architecture separates standard domain lifecycle management from the domain claiming service. Sources: src/main/java/com/resend/services/domains/Domains.java:16-118, src/main/java/com/resend/services/domains/DomainClaims.java
Domain Data Model
Domain entities share common attributes through an AbstractDomain base class. This structure ensures consistency across creation responses, retrieval objects, and list items.
Key Domain Attributes
| Field | Type | Description |
|---|---|---|
id | String | Unique identifier for the domain. |
name | String | The domain name (e.g., example.com). |
status | String | The current state of the domain (e.g., "Active", "Pending"). |
region | String | The AWS region where emails are sent from. |
dnsProvider | String | The detected DNS provider for the domain. |
records | List<Record> | DNS records required for domain verification. |
Sources: src/main/java/com/resend/services/domains/model/AbstractDomain.java:8-44, src/main/java/com/resend/services/domains/model/Domain.java:15-28
Domain Operations
Domain Creation and Verification
You create a domain by providing a name and optional configurations such as region and tracking settings. After creation, the domain remains unverified until Resend confirms the presence of required DNS records.
Configuration Options
The service supports detailed configuration for both new and existing domains:
- Tracking: You can enable or disable
open_trackingandclick_tracking. You may also specify atracking_subdomain. - Security: The
tlssetting manages transport layer security requirements (e.g., "Enforced" or "Opportunistic"). - Capabilities:
DomainCapabilitiesdefines whether the domain is configured forsending,receiving, or both.
Sources: src/main/java/com/resend/services/domains/model/CreateDomainOptions.java:23-32, src/main/java/com/resend/services/domains/model/DomainCapabilities.java:13-18
Domain Claims
The DomainClaims service manages the process of claiming a domain that another team has already verified. This process requires a specific verification record to prove authority over the domain.
| Endpoint | Method | Action |
|---|---|---|
/domains/claim | POST | Initiates a new domain claim request. |
/domains/{id}/claim | GET | Retrieves the status and required records for a claim. |
/domains/{id}/claim/verify | POST | Triggers the verification check for a pending claim. |
Sources: src/main/java/com/resend/services/domains/DomainClaims.java:36-68, src/main/java/com/resend/services/domains/model/ClaimDomainOptions.java:13-32
Error Handling and Transitions
The Domains service throws a ResendException when API requests fail. Common failure scenarios include validation errors (422) during creation if a domain name is invalid, or 404 errors when attempting to retrieve or delete a non-existent domain ID.
Sources: src/main/java/com/resend/services/domains/Domains.java:46-117, src/test/java/com/resend/services/domains/DomainsTest.java:77-135
Summary
Domain Management serves as the foundational module for establishing email sending authority. It encompasses the full lifecycle of a domain—from initial registration and DNS record management to advanced configurations like tracking and security enforcement—enabling reliable and secure email delivery through the Resend platform.