SDK Java
Java 17+, API síncrona y asíncrona (CompletableFuture), builders inmutables.
Instalación
Agrega el paquete al proyecto.
Configurar el cliente
La clave viene de COFFEEMAIL_API_KEY o del constructor. Usa una clave por entorno.
Enviar un email
El envío entra en la cola y vuelve en milisegundos con el id y el estado queued. Retorno: CoffeeMailResponse<T>.
Manejar errores
Los errores de la API llegan tipados, con code, status y requestId; nada se lanza en el camino común.
Paginar
Las listas devuelven la página y el cursor nextCursor; pásalo en after para traer la siguiente.
Verificar webhooks
Valida x-webhook-signature con el cuerpo bruto de la solicitud, x-webhook-timestamp y x-webhook-idempotency-key. La ventana por defecto es de 300 segundos.
Referencia de métodos
Todos los métodos públicos, agrupados por recurso. Cada fila muestra el endpoint llamado; abre la referencia de la API para ver campos y respuestas.
Emails8 métodos
Endpoints →| Método | Endpoint llamado |
|---|---|
coffeemail.emails().send() | POST/emails |
coffeemail.emails().sendBatch() | POST/emails/batch |
coffeemail.emails().get() | GET/emails/{id} |
coffeemail.emails().list() | GET/emails |
coffeemail.emails().getEvents() | GET/emails/{id}/events |
coffeemail.emails().getTags() | GET/emails/tags |
coffeemail.emails().cancel() | POST/emails/{id}/cancel |
coffeemail.emails().resend() | POST/emails/{id}/resend |
Dominios10 métodos
Endpoints →| Método | Endpoint llamado |
|---|---|
coffeemail.domains().create() | POST/domains |
coffeemail.domains().list() | GET/domains |
coffeemail.domains().get() | GET/domains/{id} |
coffeemail.domains().verify() | POST/domains/{id}/verify |
coffeemail.domains().delete() | DELETE/domains/{id} |
coffeemail.domains().getHealth() | POST/domains/{id}/health |
coffeemail.domains().getWarmupStatus() | GET/domains/{id}/warmup |
coffeemail.domains().rotateDkim() | POST/domains/{id}/dkim/rotate |
coffeemail.domains().setTrackingDomain() | PUT/domains/{id}/tracking-domain |
coffeemail.domains().removeTrackingDomain() | DELETE/domains/{id}/tracking-domain |
Plantillas12 métodos
Endpoints →| Método | Endpoint llamado |
|---|---|
coffeemail.templates().create() | POST/templates |
coffeemail.templates().list() | GET/templates |
coffeemail.templates().get() | GET/templates/{id} |
coffeemail.templates().update() | PATCH/templates/{id} |
coffeemail.templates().delete() | DELETE/templates/{id} |
coffeemail.templates().preview() | POST/templates/preview |
coffeemail.templates().format() | POST/templates/format |
coffeemail.templates().testRender() | POST/templates/test-render |
coffeemail.templates().testSend() | POST/templates/{id}/test-send |
coffeemail.templates().listVersions() | GET/templates/{id}/versions |
coffeemail.templates().getVersion() | GET/templates/{id}/versions/{version} |
coffeemail.templates().restoreVersion() | POST/templates/{id}/versions/{version}/restore |
Audiencias y contactos10 métodos
Endpoints →| Método | Endpoint llamado |
|---|---|
coffeemail.audiences().create() | POST/audiences |
coffeemail.audiences().list() | GET/audiences |
coffeemail.audiences().get() | GET/audiences/{id} |
coffeemail.audiences().update() | PUT/audiences/{id} |
coffeemail.audiences().delete() | DELETE/audiences/{id} |
coffeemail.audiences().contacts().create() | POST/audiences/{id}/contacts |
coffeemail.audiences().contacts().list() | GET/audiences/{id}/contacts |
coffeemail.audiences().contacts().bulkAdd() | POST/audiences/{id}/contacts/bulk |
coffeemail.audiences().contacts().update() | PUT/audiences/{id}/contacts/{contactId} |
coffeemail.audiences().contacts().delete() | DELETE/audiences/{id}/contacts/{contactId} |
Campañas6 métodos
Endpoints →| Método | Endpoint llamado |
|---|---|
coffeemail.broadcasts().create() | POST/broadcasts |
coffeemail.broadcasts().list() | GET/broadcasts |
coffeemail.broadcasts().get() | GET/broadcasts/{id} |
coffeemail.broadcasts().send() | POST/broadcasts/{id}/send |
coffeemail.broadcasts().cancel() | POST/broadcasts/{id}/cancel |
coffeemail.broadcasts().testSend() | POST/broadcasts/{id}/test-send |
Remitentes5 métodos
Endpoints →| Método | Endpoint llamado |
|---|---|
coffeemail.senders().create() | POST/senders |
coffeemail.senders().list() | GET/senders |
coffeemail.senders().verify() | POST/senders/verify |
coffeemail.senders().resendVerification() | POST/senders/{id}/resend-verification |
coffeemail.senders().delete() | DELETE/senders/{id} |
Supresiones6 métodos
Endpoints →| Método | Endpoint llamado |
|---|---|
coffeemail.suppressions().list() | GET/suppressions |
coffeemail.suppressions().get() | GET/suppressions/{id} |
coffeemail.suppressions().create() | POST/suppressions |
coffeemail.suppressions().delete() | DELETE/suppressions/{id} |
coffeemail.suppressions().reactivate() | POST/suppressions/{id}/reactivate |
coffeemail.suppressions().bulkCreate() | POST/suppressions/bulk |
Webhooks11 métodos
Endpoints →| Método | Endpoint llamado |
|---|---|
coffeemail.webhooks().create() | POST/webhooks |
coffeemail.webhooks().list() | GET/webhooks |
coffeemail.webhooks().get() | GET/webhooks/{id} |
coffeemail.webhooks().update() | PUT/webhooks/{id} |
coffeemail.webhooks().toggle() | PATCH/webhooks/{id} |
coffeemail.webhooks().delete() | DELETE/webhooks/{id} |
coffeemail.webhooks().rotateSecret() | POST/webhooks/{id}/rotate-secret |
coffeemail.webhooks().listDeliveries() | GET/webhooks/{id}/deliveries |
coffeemail.webhooks().test() | POST/webhooks/{id}/test |
coffeemail.webhooks().getDelivery() | GET/webhooks/{id}/deliveries/{deliveryId} |
coffeemail.webhooks().replayDelivery() | POST/webhooks/{id}/deliveries/{deliveryId}/replay |
Estadísticas1 método
Endpoints →| Método | Endpoint llamado |
|---|---|
coffeemail.stats().get() | GET/stats |
Validación1 método
Endpoints →| Método | Endpoint llamado |
|---|---|
coffeemail.validation().validate() | POST/validate |