Changelog
Every release of the TypeScript SDK, newest first, and what it changed.
Every release of the TypeScript SDK, newest first.
Versions are semver for the methods: a method added is a minor version, a method renamed or removed a major one, a fix a patch. The API is still 0.x and may change a field without a deprecation cycle; the types follow it.
1.2.0
verifiedRecipients, a new namespace:add,listandremovean account's verified recipients, the outside addresses it may send to while it is not yet vetted, andgetConfirmPageandconfirmByToken, the public link their owner confirms one with.accounts.getLimits: each of the account's limits, its threshold and how it is enforced.accounts.getRequests: the account's API calls over time.suppressions.list: your account's complaint entries, page by page.accounts.listLimitIncidentspages, as the API now does: awaited, one page as before; withfor await, every incident.- New options the API takes:
ifNoneMatchonmessages.getRaw,accountIdonsuppressions.getandsuppressions.remove,submissiononmta.checkRecipient, andmemberOfonroutes.list. - New fields in answers the SDK had: an account's
verifiedRecipientsOnly;bytesInandbytesOutin its and its domains' traffic; the address and domain creations inaccounts.getSendUsage; an invitation'sallDay; a suppression'saccountId; and a limit incident'slevelandledgerId. - A recipient refused because the account may send only to its verified
recipients says so:
sourcecan beverified_recipients, and a scheduled send's results now carrysource,listandpattern, as a send's do.
1.1.0
ownershipRecordOf(error), besidedeliveryIdOf: the ownership record a domain not yet verified must publish, read fromdomains.create's400 domain_not_verifiedas a typedDnsRecord, and null for any other error.
1.0.0
The first release. From here, a method's name is a promise (semver, above).
- Every operation of the public REST API, 310 in 45 namespaces, as a typed
method:
new OpenEmail({ apiKey }), thenopenemail.<namespace>.<method>(...). - Listings: awaited, the first page; with
for await, every item. - Safe retries: reads, and sends under one delivery id; any other write only when the API did nothing.
- One error type,
RequestError, with the API's code. - Webhooks: signatures verified, payloads typed.
- Live channels that reconnect on their own, every frame typed.
- No dependencies. Node 22.12 and later, Bun, Deno and Cloudflare Workers; live channels on Node and Bun.
Error codes
Every error code the API documents, with the statuses it comes with and the TypeScript SDK methods that can answer it.
openemail.accountAddressLists
An account's address lists: named allow and block lists for inbound or outbound mail, the patterns they hold, and a test of the policy they add up to.