Pular para o conteúdo principal
SDKs · Rails

Rails

Delivery method do ActionMailer e app Rack de webhooks sobre o SDK Ruby.

v0.1.0RubyGemsGitHub70 métodosResponse (data, error)

Instalação

Adicione o pacote ao projeto.

terminal
bundle add coffeemail-railsbin/rails g coffeemail:install --delivery-method

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
config.action_mailer.delivery_method = :coffeemail

Enviar um email

O envio entra na fila e volta em milissegundos com o id e o status queued. Retorno: Response (data, error).

enviar
PedidoMailer.with(pedido: @pedido).enviado.deliver_later

Tratar erros

Erros da API chegam tipados, com code, status e requestId; nada é lançado no caminho comum.

erros
rescue_from CoffeeMail::Rails::DeliveryError do |error|  Rails.logger.warn("#{error.error&.code}: #{error.message}")end

Paginar

Listas devolvem a página e o cursor nextCursor; passe-o em after para buscar a próxima.

paginar
CoffeeMail::Rails.client.emails.pages(limit: 100).each do |page|  page.data.emails.each { |email| handle(email) }end

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
Rails.application.routes.draw do  mount CoffeeMail::Rails::WebhookApp.new, at: "/webhooks/coffeemail"end

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étodoEndpoint chamado
CoffeeMail::Rails.client.emails.sendPOST/emails
CoffeeMail::Rails.client.emails.send_batchPOST/emails/batch
CoffeeMail::Rails.client.emails.getGET/emails/{id}
CoffeeMail::Rails.client.emails.listGET/emails
CoffeeMail::Rails.client.emails.get_eventsGET/emails/{id}/events
CoffeeMail::Rails.client.emails.get_tagsGET/emails/tags
CoffeeMail::Rails.client.emails.cancelPOST/emails/{id}/cancel
CoffeeMail::Rails.client.emails.resendPOST/emails/{id}/resend

Domínios10 métodos

Endpoints →
MétodoEndpoint chamado
CoffeeMail::Rails.client.domains.createPOST/domains
CoffeeMail::Rails.client.domains.listGET/domains
CoffeeMail::Rails.client.domains.getGET/domains/{id}
CoffeeMail::Rails.client.domains.verifyPOST/domains/{id}/verify
CoffeeMail::Rails.client.domains.deleteDELETE/domains/{id}
CoffeeMail::Rails.client.domains.get_healthPOST/domains/{id}/health
CoffeeMail::Rails.client.domains.get_warmup_statusGET/domains/{id}/warmup
CoffeeMail::Rails.client.domains.rotate_dkimPOST/domains/{id}/dkim/rotate
CoffeeMail::Rails.client.domains.set_tracking_domainPUT/domains/{id}/tracking-domain
CoffeeMail::Rails.client.domains.remove_tracking_domainDELETE/domains/{id}/tracking-domain

Modelos12 métodos

Endpoints →
MétodoEndpoint chamado
CoffeeMail::Rails.client.templates.createPOST/templates
CoffeeMail::Rails.client.templates.listGET/templates
CoffeeMail::Rails.client.templates.getGET/templates/{id}
CoffeeMail::Rails.client.templates.updatePATCH/templates/{id}
CoffeeMail::Rails.client.templates.deleteDELETE/templates/{id}
CoffeeMail::Rails.client.templates.previewPOST/templates/preview
CoffeeMail::Rails.client.templates.formatPOST/templates/format
CoffeeMail::Rails.client.templates.test_renderPOST/templates/test-render
CoffeeMail::Rails.client.templates.test_sendPOST/templates/{id}/test-send
CoffeeMail::Rails.client.templates.list_versionsGET/templates/{id}/versions
CoffeeMail::Rails.client.templates.get_versionGET/templates/{id}/versions/{version}
CoffeeMail::Rails.client.templates.restore_versionPOST/templates/{id}/versions/{version}/restore

Audiências e contatos10 métodos

