Index (SendByte Java SDK 0.1.0 API)

A B C D E F G H I J K L M N O P Q R S T U V W
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form

A

addAttachment(Attachment) - Method in class africa.sendbyte.emails.SendEmailRequest.Builder
africa.sendbyte - package africa.sendbyte
africa.sendbyte.apikeys - package africa.sendbyte.apikeys
africa.sendbyte.domains - package africa.sendbyte.domains
africa.sendbyte.emails - package africa.sendbyte.emails
africa.sendbyte.exceptions - package africa.sendbyte.exceptions
africa.sendbyte.http - package africa.sendbyte.http
africa.sendbyte.templates - package africa.sendbyte.templates
africa.sendbyte.webhooks - package africa.sendbyte.webhooks
after(String) - Method in class africa.sendbyte.emails.ListEmailsParams.Builder: Cursor: the id of the last email from the previous page.
ApiError() - Constructor for class africa.sendbyte.exceptions.ApiErrorEnvelope.ApiError
ApiErrorEnvelope - Class in africa.sendbyte.exceptions: Wire model for the SendByte error envelope:
ApiErrorEnvelope() - Constructor for class africa.sendbyte.exceptions.ApiErrorEnvelope
ApiErrorEnvelope.ApiError - Class in africa.sendbyte.exceptions
apiKey() - Method in class africa.sendbyte.SendByteClientOptions
apiKey(String) - Method in class africa.sendbyte.SendByteClientOptions.Builder
ApiKey - Class in africa.sendbyte.apikeys: An API key.
ApiKey() - Constructor for class africa.sendbyte.apikeys.ApiKey
ApiKeyList - Class in africa.sendbyte.apikeys: The result of ApiKeys.list(): all active (non-revoked) keys on the account.
ApiKeyList() - Constructor for class africa.sendbyte.apikeys.ApiKeyList
apiKeys() - Method in class africa.sendbyte.SendByteClient: Access the API Keys resource: create, list, and revoke scoped keys.
ApiKeys - Class in africa.sendbyte.apikeys: The API Keys resource: create scoped keys, list active keys, and revoke keys.
ApiKeys(RequestExecutor) - Constructor for class africa.sendbyte.apikeys.ApiKeys
Attachment - Class in africa.sendbyte.emails: A file attachment on an outgoing email.
Attachment(String, String, String) - Constructor for class africa.sendbyte.emails.Attachment
attachments(List<Attachment>) - Method in class africa.sendbyte.emails.SendEmailRequest.Builder
AuthenticationException - Exception Class in africa.sendbyte.exceptions: authentication_error (401): missing, revoked, or malformed API key.
AuthenticationException(String, String, int, String, String) - Constructor for exception class africa.sendbyte.exceptions.AuthenticationException
AuthorizationException - Exception Class in africa.sendbyte.exceptions: authorization_error (403): the API key's scope is insufficient.
AuthorizationException(String, String, int, String, String) - Constructor for exception class africa.sendbyte.exceptions.AuthorizationException

B

baseUrl() - Method in interface africa.sendbyte.http.HttpTransport: The base URL (including scheme and version prefix) requests are sent to.
baseUrl() - Method in class africa.sendbyte.http.OkHttpTransport
baseUrl() - Method in class africa.sendbyte.SendByteClientOptions
baseUrl(String) - Method in class africa.sendbyte.SendByteClientOptions.Builder: Override the API base URL.
bcc(String...) - Method in class africa.sendbyte.emails.SendEmailRequest.Builder
bcc(List<String>) - Method in class africa.sendbyte.emails.SendEmailRequest.Builder
body() - Method in class africa.sendbyte.http.SendByteHttpRequest: The request body as a plain object to be JSON-serialized, or null.
body() - Method in class africa.sendbyte.http.SendByteResponse
body(Object) - Method in class africa.sendbyte.http.SendByteHttpRequest.Builder
BOUNCED - Enum constant in enum africa.sendbyte.emails.EmailStatus
build() - Method in class africa.sendbyte.emails.ListEmailsParams.Builder
build() - Method in class africa.sendbyte.emails.SendEmailRequest.Builder
build() - Method in class africa.sendbyte.http.SendByteHttpRequest.Builder
build() - Method in class africa.sendbyte.SendByteClientOptions.Builder
build() - Method in class africa.sendbyte.templates.RenderRequest.Builder
build() - Method in class africa.sendbyte.templates.TemplateRequest.Builder
builder() - Static method in class africa.sendbyte.emails.ListEmailsParams
builder() - Static method in class africa.sendbyte.emails.SendEmailRequest
builder() - Static method in class africa.sendbyte.SendByteClientOptions
builder() - Static method in class africa.sendbyte.templates.RenderRequest
builder() - Static method in class africa.sendbyte.templates.TemplateRequest
builder(String, String) - Static method in class africa.sendbyte.http.SendByteHttpRequest
Builder() - Constructor for class africa.sendbyte.emails.ListEmailsParams.Builder
Builder() - Constructor for class africa.sendbyte.emails.SendEmailRequest.Builder
Builder() - Constructor for class africa.sendbyte.SendByteClientOptions.Builder
Builder() - Constructor for class africa.sendbyte.templates.RenderRequest.Builder
Builder() - Constructor for class africa.sendbyte.templates.TemplateRequest.Builder

C

