Skip to main content
SDKs · Rails

Rails

ActionMailer delivery method and webhook Rack app on top of the Ruby SDK.

v0.1.0RubyGemsGitHub70 methodsResponse (data, error)

Installation

Add the package to your project.

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

Configure the client

The key comes from COFFEEMAIL_API_KEY or the constructor. Use one key per environment.

With the delivery method, your app mailers send through CoffeeMail without code changes. The full SDK client lives at CoffeeMail::Rails.client.
client
config.action_mailer.delivery_method = :coffeemail

Send an email

The send is queued and returns within milliseconds with the id and the queued status. Returns: Response (data, error).

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

Handle errors

API errors arrive typed, with code, status and requestId; nothing is thrown on the common path.

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

Paginate

Lists return the page and a nextCursor; pass it as after to fetch the next one.

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

Verify webhooks

Validate x-webhook-signature against the raw request body, x-webhook-timestamp and x-webhook-idempotency-key. The default window is 300 seconds.

webhook
Rails.application.routes.draw do  mount CoffeeMail::Rails::WebhookApp.new, at: "/webhooks/coffeemail"end

Method reference

Every public method, grouped by resource. Each row shows the endpoint it calls; open the API reference for fields and responses.

The methods below come from the Ruby SDK, reached through CoffeeMail::Rails.client.

Emails8 methods

Endpoints →
MethodEndpoint called
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

Domains10 methods

Endpoints →
MethodEndpoint called
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

Templates12 methods

Endpoints →
MethodEndpoint called
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

Audiences and contacts10 methods

Endpoints →
MethodEndpoint called
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}

Campaigns6 methods

Endpoints →
MethodEndpoint called
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

Senders5 methods

Endpoints →
MethodEndpoint called
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}

Suppressions6 methods

Endpoints →
MethodEndpoint called
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 methods

Endpoints →
MethodEndpoint called
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

Statistics1 method

Endpoints →
MethodEndpoint called
CoffeeMail::Rails.client.stats.getGET/stats

Validation1 method

Endpoints →
MethodEndpoint called
CoffeeMail::Rails.client.validation.validatePOST/validate