Email

Get one email

One email with its status (queued, sent, delivered, bounced, complained: marked as spam, failed or simulated), a short reason, the status per recipient (one can bounce while the others are delivered) and the timeline with times.

get/emails/{id}

Request

  • Base URL: https://api.hypamoon.com/api/v1
  • URL: https://api.hypamoon.com/api/v1/emails/{id}
  • Auth: one of:
    • HTTP bearer
    • OAuth 2 (authorization code, authorization URL https://app.hypamoon.com/oauth/authorize, token URL https://api.hypamoon.com/oauth/token, scopes: messages:read)

Path parameters

idstring uuid required

The id of the email.

Response

The email.

idstring uuid required

The id of the email. sendEmail and sendEmailBatch in an app return it; getEmail(id) reads it back.

app_idstring uuid nullable required

The app that sent it with env.HYPAMOON.sendEmail; null when it was sent with the API, by an agent or from the portal.

fromstring required
tostring required

The first address in to. All recipients are in recipients.

recipient_countinteger required

to, cc and bcc together; each counts toward the limits and the bundle.

reply_tostring nullable required
subjectstring required
category'transactional' | 'other' required
status'queued' | 'sent' | 'delivered' | 'bounced' | 'complained' | 'failed' | 'simulated' required

queued, sent (accepted for delivery), delivered, bounced, complained (marked as spam), failed, or simulated (test mode).

recipient_source'confirmed' | 'member' | 'form' | 'document' | 'conversation' | 'app_user' | 'buyer' | 'pass_holder' | 'null' nullable required

Where the recipient appears in the project.

testboolean required
errorstring nullable required
reasonstring nullable required

Why the email bounced, was marked as spam, is delayed or was not sent, in plain words. null otherwise.

created_atstring required
sent_atstring nullable required
delivered_atstring nullable required
bounced_atstring nullable required
complained_atstring nullable required
sender'hypamoon_fallback'

Only when the project has no verified sending domain of its own: the email went from Hypamoon's address ("<app or project> via Hypamoon"), in a neutral layout without the project's images or design. Tell the user so.

next_stepstring

With sender hypamoon_fallback: how to send from the project's own address with its own design.

Changes

No recorded changes to this operation across all 1 revision of this API.