cc(String...) - Method in class africa.sendbyte.emails.SendEmailRequest.Builder
cc(List<String>) - Method in class africa.sendbyte.emails.SendEmailRequest.Builder
close() - Method in interface africa.sendbyte.http.HttpTransport: Release any underlying resources.
close() - Method in class africa.sendbyte.http.OkHttpTransport
close() - Method in class africa.sendbyte.SendByteClient
COMPLAINED - Enum constant in enum africa.sendbyte.emails.EmailStatus
connectTimeout() - Method in class africa.sendbyte.SendByteClientOptions
connectTimeout(Duration) - Method in class africa.sendbyte.SendByteClientOptions.Builder
create(TemplateRequest) - Method in class africa.sendbyte.templates.Templates: Create a new template.
create(String) - Method in class africa.sendbyte.domains.Domains: Register a sending domain and receive the SPF, DKIM, and DMARC records to publish.
create(String) - Method in class africa.sendbyte.webhooks.Webhooks: Register an endpoint subscribed to all event types.
create(String, KeyScope, KeyMode) - Method in class africa.sendbyte.apikeys.ApiKeys: Create a new API key.
create(String, List<String>) - Method in class africa.sendbyte.webhooks.Webhooks: Register an endpoint subscribed to specific event types (e.g.
createAsync(TemplateRequest) - Method in class africa.sendbyte.templates.Templates: Asynchronous Templates.create(TemplateRequest).
createAsync(String) - Method in class africa.sendbyte.domains.Domains: Asynchronous Domains.create(String).
createAsync(String, KeyScope, KeyMode) - Method in class africa.sendbyte.apikeys.ApiKeys: Asynchronous ApiKeys.create(String, KeyScope, KeyMode).
createAsync(String, List<String>) - Method in class africa.sendbyte.webhooks.Webhooks: Asynchronous Webhooks.create(String, List).

D

DEFAULT_BASE_URL - Static variable in class africa.sendbyte.SendByteClientOptions: Default production API base URL, including the /v1 version prefix.
DEFAULT_TOLERANCE - Static variable in class africa.sendbyte.webhooks.WebhookSignature: Default replay tolerance: reject deliveries whose timestamp is older than this.
DEGRADED - Enum constant in enum africa.sendbyte.domains.DomainStatus: Was verified, but a later check found required records missing or invalid.
delete(String) - Method in class africa.sendbyte.templates.Templates: Permanently delete a template.
deleteAsync(String) - Method in class africa.sendbyte.templates.Templates: Asynchronous Templates.delete(String).
DELIVERED - Enum constant in enum africa.sendbyte.emails.EmailStatus
deliveries(String) - Method in class africa.sendbyte.webhooks.Webhooks: Fetch the recent delivery attempts (up to the last 50) for an endpoint.
deliveriesAsync(String) - Method in class africa.sendbyte.webhooks.Webhooks: Asynchronous Webhooks.deliveries(String).
disable(String) - Method in class africa.sendbyte.webhooks.Webhooks: Disable an endpoint so it stops receiving deliveries.
disableAsync(String) - Method in class africa.sendbyte.webhooks.Webhooks: Asynchronous Webhooks.disable(String).
DnsRecord - Class in africa.sendbyte.domains: A DNS record you must publish to authenticate a sending domain, returned by Domains.create(String) and Domains.get(String).
DnsRecord() - Constructor for class africa.sendbyte.domains.DnsRecord
Domain - Class in africa.sendbyte.domains: A sending domain.
Domain() - Constructor for class africa.sendbyte.domains.Domain
DomainCheck - Class in africa.sendbyte.domains: The result of a live DNS check for a single record, returned by Domains.verify(String).
DomainCheck() - Constructor for class africa.sendbyte.domains.DomainCheck
DomainList - Class in africa.sendbyte.domains: The result of Domains.list(): all sending domains on the account.
DomainList() - Constructor for class africa.sendbyte.domains.DomainList
DomainNotVerifiedException - Exception Class in africa.sendbyte.exceptions: domain_not_verified (403): live send attempted from an unverified domain.
DomainNotVerifiedException(String, String, int, String, String) - Constructor for exception class africa.sendbyte.exceptions.DomainNotVerifiedException
domains() - Method in class africa.sendbyte.SendByteClient: Access the Domains resource: register, retrieve, list, and verify sending domains.
Domains - Class in africa.sendbyte.domains: The Domains resource: register sending domains, fetch their DNS records, and trigger verification.
Domains(RequestExecutor) - Constructor for class africa.sendbyte.domains.Domains
DomainStatus - Enum in africa.sendbyte.domains: Verification status of a sending domain.

E

Email - Class in africa.sendbyte.emails: A sent email as returned by Emails.send(africa.sendbyte.emails.SendEmailRequest), Emails.get(java.lang.String), and the items of Emails.list().
Email() - Constructor for class africa.sendbyte.emails.Email
EmailEvent - Class in africa.sendbyte.emails: A single lifecycle event in an email's timeline, e.g.
EmailEvent() - Constructor for class africa.sendbyte.emails.EmailEvent
EmailList - Class in africa.sendbyte.emails: A single page of results from Emails.list().
EmailList() - Constructor for class africa.sendbyte.emails.EmailList
emails() - Method in class africa.sendbyte.SendByteClient: Access the Emails resource: send, retrieve, and list transactional emails.
Emails - Class in africa.sendbyte.emails: The Emails resource: send transactional emails and read them back.
Emails(RequestExecutor) - Constructor for class africa.sendbyte.emails.Emails
EmailStatus - Enum in africa.sendbyte.emails: The delivery status of an email.
execute(SendByteHttpRequest, Class<T>) - Method in class africa.sendbyte.http.RequestExecutor: Execute a request and deserialize the success body into type.
execute(String, String, Map<String, String>, String) - Method in interface africa.sendbyte.http.HttpTransport: Execute a request synchronously.
execute(String, String, Map<String, String>, String) - Method in class africa.sendbyte.http.OkHttpTransport
executeAsync(SendByteHttpRequest, Class<T>) - Method in class africa.sendbyte.http.RequestExecutor: Execute a request asynchronously and deserialize the success body into type.
executeAsync(String, String, Map<String, String>, String) - Method in interface africa.sendbyte.http.HttpTransport: Execute a request asynchronously.
executeAsync(String, String, Map<String, String>, String) - Method in class africa.sendbyte.http.OkHttpTransport

F

from(String) - Method in class africa.sendbyte.emails.SendEmailRequest.Builder: Sender address.
fromApiError(int, String, String, String, String, Integer) - Static method in exception class africa.sendbyte.exceptions.SendByteException: Build the most specific exception subclass for an API error response.
fromWire(String) - Static method in enum africa.sendbyte.apikeys.KeyMode
fromWire(String) - Static method in enum africa.sendbyte.apikeys.KeyScope
fromWire(String) - Static method in enum africa.sendbyte.domains.DomainStatus
fromWire(String) - Static method in enum africa.sendbyte.emails.EmailStatus
FULL_ACCESS - Enum constant in enum africa.sendbyte.apikeys.KeyScope: All operations, including creating and revoking keys.

G

get(String) - Method in class africa.sendbyte.domains.Domains: Fetch a single domain and its verification status by id.
get(String) - Method in class africa.sendbyte.emails.Emails: Retrieve a single email by id, including its rendered body and full event timeline.
get(String) - Method in interface africa.sendbyte.http.SendByteResponse.HeaderLookup
get(String) - Method in class africa.sendbyte.templates.Templates: Retrieve a template by id, including its stored HTML and MJML source.
getAfter() - Method in class africa.sendbyte.emails.ListEmailsParams
getAsync(String) - Method in class africa.sendbyte.domains.Domains: Asynchronous Domains.get(String).
getAsync(String) - Method in class africa.sendbyte.emails.Emails: Asynchronous Emails.get(String).
getAsync(String) - Method in class africa.sendbyte.templates.Templates: Asynchronous Templates.get(String).
getAttachments() - Method in class africa.sendbyte.emails.SendEmailRequest
getAttemptedAt() - Method in class africa.sendbyte.webhooks.WebhookDelivery: ISO 8601 timestamp of the attempt, or null if not yet attempted.
getBcc() - Method in class africa.sendbyte.emails.SendEmailRequest
getCc() - Method in class africa.sendbyte.emails.SendEmailRequest
getChecks() - Method in class africa.sendbyte.domains.Domain: Per-record DNS check results.
getCode() - Method in class africa.sendbyte.exceptions.ApiErrorEnvelope.ApiError
getCode() - Method in exception class africa.sendbyte.exceptions.SendByteException: Stable machine-readable error code, e.g.
getContent() - Method in class africa.sendbyte.emails.Attachment: Base64-encoded file content.
getContentType() - Method in class africa.sendbyte.emails.Attachment
getCreatedAt() - Method in class africa.sendbyte.apikeys.ApiKey
getCreatedAt() - Method in class africa.sendbyte.domains.Domain
getCreatedAt() - Method in class africa.sendbyte.emails.Email
getCreatedAt() - Method in class africa.sendbyte.emails.EmailEvent: ISO 8601 timestamp of when the event was recorded.
getCreatedAt() - Method in class africa.sendbyte.templates.Template
getCreatedAt() - Method in class africa.sendbyte.webhooks.WebhookEndpoint
getData() - Method in class africa.sendbyte.apikeys.ApiKeyList: The active keys.
getData() - Method in class africa.sendbyte.domains.DomainList: The registered domains.
getData() - Method in class africa.sendbyte.emails.EmailList: The emails on this page, newest-first.
getData() - Method in class africa.sendbyte.templates.TemplateList: The templates in the project.
getData() - Method in class africa.sendbyte.webhooks.WebhookDeliveryList: The delivery attempts (up to the last 50), newest first.
getData() - Method in class africa.sendbyte.webhooks.WebhookEndpointList: The registered endpoints.
getDkimSelector() - Method in class africa.sendbyte.domains.Domain: The DKIM selector (e.g.
getDnsRecords() - Method in class africa.sendbyte.domains.Domain: DNS records to publish.
getDocsUrl() - Method in class africa.sendbyte.exceptions.ApiErrorEnvelope.ApiError
getDocsUrl() - Method in exception class africa.sendbyte.exceptions.SendByteException: Link to the documentation page for this error, or null.
getDomain() - Method in class africa.sendbyte.domains.Domain: The bare domain name, e.g.
getError() - Method in class africa.sendbyte.exceptions.ApiErrorEnvelope
getEvents() - Method in class africa.sendbyte.emails.Email: Chronological lifecycle timeline.
getEvents() - Method in class africa.sendbyte.webhooks.WebhookEndpoint: The subscribed event types.
getEventType() - Method in class africa.sendbyte.webhooks.WebhookDelivery: The event type that triggered this delivery, e.g.
getFilename() - Method in class africa.sendbyte.emails.Attachment
getFormat() - Method in class africa.sendbyte.templates.Template: The stored body format, e.g.
getFrom() - Method in class africa.sendbyte.emails.Email
getFrom() - Method in class africa.sendbyte.emails.SendEmailRequest
getHeaders() - Method in class africa.sendbyte.emails.SendEmailRequest
getHost() - Method in class africa.sendbyte.domains.DnsRecord: The host/name to publish the record at, e.g.
getHost() - Method in class africa.sendbyte.domains.DomainCheck: The DNS host that was queried.
getHtml() - Method in class africa.sendbyte.emails.Email: Rendered HTML body.
getHtml() - Method in class africa.sendbyte.emails.SendEmailRequest
getHtml() - Method in class africa.sendbyte.templates.RenderedTemplate
getHtml() - Method in class africa.sendbyte.templates.RenderRequest
getHtml() - Method in class africa.sendbyte.templates.Template: The stored HTML body.
getHtml() - Method in class africa.sendbyte.templates.TemplateRequest
getId() - Method in class africa.sendbyte.apikeys.ApiKey: Unique key identifier (prefixed key_); pass to ApiKeys.revoke(String).
getId() - Method in class africa.sendbyte.domains.Domain: Unique domain identifier; use as the id for Domains.verify(String).
getId() - Method in class africa.sendbyte.emails.Email: Unique email identifier (prefixed em_).
getId() - Method in class africa.sendbyte.templates.Template: Unique template identifier (a UUID).
getId() - Method in class africa.sendbyte.webhooks.WebhookDelivery: Unique delivery identifier (prefixed del_); pass to Webhooks.replay(String).
getId() - Method in class africa.sendbyte.webhooks.WebhookEndpoint: Unique endpoint identifier (prefixed wh_).
getIdempotencyKey() - Method in class africa.sendbyte.emails.SendEmailRequest
getKey() - Method in class africa.sendbyte.apikeys.ApiKey: The full API key string.
getLastUsedAt() - Method in class africa.sendbyte.apikeys.ApiKey: ISO 8601 timestamp of the most recent authenticated request, or null if unused.
getLatencyMs() - Method in class africa.sendbyte.webhooks.WebhookDelivery: Round-trip latency in milliseconds, or null if not yet attempted.
getLimit() - Method in class africa.sendbyte.emails.ListEmailsParams
getMessage() - Method in class africa.sendbyte.exceptions.ApiErrorEnvelope.ApiError
getMjml() - Method in class africa.sendbyte.templates.RenderRequest
getMjml() - Method in class africa.sendbyte.templates.Template: The original MJML source, if the template was authored in MJML.
getMjml() - Method in class africa.sendbyte.templates.TemplateRequest
getMode() - Method in class africa.sendbyte.apikeys.ApiKey: Raw mode string.
getName() - Method in class africa.sendbyte.apikeys.ApiKey: The human-readable label assigned at creation.
getName() - Method in class africa.sendbyte.templates.Template: The unique, human-readable template name within the project.
getName() - Method in class africa.sendbyte.templates.TemplateRequest
getPayload() - Method in class africa.sendbyte.emails.EmailEvent: Event-specific metadata such as SMTP response codes or delivery timing.
getPrefix() - Method in class africa.sendbyte.apikeys.ApiKey: A masked prefix identifying the key (e.g.
getPurpose() - Method in class africa.sendbyte.domains.DnsRecord: The protocol this record serves: spf, dkim, or dmarc.
getPurpose() - Method in class africa.sendbyte.domains.DomainCheck: The protocol this check covers: spf, dkim, or dmarc.
getReplayOf() - Method in class africa.sendbyte.webhooks.WebhookDelivery: For a replay, the id of the original delivery it was created from; null otherwise.
getReplyTo() - Method in class africa.sendbyte.emails.SendEmailRequest
getRequestId() - Method in exception class africa.sendbyte.exceptions.SendByteException: Value of the x-request-id response header, or null.
getRetryAfterSeconds() - Method in exception class africa.sendbyte.exceptions.RateLimitException: Seconds to wait before retrying, from the Retry-After header, or null.
getScheduledAt() - Method in class africa.sendbyte.emails.Email: ISO 8601 scheduled send time, or null for immediate delivery.
getScheduledAt() - Method in class africa.sendbyte.emails.SendEmailRequest
getScope() - Method in class africa.sendbyte.apikeys.ApiKey: Raw scope string.
getSecret() - Method in class africa.sendbyte.webhooks.WebhookEndpoint: The signing secret (whsec_...).
getStatus() - Method in class africa.sendbyte.domains.Domain: Raw status string.
getStatus() - Method in class africa.sendbyte.emails.Email: Raw status string, e.g.
getStatus() - Method in class africa.sendbyte.emails.ListEmailsParams
getStatus() - Method in exception class africa.sendbyte.exceptions.SendByteException: HTTP status code, or 0 for transport-level errors.
getStatusCode() - Method in class africa.sendbyte.webhooks.WebhookDelivery: HTTP status your endpoint returned; 0 if the connection failed, null if not yet attempted.
getSubject() - Method in class africa.sendbyte.emails.Email
getSubject() - Method in class africa.sendbyte.emails.SendEmailRequest
getSubject() - Method in class africa.sendbyte.templates.RenderedTemplate
getSubject() - Method in class africa.sendbyte.templates.RenderRequest
getSubject() - Method in class africa.sendbyte.templates.Template: The subject line, which may contain Handlebars variables.
getSubject() - Method in class africa.sendbyte.templates.TemplateRequest
getSucceeded() - Method in class africa.sendbyte.webhooks.WebhookDelivery: true if your endpoint returned 2xx in time; null if not yet attempted.
getTags() - Method in class africa.sendbyte.emails.SendEmailRequest
getTemplateId() - Method in class africa.sendbyte.emails.SendEmailRequest
getText() - Method in class africa.sendbyte.emails.Email
getText() - Method in class africa.sendbyte.emails.SendEmailRequest
getText() - Method in class africa.sendbyte.templates.RenderedTemplate
getText() - Method in class africa.sendbyte.templates.RenderRequest
getText() - Method in class africa.sendbyte.templates.Template
getText() - Method in class africa.sendbyte.templates.TemplateRequest
getTo() - Method in class africa.sendbyte.emails.Email
getTo() - Method in class africa.sendbyte.emails.SendEmailRequest
getType() - Method in class africa.sendbyte.domains.DnsRecord: DNS record type.
getType() - Method in class africa.sendbyte.emails.EmailEvent: The event name, e.g.
getUpdatedAt() - Method in class africa.sendbyte.templates.Template
getUrl() - Method in class africa.sendbyte.webhooks.WebhookEndpoint: The HTTPS destination URL.
getValue() - Method in class africa.sendbyte.domains.DnsRecord: The exact TXT value to publish.
getVariables() - Method in class africa.sendbyte.emails.SendEmailRequest
getVariables() - Method in class africa.sendbyte.templates.RenderRequest
getVerifiedAt() - Method in class africa.sendbyte.domains.Domain: ISO 8601 timestamp of verification, or null if not yet verified.
getVersion() - Method in class africa.sendbyte.templates.Template: The version counter, bumped on each update.

H

header(String) - Method in class africa.sendbyte.http.SendByteResponse: Case-insensitive header lookup; returns null when absent.
header(String, String) - Method in class africa.sendbyte.emails.SendEmailRequest.Builder: Add a single custom MIME header.
header(String, String) - Method in class africa.sendbyte.http.SendByteHttpRequest.Builder
headers() - Method in class africa.sendbyte.http.SendByteHttpRequest
headers(Map<String, String>) - Method in class africa.sendbyte.emails.SendEmailRequest.Builder
html(String) - Method in class africa.sendbyte.emails.SendEmailRequest.Builder
html(String) - Method in class africa.sendbyte.templates.RenderRequest.Builder
html(String) - Method in class africa.sendbyte.templates.TemplateRequest.Builder: HTML body with Handlebars syntax.
HttpTransport - Interface in africa.sendbyte.http: Abstraction over the underlying HTTP client.

I

IdempotencyConflictException - Exception Class in africa.sendbyte.exceptions: idempotency_conflict (409): idempotency key reused with a different payload.
IdempotencyConflictException(String, String, int, String, String) - Constructor for exception class africa.sendbyte.exceptions.IdempotencyConflictException
idempotencyKey(String) - Method in class africa.sendbyte.emails.SendEmailRequest.Builder: A unique key (UUID recommended) that makes retries safe against duplicate sends.
InternalServerException - Exception Class in africa.sendbyte.exceptions: internal_error (500): a server-side fault occurred.
InternalServerException(String, String, int, String, String) - Constructor for exception class africa.sendbyte.exceptions.InternalServerException
isDisabled() - Method in class africa.sendbyte.webhooks.WebhookEndpoint: true if the endpoint has been disabled.
isHasMore() - Method in class africa.sendbyte.emails.EmailList: true if more emails exist older than the last item on this page.
isHasMore() - Method in class africa.sendbyte.templates.TemplateList: true if the API paginated the result and more templates exist.
isPass() - Method in class africa.sendbyte.domains.DomainCheck: true if the expected record was found and valid at query time.
isRequired() - Method in class africa.sendbyte.domains.DnsRecord: true if this record must be present for the domain to verify (SPF and DKIM).
isRequired() - Method in class africa.sendbyte.domains.DomainCheck: true if this record must pass for the domain to be marked verified.
isSandbox() - Method in class africa.sendbyte.emails.Email
isSuccessful() - Method in class africa.sendbyte.http.SendByteResponse

J

json() - Method in class africa.sendbyte.http.RequestExecutor
Json - Class in africa.sendbyte.http: Internal JSON helper wrapping a configured Jackson ObjectMapper.
Json() - Constructor for class africa.sendbyte.http.Json

K

KeyMode - Enum in africa.sendbyte.apikeys: The environment mode of an API key.
KeyScope - Enum in africa.sendbyte.apikeys: The permission scope of an API key.

L

limit(Integer) - Method in class africa.sendbyte.emails.ListEmailsParams.Builder: Page size, 1-100.
list() - Method in class africa.sendbyte.apikeys.ApiKeys: List all active (non-revoked) keys.
list() - Method in class africa.sendbyte.domains.Domains: List all domains registered on the account.
list() - Method in class africa.sendbyte.emails.Emails: List sent emails, newest-first, using default paging.
list() - Method in class africa.sendbyte.templates.Templates: List all templates in the project.
list() - Method in class africa.sendbyte.webhooks.Webhooks: List all webhook endpoints on the account.
list(ListEmailsParams) - Method in class africa.sendbyte.emails.Emails: List sent emails with optional filtering and cursor pagination.
listAsync() - Method in class africa.sendbyte.apikeys.ApiKeys: Asynchronous ApiKeys.list().
listAsync() - Method in class africa.sendbyte.domains.Domains: Asynchronous Domains.list().
listAsync() - Method in class africa.sendbyte.templates.Templates: Asynchronous Templates.list().
listAsync() - Method in class africa.sendbyte.webhooks.Webhooks: Asynchronous Webhooks.list().
listAsync(ListEmailsParams) - Method in class africa.sendbyte.emails.Emails: Asynchronous Emails.list(ListEmailsParams).
ListEmailsParams - Class in africa.sendbyte.emails: Optional query parameters for Emails.list(ListEmailsParams).
ListEmailsParams.Builder - Class in africa.sendbyte.emails
LIVE - Enum constant in enum africa.sendbyte.apikeys.KeyMode: Sends real email.

M

mapper() - Method in class africa.sendbyte.http.Json
method() - Method in class africa.sendbyte.http.SendByteHttpRequest
mjml(String) - Method in class africa.sendbyte.templates.RenderRequest.Builder
mjml(String) - Method in class africa.sendbyte.templates.TemplateRequest.Builder: MJML source; compiled to responsive HTML at save time.
mode() - Method in class africa.sendbyte.apikeys.ApiKey: The mode as a typed enum, mapping unknown values to KeyMode.UNKNOWN.

N

name(String) - Method in class africa.sendbyte.templates.TemplateRequest.Builder: A unique, human-readable template name, e.g.
NotFoundException - Exception Class in africa.sendbyte.exceptions: not_found (404): the requested resource does not exist.
NotFoundException(String, String, int, String, String) - Constructor for exception class africa.sendbyte.exceptions.NotFoundException

O

of(String, String, byte[]) - Static method in class africa.sendbyte.emails.Attachment: Build an attachment from raw bytes, Base64-encoding them for you.
OkHttpTransport - Class in africa.sendbyte.http: Default HttpTransport backed by OkHttp.
OkHttpTransport(SendByteClientOptions) - Constructor for class africa.sendbyte.http.OkHttpTransport

P

path() - Method in class africa.sendbyte.http.SendByteHttpRequest
PENDING - Enum constant in enum africa.sendbyte.domains.DomainStatus: Registered but not yet passed a DNS check.
preview(String, Map<String, Object>) - Method in class africa.sendbyte.templates.Templates: Render a previously saved template against a set of variables, without sending.
previewAsync(String, Map<String, Object>) - Method in class africa.sendbyte.templates.Templates: Asynchronous Templates.preview(String, Map).

Q

query() - Method in class africa.sendbyte.http.SendByteHttpRequest
query(String, Object) - Method in class africa.sendbyte.http.SendByteHttpRequest.Builder: Add a query parameter.
QUEUED - Enum constant in enum africa.sendbyte.emails.EmailStatus

R

RateLimitException - Exception Class in africa.sendbyte.exceptions: rate_limit_exceeded (429): the per-key request rate was exceeded.
RateLimitException(String, String, int, String, String, Integer) - Constructor for exception class africa.sendbyte.exceptions.RateLimitException
read(String, Class<T>) - Method in class africa.sendbyte.http.Json: Deserialize a JSON string into the given type.
READ_ONLY - Enum constant in enum africa.sendbyte.apikeys.KeyScope: Read emails, domains, and logs.
readTimeout() - Method in class africa.sendbyte.SendByteClientOptions
readTimeout(Duration) - Method in class africa.sendbyte.SendByteClientOptions.Builder
receivesAllEvents() - Method in class africa.sendbyte.webhooks.WebhookEndpoint: true if this endpoint subscribes to every event type.
render(RenderRequest) - Method in class africa.sendbyte.templates.Templates: Render a template body with variables inline, without saving anything.
renderAsync(RenderRequest) - Method in class africa.sendbyte.templates.Templates: Asynchronous Templates.render(RenderRequest).
RenderedTemplate - Class in africa.sendbyte.templates: 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.
RenderedTemplate() - Constructor for class africa.sendbyte.templates.RenderedTemplate
RenderRequest - Class in africa.sendbyte.templates: The payload for Templates.render(RenderRequest): a template body plus variables, compiled and rendered inline without saving anything.
RenderRequest.Builder - Class in africa.sendbyte.templates
replay(String) - Method in class africa.sendbyte.webhooks.Webhooks: Re-enqueue a past delivery as a fresh attempt.
replayAsync(String) - Method in class africa.sendbyte.webhooks.Webhooks: Asynchronous Webhooks.replay(String).
replyTo(String) - Method in class africa.sendbyte.emails.SendEmailRequest.Builder
RequestExecutor - Class in africa.sendbyte.http: 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.
RequestExecutor(HttpTransport) - Constructor for class africa.sendbyte.http.RequestExecutor
revoke(String) - Method in class africa.sendbyte.apikeys.ApiKeys: Revoke a key immediately.
revokeAsync(String) - Method in class africa.sendbyte.apikeys.ApiKeys: Asynchronous ApiKeys.revoke(String).

S

scheduledAt(String) - Method in class africa.sendbyte.emails.SendEmailRequest.Builder: Schedule delivery for an ISO 8601 datetime string, e.g.
scheduledAt(Instant) - Method in class africa.sendbyte.emails.SendEmailRequest.Builder: Schedule delivery for a specific Instant.
scope() - Method in class africa.sendbyte.apikeys.ApiKey: The scope as a typed enum, mapping unknown values to KeyScope.UNKNOWN.
send(SendEmailRequest) - Method in class africa.sendbyte.emails.Emails: Send a transactional email.
SEND_ONLY - Enum constant in enum africa.sendbyte.apikeys.KeyScope: Send emails only.
sendAsync(SendEmailRequest) - Method in class africa.sendbyte.emails.Emails: Asynchronous Emails.send(SendEmailRequest).
SendByteClient - Class in africa.sendbyte: The entry point to the SendByte API.
SendByteClient(HttpTransport) - Constructor for class africa.sendbyte.SendByteClient: Create a client over a custom HttpTransport.
SendByteClient(SendByteClientOptions) - Constructor for class africa.sendbyte.SendByteClient: Create a client from a full options object.
SendByteClient(String) - Constructor for class africa.sendbyte.SendByteClient: Create a client with the given API key and default configuration.
SendByteClientOptions - Class in africa.sendbyte: Immutable configuration for a SendByteClient.
SendByteClientOptions.Builder - Class in africa.sendbyte
SendByteConnectionException - Exception Class in africa.sendbyte.exceptions: Raised when the SDK cannot reach the SendByte API at all (DNS failure, connection reset, timeout, etc.).
SendByteConnectionException(String, Throwable) - Constructor for exception class africa.sendbyte.exceptions.SendByteConnectionException
SendByteException - Exception Class in africa.sendbyte.exceptions: Base type for every error surfaced by the SendByte SDK.
SendByteException(String, String, int, String, String) - Constructor for exception class africa.sendbyte.exceptions.SendByteException
SendByteException(String, Throwable) - Constructor for exception class africa.sendbyte.exceptions.SendByteException
SendByteHttpRequest - Class in africa.sendbyte.http: A transport-agnostic description of an HTTP request to the SendByte API.
SendByteHttpRequest.Builder - Class in africa.sendbyte.http
SendByteResponse - Class in africa.sendbyte.http: A minimal, transport-agnostic view of an HTTP response from the SendByte API.
SendByteResponse(int, String, SendByteResponse.HeaderLookup) - Constructor for class africa.sendbyte.http.SendByteResponse
SendByteResponse.HeaderLookup - Interface in africa.sendbyte.http: Functional lookup so transports can adapt their own header representation.
SendEmailRequest - Class in africa.sendbyte.emails: The payload for Emails.send(SendEmailRequest).
SendEmailRequest.Builder - Class in africa.sendbyte.emails
SENT - Enum constant in enum africa.sendbyte.emails.EmailStatus
setAttemptedAt(String) - Method in class africa.sendbyte.webhooks.WebhookDelivery
setChecks(List<DomainCheck>) - Method in class africa.sendbyte.domains.Domain
setCode(String) - Method in class africa.sendbyte.exceptions.ApiErrorEnvelope.ApiError
setCreatedAt(String) - Method in class africa.sendbyte.apikeys.ApiKey
setCreatedAt(String) - Method in class africa.sendbyte.domains.Domain
setCreatedAt(String) - Method in class africa.sendbyte.emails.Email
setCreatedAt(String) - Method in class africa.sendbyte.emails.EmailEvent
setCreatedAt(String) - Method in class africa.sendbyte.templates.Template
setCreatedAt(String) - Method in class africa.sendbyte.webhooks.WebhookEndpoint
setData(List<ApiKey>) - Method in class africa.sendbyte.apikeys.ApiKeyList
setData(List<Domain>) - Method in class africa.sendbyte.domains.DomainList
setData(List<Email>) - Method in class africa.sendbyte.emails.EmailList
setData(List<Template>) - Method in class africa.sendbyte.templates.TemplateList
setData(List<WebhookDelivery>) - Method in class africa.sendbyte.webhooks.WebhookDeliveryList
setData(List<WebhookEndpoint>) - Method in class africa.sendbyte.webhooks.WebhookEndpointList
setDisabled(boolean) - Method in class africa.sendbyte.webhooks.WebhookEndpoint
setDkimSelector(String) - Method in class africa.sendbyte.domains.Domain
setDnsRecords(List<DnsRecord>) - Method in class africa.sendbyte.domains.Domain
setDocsUrl(String) - Method in class africa.sendbyte.exceptions.ApiErrorEnvelope.ApiError
setDomain(String) - Method in class africa.sendbyte.domains.Domain
setError(ApiErrorEnvelope.ApiError) - Method in class africa.sendbyte.exceptions.ApiErrorEnvelope
setEvents(List<EmailEvent>) - Method in class africa.sendbyte.emails.Email
setEvents(List<String>) - Method in class africa.sendbyte.webhooks.WebhookEndpoint
setEventType(String) - Method in class africa.sendbyte.webhooks.WebhookDelivery
setFormat(String) - Method in class africa.sendbyte.templates.Template
setFrom(String) - Method in class africa.sendbyte.emails.Email
setHasMore(boolean) - Method in class africa.sendbyte.emails.EmailList
setHasMore(boolean) - Method in class africa.sendbyte.templates.TemplateList
setHost(String) - Method in class africa.sendbyte.domains.DnsRecord
setHost(String) - Method in class africa.sendbyte.domains.DomainCheck
setHtml(String) - Method in class africa.sendbyte.emails.Email
setHtml(String) - Method in class africa.sendbyte.templates.RenderedTemplate
setHtml(String) - Method in class africa.sendbyte.templates.Template
setId(String) - Method in class africa.sendbyte.apikeys.ApiKey
setId(String) - Method in class africa.sendbyte.domains.Domain
setId(String) - Method in class africa.sendbyte.emails.Email
setId(String) - Method in class africa.sendbyte.templates.Template
setId(String) - Method in class africa.sendbyte.webhooks.WebhookDelivery
setId(String) - Method in class africa.sendbyte.webhooks.WebhookEndpoint
setKey(String) - Method in class africa.sendbyte.apikeys.ApiKey
setLastUsedAt(String) - Method in class africa.sendbyte.apikeys.ApiKey
setLatencyMs(Integer) - Method in class africa.sendbyte.webhooks.WebhookDelivery
setMessage(String) - Method in class africa.sendbyte.exceptions.ApiErrorEnvelope.ApiError
setMjml(String) - Method in class africa.sendbyte.templates.Template
setMode(String) - Method in class africa.sendbyte.apikeys.ApiKey
setName(String) - Method in class africa.sendbyte.apikeys.ApiKey
setName(String) - Method in class africa.sendbyte.templates.Template
setPass(boolean) - Method in class africa.sendbyte.domains.DomainCheck
setPayload(Map<String, Object>) - Method in class africa.sendbyte.emails.EmailEvent
setPrefix(String) - Method in class africa.sendbyte.apikeys.ApiKey
setPurpose(String) - Method in class africa.sendbyte.domains.DnsRecord
setPurpose(String) - Method in class africa.sendbyte.domains.DomainCheck
setReplayOf(String) - Method in class africa.sendbyte.webhooks.WebhookDelivery
setRequired(boolean) - Method in class africa.sendbyte.domains.DnsRecord
setRequired(boolean) - Method in class africa.sendbyte.domains.DomainCheck
setSandbox(boolean) - Method in class africa.sendbyte.emails.Email
setScheduledAt(String) - Method in class africa.sendbyte.emails.Email
setScope(String) - Method in class africa.sendbyte.apikeys.ApiKey
setSecret(String) - Method in class africa.sendbyte.webhooks.WebhookEndpoint
setStatus(String) - Method in class africa.sendbyte.domains.Domain
setStatus(String) - Method in class africa.sendbyte.emails.Email
setStatusCode(Integer) - Method in class africa.sendbyte.webhooks.WebhookDelivery
setSubject(String) - Method in class africa.sendbyte.emails.Email
setSubject(String) - Method in class africa.sendbyte.templates.RenderedTemplate
setSubject(String) - Method in class africa.sendbyte.templates.Template
setSucceeded(Boolean) - Method in class africa.sendbyte.webhooks.WebhookDelivery
setText(String) - Method in class africa.sendbyte.emails.Email
setText(String) - Method in class africa.sendbyte.templates.RenderedTemplate
setText(String) - Method in class africa.sendbyte.templates.Template
setTo(List<String>) - Method in class africa.sendbyte.emails.Email
setType(String) - Method in class africa.sendbyte.domains.DnsRecord
setType(String) - Method in class africa.sendbyte.emails.EmailEvent
setUpdatedAt(String) - Method in class africa.sendbyte.templates.Template
setUrl(String) - Method in class africa.sendbyte.webhooks.WebhookEndpoint
setValue(String) - Method in class africa.sendbyte.domains.DnsRecord
setVerifiedAt(String) - Method in class africa.sendbyte.domains.Domain
setVersion(Integer) - Method in class africa.sendbyte.templates.Template
sign(String, long, byte[]) - Static method in class africa.sendbyte.webhooks.WebhookSignature: Compute the "sendbyte-signature" header value for a body.
SIGNATURE_HEADER - Static variable in class africa.sendbyte.webhooks.WebhookSignature: The header carrying the signature on every webhook delivery.
status() - Method in class africa.sendbyte.domains.Domain: The status as a typed enum, mapping unknown values to DomainStatus.UNKNOWN.
status() - Method in class africa.sendbyte.emails.Email: The status as a typed enum, mapping unknown values to EmailStatus.UNKNOWN.
status(EmailStatus) - Method in class africa.sendbyte.emails.ListEmailsParams.Builder: Filter to a single delivery status.
statusCode() - Method in class africa.sendbyte.http.SendByteResponse
subject(String) - Method in class africa.sendbyte.emails.SendEmailRequest.Builder
subject(String) - Method in class africa.sendbyte.templates.RenderRequest.Builder
subject(String) - Method in class africa.sendbyte.templates.TemplateRequest.Builder: The subject line; supports Handlebars variables.
SUPPRESSED - Enum constant in enum africa.sendbyte.emails.EmailStatus
SuppressedRecipientException - Exception Class in africa.sendbyte.exceptions: suppressed_recipient (422): a recipient is on the project's suppression list.
SuppressedRecipientException(String, String, int, String, String) - Constructor for exception class africa.sendbyte.exceptions.SuppressedRecipientException

T

tags(String...) - Method in class africa.sendbyte.emails.SendEmailRequest.Builder
tags(List<String>) - Method in class africa.sendbyte.emails.SendEmailRequest.Builder
Template - Class in africa.sendbyte.templates: A saved, server-side email template.
Template() - Constructor for class africa.sendbyte.templates.Template
templateId(String) - Method in class africa.sendbyte.emails.SendEmailRequest.Builder: Send using a saved template (UUID or name) instead of inline html/text.
TemplateList - Class in africa.sendbyte.templates: The result of Templates.list(): all templates in the project.
TemplateList() - Constructor for class africa.sendbyte.templates.TemplateList
TemplateRequest - Class in africa.sendbyte.templates: The definition used to create or update a template.
TemplateRequest.Builder - Class in africa.sendbyte.templates
templates() - Method in class africa.sendbyte.SendByteClient: Access the Templates resource: manage and preview reusable email templates.
Templates - Class in africa.sendbyte.templates: The Templates resource: manage reusable server-side Handlebars/MJML templates and preview their rendered output.
Templates(RequestExecutor) - Constructor for class africa.sendbyte.templates.Templates
TEST - Enum constant in enum africa.sendbyte.apikeys.KeyMode: Sandbox mode; fully simulated delivery, no domain required.
text(String) - Method in class africa.sendbyte.emails.SendEmailRequest.Builder
text(String) - Method in class africa.sendbyte.templates.RenderRequest.Builder
text(String) - Method in class africa.sendbyte.templates.TemplateRequest.Builder: Plain-text alternative body.
to(String...) - Method in class africa.sendbyte.emails.SendEmailRequest.Builder: Add one or more recipients.
to(List<String>) - Method in class africa.sendbyte.emails.SendEmailRequest.Builder

U

UNKNOWN - Enum constant in enum africa.sendbyte.apikeys.KeyMode
UNKNOWN - Enum constant in enum africa.sendbyte.apikeys.KeyScope
UNKNOWN - Enum constant in enum africa.sendbyte.domains.DomainStatus
UNKNOWN - Enum constant in enum africa.sendbyte.emails.EmailStatus
update(String, TemplateRequest) - Method in class africa.sendbyte.templates.Templates: Replace a template's definition, bumping its version.
updateAsync(String, TemplateRequest) - Method in class africa.sendbyte.templates.Templates: Asynchronous Templates.update(String, TemplateRequest).
userAgent() - Method in class africa.sendbyte.SendByteClientOptions
userAgent(String) - Method in class africa.sendbyte.SendByteClientOptions.Builder

V

ValidationException - Exception Class in africa.sendbyte.exceptions: validation_error (422): one or more request fields failed validation.
ValidationException(String, String, int, String, String) - Constructor for exception class africa.sendbyte.exceptions.ValidationException
valueOf(String) - Static method in enum africa.sendbyte.apikeys.KeyMode: Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum africa.sendbyte.apikeys.KeyScope: Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum africa.sendbyte.domains.DomainStatus: Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum africa.sendbyte.emails.EmailStatus: Returns the enum constant of this type with the specified name.
values() - Static method in enum africa.sendbyte.apikeys.KeyMode: Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum africa.sendbyte.apikeys.KeyScope: Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum africa.sendbyte.domains.DomainStatus: Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum africa.sendbyte.emails.EmailStatus: Returns an array containing the constants of this enum type, in the order they are declared.
variable(String, Object) - Method in class africa.sendbyte.emails.SendEmailRequest.Builder: Add a single template variable.
variable(String, Object) - Method in class africa.sendbyte.templates.RenderRequest.Builder: Add a single variable.
variables(Map<String, ?>) - Method in class africa.sendbyte.emails.SendEmailRequest.Builder
variables(Map<String, ?>) - Method in class africa.sendbyte.templates.RenderRequest.Builder
VERIFIED - Enum constant in enum africa.sendbyte.domains.DomainStatus: All required records (SPF + DKIM) passed; ready for live sends.
verify(String) - Method in class africa.sendbyte.domains.Domains: Trigger a live DNS check.
verify(String, String, byte[]) - Static method in class africa.sendbyte.webhooks.WebhookSignature: Verify a raw byte body using the default tolerance.
verify(String, String, byte[], Duration) - Static method in class africa.sendbyte.webhooks.WebhookSignature: Verify a raw byte body against the signature header.
verify(String, String, String) - Static method in class africa.sendbyte.webhooks.WebhookSignature: Verify a string body using the default tolerance.
verifyAsync(String) - Method in class africa.sendbyte.domains.Domains: Asynchronous Domains.verify(String).

W

WebhookDelivery - Class in africa.sendbyte.webhooks: A single webhook delivery attempt, from Webhooks.deliveries(String) or the fresh attempt created by Webhooks.replay(String).
WebhookDelivery() - Constructor for class africa.sendbyte.webhooks.WebhookDelivery
WebhookDeliveryList - Class in africa.sendbyte.webhooks: The result of Webhooks.deliveries(String): recent delivery attempts, newest first.
WebhookDeliveryList() - Constructor for class africa.sendbyte.webhooks.WebhookDeliveryList
WebhookEndpoint - Class in africa.sendbyte.webhooks: A registered webhook endpoint that SendByte delivers events to.
WebhookEndpoint() - Constructor for class africa.sendbyte.webhooks.WebhookEndpoint
WebhookEndpointList - Class in africa.sendbyte.webhooks: The result of Webhooks.list(): all webhook endpoints on the account.
WebhookEndpointList() - Constructor for class africa.sendbyte.webhooks.WebhookEndpointList
webhooks() - Method in class africa.sendbyte.SendByteClient: Access the Webhooks resource: manage endpoints, inspect deliveries, and replay them.
Webhooks - Class in africa.sendbyte.webhooks: The Webhooks resource: register and manage webhook endpoints, inspect delivery history, and replay deliveries.
Webhooks(RequestExecutor) - Constructor for class africa.sendbyte.webhooks.Webhooks
WebhookSignature - Class in africa.sendbyte.webhooks: Verifies the signature on inbound SendByte webhook requests.
wire() - Method in enum africa.sendbyte.apikeys.KeyMode
wire() - Method in enum africa.sendbyte.apikeys.KeyScope
wire() - Method in enum africa.sendbyte.domains.DomainStatus
wire() - Method in enum africa.sendbyte.emails.EmailStatus: The lowercase string used by the API.
write(Object) - Method in class africa.sendbyte.http.Json: Serialize a value to a JSON string, omitting null fields.
writeTimeout() - Method in class africa.sendbyte.SendByteClientOptions
writeTimeout(Duration) - Method in class africa.sendbyte.SendByteClientOptions.Builder

A B C D E F G H I J K L M N O P Q R S T U V W
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form