SDKs · Rails
Rails
Delivery method do ActionMailer e app Rack de webhooks sobre o SDK Ruby.
Instalação
Adicione o pacote ao projeto.
terminal
Configurar o cliente
A chave vem de COFFEEMAIL_API_KEY ou do construtor. Use uma chave por ambiente.
Com o delivery method, os mailers do app enviam pela CoffeeMail sem mudar o código. O client completo do SDK fica em CoffeeMail::Rails.client.
cliente
Enviar um email
O envio entra na fila e volta em milissegundos com o id e o status queued. Retorno: Response (data, error).
enviar
Tratar erros
Erros da API chegam tipados, com code, status e requestId; nada é lançado no caminho comum.
erros
Paginar
Listas devolvem a página e o cursor nextCursor; passe-o em after para buscar a próxima.
paginar
Verificar webhooks
Valide x-webhook-signature com o corpo bruto da requisição, x-webhook-timestamp e x-webhook-idempotency-key. A janela padrão é de 300 segundos.
webhook
Referência de métodos
Todos os métodos públicos, agrupados por recurso. Cada linha mostra o endpoint chamado; abra a referência da API para ver campos e respostas.
Os métodos abaixo são do SDK Ruby, acessados por CoffeeMail::Rails.client.
Emails8 métodos
Endpoints →| Método | Endpoint chamado |
|---|---|
CoffeeMail::Rails.client.emails.send | POST/emails |
CoffeeMail::Rails.client.emails.send_batch | POST/emails/batch |
CoffeeMail::Rails.client.emails.get | GET/emails/{id} |
CoffeeMail::Rails.client.emails.list | GET/emails |
CoffeeMail::Rails.client.emails.get_events | GET/emails/{id}/events |
CoffeeMail::Rails.client.emails.get_tags | GET/emails/tags |
CoffeeMail::Rails.client.emails.cancel | POST/emails/{id}/cancel |
CoffeeMail::Rails.client.emails.resend | POST/emails/{id}/resend |
Domínios10 métodos
Endpoints →| Método | Endpoint chamado |
|---|---|
CoffeeMail::Rails.client.domains.create | POST/domains |
CoffeeMail::Rails.client.domains.list | GET/domains |
CoffeeMail::Rails.client.domains.get | GET/domains/{id} |
CoffeeMail::Rails.client.domains.verify | POST/domains/{id}/verify |
CoffeeMail::Rails.client.domains.delete | DELETE/domains/{id} |
CoffeeMail::Rails.client.domains.get_health | POST/domains/{id}/health |
CoffeeMail::Rails.client.domains.get_warmup_status | GET/domains/{id}/warmup |
CoffeeMail::Rails.client.domains.rotate_dkim | POST/domains/{id}/dkim/rotate |
CoffeeMail::Rails.client.domains.set_tracking_domain | PUT/domains/{id}/tracking-domain |
CoffeeMail::Rails.client.domains.remove_tracking_domain | DELETE/domains/{id}/tracking-domain |
Modelos12 métodos
Endpoints →| Método | Endpoint chamado |
|---|---|
CoffeeMail::Rails.client.templates.create | POST/templates |
CoffeeMail::Rails.client.templates.list | GET/templates |
CoffeeMail::Rails.client.templates.get | GET/templates/{id} |
CoffeeMail::Rails.client.templates.update | PATCH/templates/{id} |
CoffeeMail::Rails.client.templates.delete | DELETE/templates/{id} |
CoffeeMail::Rails.client.templates.preview | POST/templates/preview |
CoffeeMail::Rails.client.templates.format | POST/templates/format |
CoffeeMail::Rails.client.templates.test_render | POST/templates/test-render |
CoffeeMail::Rails.client.templates.test_send | POST/templates/{id}/test-send |
CoffeeMail::Rails.client.templates.list_versions | GET/templates/{id}/versions |
CoffeeMail::Rails.client.templates.get_version | GET/templates/{id}/versions/{version} |
CoffeeMail::Rails.client.templates.restore_version | POST/templates/{id}/versions/{version}/restore |
Audiências e contatos10 métodos
Endpoints →| Método | Endpoint chamado |
|---|---|
CoffeeMail::Rails.client.audiences.create | POST/audiences |
CoffeeMail::Rails.client.audiences.list | GET/audiences |
CoffeeMail::Rails.client.audiences.get | GET/audiences/{id} |
CoffeeMail::Rails.client.audiences.update | PUT/audiences/{id} |
CoffeeMail::Rails.client.audiences.delete | DELETE/audiences/{id} |
CoffeeMail::Rails.client.audiences.contacts.create | POST/audiences/{id}/contacts |
CoffeeMail::Rails.client.audiences.contacts.list | GET/audiences/{id}/contacts |
CoffeeMail::Rails.client.audiences.contacts.bulk_add | POST/audiences/{id}/contacts/bulk |
CoffeeMail::Rails.client.audiences.contacts.update | PUT/audiences/{id}/contacts/{contactId} |
CoffeeMail::Rails.client.audiences.contacts.delete | DELETE/audiences/{id}/contacts/{contactId} |
Campanhas6 métodos
Endpoints →| Método | Endpoint chamado |
|---|---|
CoffeeMail::Rails.client.broadcasts.create | POST/broadcasts |
CoffeeMail::Rails.client.broadcasts.list | GET/broadcasts |
CoffeeMail::Rails.client.broadcasts.get | GET/broadcasts/{id} |
CoffeeMail::Rails.client.broadcasts.send | POST/broadcasts/{id}/send |
CoffeeMail::Rails.client.broadcasts.test_send | POST/broadcasts/{id}/test-send |
CoffeeMail::Rails.client.broadcasts.cancel | POST/broadcasts/{id}/cancel |
Remetentes5 métodos
Endpoints →| Método | Endpoint chamado |
|---|---|
CoffeeMail::Rails.client.senders.create | POST/senders |
CoffeeMail::Rails.client.senders.list | GET/senders |
CoffeeMail::Rails.client.senders.verify | POST/senders/verify |
CoffeeMail::Rails.client.senders.resend_verification | POST/senders/{id}/resend-verification |
CoffeeMail::Rails.client.senders.delete | DELETE/senders/{id} |
Supressões6 métodos
Endpoints →| Método | Endpoint chamado |
|---|---|
CoffeeMail::Rails.client.suppressions.create | POST/suppressions |
CoffeeMail::Rails.client.suppressions.list | GET/suppressions |
CoffeeMail::Rails.client.suppressions.get | GET/suppressions/{id} |
CoffeeMail::Rails.client.suppressions.delete | DELETE/suppressions/{id} |
CoffeeMail::Rails.client.suppressions.reactivate | POST/suppressions/{id}/reactivate |
CoffeeMail::Rails.client.suppressions.bulk_create | POST/suppressions/bulk |
Webhooks11 métodos
Endpoints →| Método | Endpoint chamado |
|---|---|
CoffeeMail::Rails.client.webhooks.create | POST/webhooks |
CoffeeMail::Rails.client.webhooks.list | GET/webhooks |
CoffeeMail::Rails.client.webhooks.get | GET/webhooks/{id} |
CoffeeMail::Rails.client.webhooks.update | PUT/webhooks/{id} |
CoffeeMail::Rails.client.webhooks.toggle | PATCH/webhooks/{id} |
CoffeeMail::Rails.client.webhooks.delete | DELETE/webhooks/{id} |
CoffeeMail::Rails.client.webhooks.rotate_secret | POST/webhooks/{id}/rotate-secret |
CoffeeMail::Rails.client.webhooks.list_deliveries | GET/webhooks/{id}/deliveries |
CoffeeMail::Rails.client.webhooks.test | POST/webhooks/{id}/test |
CoffeeMail::Rails.client.webhooks.get_delivery | GET/webhooks/{id}/deliveries/{deliveryId} |
CoffeeMail::Rails.client.webhooks.replay_delivery | POST/webhooks/{id}/deliveries/{deliveryId}/replay |
Estatísticas1 método
Endpoints →| Método | Endpoint chamado |
|---|---|
CoffeeMail::Rails.client.stats.get | GET/stats |
Validação1 método
Endpoints →| Método | Endpoint chamado |
|---|---|
CoffeeMail::Rails.client.validation.validate | POST/validate |