Endpoints →
MétodoEndpoint chamado
CoffeeMail::Rails.client.audiences.createPOST/audiences
CoffeeMail::Rails.client.audiences.listGET/audiences
CoffeeMail::Rails.client.audiences.getGET/audiences/{id}
CoffeeMail::Rails.client.audiences.updatePUT/audiences/{id}
CoffeeMail::Rails.client.audiences.deleteDELETE/audiences/{id}
CoffeeMail::Rails.client.audiences.contacts.createPOST/audiences/{id}/contacts
CoffeeMail::Rails.client.audiences.contacts.listGET/audiences/{id}/contacts
CoffeeMail::Rails.client.audiences.contacts.bulk_addPOST/audiences/{id}/contacts/bulk
CoffeeMail::Rails.client.audiences.contacts.updatePUT/audiences/{id}/contacts/{contactId}
CoffeeMail::Rails.client.audiences.contacts.deleteDELETE/audiences/{id}/contacts/{contactId}

Campanhas6 métodos

Endpoints →
MétodoEndpoint chamado
CoffeeMail::Rails.client.broadcasts.createPOST/broadcasts
CoffeeMail::Rails.client.broadcasts.listGET/broadcasts
CoffeeMail::Rails.client.broadcasts.getGET/broadcasts/{id}
CoffeeMail::Rails.client.broadcasts.sendPOST/broadcasts/{id}/send
CoffeeMail::Rails.client.broadcasts.test_sendPOST/broadcasts/{id}/test-send
CoffeeMail::Rails.client.broadcasts.cancelPOST/broadcasts/{id}/cancel

Remetentes5 métodos

Endpoints →
MétodoEndpoint chamado
CoffeeMail::Rails.client.senders.createPOST/senders
CoffeeMail::Rails.client.senders.listGET/senders
CoffeeMail::Rails.client.senders.verifyPOST/senders/verify
CoffeeMail::Rails.client.senders.resend_verificationPOST/senders/{id}/resend-verification
CoffeeMail::Rails.client.senders.deleteDELETE/senders/{id}

Supressões6 métodos

Endpoints →
MétodoEndpoint chamado
CoffeeMail::Rails.client.suppressions.createPOST/suppressions
CoffeeMail::Rails.client.suppressions.listGET/suppressions
CoffeeMail::Rails.client.suppressions.getGET/suppressions/{id}
CoffeeMail::Rails.client.suppressions.deleteDELETE/suppressions/{id}
CoffeeMail::Rails.client.suppressions.reactivatePOST/suppressions/{id}/reactivate
CoffeeMail::Rails.client.suppressions.bulk_createPOST/suppressions/bulk

Webhooks11 métodos

Endpoints →
MétodoEndpoint chamado
CoffeeMail::Rails.client.webhooks.createPOST/webhooks
CoffeeMail::Rails.client.webhooks.listGET/webhooks
CoffeeMail::Rails.client.webhooks.getGET/webhooks/{id}
CoffeeMail::Rails.client.webhooks.updatePUT/webhooks/{id}
CoffeeMail::Rails.client.webhooks.togglePATCH/webhooks/{id}
CoffeeMail::Rails.client.webhooks.deleteDELETE/webhooks/{id}
CoffeeMail::Rails.client.webhooks.rotate_secretPOST/webhooks/{id}/rotate-secret
CoffeeMail::Rails.client.webhooks.list_deliveriesGET/webhooks/{id}/deliveries
CoffeeMail::Rails.client.webhooks.testPOST/webhooks/{id}/test
CoffeeMail::Rails.client.webhooks.get_deliveryGET/webhooks/{id}/deliveries/{deliveryId}
CoffeeMail::Rails.client.webhooks.replay_deliveryPOST/webhooks/{id}/deliveries/{deliveryId}/replay

Estatísticas1 método

Endpoints →
MétodoEndpoint chamado
CoffeeMail::Rails.client.stats.getGET/stats

Validação1 método

Endpoints →
MétodoEndpoint chamado
CoffeeMail::Rails.client.validation.validatePOST/validate