fastmail-masked-email
Version:
A library for creating, deleting, and updating Fastmail masked emails
310 lines (156 loc) • 13 kB
Markdown
# [3.0.0](https://github.com/ajyey/fastmail-masked-email/compare/v2.1.15...v3.0.0) (2025-08-12)
### Features
* adds getSession method ([b0b3403](https://github.com/ajyey/fastmail-masked-email/commit/b0b3403f66a53190942be2688f423feb03c758b0))
* **major:** adds MaskedEmailService class ([9f3a5d8](https://github.com/ajyey/fastmail-masked-email/commit/9f3a5d85eff8e5bc7367061137adde69e89c3d03))
### BREAKING CHANGES
* **major:** Removes individual modules in favor of a MaskedEmailService class
# [3.0.0-beta.2](https://github.com/ajyey/fastmail-masked-email/compare/v3.0.0-beta.1...v3.0.0-beta.2) (2025-08-12)
### Features
* adds getSession method ([b0b3403](https://github.com/ajyey/fastmail-masked-email/commit/b0b3403f66a53190942be2688f423feb03c758b0))
# [3.0.0-beta.1](https://github.com/ajyey/fastmail-masked-email/compare/v2.1.14-beta.1...v3.0.0-beta.1) (2025-08-12)
### Features
* **major:** adds MaskedEmailService class ([9f3a5d8](https://github.com/ajyey/fastmail-masked-email/commit/9f3a5d85eff8e5bc7367061137adde69e89c3d03))
### BREAKING CHANGES
* **major:** Removes individual modules in favor of a MaskedEmailService class
## [2.1.15](https://github.com/ajyey/fastmail-masked-email/compare/v2.1.14...v2.1.15) (2025-08-12)
## [2.1.14](https://github.com/ajyey/fastmail-masked-email/compare/v2.1.13...v2.1.14) (2025-06-18)
## [2.1.14-beta.1](https://github.com/ajyey/fastmail-masked-email/compare/v2.1.13...v2.1.14-beta.1) (2025-06-18)
## [2.1.13](https://github.com/ajyey/fastmail-masked-email/compare/v2.1.12...v2.1.13) (2025-04-25)
## [2.1.12](https://github.com/ajyey/fastmail-masked-email/compare/v2.1.11...v2.1.12) (2025-04-16)
## [2.1.11](https://github.com/ajyey/fastmail-masked-email/compare/v2.1.10...v2.1.11) (2024-09-15)
## [2.1.10](https://github.com/ajyey/fastmail-masked-email/compare/v2.1.9...v2.1.10) (2024-09-11)
## [2.1.9](https://github.com/ajyey/fastmail-masked-email/compare/v2.1.8...v2.1.9) (2024-06-12)
## [2.1.8](https://github.com/ajyey/fastmail-masked-email/compare/v2.1.7...v2.1.8) (2024-06-12)
## [2.1.7](https://github.com/ajyey/fastmail-masked-email/compare/v2.1.6...v2.1.7) (2024-04-18)
## [2.1.6](https://github.com/ajyey/fastmail-masked-email/compare/v2.1.5...v2.1.6) (2024-04-15)
## [2.1.5](https://github.com/ajyey/fastmail-masked-email/compare/v2.1.4...v2.1.5) (2024-03-25)
## [2.1.4](https://github.com/ajyey/fastmail-masked-email/compare/v2.1.3...v2.1.4) (2024-03-18)
## [2.1.3](https://github.com/ajyey/fastmail-masked-email/compare/v2.1.2...v2.1.3) (2024-01-15)
## [2.1.2](https://github.com/ajyey/fastmail-masked-email/compare/v2.1.1...v2.1.2) (2023-11-15)
## [2.1.1](https://github.com/ajyey/fastmail-masked-email/compare/v2.1.0...v2.1.1) (2023-09-25)
# [2.1.0](https://github.com/ajyey/fastmail-masked-email/compare/v2.0.1...v2.1.0) (2023-09-09)
### Features
* add emailPrefix ([#92](https://github.com/ajyey/fastmail-masked-email/issues/92)) ([b53b7b9](https://github.com/ajyey/fastmail-masked-email/commit/b53b7b90e16846abd0dbc9b7b3abde650badb844))
## [2.0.1](https://github.com/ajyey/fastmail-masked-email/compare/v2.0.0...v2.0.1) (2023-07-11)
# [2.0.0](https://github.com/ajyey/fastmail-masked-email/compare/v1.3.1...v2.0.0) (2023-07-04)
### Code Refactoring
* rename enable function to enableEmail ([b46b77c](https://github.com/ajyey/fastmail-masked-email/commit/b46b77cab4cb3beaee6bcba40c28546185c92c5e))
* **getByAddress:** rename getByAddress function ([731c7e1](https://github.com/ajyey/fastmail-masked-email/commit/731c7e18f48ecf1844b26526faab75f3b9010b1e))
* **getbyid:** rename getById function ([9ea778a](https://github.com/ajyey/fastmail-masked-email/commit/9ea778a07ca837a9fa9190b04e11369dc8d06f67))
* **create:** renames create function ([324a7af](https://github.com/ajyey/fastmail-masked-email/commit/324a7af8d72173a5417bc1e9d5a6a655500bfd29))
* renames disable function to disableEmail ([2e3feba](https://github.com/ajyey/fastmail-masked-email/commit/2e3feba0e3edd40a7afc05e978bd2e2b2118e4d9))
* renames remove method to deleteEmail ([2ae0df9](https://github.com/ajyey/fastmail-masked-email/commit/2ae0df97e8bda75560612c301ce643453993470c))
* **list:** renames the list function to getAllEmails ([d4cdbb0](https://github.com/ajyey/fastmail-masked-email/commit/d4cdbb0fb973b0de9dbb51f297208ef3d6f264b0))
* update function name change ([abaf4cf](https://github.com/ajyey/fastmail-masked-email/commit/abaf4cf08033d0d11792d84c98ab0aa9fca5634c))
### Features
* add function for permanently deleting a masked email ([b7df294](https://github.com/ajyey/fastmail-masked-email/commit/b7df2940d72c7fa756169803bf6976dc50a98a8e))
### BREAKING CHANGES
* rename enable function to enableEmail
* renames disable function to disableEmail
* renames the remove method to deleteEmail
* changes the update function to be updateEmail
* **getByAddress:** renames getByAddress to getEmailByAddress
* **create:** renames the create function to createEmail
* **getbyid:** renames getById to getEmailById
* **list:** rename list to getAllEmails
# [2.0.0-beta.5](https://github.com/ajyey/fastmail-masked-email/compare/v2.0.0-beta.4...v2.0.0-beta.5) (2023-07-04)
### Features
* add function for permanently deleting a masked email ([b7df294](https://github.com/ajyey/fastmail-masked-email/commit/b7df2940d72c7fa756169803bf6976dc50a98a8e))
# [2.0.0-beta.4](https://github.com/ajyey/fastmail-masked-email/compare/v2.0.0-beta.3...v2.0.0-beta.4) (2023-07-04)
### Code Refactoring
* rename enable function to enableEmail ([b46b77c](https://github.com/ajyey/fastmail-masked-email/commit/b46b77cab4cb3beaee6bcba40c28546185c92c5e))
### BREAKING CHANGES
* rename enable function to enableEmail
# [2.0.0-beta.3](https://github.com/ajyey/fastmail-masked-email/compare/v2.0.0-beta.2...v2.0.0-beta.3) (2023-07-04)
### Code Refactoring
* renames disable function to disableEmail ([2e3feba](https://github.com/ajyey/fastmail-masked-email/commit/2e3feba0e3edd40a7afc05e978bd2e2b2118e4d9))
### BREAKING CHANGES
* renames disable function to disableEmail
# [2.0.0-beta.2](https://github.com/ajyey/fastmail-masked-email/compare/v2.0.0-beta.1...v2.0.0-beta.2) (2023-07-04)
### Code Refactoring
* renames remove method to deleteEmail ([2ae0df9](https://github.com/ajyey/fastmail-masked-email/commit/2ae0df97e8bda75560612c301ce643453993470c))
### BREAKING CHANGES
* renames the remove method to deleteEmail
# [2.0.0-beta.1](https://github.com/ajyey/fastmail-masked-email/compare/v1.3.2-beta.4...v2.0.0-beta.1) (2023-07-04)
### Code Refactoring
* update function name change ([abaf4cf](https://github.com/ajyey/fastmail-masked-email/commit/abaf4cf08033d0d11792d84c98ab0aa9fca5634c))
* **getByAddress:** rename getByAddress function ([731c7e1](https://github.com/ajyey/fastmail-masked-email/commit/731c7e18f48ecf1844b26526faab75f3b9010b1e))
* **create:** renames create function ([324a7af](https://github.com/ajyey/fastmail-masked-email/commit/324a7af8d72173a5417bc1e9d5a6a655500bfd29))
* **getbyid:** rename getById function ([9ea778a](https://github.com/ajyey/fastmail-masked-email/commit/9ea778a07ca837a9fa9190b04e11369dc8d06f67))
* **list:** renames the list function to getAllEmails ([d4cdbb0](https://github.com/ajyey/fastmail-masked-email/commit/d4cdbb0fb973b0de9dbb51f297208ef3d6f264b0))
### BREAKING CHANGES
* changes the update function to be updateEmail
* **getByAddress:** renames getByAddress to getEmailByAddress
* **create:** renames the create function to createEmail
* **getbyid:** renames getById to getEmailById
* **list:** rename list to getAllEmails
## [1.3.1](https://github.com/ajyey/fastmail-masked-email/compare/v1.3.0...v1.3.1) (2023-05-24)
# [1.3.0](https://github.com/ajyey/fastmail-masked-email/compare/v1.2.3...v1.3.0) (2023-05-23)
### Bug Fixes
* entrypoint in package.json ([6cf5f5b](https://github.com/ajyey/fastmail-masked-email/commit/6cf5f5be63f6ebb1e8497ee162676d178b3976ed))
### Features
* **create:** add better axios error handling for creating masked emails ([35782b3](https://github.com/ajyey/fastmail-masked-email/commit/35782b39612300f52523228ddc95ccbd2ca3045c))
* **errors:** add util function for handling axios errors ([c560d4c](https://github.com/ajyey/fastmail-masked-email/commit/c560d4c9da169c815358cb7dfa9a1d9638ec203b))
# [1.3.0-beta.5](https://github.com/ajyey/fastmail-masked-email/compare/v1.3.0-beta.4...v1.3.0-beta.5) (2023-05-23)
### Reverts
* Revert "fix: errors occurring due to axios being mocked" ([fa4c66d](https://github.com/ajyey/fastmail-masked-email/commit/fa4c66d02ecbc7b609220acede8456d93b2fc385))
# [1.3.0-beta.4](https://github.com/ajyey/fastmail-masked-email/compare/v1.3.0-beta.3...v1.3.0-beta.4) (2023-05-23)
### Bug Fixes
* errors occurring due to axios being mocked ([6d158ca](https://github.com/ajyey/fastmail-masked-email/commit/6d158ca858cfecbd7c70cdc9085fcb514dce02ac))
# [1.3.0-beta.3](https://github.com/ajyey/fastmail-masked-email/compare/v1.3.0-beta.2...v1.3.0-beta.3) (2023-05-23)
### Bug Fixes
* entrypoint in package.json ([6cf5f5b](https://github.com/ajyey/fastmail-masked-email/commit/6cf5f5be63f6ebb1e8497ee162676d178b3976ed))
# [1.3.0-beta.2](https://github.com/ajyey/fastmail-masked-email/compare/v1.3.0-beta.1...v1.3.0-beta.2) (2023-05-23)
### Features
* **errors:** add util function for handling axios errors ([c560d4c](https://github.com/ajyey/fastmail-masked-email/commit/c560d4c9da169c815358cb7dfa9a1d9638ec203b))
# [1.3.0-beta.1](https://github.com/ajyey/fastmail-masked-email/compare/v1.2.4-beta.2...v1.3.0-beta.1) (2023-05-23)
### Features
* **create:** add better axios error handling for creating masked emails ([35782b3](https://github.com/ajyey/fastmail-masked-email/commit/35782b39612300f52523228ddc95ccbd2ca3045c))
## [1.2.4-beta.2](https://github.com/ajyey/fastmail-masked-email/compare/v1.2.4-beta.1...v1.2.4-beta.2) (2023-05-23)
## [1.2.4-beta.1](https://github.com/ajyey/fastmail-masked-email/compare/v1.2.3...v1.2.4-beta.1) (2023-05-23)
## [1.2.3](https://github.com/ajyey/fastmail-masked-email/compare/v1.2.2...v1.2.3) (2023-05-23)
## [1.2.2](https://github.com/ajyey/fastmail-masked-email/compare/v1.2.1...v1.2.2) (2023-05-21)
### Bug Fixes
* bump eslint version ([ff6f76c](https://github.com/ajyey/fastmail-masked-email/commit/ff6f76c1cdea9bc8818bc9287e199bb9f8048edd))
## [1.2.1](https://github.com/ajyey/fastmail-masked-email/compare/v1.2.0...v1.2.1) (2023-05-21)
# [1.2.0](https://github.com/ajyey/fastmail-masked-email/compare/v1.1.2...v1.2.0) (2023-05-20)
### Code Refactoring
* adds generic typing for jmap requests and responses ([af21328](https://github.com/ajyey/fastmail-masked-email/commit/af21328b1022a68d348483e785d9f41b11e010d1))
### Features
* condense create/update options types into a single options type ([2ad852d](https://github.com/ajyey/fastmail-masked-email/commit/2ad852d6a0359e752d761205b8b5182407c2531b))
### BREAKING CHANGES
* removes GetMethodResponse and SetMethodResponse types
# [1.2.0-beta.2](https://github.com/ajyey/fastmail-masked-email/compare/v1.2.0-beta.1...v1.2.0-beta.2) (2023-05-20)
### Code Refactoring
* adds generic typing for jmap requests and responses ([af21328](https://github.com/ajyey/fastmail-masked-email/commit/af21328b1022a68d348483e785d9f41b11e010d1))
### BREAKING CHANGES
* removes GetMethodResponse and SetMethodResponse types
# [1.2.0-beta.1](https://github.com/ajyey/fastmail-masked-email/compare/v1.1.2...v1.2.0-beta.1) (2023-05-19)
### Features
* condense create/update options types into a single options type ([2ad852d](https://github.com/ajyey/fastmail-masked-email/commit/2ad852d6a0359e752d761205b8b5182407c2531b))
## [1.1.2](https://github.com/ajyey/fastmail-masked-email/compare/v1.1.1...v1.1.2) (2023-05-19)
## [1.1.1](https://github.com/ajyey/fastmail-masked-email/compare/v1.1.0...v1.1.1) (2023-05-19)
# [1.1.0](https://github.com/ajyey/fastmail-masked-email/compare/v1.0.0...v1.1.0) (2023-05-19)
### Features
* deleteEmail minor scope release rule ([91b2eb2](https://github.com/ajyey/fastmail-masked-email/commit/91b2eb2a60d2031ccaeeaa28f1b71dd3d7cc6646))
# 1.0.0-beta.1 (2023-05-19)
### Features
* check the notFound field to determine if a masked email could not be found ([1988fab](https://github.com/ajyey/fastmail-masked-email/commit/1988fabaab2f45946efb7db291028d7db129591c))
# 1.0.0-alpha.2 (2022-10-24)
### Added
- Better error types for invalid arguments and invalid credentials
- Much better typedoc descriptions and annotations
- Eslint plugin for tsdoc
# 1.0.0-alpha.1 (2022-10-17)
### Fixed
- Fixed a bug where the entry point was not being set correctly in the package.json file
- Fixed a bug where the `debug` package should have been a dependency instead of a devDependency
# 1.0.0-alpha.0 (2022-10-17)
### Added
- Initial package structure
- Initial barebones unit tests
- Specifically for the 'getUtil' function
- Initial barebones fixtures
- Specifically for masked email and session objects
- Initial documentation
- Initial barebones error handling