All Classes and Interfaces
Class
Description
Wire model for the SendByte error envelope:
An API key.
The result of
ApiKeys.list(): all active (non-revoked) keys on the account.The API Keys resource: create scoped keys, list active keys, and revoke keys.
A file attachment on an outgoing email.
authentication_error (401): missing, revoked, or malformed API key.authorization_error (403): the API key's scope is insufficient.A DNS record you must publish to authenticate a sending domain, returned by
Domains.create(String) and Domains.get(String).A sending domain.
The result of a live DNS check for a single record, returned by
Domains.verify(String).The result of
Domains.list(): all sending domains on the account.domain_not_verified (403): live send attempted from an unverified domain.The Domains resource: register sending domains, fetch their DNS records, and
trigger verification.
Verification status of a sending domain.
A sent email as returned by
Emails.send(africa.sendbyte.emails.SendEmailRequest), Emails.get(java.lang.String), and the
items of Emails.list().A single lifecycle event in an email's timeline, e.g.
A single page of results from
Emails.list().The Emails resource: send transactional emails and read them back.
The delivery status of an email.
Abstraction over the underlying HTTP client.
idempotency_conflict (409): idempotency key reused with a different payload.internal_error (500): a server-side fault occurred.Internal JSON helper wrapping a configured Jackson
ObjectMapper.The environment mode of an API key.
The permission scope of an API key.
Optional query parameters for
Emails.list(ListEmailsParams).not_found (404): the requested resource does not exist.Default
HttpTransport backed by OkHttp.rate_limit_exceeded (429): the per-key request rate was exceeded.The rendered output of
Templates.render(RenderRequest) or
Templates.preview(String, java.util.Map) — the final subject and bodies a
recipient would receive, with variables interpolated.The payload for
Templates.render(RenderRequest): a template body plus
variables, compiled and rendered inline without saving anything.Central request pipeline: builds the URL, serializes the body, delegates to the
HttpTransport, and turns the raw response into either a typed model or a
SendByteException.The entry point to the SendByte API.
Immutable configuration for a
SendByteClient.Raised when the SDK cannot reach the SendByte API at all (DNS failure,
connection reset, timeout, etc.).
Base type for every error surfaced by the SendByte SDK.
A transport-agnostic description of an HTTP request to the SendByte API.
A minimal, transport-agnostic view of an HTTP response from the SendByte API.
Functional lookup so transports can adapt their own header representation.
The payload for
Emails.send(SendEmailRequest).suppressed_recipient (422): a recipient is on the project's suppression list.A saved, server-side email template.
The result of
Templates.list(): all templates in the project.The Templates resource: manage reusable server-side Handlebars/MJML templates and
preview their rendered output.
validation_error (422): one or more request fields failed validation.A single webhook delivery attempt, from
Webhooks.deliveries(String) or the
fresh attempt created by Webhooks.replay(String).The result of
Webhooks.deliveries(String): recent delivery attempts, newest first.A registered webhook endpoint that SendByte delivers events to.
The result of
Webhooks.list(): all webhook endpoints on the account.The Webhooks resource: register and manage webhook endpoints, inspect delivery
history, and replay deliveries.
Verifies the signature on inbound SendByte webhook requests.