Skip to content

CHANGELOG.md

Latest commit

 

History

History
278 lines (155 loc) · 6.89 KB

CHANGELOG.md

File metadata and controls

278 lines (155 loc) · 6.89 KB
Raw

Changelog

5.1.1

  • stop requesting Brotli-encoded responses: requests now send Accept-Encoding: gzip, deflate (hardening for CVE-2026-111497, #197). This does not protect an unpatched runtime; the fix is Node 22.23.4+, 24.22.1+ or 26.12.1+ (official builds; builds linked against the system Brotli library also need that library updated). See the Node.js security release.
  • the 4.x line receives no further fixes; upgrade to 5.x.

5.1.0

  • added support for the Bulk Email API (#185):
    • ServerClient.sendBulkEmail() — send a bulk email (POST /email/bulk)
    • ServerClient.getBulkEmailStatus() — poll a bulk request's status (GET /email/bulk/{bulk-request-id})
    • new models BulkEmailRequest, BulkEmailMessage, BulkEmailSendingResponse, BulkEmailStatusResponse, and the BulkEmailStatus enum, with BulkEmailRequest/BulkEmailMessage exposed as top-level exports

5.0.0

Migrated the HTTP client from axios to the native Fetch API, making the SDK dependency-free. This is a major release; the migration introduces five breaking changes, detailed below.

Breaking changes

  1. Minimum Node version is now 18.0.0 (dropped Node 14 and 16). The native Fetch API requires Node 18+.
  2. Proxy environment variables (HTTP_PROXY / HTTPS_PROXY / NO_PROXY) are no longer honored automatically. axios read them via proxy-from-env, but Node's built-in fetch (undici) does not. To route requests through a proxy, pass a custom fetch via the new fetch client option (e.g. bound to an undici ProxyAgent dispatcher) — see the README "Proxies / custom fetch" section.
  3. An empty 2xx response body now resolves to {} instead of the empty string "" that axios surfaced.
  4. client.httpClient.client is no longer an axios instance — it is now a fetch function. Code that reached into it to add axios interceptors, set defaults, or attach an axios adapter/proxy will no longer work; use the new fetch client option for transport customization instead.
  5. Request timeout semantics changed. With axios timeout was a response/inactivity timeout; it is now mapped to AbortSignal.timeout(), which is a total deadline for the entire request. Slow-but-progressing responses that previously completed may now abort once the total duration exceeds the configured timeout.

Other changes

  • removed the axios dependency (resolves CVE exposure and url.parse() deprecation warnings, and restores compatibility with Edge/Workers runtimes)
  • added the fetch client option, allowing a custom fetch implementation to be supplied for proxy support, testing, or other transport customization

4.0.7

  • update axios to 1.13.5
  • fix getOutboundMessageDetails route to be consistent with public documentation

4.0.6

  • update axios to 1.13.4

4.0.5

  • update axios to 1.7.4

4.0.4

  • update axios to 1.7.2

4.0.3

  • updated models to support adding content disposition to attachments
  • update domain model

4.0.2

  • updated models to be more accurate mostly within webhook payloads area

4.0.1

  • update development libraries

4.0.0

  • dropped support for older EOL Node JS versions, minimum supported Node version is 14.0.0
  • updated axios to the version 1.6.2

3.11.0

  • added filtering to get suppressions endpoint

3.1.2

  • add content type header to the http client default headers list

3.1.1

  • small naming update for data removal endpoints

3.1.0

  • added data removal endpoints

3.0.20

  • small fix to webhook types model

3.0.19

  • updated model to contain webhook types

3.0.18

  • fix domain endpoint request types

3.0.17

  • updated test library versions
  • switched from nconf to dotenv for configuration loading for tests

3.0.15

  • added Sanboxed field to the outbound message model
  • fix parsing bounced messages

3.0.14

  • Updated statistics filtering parameter

3.0.13

  • Minor code fix, fixing up library versions for older versions of node

3.0.12

  • Migrated to ActiveCampaign

3.0.11

  • Small bug fix to data model

3.0.1

  • Separated error handling responsibility between postmark client and http client

3.0.0

  • Updated message response for sending
  • Decoupled and refactored http client part of the library

2.9.5

  • Improved error handling
  • Parsed inactive recipients when email sending

2.9.0

  • Update sender signature name field to match documentation by being required
  • Updated dev libraries to resolve security issues (typedoc, typescript)
  • Updated axios http client version

2.8.2

Update attachments model for inbound and outbound messages

2.8.1

Updated sender signature model with personal note

2.7.9

Updated axios client version

2.7.7

  • Added delivery types to server model

2.7.6

  • Improved data model for webhook triggers

2.7.4

  • Small update to the server update model

2.7.3

  • Updated message streams model with unsubscribe types

2.7.2

  • Remove old request client dev dependency

2.7.1

  • Increase client tolerance to long and big requests

2.7.0

  • Updated axios to 0.21.1

2.6.1

  • Updated createWebhook endpoint to support MessageStream
  • default CI tool is now circleCi

2.6.0

  • Added message stream endpoints

2.5.6

  • Updated release docs and sending message response model

2.5.5

  • library updates

2.5.4

  • Fix domain details model

2.5.3

  • Http client size limitation removed

2.5.2

  • Better error handling
  • Improved client options setup and default client setup

2.3.5

  • Added supression management

2.3.4

  • Removed obsolete TriggerTags endpoint and added filtering bounces by stream

2.3.2

  • messages can now be filtered by message stream
  • bounceTags endpoint is deprecated/removed

2.3.1

  • Added webhook management support
  • Improved test coverage
  • Improved type model

2.3.0

  • Small improvement to error handling

2.2.8

  • Servers list type model update

2.2.7

  • Template layouts support

2.2.6

  • Add support for metadata for email templates

2.2.5

  • Ignore docs from npm library

2.2.4

  • Added templates push feature

2.2.2

  • Minor fix for proper error handling

2.2.0

  • added filtering by count, offset defaults in case of passing parameters straight to client methods
  • updated aliases for client objects for backward compatibility

2.1.0

  • Make filter parameters use constructors for simpler querying
  • Minor type definition re-organization

2.0.0

  • migrated library to add Typescript support
  • removed not needed dependencies
  • completely revamped the client with simpler call model (callbacks, promises, http requests separation etc)
  • added custom error handling
  • added all missing account level, server level endpoints (verifyDKIM for example)

1.0.0

  • Initial release