Open Source Licenses
core
Version 6.3.1
MIT
Published by Claudéric Demers
View License Text
MIT License Copyright (c) 2021, Claudéric Demers Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
sortable
Version 10.0.0
MIT
Published by Claudéric Demers
View License Text
MIT License Copyright (c) 2021, Claudéric Demers Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
utilities
Version 3.2.2
MIT
Published by Claudéric Demers
View License Text
MIT License Copyright (c) 2021, Claudéric Demers Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
storage
Version 7.21.0
Apache-2.0
Published by Google Inc.
View License Text
Apache License
Version 2.0, January 2004
http://www.apache.org/licenses/
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
1. Definitions.
"License" shall mean the terms and conditions for use, reproduction,
and distribution as defined by Sections 1 through 9 of this document.
"Licensor" shall mean the copyright owner or entity authorized by
the copyright owner that is granting the License.
"Legal Entity" shall mean the union of the acting entity and all
other entities that control, are controlled by, or are under common
control with that entity. For the purposes of this definition,
"control" means (i) the power, direct or indirect, to cause the
direction or management of such entity, whether by contract or
otherwise, or (ii) ownership of fifty percent (50%) or more of the
outstanding shares, or (iii) beneficial ownership of such entity.
"You" (or "Your") shall mean an individual or Legal Entity
exercising permissions granted by this License.
"Source" form shall mean the preferred form for making modifications,
including but not limited to software source code, documentation
source, and configuration files.
"Object" form shall mean any form resulting from mechanical
transformation or translation of a Source form, including but
not limited to compiled object code, generated documentation,
and conversions to other media types.
"Work" shall mean the work of authorship, whether in Source or
Object form, made available under the License, as indicated by a
copyright notice that is included in or attached to the work
(an example is provided in the Appendix below).
"Derivative Works" shall mean any work, whether in Source or Object
form, that is based on (or derived from) the Work and for which the
editorial revisions, annotations, elaborations, or other modifications
represent, as a whole, an original work of authorship. For the purposes
of this License, Derivative Works shall not include works that remain
separable from, or merely link (or bind by name) to the interfaces of,
the Work and Derivative Works thereof.
"Contribution" shall mean any work of authorship, including
the original version of the Work and any modifications or additions
to that Work or Derivative Works thereof, that is intentionally
submitted to Licensor for inclusion in the Work by the copyright owner
or by an individual or Legal Entity authorized to submit on behalf of
the copyright owner. For the purposes of this definition, "submitted"
means any form of electronic, verbal, or written communication sent
to the Licensor or its representatives, including but not limited to
communication on electronic mailing lists, source code control systems,
and issue tracking systems that are managed by, or on behalf of, the
Licensor for the purpose of discussing and improving the Work, but
excluding communication that is conspicuously marked or otherwise
designated in writing by the copyright owner as "Not a Contribution."
"Contributor" shall mean Licensor and any individual or Legal Entity
on behalf of whom a Contribution has been received by Licensor and
subsequently incorporated within the Work.
2. Grant of Copyright License. Subject to the terms and conditions of
this License, each Contributor hereby grants to You a perpetual,
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
copyright license to reproduce, prepare Derivative Works of,
publicly display, publicly perform, sublicense, and distribute the
Work and such Derivative Works in Source or Object form.
3. Grant of Patent License. Subject to the terms and conditions of
this License, each Contributor hereby grants to You a perpetual,
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
(except as stated in this section) patent license to make, have made,
use, offer to sell, sell, import, and otherwise transfer the Work,
where such license applies only to those patent claims licensable
by such Contributor that are necessarily infringed by their
Contribution(s) alone or by combination of their Contribution(s)
with the Work to which such Contribution(s) was submitted. If You
institute patent litigation against any entity (including a
cross-claim or counterclaim in a lawsuit) alleging that the Work
or a Contribution incorporated within the Work constitutes direct
or contributory patent infringement, then any patent licenses
granted to You under this License for that Work shall terminate
as of the date such litigation is filed.
4. Redistribution. You may reproduce and distribute copies of the
Work or Derivative Works thereof in any medium, with or without
modifications, and in Source or Object form, provided that You
meet the following conditions:
(a) You must give any other recipients of the Work or
Derivative Works a copy of this License; and
(b) You must cause any modified files to carry prominent notices
stating that You changed the files; and
(c) You must retain, in the Source form of any Derivative Works
that You distribute, all copyright, patent, trademark, and
attribution notices from the Source form of the Work,
excluding those notices that do not pertain to any part of
the Derivative Works; and
(d) If the Work includes a "NOTICE" text file as part of its
distribution, then any Derivative Works that You distribute must
include a readable copy of the attribution notices contained
within such NOTICE file, excluding those notices that do not
pertain to any part of the Derivative Works, in at least one
of the following places: within a NOTICE text file distributed
as part of the Derivative Works; within the Source form or
documentation, if provided along with the Derivative Works; or,
within a display generated by the Derivative Works, if and
wherever such third-party notices normally appear. The contents
of the NOTICE file are for informational purposes only and
do not modify the License. You may add Your own attribution
notices within Derivative Works that You distribute, alongside
or as an addendum to the NOTICE text from the Work, provided
that such additional attribution notices cannot be construed
as modifying the License.
You may add Your own copyright statement to Your modifications and
may provide additional or different license terms and conditions
for use, reproduction, or distribution of Your modifications, or
for any such Derivative Works as a whole, provided Your use,
reproduction, and distribution of the Work otherwise complies with
the conditions stated in this License.
5. Submission of Contributions. Unless You explicitly state otherwise,
any Contribution intentionally submitted for inclusion in the Work
by You to the Licensor shall be under the terms and conditions of
this License, without any additional terms or conditions.
Notwithstanding the above, nothing herein shall supersede or modify
the terms of any separate license agreement you may have executed
with Licensor regarding such Contributions.
6. Trademarks. This License does not grant permission to use the trade
names, trademarks, service marks, or product names of the Licensor,
except as required for reasonable and customary use in describing the
origin of the Work and reproducing the content of the NOTICE file.
7. Disclaimer of Warranty. Unless required by applicable law or
agreed to in writing, Licensor provides the Work (and each
Contributor provides its Contributions) on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
implied, including, without limitation, any warranties or conditions
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
PARTICULAR PURPOSE. You are solely responsible for determining the
appropriateness of using or redistributing the Work and assume any
risks associated with Your exercise of permissions under this License.
8. Limitation of Liability. In no event and under no legal theory,
whether in tort (including negligence), contract, or otherwise,
unless required by applicable law (such as deliberate and grossly
negligent acts) or agreed to in writing, shall any Contributor be
liable to You for damages, including any direct, indirect, special,
incidental, or consequential damages of any character arising as a
result of this License or out of the use or inability to use the
Work (including but not limited to damages for loss of goodwill,
work stoppage, computer failure or malfunction, or any and all
other commercial damages or losses), even if such Contributor
has been advised of the possibility of such damages.
9. Accepting Warranty or Additional Liability. While redistributing
the Work or Derivative Works thereof, You may choose to offer,
and charge a fee for, acceptance of support, warranty, indemnity,
or other liability obligations and/or rights consistent with this
License. However, in accepting such obligations, You may act only
on Your own behalf and on Your sole responsibility, not on behalf
of any other Contributor, and only if You agree to indemnify,
defend, and hold each Contributor harmless for any liability
incurred by, or claims asserted against, such Contributor by reason
of your accepting any such warranty or additional liability.
END OF TERMS AND CONDITIONS
APPENDIX: How to apply the Apache License to your work.
To apply the Apache License to your work, attach the following
boilerplate notice, with the fields enclosed by brackets "[]"
replaced with your own identifying information. (Don't include
the brackets!) The text should be enclosed in the appropriate
comment syntax for the file format. We also recommend that a
file or class name and description of purpose be included on the
same "printed page" as the copyright notice for easier
identification within third-party archives.
Copyright [yyyy] [name of copyright owner]
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.react
Version 2.2.0
MIT
View License Text
MIT License Copyright (c) Tailwind Labs, Inc. Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
resolvers
Version 5.4.0
MIT
Published by bluebill1049 (bluebill1049@hotmail.com)
View License Text
MIT License Copyright (c) 2019-present Beier(Bill) Luo Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
third-parties
Version 16.2.9
MIT
View License Text
# Experimental `@next/third-parties`
`@next/third-parties` is a collection of components and utilities that can be used to efficiently load third-party libraries into your Next.js application.
> Note: `@next/third-parties` is still experimental and under active development.
# Usage
## Google Third-Parties
### YouTube Embed
The `YouTubeEmbed` component is used to load and display a YouTube embed. This component loads faster by using [lite-youtube-embed](https://github.com/paulirish/lite-youtube-embed) under the hood.
```js
import { YouTubeEmbed } from '@next/third-parties/google'
export default function Page() {
return <YouTubeEmbed videoid="ogfYd705cRs" height={400} />
}
```
### Google Maps Embed
The `GoogleMapsEmbed` component can be used to add a [Google Maps Embed](https://developers.google.com/maps/documentation/embed/get-started) to your page. By default, it uses the `loading` attribute to lazy-load below the fold.
```js
import { GoogleMapsEmbed } from '@next/third-parties/google'
export default function Page() {
return (
<GoogleMapsEmbed
apiKey="XYZ"
height={200}
width="100%"
mode="place"
q="Brooklyn+Bridge,New+York,NY"
/>
)
}
```
To get a better idea of how these components work, take a look at this [demo](https://test-next-script-housseindjirdeh.vercel.app/). <!--- TODO: Replace with a better demo page -->api
Version 1.9.1
Apache-2.0
Published by OpenTelemetry Authors
View License Text
Apache License
Version 2.0, January 2004
http://www.apache.org/licenses/
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
1. Definitions.
"License" shall mean the terms and conditions for use, reproduction,
and distribution as defined by Sections 1 through 9 of this document.
"Licensor" shall mean the copyright owner or entity authorized by
the copyright owner that is granting the License.
"Legal Entity" shall mean the union of the acting entity and all
other entities that control, are controlled by, or are under common
control with that entity. For the purposes of this definition,
"control" means (i) the power, direct or indirect, to cause the
direction or management of such entity, whether by contract or
otherwise, or (ii) ownership of fifty percent (50%) or more of the
outstanding shares, or (iii) beneficial ownership of such entity.
"You" (or "Your") shall mean an individual or Legal Entity
exercising permissions granted by this License.
"Source" form shall mean the preferred form for making modifications,
including but not limited to software source code, documentation
source, and configuration files.
"Object" form shall mean any form resulting from mechanical
transformation or translation of a Source form, including but
not limited to compiled object code, generated documentation,
and conversions to other media types.
"Work" shall mean the work of authorship, whether in Source or
Object form, made available under the License, as indicated by a
copyright notice that is included in or attached to the work
(an example is provided in the Appendix below).
"Derivative Works" shall mean any work, whether in Source or Object
form, that is based on (or derived from) the Work and for which the
editorial revisions, annotations, elaborations, or other modifications
represent, as a whole, an original work of authorship. For the purposes
of this License, Derivative Works shall not include works that remain
separable from, or merely link (or bind by name) to the interfaces of,
the Work and Derivative Works thereof.
"Contribution" shall mean any work of authorship, including
the original version of the Work and any modifications or additions
to that Work or Derivative Works thereof, that is intentionally
submitted to Licensor for inclusion in the Work by the copyright owner
or by an individual or Legal Entity authorized to submit on behalf of
the copyright owner. For the purposes of this definition, "submitted"
means any form of electronic, verbal, or written communication sent
to the Licensor or its representatives, including but not limited to
communication on electronic mailing lists, source code control systems,
and issue tracking systems that are managed by, or on behalf of, the
Licensor for the purpose of discussing and improving the Work, but
excluding communication that is conspicuously marked or otherwise
designated in writing by the copyright owner as "Not a Contribution."
"Contributor" shall mean Licensor and any individual or Legal Entity
on behalf of whom a Contribution has been received by Licensor and
subsequently incorporated within the Work.
2. Grant of Copyright License. Subject to the terms and conditions of
this License, each Contributor hereby grants to You a perpetual,
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
copyright license to reproduce, prepare Derivative Works of,
publicly display, publicly perform, sublicense, and distribute the
Work and such Derivative Works in Source or Object form.
3. Grant of Patent License. Subject to the terms and conditions of
this License, each Contributor hereby grants to You a perpetual,
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
(except as stated in this section) patent license to make, have made,
use, offer to sell, sell, import, and otherwise transfer the Work,
where such license applies only to those patent claims licensable
by such Contributor that are necessarily infringed by their
Contribution(s) alone or by combination of their Contribution(s)
with the Work to which such Contribution(s) was submitted. If You
institute patent litigation against any entity (including a
cross-claim or counterclaim in a lawsuit) alleging that the Work
or a Contribution incorporated within the Work constitutes direct
or contributory patent infringement, then any patent licenses
granted to You under this License for that Work shall terminate
as of the date such litigation is filed.
4. Redistribution. You may reproduce and distribute copies of the
Work or Derivative Works thereof in any medium, with or without
modifications, and in Source or Object form, provided that You
meet the following conditions:
(a) You must give any other recipients of the Work or
Derivative Works a copy of this License; and
(b) You must cause any modified files to carry prominent notices
stating that You changed the files; and
(c) You must retain, in the Source form of any Derivative Works
that You distribute, all copyright, patent, trademark, and
attribution notices from the Source form of the Work,
excluding those notices that do not pertain to any part of
the Derivative Works; and
(d) If the Work includes a "NOTICE" text file as part of its
distribution, then any Derivative Works that You distribute must
include a readable copy of the attribution notices contained
within such NOTICE file, excluding those notices that do not
pertain to any part of the Derivative Works, in at least one
of the following places: within a NOTICE text file distributed
as part of the Derivative Works; within the Source form or
documentation, if provided along with the Derivative Works; or,
within a display generated by the Derivative Works, if and
wherever such third-party notices normally appear. The contents
of the NOTICE file are for informational purposes only and
do not modify the License. You may add Your own attribution
notices within Derivative Works that You distribute, alongside
or as an addendum to the NOTICE text from the Work, provided
that such additional attribution notices cannot be construed
as modifying the License.
You may add Your own copyright statement to Your modifications and
may provide additional or different license terms and conditions
for use, reproduction, or distribution of Your modifications, or
for any such Derivative Works as a whole, provided Your use,
reproduction, and distribution of the Work otherwise complies with
the conditions stated in this License.
5. Submission of Contributions. Unless You explicitly state otherwise,
any Contribution intentionally submitted for inclusion in the Work
by You to the Licensor shall be under the terms and conditions of
this License, without any additional terms or conditions.
Notwithstanding the above, nothing herein shall supersede or modify
the terms of any separate license agreement you may have executed
with Licensor regarding such Contributions.
6. Trademarks. This License does not grant permission to use the trade
names, trademarks, service marks, or product names of the Licensor,
except as required for reasonable and customary use in describing the
origin of the Work and reproducing the content of the NOTICE file.
7. Disclaimer of Warranty. Unless required by applicable law or
agreed to in writing, Licensor provides the Work (and each
Contributor provides its Contributions) on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
implied, including, without limitation, any warranties or conditions
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
PARTICULAR PURPOSE. You are solely responsible for determining the
appropriateness of using or redistributing the Work and assume any
risks associated with Your exercise of permissions under this License.
8. Limitation of Liability. In no event and under no legal theory,
whether in tort (including negligence), contract, or otherwise,
unless required by applicable law (such as deliberate and grossly
negligent acts) or agreed to in writing, shall any Contributor be
liable to You for damages, including any direct, indirect, special,
incidental, or consequential damages of any character arising as a
result of this License or out of the use or inability to use the
Work (including but not limited to damages for loss of goodwill,
work stoppage, computer failure or malfunction, or any and all
other commercial damages or losses), even if such Contributor
has been advised of the possibility of such damages.
9. Accepting Warranty or Additional Liability. While redistributing
the Work or Derivative Works thereof, You may choose to offer,
and charge a fee for, acceptance of support, warranty, indemnity,
or other liability obligations and/or rights consistent with this
License. However, in accepting such obligations, You may act only
on Your own behalf and on Your sole responsibility, not on behalf
of any other Contributor, and only if You agree to indemnify,
defend, and hold each Contributor harmless for any liability
incurred by, or claims asserted against, such Contributor by reason
of your accepting any such warranty or additional liability.
END OF TERMS AND CONDITIONS
APPENDIX: How to apply the Apache License to your work.
To apply the Apache License to your work, attach the following
boilerplate notice, with the fields enclosed by brackets "[]"
replaced with your own identifying information. (Don't include
the brackets!) The text should be enclosed in the appropriate
comment syntax for the file format. We also recommend that a
file or class name and description of purpose be included on the
same "printed page" as the copyright notice for easier
identification within third-party archives.
Copyright [yyyy] [name of copyright owner]
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.react-accordion
Version 1.2.14
MIT
View License Text
MIT License Copyright (c) 2022 WorkOS Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
react-alert-dialog
Version 1.1.17
MIT
View License Text
MIT License Copyright (c) 2022 WorkOS Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
react-avatar
Version 1.2.0
MIT
View License Text
MIT License Copyright (c) 2022 WorkOS Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
react-checkbox
Version 1.3.5
MIT
View License Text
MIT License Copyright (c) 2022 WorkOS Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
react-collapsible
Version 1.1.14
MIT
View License Text
MIT License Copyright (c) 2022 WorkOS Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
react-dialog
Version 1.1.17
MIT
View License Text
MIT License Copyright (c) 2022 WorkOS Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
react-dropdown-menu
Version 2.1.18
MIT
View License Text
MIT License Copyright (c) 2022 WorkOS Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
react-hover-card
Version 1.1.17
MIT
View License Text
MIT License Copyright (c) 2022 WorkOS Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
react-label
Version 2.1.10
MIT
View License Text
MIT License Copyright (c) 2022 WorkOS Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
react-popover
Version 1.1.17
MIT
View License Text
MIT License Copyright (c) 2022 WorkOS Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
react-scroll-area
Version 1.2.12
MIT
View License Text
MIT License Copyright (c) 2022 WorkOS Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
react-select
Version 2.3.1
MIT
View License Text
MIT License Copyright (c) 2022 WorkOS Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
react-separator
Version 1.1.10
MIT
View License Text
MIT License Copyright (c) 2022 WorkOS Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
react-slider
Version 1.4.1
MIT
View License Text
MIT License Copyright (c) 2022 WorkOS Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
react-slot
Version 1.3.0
MIT
View License Text
MIT License Copyright (c) 2022 WorkOS Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
react-switch
Version 1.3.1
MIT
View License Text
MIT License Copyright (c) 2022 WorkOS Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
react-tabs
Version 1.1.15
MIT
View License Text
MIT License Copyright (c) 2022 WorkOS Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
react-toast
Version 1.2.17
MIT
View License Text
MIT License Copyright (c) 2022 WorkOS Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
react-tooltip
Version 1.2.10
MIT
View License Text
MIT License Copyright (c) 2022 WorkOS Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
react-query
Version 5.101.0
MIT
Published by tannerlinsley
View License Text
MIT License Copyright (c) 2021-present Tanner Linsley Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
react-table
Version 8.21.3
MIT
Published by Tanner Linsley
View License Text
MIT License Copyright (c) 2016 Tanner Linsley Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
bcryptjs
Version 3.0.3
BSD-3-Clause
Published by Daniel Wirtz (dcode@dcode.io)
View License Text
bcrypt.js --------- Copyright (c) 2012 Nevins Bartolomeo <nevins.bartolomeo@gmail.com> Copyright (c) 2012 Shane Girish <shaneGirish@gmail.com> Copyright (c) 2025 Daniel Wirtz <dcode@dcode.io> Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: 1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer. 2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution. 3. The name of the author may not be used to endorse or promote products derived from this software without specific prior written permission. THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
class-variance-authority
Version 0.7.1
Apache-2.0
Published by Joe Bell
View License Text
Apache License
Version 2.0, January 2004
http://www.apache.org/licenses/
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
1. Definitions.
"License" shall mean the terms and conditions for use, reproduction,
and distribution as defined by Sections 1 through 9 of this document.
"Licensor" shall mean the copyright owner or entity authorized by
the copyright owner that is granting the License.
"Legal Entity" shall mean the union of the acting entity and all
other entities that control, are controlled by, or are under common
control with that entity. For the purposes of this definition,
"control" means (i) the power, direct or indirect, to cause the
direction or management of such entity, whether by contract or
otherwise, or (ii) ownership of fifty percent (50%) or more of the
outstanding shares, or (iii) beneficial ownership of such entity.
"You" (or "Your") shall mean an individual or Legal Entity
exercising permissions granted by this License.
"Source" form shall mean the preferred form for making modifications,
including but not limited to software source code, documentation
source, and configuration files.
"Object" form shall mean any form resulting from mechanical
transformation or translation of a Source form, including but
not limited to compiled object code, generated documentation,
and conversions to other media types.
"Work" shall mean the work of authorship, whether in Source or
Object form, made available under the License, as indicated by a
copyright notice that is included in or attached to the work
(an example is provided in the Appendix below).
"Derivative Works" shall mean any work, whether in Source or Object
form, that is based on (or derived from) the Work and for which the
editorial revisions, annotations, elaborations, or other modifications
represent, as a whole, an original work of authorship. For the purposes
of this License, Derivative Works shall not include works that remain
separable from, or merely link (or bind by name) to the interfaces of,
the Work and Derivative Works thereof.
"Contribution" shall mean any work of authorship, including
the original version of the Work and any modifications or additions
to that Work or Derivative Works thereof, that is intentionally
submitted to Licensor for inclusion in the Work by the copyright owner
or by an individual or Legal Entity authorized to submit on behalf of
the copyright owner. For the purposes of this definition, "submitted"
means any form of electronic, verbal, or written communication sent
to the Licensor or its representatives, including but not limited to
communication on electronic mailing lists, source code control systems,
and issue tracking systems that are managed by, or on behalf of, the
Licensor for the purpose of discussing and improving the Work, but
excluding communication that is conspicuously marked or otherwise
designated in writing by the copyright owner as "Not a Contribution."
"Contributor" shall mean Licensor and any individual or Legal Entity
on behalf of whom a Contribution has been received by Licensor and
subsequently incorporated within the Work.
2. Grant of Copyright License. Subject to the terms and conditions of
this License, each Contributor hereby grants to You a perpetual,
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
copyright license to reproduce, prepare Derivative Works of,
publicly display, publicly perform, sublicense, and distribute the
Work and such Derivative Works in Source or Object form.
3. Grant of Patent License. Subject to the terms and conditions of
this License, each Contributor hereby grants to You a perpetual,
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
(except as stated in this section) patent license to make, have made,
use, offer to sell, sell, import, and otherwise transfer the Work,
where such license applies only to those patent claims licensable
by such Contributor that are necessarily infringed by their
Contribution(s) alone or by combination of their Contribution(s)
with the Work to which such Contribution(s) was submitted. If You
institute patent litigation against any entity (including a
cross-claim or counterclaim in a lawsuit) alleging that the Work
or a Contribution incorporated within the Work constitutes direct
or contributory patent infringement, then any patent licenses
granted to You under this License for that Work shall terminate
as of the date such litigation is filed.
4. Redistribution. You may reproduce and distribute copies of the
Work or Derivative Works thereof in any medium, with or without
modifications, and in Source or Object form, provided that You
meet the following conditions:
(a) You must give any other recipients of the Work or
Derivative Works a copy of this License; and
(b) You must cause any modified files to carry prominent notices
stating that You changed the files; and
(c) You must retain, in the Source form of any Derivative Works
that You distribute, all copyright, patent, trademark, and
attribution notices from the Source form of the Work,
excluding those notices that do not pertain to any part of
the Derivative Works; and
(d) If the Work includes a "NOTICE" text file as part of its
distribution, then any Derivative Works that You distribute must
include a readable copy of the attribution notices contained
within such NOTICE file, excluding those notices that do not
pertain to any part of the Derivative Works, in at least one
of the following places: within a NOTICE text file distributed
as part of the Derivative Works; within the Source form or
documentation, if provided along with the Derivative Works; or,
within a display generated by the Derivative Works, if and
wherever such third-party notices normally appear. The contents
of the NOTICE file are for informational purposes only and
do not modify the License. You may add Your own attribution
notices within Derivative Works that You distribute, alongside
or as an addendum to the NOTICE text from the Work, provided
that such additional attribution notices cannot be construed
as modifying the License.
You may add Your own copyright statement to Your modifications and
may provide additional or different license terms and conditions
for use, reproduction, or distribution of Your modifications, or
for any such Derivative Works as a whole, provided Your use,
reproduction, and distribution of the Work otherwise complies with
the conditions stated in this License.
5. Submission of Contributions. Unless You explicitly state otherwise,
any Contribution intentionally submitted for inclusion in the Work
by You to the Licensor shall be under the terms and conditions of
this License, without any additional terms or conditions.
Notwithstanding the above, nothing herein shall supersede or modify
the terms of any separate license agreement you may have executed
with Licensor regarding such Contributions.
6. Trademarks. This License does not grant permission to use the trade
names, trademarks, service marks, or product names of the Licensor,
except as required for reasonable and customary use in describing the
origin of the Work and reproducing the content of the NOTICE file.
7. Disclaimer of Warranty. Unless required by applicable law or
agreed to in writing, Licensor provides the Work (and each
Contributor provides its Contributions) on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
implied, including, without limitation, any warranties or conditions
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
PARTICULAR PURPOSE. You are solely responsible for determining the
appropriateness of using or redistributing the Work and assume any
risks associated with Your exercise of permissions under this License.
8. Limitation of Liability. In no event and under no legal theory,
whether in tort (including negligence), contract, or otherwise,
unless required by applicable law (such as deliberate and grossly
negligent acts) or agreed to in writing, shall any Contributor be
liable to You for damages, including any direct, indirect, special,
incidental, or consequential damages of any character arising as a
result of this License or out of the use or inability to use the
Work (including but not limited to damages for loss of goodwill,
work stoppage, computer failure or malfunction, or any and all
other commercial damages or losses), even if such Contributor
has been advised of the possibility of such damages.
9. Accepting Warranty or Additional Liability. While redistributing
the Work or Derivative Works thereof, You may choose to offer,
and charge a fee for, acceptance of support, warranty, indemnity,
or other liability obligations and/or rights consistent with this
License. However, in accepting such obligations, You may act only
on Your own behalf and on Your sole responsibility, not on behalf
of any other Contributor, and only if You agree to indemnify,
defend, and hold each Contributor harmless for any liability
incurred by, or claims asserted against, such Contributor by reason
of your accepting any such warranty or additional liability.
END OF TERMS AND CONDITIONS
Copyright 2022 Joe Bell
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.clsx
Version 2.1.1
MIT
Published by Luke Edwards (luke.edwards05@gmail.com)
View License Text
MIT License Copyright (c) Luke Edwards <luke.edwards05@gmail.com> (lukeed.com) Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
cmdk
Version 1.1.1
MIT
Published by Paco
View License Text
MIT License Copyright (c) 2022 Paco Coursey Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
common-password
Version 0.1.2
ISC
Published by Michał Adamski (meehow808@gmail.com)
View License Text
This package was inspired by an article "[10,000 Top Passwords](https://xato.net/passwords/more-top-worst-passwords/)" by [Mark Burnett](https://xato.net/author/mb/).  This package can be used as password requirement, but should be combined with length checking. Some passwords are not listed as popular because they don't meet length requirement in many systems. For example `1234` is listed as popular password, but `123` is not. Installation ------------ ``` npm install common-password ``` Example ------- Check [example.js](./example.js). ``` $ node ./example.js passw0rd password is too easy to guess not OK $ node ./example.js eiGoh8ou OK ```
date-fns-tz
Version 3.2.0
MIT
Published by Marnus Weststrate (marnusw@gmail.com)
View License Text
The MIT License (MIT) Copyright © 2018 Marnus Weststrate Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
date-fns
Version 4.4.0
MIT
View License Text
MIT License Copyright (c) 2021 Sasha Koss and Lesha Koss https://kossnocorp.mit-license.org Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
geist
Version 1.7.2
MIT*
View License Text
Copyright (c) 2023 Vercel, in collaboration with basement.studio This Font Software is licensed under the SIL Open Font License, Version 1.1. This license is copied below, and is also available with a FAQ at: http://scripts.sil.org/OFL ----------------------------------------------------------- SIL OPEN FONT LICENSE Version 1.1 - 26 February 2007 ----------------------------------------------------------- PREAMBLE The goals of the Open Font License (OFL) are to stimulate worldwide development of collaborative font projects, to support the font creation efforts of academic and linguistic communities, and to provide a free and open framework in which fonts may be shared and improved in partnership with others. The OFL allows the licensed fonts to be used, studied, modified and redistributed freely as long as they are not sold by themselves. The fonts, including any derivative works, can be bundled, embedded, redistributed and/or sold with any software provided that any reserved names are not used by derivative works. The fonts and derivatives, however, cannot be released under any other type of license. The requirement for fonts to remain under this license does not apply to any document created using the fonts or their derivatives. DEFINITIONS "Font Software" refers to the set of files released by the Copyright Holder(s) under this license and clearly marked as such. This may include source files, build scripts and documentation. "Reserved Font Name" refers to any names specified as such after the copyright statement(s). "Original Version" refers to the collection of Font Software components as distributed by the Copyright Holder(s). "Modified Version" refers to any derivative made by adding to, deleting, or substituting -- in part or in whole -- any of the components of the Original Version, by changing formats or by porting the Font Software to a new environment. "Author" refers to any designer, engineer, programmer, technical writer or other person who contributed to the Font Software. PERMISSION AND CONDITIONS Permission is hereby granted, free of charge, to any person obtaining a copy of the Font Software, to use, study, copy, merge, embed, modify, redistribute, and sell modified and unmodified copies of the Font Software, subject to the following conditions: 1) Neither the Font Software nor any of its individual components, in Original or Modified Versions, may be sold by itself. 2) Original or Modified Versions of the Font Software may be bundled, redistributed and/or sold with any software, provided that each copy contains the above copyright notice and this license. These can be included either as stand-alone text files, human-readable headers or in the appropriate machine-readable metadata fields within text or binary files as long as those fields can be easily viewed by the user. 3) No Modified Version of the Font Software may use the Reserved Font Name(s) unless explicit written permission is granted by the corresponding Copyright Holder. This restriction only applies to the primary font name as presented to the users. 4) The name(s) of the Copyright Holder(s) or the Author(s) of the Font Software shall not be used to promote, endorse or advertise any Modified Version, except to acknowledge the contribution(s) of the Copyright Holder(s) and the Author(s) or with their explicit written permission. 5) The Font Software, modified or unmodified, in part or in whole, must be distributed entirely under this license, and must not be distributed under any other license. The requirement for fonts to remain under this license does not apply to any document created using the Font Software. TERMINATION This license becomes null and void if any of the above conditions are not met. DISCLAIMER THE FONT SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO ANY WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT OF COPYRIGHT, PATENT, TRADEMARK, OR OTHER RIGHT. IN NO EVENT SHALL THE COPYRIGHT HOLDER BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, INCLUDING ANY GENERAL, SPECIAL, INDIRECT, INCIDENTAL, OR CONSEQUENTIAL DAMAGES, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF THE USE OR INABILITY TO USE THE FONT SOFTWARE OR FROM OTHER DEALINGS IN THE FONT SOFTWARE.
handlebars
Version 4.7.9
MIT
Published by Yehuda Katz
View License Text
Copyright (C) 2011-2019 by Yehuda Katz Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
knex-types
Version 0.5.0
MIT
Published by Kriasoft (hello@kriasoft.com)
View License Text
Copyright 2021-present Kriasoft <hello@kriasoft.com> Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
knex
Version 3.2.10
MIT
Published by Tim Griesser
View License Text
Copyright (c) 2013-present Tim Griesser Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
leaflet
Version 1.9.4
BSD-2-Clause
View License Text
BSD 2-Clause License Copyright (c) 2010-2023, Volodymyr Agafonkin Copyright (c) 2010-2011, CloudMade All rights reserved. Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: 1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer. 2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution. THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
lucide-react
Version 1.21.0
ISC
Published by Eric Fennis
View License Text
ISC License Copyright (c) 2026 Lucide Icons and Contributors Permission to use, copy, modify, and/or distribute this software for any purpose with or without fee is hereby granted, provided that the above copyright notice and this permission notice appear in all copies. THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. --- The following Lucide icons are derived from the Feather project: airplay, alert-circle, alert-octagon, alert-triangle, aperture, arrow-down-circle, arrow-down-left, arrow-down-right, arrow-down, arrow-left-circle, arrow-left, arrow-right-circle, arrow-right, arrow-up-circle, arrow-up-left, arrow-up-right, arrow-up, at-sign, calendar, cast, check, chevron-down, chevron-left, chevron-right, chevron-up, chevrons-down, chevrons-left, chevrons-right, chevrons-up, circle, clipboard, clock, code, columns, command, compass, corner-down-left, corner-down-right, corner-left-down, corner-left-up, corner-right-down, corner-right-up, corner-up-left, corner-up-right, crosshair, database, divide-circle, divide-square, dollar-sign, download, external-link, feather, frown, hash, headphones, help-circle, info, italic, key, layout, life-buoy, link-2, link, loader, lock, log-in, log-out, maximize, meh, minimize, minimize-2, minus-circle, minus-square, minus, monitor, moon, more-horizontal, more-vertical, move, music, navigation-2, navigation, octagon, pause-circle, percent, plus-circle, plus-square, plus, power, radio, rss, search, server, share, shopping-bag, sidebar, smartphone, smile, square, table-2, tablet, target, terminal, trash-2, trash, triangle, tv, type, upload, x-circle, x-octagon, x-square, x, zoom-in, zoom-out The MIT License (MIT) (for the icons listed above) Copyright (c) 2013-present Cole Bemis Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
mailgun.js
Version 13.2.0
MIT
Published by Mailgun
View License Text
# Mailgun.js
A javascript sdk for Mailgun built with webpack, babel & es6. This can be used in node or in the browser*.
NOTE: If used in the browser, a proxy is required to communicate with the Mailgun api due to cors limitations. Also, do not publish your private api key in frontend code.
__Table of Contents__
- [Documentation](#documentation)
- [Install](#install)
- [Setup Client](#setup-client)
- [Available Imports](#imports)
- [Types imports](#types-imports)
- [Interfaces and Enums imports](#interfaces-and-enums-imports)
- [Fetch API usage](#fetch-api-usage)
- [Proxy configuration](proxy-configuration)
- [SubAccounts](#using-subaccounts)
- [Generated docs](#generated-docs)
- [Methods](#methods)
- [Pagination](#pagination)
- [Browser Demo](#browser-demo)
- [Examples](https://github.com/mailgun/mailgun-js/tree/master/examples)
- [Development](#development)
- [Requirements](#requirements)
- [Build](#build)
- [Tests](#tests)
- [Release Process](#release-process)
# Documentation
[Mailgun API Documentation](https://documentation.mailgun.com/docs/mailgun/api-reference/api-overview)
## Install
- Requires node.js >= 18.x
Install mailgun.js with:
```SH
npm install mailgun.js
```
## Setup Client
The next step is to import the module and instantiate a mailgun client by calling `new Mailgun(formData)` and then using `mailgun.client` setup the client with basic auth credentials `(username: 'api', key: 'MAILGUN_API_KEY')`.
NOTE: starting from version 3.0 you need to pass FormData (we need this to keep library universal). For node.js you can use built-in FormData or `form-data` library.
**IMPORTANT**: if you use EU infrastructure, you need to also pass `url: 'https://api.eu.mailgun.net'` together with auth credentials as stated in [Mailgun docs](https://documentation.mailgun.com/docs/mailgun/api-reference/api-overview#base-url)
### Imports
Once the package is installed, you can import the library using `import` or `require` approach:
```js
const Mailgun = require('mailgun.js');
const mailgun = new Mailgun(FormData); // or const formData = require('form-data');
const mg = mailgun.client({username: 'api', key: process.env.MAILGUN_API_KEY || 'MAILGUN_API_KEY'});
```
```js
import Mailgun from 'mailgun.js';
const mailgun = new Mailgun(FormData); // or import formData from 'form-data';
const mg = mailgun.client({username: 'api', key: process.env.MAILGUN_API_KEY || 'MAILGUN_API_KEY'});
```
Be aware that there are four bundles available for usage. All of them are conditionally exported by package.json and separated by environment (Browser/Node.js):
- Node.js environment:
- CommonJS ([CJS](https://nodejs.org/api/modules.html#modules-commonjs-modules)), a bundle to use with the CommonJS module system in Node.js.
Usage example:
``` JS
// In this case, the .dist/CJS/mailgun.node.cjs file is expected to be used
const Mailgun = require('mailgun.js');
const mailgun = new Mailgun(FormData);
```
- ECMAScript modules ([ESM](https://nodejs.org/download/release/v18.11.0/docs/api/esm.html#modules-ecmascript-modules)) a bundle for the **Node.js** environment
Usage example:
``` JS
// In this case, the .dist/ESM/mailgun.node.js file is expected to be used
import Mailgun from 'mailgun.js';
const mailgun = new Mailgun(FormData);
...
```
or with dynamic imports:
``` JS
// In this case, the .dist/ESM/mailgun.node.js file is expected to be used
const Mailgun = await import('mailgun.js');
const mailgun = new Mailgun.default(FormData);
...
```
- Browser environment:
- Asynchronous Module Definition ([AMD](https://github.com/amdjs/amdjs-api/wiki/AMD)), a bundle to use with the `Require.js` module loader in the browser. This bundle requires the RequireJS module loader to be present in the environment.
Usage example for the case when the distribution is used directly in the browser:
``` HTML
<script src='http://requirejs.org/docs/release/2.3.6/comments/require.js'></script>
<script>
require(['./dist/AMD/mailgun.amd.js'], function(Mailgun) {
const mailgun = new Mailgun(FormData);
...
})
</script>
```
- ECMAScript modules ([ESM](https://nodejs.org/download/release/v18.11.0/docs/api/esm.html#modules-ecmascript-modules)) a bundle for **browser** environment.
Usage example for the case the distribution is used directly in the browser:
``` HTML
<script type="module">
import Mailgun from './dist/ESM/mailgun.browser.js';
const mailgun = new Mailgun(FormData);
...
</script>
```
or with dynamic imports:
``` HTML
<script>
import ('./dist/ESM/mailgun.browser.js').then(Mailgun =>{
const mailgun = new Mailgun.default(FormData);
...
})
</script>
```
### Types imports
Types defined by SDK can be imported from 'definitions' submodule:
```TS
import { MailgunClientOptions, MessagesSendResult } from 'mailgun.js/definitions';
```
### Interfaces and Enums imports
Interfaces and Enums defined by SDK can be imported from 'definitions' submodule:
```TS
import { Interfaces, Enums } from 'mailgun.js/definitions';
...
const mailgunClient: Interfaces.IMailgunClient = mailgun.client(clientOptions);
const yes = Enums.YesNo.YES;
...
```
### Fetch API usage
Starting from version `12.1.0`, the [Fetch API](https://developer.mozilla.org/en-US/docs/Web/API/Fetch_API) is available for use in environments that do not support `XMLHttpRequest`.
The new `useFetch` configuration parameter is responsible for this.
***Note that proxy configuration and the `form-data` NPM package are not supported in this case.***
Example:
```TS
import Mailgun from 'mailgun.js';
const mailgun = new Mailgun(FormData);
const mg = mailgun.client({
username: 'api',
key: process.env.MAILGUN_API_KEY || 'MAILGUN_API_KEY',
useFetch: true,
});
```
### Proxy configuration
By leveraging client configuration options, users can effortlessly establish proxy connections that align with their network requirements.
Example:
```js
import Mailgun from 'mailgun.js';
const mailgun = new Mailgun(FormData);// or import FormData from 'form-data';
const mg = mailgun.client({
username: 'api',
key: process.env.MAILGUN_API_KEY || 'MAILGUN_API_KEY',
proxy: {
protocol: 'https' // 'http' ,
host: '127.0.0.1', // use your proxy host here
port: 9000, // use your proxy port here
auth: { // may be omitted if proxy doesn't require authentication
username: 'user_name', // provide username
password: 'user_password' // provide password
}
},
});
```
### SubAccounts Usage
Primary accounts can make API calls on behalf of their subaccounts. [API documentation](https://documentation.mailgun.com/docs/mailgun/api-reference/send/mailgun/subaccounts)
```js
import Mailgun from 'mailgun.js';
const mailgun = new Mailgun(FormData); // or import FormData from 'form-data'
const mg = mailgun.client({username: 'api', key: process.env.MAILGUN_API_KEY || 'MAILGUN_API_KEY'});
mg.setSubaccount('subaccount-id');
// then, if you need to reset it back to the primary account:
mg.resetSubaccount();
```
### Generated docs
The list of all available Types, Interfaces and Enums is auto-generated and located in the [docs](./docs/modules.md) folder.
## Methods
The following service methods are available to instantiated clients. The examples assume you have already created a mailgun client as `mg` with valid credentials.
- [Documentation](#documentation)
- [Install](#install)
- [Setup Client](#setup-client)
- [Methods](#methods)
- [messages](#messages)
- [create](#create)
- [retrieveStoredEmail](#retrievestoredemail)
- [resendEmail](#resendemail)
- [getMessagesQueueStatus](#getmessagesqueuestatus)
- [clearMessagesQueue](#clearmessagesqueue)
- [domains](#domains)
- [list](#list)
- [get](#get)
- [create](#create-1)
- [update](#update)
- [verify](#verify)
- [destroy](#destroy)
- [getTracking](#gettracking)
- [updateTracking](#updatetracking)
- [getConnection](#getconnection)
- [updateConnection](#updateconnection)
- [updateDKIMAuthority](#updatedkimauthority)
- [updateDKIMSelector](#updatedkimselector)
- [getIps](#getips)
- [assignIp](#assignip)
- [domain templates](#domain-templates)
- [list](#list-1)
- [get](#get-1)
- [create](#create-2)
- [update](#update-1)
- [destroy](#destroy-1)
- [destroyAll](#destroyall)
- [listVersions](#listversions)
- [getVersion](#getversion)
- [createVersion](#createversion)
- [updateVersion](#updateversion)
- [destroyVersion](#destroyversion)
- [domain tracking](#domain-tracking)
- [getTracking](#gettracking-1)
- [updateTracking](#updatetracking-1)
- [get](#get-2)
- [generate](#generate)
- [regenerate](#regenerate)
- [domain keys](#domain-keys)
- [list](#list-2)
- [listAll](#listall)
- [create](#create-3)
- [activate](#activate)
- [deactivate](#deactivate)
- [destroy](#destroy-2)
- [updateDKIMAuthority](#updatedkimauthority-1)
- [updateDKIMSelector](#updatedkimselector-1)
- [events](#events)
- [get](#get-3)
- [Example with Date and *Filter field*](#example-with-date-and-filter-field)
- [logs](#logs)
- [list](#list-3)
- [stats](#stats)
- [Stats Options](#stats-options)
- [getDomain](#getdomain)
- [getAccount](#getaccount)
- [metrics](#metrics)
- [getAccount](#getaccount-1)
- [getAccountUsage](#getaccountusage)
- [suppressions](#suppressions)
- [list](#list-4)
- [Bounces Example](#bounces-example)
- [Unsubscribes Example](#unsubscribes-example)
- [Complaints Example](#complaints-example)
- [get](#get-4)
- [Bounces Example](#bounces-example-1)
- [Unsubscribes Example](#unsubscribes-example-1)
- [Complaints Example](#complaints-example-1)
- [create](#create-4)
- [Bounces Example](#bounces-example-2)
- [Unsubscribes Example](#unsubscribes-example-2)
- [Unsubscribe from one tag](#unsubscribe-from-one-tag)
- [Unsubscribe from particular tags](#unsubscribe-from-particular-tags)
- [Complaints Example](#complaints-example-2)
- [upload](#upload)
- [Bounces list upload example](#bounces-file-upload-example)
- [Unsubscribes list upload example](#unsubscribes-file-upload-example)
- [Complaints list upload example](#complaints-file-upload-example)
- [Whitelists list upload example](#whitelists-file-upload-example)
- [destroy](#destroy-3)
- [Bounces Example](#bounces-example-3)
- [Unsubscribes Example](#unsubscribes-example-3)
- [Complaints Example](#complaints-example-3)
- [destroyAll](#destroyall-1)
- [Bounces Example](#bounces-example-4)
- [Unsubscribes Example](#unsubscribes-example-4)
- [Complaints Example](#complaints-example-4)
- [Whitelists Example](#whitelists-example)
- [webhooks](#webhooks)
- [list](#list-5)
- [get](#get-5)
- [create](#create-5)
- [update](#update-2)
- [destroy](#destroy-4)
- [routes](#routes)
- [list](#list-6)
- [get](#get-6)
- [create](#create-6)
- [update](#update-3)
- [destroy](#destroy-5)
- [matchAddress](#matchaddress)
- [validate](#validate)
- [get](#get-7)
- [multiple validation](#multiple-validation)
- [create](#create-7)
- [list](#list-7)
- [get](#get-8)
- [destroy](#destroy-6)
- [mailing lists](#mailing-lists)
- [list](#list-8)
- [listByAddress](#listbyaddress)
- [get](#get-9)
- [create](#create-8)
- [update](#update-4)
- [destroy](#destroy-7)
- [mailing list members](#mailing-list-members)
- [listMembers](#listmember)
- [listMembersByAddress](#listmembersbyaddress)
- [getMember](#getmember)
- [createMember](#createmember)
- [createMembers](#createmembers)
- [updateMember](#updatemember)
- [destroyMember](#destroymember)
- [subaccounts](#subaccounts)
- [list](#list-9)
- [get](#get-10)
- [create](#create-9)
- [enable](#enable)
- [disable](#disable)
- [destroy](#destroy-8)
- [setMonthlySendingLimit](#setmonthlysendinglimit)
- [getMonthlySendingLimit](#getmonthlysendinglimit)
- [updateSubaccountFeature](#updatesubaccountfeature)
- [inbox placements](#inbox-placements)
- [SeedsLists](#seedslists)
- [list](#list-10)
- [get](#get-11)
- [create](#create-10)
- [update](#update-5)
- [destroy](#destroy-9)
- [SeedsLists Attributes](#attributes)
- [list](#list-11)
- [get](#get-12)
- [SeedsLists Filters](#filters)
- [list](#list-12)
- [Providers](#providers)
- [list](#list-13)
- [Results](#results)
- [list](#list-14)
- [get](#get-13)
- [destroy](#destroy-10)
- [getResultByShareId](#getresultbyshareid)
- [Results Attributes](#attributes-1)
- [list](#list-15)
- [get](#get-14)
- [Results Filters](#filters-1)
- [list](#list-16)
- [Sharing](#sharing)
- [get](#get-15)
- [update](#update-6)
- [Run Test](#run-test)
- [DKIM Management](#dkim-management)
- [update](#update-7)
- [Bounce Classification](#bounce-classification)
- [list](#list-17)
- [Tags](#tags)
- [list](#list-18)
- [limits](#limits)
- [update](#update-8)
- [destroy](#destroy-11)
- [Custom Message Limit](#custom-message-limit)
- [get](#get-16)
- [set](#set)
- [destroy](#destroy-12)
- [enable](#enable-1)
- [Account Management](#account-management)
- [updateAccountSettings](#updateaccountsettings)
- [getWebhookSigningKey](#getwebhooksigningkey)
- [createWebhookSigningKey](#createwebhooksigningkey)
- [getSandboxAuthorizedRecipients](#getsandboxauthorizedrecipients)
- [addSandboxAuthorizedRecipient](#addsandboxauthorizedrecipient)
- [removeSandboxAuthorizedRecipient](#removesandboxauthorizedrecipient)
- [resendActivationEmail](#resendactivationemail)
- [updateAccountFeature](#updateaccountfeature)
- [Browser Demo](#browser-demo)
- [Development](#development)
- [Requirements](#requirements)
- [Build](#build)
- [Tests](#tests)
- [Release Process](#release-process)
- [TODO](#todo)
### Method naming conventions:
- `get` or `get{{Item}}` - expected response for client is a single object
- `list` or `list{{Items}}` - expected response for client is a list of objects
- `create` or `create{{Item}}` - expected response for client is a single object
- `update` or `update{{Item}}` - expected response is an object with a status message
- `destroy` or `destroy{{Item}}` - expected response is an object with a status message
### Messages
- #### create
[API Reference](https://documentation.mailgun.com/docs/mailgun/api-reference/send/mailgun/messages/post-v3--domain-name--messages)
`mg.messages.create(domain, data)`
Options:
Parameter | Description
:---------------- | :---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
to | Email address of the recipient(s). Example: "Bob <bob@host.com>". You can use commas to separate multiple recipients (e.g.: "test@example.com,test@example.com" or ["test@example.com", "test@example.com"]).
cc | Same as `To` but for `carbon copy`
bcc | Same as `To` but for `blind carbon copy`
subject | Subject of the message.
html | HTML version of the message.
text | Text version of the message.
message | MIME string of the message. Make sure to use multipart/form-data to send this as a file upload.
attachment | File attachment. You can post multiple attachment values. Important: You must use multipart/form-data encoding when sending attachments. Also you can use `{data: file, filename: filename}` to define custom filename.
o:tag | Tag string. See Tagging for more information.
o:campaign | Id of the campaign the message belongs to. See um-campaign-analytics for details.
o:deliverytime | Desired time of delivery. See Date Format. Note: Messages can be scheduled for a maximum of 3 days in the future.
o:dkim | Enables/disabled DKIM signatures on per-message basis. Pass yes or no
o:testmode | Enables sending in test mode. Pass yes if needed. See Sending in Test Mode
o:tracking | Toggles tracking on a per-message basis, see Tracking Messages for details. Pass yes or no.
o:tracking-clicks | Toggles clicks tracking on a per-message basis. Has higher priority than domain-level setting. Pass yes, no or htmlonly.
o:tracking-opens | Toggles opens tracking on a per-message basis. Has higher priority than domain-level setting. Pass yes or no.
h:X-My-Header | h: prefix followed by an arbitrary value allows to append a custom MIME header to the message (X-My-Header in this case). For example, h:Reply-To to specify Reply-To address.
v:my-var | v: prefix followed by an arbitrary name allows to attach a custom JSON data to the message. See Attaching Data to Messages for more information.
- HTML/TEXT Example:
```JS
mg.messages.create('sandbox-123.mailgun.org', {
from: "Excited User <mailgun@sandbox-123.mailgun.org>",
to: ["test@example.com"],
subject: "Hello",
text: "Testing some Mailgun awesomness!",
html: "<h1>Testing some Mailgun awesomness!</h1>"
})
.then(msg => console.log(msg)) // logs response data
.catch(err => console.error(err)); // logs any error
```
- MIME Example:
```js
mg.messages.create('sandbox-123.mailgun.org', {
from: "Excited User <mailgun@sandbox-123.mailgun.org>",
to: ["test@example.com"],
subject: "Hello",
message: "<mime encoded string here>"
})
.then(msg => console.log(msg)) // logs response data
.catch(err => console.error(err)); // logs any error
```
- Messages with attachments:
- Node.js example of send file as an attachment
```js
const fsPromises = require('fs').promises;
const path = require('path');
const filepath = path.resolve(__dirname, '../test.pdf');
let messageParams = {
from: "Excited User <mailgun@sandbox-123.mailgun.org>",
to: ["test@example.com"],
subject: "Test subject",
text: "Hello here is a file in the attachment"
}
fsPromises.readFile(filepath)
.then(data => {
const file = {
filename: 'test-rename.pdf',
data
}
messageParams.attachment = file;
return mg.messages.create('sandbox-123.mailgun.org', messageParams);
})
.then(response => {
console.log(response);
})
```
- Node.js example of send multiple files as an attachment
```js
const fsPromises = require('fs').promises;
const path = require('path');
const filepath = path.resolve(__dirname, '../test.pdf');
const filepath1 = path.resolve(__dirname, '../test.jpg');
let messageParams = {
from: "Excited User <mailgun@sandbox-123.mailgun.org>",
to: ["test@example.com"],
subject: "Test subject",
text: "Test message"
}
(async () =>{
try {
const firstFile = {
filename: 'test.pdf',
data: await fsPromises.readFile(filepath)
}
const secondFile = {
filename: 'test.jpg',
data: await fsPromises.readFile(filepath1)
}
messageParams.attachment = [firstFile, secondFile];
const result = await mg.messages.create('sandbox-123.mailgun.org', messageParams);
console.log(result);
} catch (error) {
console.error(error);
}
})()
```
- Node.js example of send file as inline image
```js
const fsPromises = require('fs').promises;
const path = require('path');
const filepath = path.resolve(__dirname, '../test.jpg');
let messageParams = {
from: "Excited User <mailgun@sandbox-123.mailgun.org>",
to: ["test@example.com"],
subject: "Test subject",
html: '<div><img alt="image" id="1" src="cid:test.jpg"/></div> Some extra text'
}
fsPromises.readFile(filepath)
.then(data => {
const file = {
filename: 'test.jpg',
data
}
messageParams.inline = file;
return mg.messages.create('sandbox-123.mailgun.org', messageParams);
})
.then(response => console.log(response))
```
- Browser example of send file
Before sending the file you need to somehow get the Blob of the file.
Usually can get it from the onChange event of input tag with type file.
```js
const handleFileSelected = async (event) => {
const files = Array.from(event.target.files)
const fileBuffer = await files[0];
}
<input type="file" onChange={handleFileSelected} name="file-uploader"/>
```
Then you can use the same approach as shown above for node.js apps.
```js
const file = {
filename: 'test.pdf',
data: fileBuffer
};
let messageParams = {
from: "Excited User <mailgun@sandbox-123.mailgun.org>",
to: ["test@example.com"],
subject: "Test subject",
text: "Hello here is a file in the attachment",
attachment: file
};
const res = await mg.messages.create(DOMAIN, messageParams);
```
Promise returns:
```js
{
id: '<20151025002517.117282.79817@sandbox-123.mailgun.org>',
message: 'Queued. Thank you.'
}
```
- #### retrieveStoredEmail
[API Reference](https://documentation.mailgun.com/docs/mailgun/api-reference/send/mailgun/messages/get-v3-domains--domain-name--messages--storage-key-)
`mg.messages.retrieveStoredEmail(domain, storageKey)`
**storageKey** - Storage key from the email's associated events (Example: Accepted/Delivered events storage.key field). Mentioned events can be found on https://app.mailgun.com/ (Send -> logs).
*Note: Storage keys are available for the duration of your domain's message retention policy.*
Example:
```JS
mg.messages.retrieveStoredEmail('sandbox-123.mailgun.org', 'BABEAAeEDgPUyeFqr-tATLaCfYqyqvLpbg')
.then(storedEmail => console.log(storedEmail)) // logs response data
.catch(err => console.error(err)); // logs any error
```
Promise returns:
```JS
{
'Content-Type': 'multipart/alternative; boundary="boundary_12345"',
From: 'postmaster@sandbox.mailgun.org',
'Message-Id': '<123.123@sandbox.mailgun.org>',
'Mime-Version': '1.0',
Subject: 'Hello',
To: 'foo@example.com',
'X-Mailgun-Deliver-By': 'Fri, 28 Nov 2025 18:02:00 +0000',
sender: 'postmaster@sandbox.mailgun.org',
recipients: 'foo@example.com',
from: 'postmaster@sandbox.mailgun.org',
subject: 'Hello',
'body-html': '<a href="https://test.com">Test</a>',
'body-plain': 'Testing some Mailgun awesomness!',
attachments: [],
'content-id-map': {},
'message-headers': [
['Mime-Version', '1.0'],
[
'Content-Type',
'multipart/alternative; boundary="boundary_12345'
],
['Subject', 'Hello'],
['From', 'postmaster@sandbox.mailgun.org'],
['To', 'foo@example.com'],
['X-Mailgun-Deliver-By', 'Fri, 28 Nov 2025 18:02:00 +0000'],
[
'Message-Id',
'<123.123@sandbox.mailgun.org>'
]
],
'stripped-html': '<a href="https://test.com">Test</a>',
'stripped-text': 'Testing some Mailgun awesomness!',
'stripped-signature': ''
}
```
- ### resendEmail
[API Reference](https://documentation.mailgun.com/docs/mailgun/api-reference/send/mailgun/messages/post-v3-domains--domain-name--messages--storage-key-)
`mg.messages.resendEmail(domain, storageKey, recipient)`
**storageKey** - Storage key from the email's associated events (Example: Accepted/Delivered events storage.key field). Mentioned events can be found on https://app.mailgun.com/ (Send -> logs).
*Note: Storage keys are available for the duration of your domain's message retention policy.*
**recipient** - Email address of the recipient(s). Supports friendly name format.
Example: "Bob <bob@host.com>". Use commas to separate multiple recipients. Duplicate addresses are automatically ignored.
Example:
```JS
mg.messages.resendEmail(
'sandbox-123.mailgun.org',
'BABEAAeEDgPUyeFqr-tATLaCfYqyqvLpbg',
'foo@test.com, bar@test.com'
).then(resendStatus => console.log(resendStatus)) // logs response data
.catch(err => console.error(err)); // logs any error
```
Promise returns:
```JS
{
id: '<20151025002517.117282.79817@sandbox-123.mailgun.org>',
message: 'Queued. Thank you.'
}
```
- ### getMessagesQueueStatus
[API Reference](https://documentation.mailgun.com/docs/mailgun/api-reference/send/mailgun/messages/get-v3-domains--name--sending-queues)
`mg.messages.getMessagesQueueStatus(domain)`
Example:
```JS
mg.messages.getMessagesQueueStatus('sandbox-123.mailgun.org')
.then(queueStatus => console.log(queueStatus)) // logs response data
.catch(err => console.error(err)); // logs any error
```
Promise returns:
```JS
{
regular: {
is_disabled: false,
disabled: {
until: null,
reason: ''
}
},
scheduled: {
is_disabled: true,
disabled: {
until: new Date('2025-11-28T18:02:00Z'),
reason: 'High load'
}
}
}
```
- ### clearMessagesQueue
Deletes all scheduled and undelivered mail from the domain queue.
[API Reference](https://documentation.mailgun.com/docs/mailgun/api-reference/send/mailgun/messages/delete-v3--domain-name--envelopes)
`mg.messages.getMessagesQueueStatus(domain, storageUrl)`
**storageUrl** - Mail's generated storage URL. e.g. https://storage-us-east4.api.mailgun.net/v3/example.com/envelopes. Can be found on https://app.mailgun.com/ (Send -> logs -> event). Allowed values: `storage-us-east4.api.mailgun.net`, `storage-us-west1.api.mailgun.net`, and `storage-europe-west1.api.mailgun.net`.
Example:
```JS
mg.messages.clearMessagesQueue('sandbox-123.mailgun.org', 'storage-us-east4.api.mailgun.net')
.then(result => console.log(result)) // logs response data
.catch(err => console.error(err)); // logs any error
```
Promise returns:
```JS
{
message: "done"
}
```
### Templates
Mailgun’s templates uses a fork of the very popular template engine [handlebars](https://handlebarsjs.com/).
To provide values for a substitution you need to use `h:X-Mailgun-Variables` property in the message description.
Make sure that this property is a JSON string like:
```JS
JSON.stringify({
title: "A title",
body: "The body"
})
```
You can find few examples of how to use templates below.
- Providing values for **title** and **slug** variables to render in template
```JS
...
const {
title,
slug,
} = someDataSource;
const mailgunData = {
from: 'mailer@example.com>',
to: 'recipient@example.com',
subject: `Email ${title}`,
template: 'name-of-the-template-you-made-in-mailgun-web-portal',
'h:X-Mailgun-Variables': JSON.stringify({ // be sure to stringify your payload
title,
slug,
}),
'h:Reply-To': 'reply-to@example.com',
};
try {
const response = await mailgun.messages.create(DOMAIN_NAME, mailgunData);
...
```
- Providing an array of objects to render them in the template
```JS
...
const mailgunData = {
from: 'mailer@example.com>',
to: 'recipient@example.com',
subject: `Email ${title}`,
template: 'name-of-the-another-template-you-made-in-mailgun-web-portal',
'h:X-Mailgun-Variables': JSON.stringify({
"arrayItems": [
{
"question": "test_question",
"answer": "test_answer"
},
{
"question": "test_question",
"answer": "test_answer"
}
]})
};
try {
const response = await mailgun.messages.create(DOMAIN_NAME, mailgunData);
...
```
### Recipient Variables
[API Reference](https://documentation.mailgun.com/docs/mailgun/api-reference/send/mailgun/messages/post-v3--domain-name--messages)
Recipient Variables are custom variables that you define, which you can then reference in the message body. They give you the ability to send a custom message to each recipient while still using a single API Call.
```JS
...
const mailgunData = {
from: 'Example.com Mailer <mailer@mailer.example.com>',
to: ['me@example.com', 'you@example.com'],
subject: 'Recipient - %recipient.title%',
html: 'Here\'s %recipient.title% and <a href="%recipient.link%">link</a>',
'recipient-variables': JSON.stringify({
'me@example.com': {
title: 'Me',
link: 'href-var',
},
'you@example.com': {
title: 'You',
link: 'slug-recipient-var-c',
},
}),
};
try {
const response = await mailgun.messages.create(DOMAIN_NAME, mailgunData);
...
```
### Domains
Domains API manages domains, domain keys and DNS verification.
- #### list
Get the list of domains. Can be filtered by state or authority. Sorting is optional. The list is paginated and limited to 1000 items per page.
[API Reference](https://documentation.mailgun.com/docs/mailgun/api-reference/send/mailgun/domains/get-v4-domains)
`mg.domains.list(query)`
Example:
```JS
mg.domains.list()
.then(domains => console.log(domains)) // logs array of domains
.catch(err => console.error(err)); // logs any error
```
Promise returns: array of Domain instances
```JS
[{
name: 'testing.example.com',
require_tls: true,
skip_verification: true,
state: 'unverified',
wildcard: true
spam_action: 'disabled',
created_at: 'Sun, 19 Oct 2014 18:49:36 GMT',
smtp_password: undefined,
smtp_login: 'postmaster@testing.example.com',
type: 'custom',
receiving_dns_records: null,
sending_dns_records: null,
id: '697d01d38712cf0322bb24d1',
is_disabled: false,
web_prefix: 'test',
web_scheme: 'https',
use_automatic_sender_security: true
}]
```
Query data may have next properties:
| Property | Description |
|:----------|:------------------------------------------------------|
| limit | Maximum number of records to return. (100 by default) |
| skip | Number of records to skip. (0 by default) |
| state | To only get domains with a specific state. Can be either active, unverified or disabled. |
| sort | Valid sort options are **name** which defaults to asc order, **name:asc**, or **name:desc**. If sorting is not specified domains are returned in reverse creation date order. |
| authority | To only get domains with a specific authority. If state is specified then only state filtering will be proceed |
| search | Search domains by the given partial or complete name. Does not support wildcards|
- #### get
Fetches representation of a domain that includes details about the domain's state and settings.
[API Reference](https://documentation.mailgun.com/docs/mailgun/api-reference/send/mailgun/domains/get-v4-domains--name-)
`mg.domains.get(domain, query)`
Example:
```JS
mg.domains.get('testing.example.com', {
extended: true
})
.then(domain => console.log(domain)) // logs domain object
.catch(err => console.error(err)); // logs any error
```
Query object may have next properties:
| Property | Description |
|:----------|:------------------------------------------------------|
| extended | Default to false. If set to true, domain payload will include dkim_host, mailfrom_host and pod |
| with_dns | Default to true, domain payload will include sending and receiving dns records payload|
Promise returns: Domain instance
```JS
{
name: 'testing.example.com',
require_tls: true,
skip_verification: true,
state: 'unverified',
wildcard: true,
spam_action: 'disabled',
created_at: new Date('Sun, 19 Oct 2014 18:49:36 GMT'),
smtp_password: undefined,
smtp_login: 'postmaster@testing.example.com',
type: 'custom',
receiving_dns_records: [ // may be null if with_dns is set to false.
{
is_active: true,
cached: [],
priority: '10',
record_type: 'TXT',
valid: "unknown",
value: "dns_record_value"
},
...
],
sending_dns_records: [ // may be null if with_dns is set to false.
{
is_active: true,
cached: [],
name: 'dns_record_name',
record_type: 'CNAME',
valid: 'unknown',
value: 'dns_record_value'
},
...
],
id: '697d01d38712cf0322bb24d1',
is_disabled: false,
web_prefix: 'email',
web_scheme: 'http',
use_automatic_sender_security: true,
dkim_host: 'dkim_host_value', // absent if 'extended' was not set to true.
mailfrom_host: 'mailfrom_host_value', // absent if 'extended' was not set to true.
}
```
- #### create
Creates a domain for sending emails
[API Reference](https://documentation.mailgun.com/docs/mailgun/api-reference/send/mailgun/domains/post-v4-domains)
`mg.domains.create(data)`
Example:
```js
mg.domains.create({
name: 'foobar.example.com',
dkim_key_size: 1024,
dkim_selector: 's1',
encrypt_incoming_message: true,
force_dkim_authority: false,
force_root_dkim_host: false,
wildcard: true,
pool_id: 'pool_id',
ips: '',
spam_action: 'tag',
smtp_password: 'smtp_password_value',
use_automatic_sender_security: true,
web_prefix: 'test',
web_scheme: 'https',
})
.then(data => console.log(data)) // logs response data
.catch(err => console.error(err)); // logs any error
```
Create method accepts data object with next properties:
| Parameter | Description |
|--- |--- |
| name (required) | Name of the domain (ex. domain.com) |
| dkim_host_name | Set the DKIM host name for the domain that is being created. Note, the value must be a valid domain name, and can be the domain name being created, a subdomain of the domain being created, or the root domain. This parameter cannot be used in conjunction with `force_dkim_authority` or `force_root_dkim_host`. |
| dkim_key_size | **1024** or **2048**<br>Set the length of your domain’s generated DKIM key<br>The default is **1024** |
| dkim_selector | Explicitly set the value of the DKIM selector for the domain being created. If the domain key does not already exist, one will be created. The selector must be a valid atom per RFC2822. e.g valid value foobar, invalid value foo.bar https://datatracker.ietf.org/doc/html/rfc2822#section-3.2.4|
| encrypt_incoming_message | Enable encrypting incoming messages for the given domain. This cannot be altered via API after being set for security purposes. Reach out to Support to disable if necessary. Default to false|
| force_dkim_authority| If set to true, the domain will be the DKIM authority for itself even if the root domain is registered on the same mailgun account. If set to false, the domain will have the same DKIM authority as the root domain registered on the same mailgun account. Default to false. |
| force_root_dkim_host | If set to true, the root domain will be the DKIM Host for the domain being created even if the root domain itself is not registered with Mailgun. The domain being created will still need to pass domain verification with valid spf records for the domain and valid DKIM record for the root domain. This does not effect the smtp mail-from host for the domain being created. The mail-from host will remain the domain name being created, not the root domain.|
| wildcard | Determines whether the domain will accept email for sub-domains when sending messages. Default to false. |
| pool_id | Requested IP Pool to be assigned to the domain at creation. |
| ips | An optional, comma-separated list of IP addresses to be assigned to this domain. If not specified, all dedicated IP addresses on the account will be assigned. If the request cannot be fulfilled (e.g. a requested IP is not assigned to the account, etc), a 400 will be returned. |
| spam_action | `disabled`, `block`, or `tag`<br>If `disabled`, no spam filtering will occur for inbound messages.<br>If `block`, inbound spam messages will not be delivered.<br>If `tag`, inbound messages will be tagged with a spam header. [Spam Filter](https://documentation.mailgun.com/en/latest/user_manual.html#um-spam-filter)<br>The default is `disabled`. |
| smtp_password | Password for SMTP authentication |
| use_automatic_sender_security | Enable Automatic Sender Security. This requires setting DNS CNAME entries for DKIM keys instead of a TXT record. Defaults to false. |
| web_prefix | Sets your open, click and unsubscribe URLs domain name prefix. Links rewritten or added by Mailgun in your emails will look like ://./... Default to email |
| web_scheme |Sets your open, click and unsubscribe URLs to use http or https. Value either `http` or `https`. Defaults to http. In order for https to work, you must have a valid cert created for your domain. See Domain Tracking for TLS cert generation. |
Promise returns:
```JS
{
name: 'foobar.example.com',
require_tls: false,
skip_verification: false,
state: 'unverified',
wildcard: true,
spam_action: 'tag',
created_at: 2025-01-08T12:52:29.000Z,
smtp_password: undefined,
smtp_login: new Date('postmaster@foobar.example.com'),
type: 'custom',
receiving_dns_records: [
{
is_active: true,
cached: [],
priority: '10',
record_type: 'MX',
valid: 'unknown',
value: 'dns_record_value'
},
...
],
sending_dns_records: [
{
is_active: false,
cached: [],
name: 'sending_dns_record_name',
record_type: 'CNAME',
valid: 'unknown',
value: 'sending_dns_record_value'
},
...
],
id: '64a4291ebbe4ec7e1d78bc80',
is_disabled: false,
web_prefix: 'test',
web_scheme: 'https',
use_automatic_sender_security: true
}
```
- #### verify
Verify the domains DNS records (includes A, CNAME, SPF, DKIM and MX records) to ensure the domain is ready and able to send
[API Reference](https://documentation.mailgun.com/docs/mailgun/api-reference/send/mailgun/domains/put-v4-domains--name--verify)
`mg.domains.verify(domainAddress)`
Example:
```JS
mg.domains.destroy('foobar.example.com')
.then(data => console.log(data)) // logs response data
.catch(err => console.error(err)); // logs any error
```
Promise returns:
```JS
{
name: 'foobar.example.com',
require_tls: false,
skip_verification: false,
state: 'active',
wildcard: false,
spam_action: 'tag',
created_at: new Date('2017-10-05T14:55:20.000Z'),
smtp_password: undefined,
smtp_login: 'postmaster@foobar.example.com',
type: 'custom',
receiving_dns_records: [
{
is_active: true,
cached: [],
priority: '10',
record_type: 'MX',
valid: 'valid',
value: 'receiving_dns_record_value'
},
...
],
sending_dns_records: [
{
is_active: true,
cached: [],
name: 'foobar.example.com',
record_type: 'CNAME',
valid: 'unknown',
value: 'sending_dns_record_value'
},
...
],
id: '64a5880eere4eg7e1d85bc69',
is_disabled: false,
web_prefix: 'email',
web_scheme: 'https',
use_automatic_sender_security: true
}
```
- #### update
Update domains configuration like smtp credentials, enable/disable automatic sender security, spam actions, wildcard, or tracking web scheme.
[API Reference](https://documentation.mailgun.com/docs/mailgun/api-reference/send/mailgun/domains/put-v4-domains--name-)
`mg.domains.update(domain, options)`
Example:
```js
mg.domains.update('foobar.example.com',{
mailfrom_host: 'mailfrom_host_value',
message_ttl: 20,
smtp_password: 'smtp_password_value'
spam_action: 'tag',
use_automatic_sender_security: true
web_scheme: 'http',
web_prefix: 'web_prefix_value'
wildcard: 'true',
})
.then(data => console.log(data)) // logs response data
.catch(err => console.error(err)); // logs any error
```
Update method accepts data object with next properties:
| Property | Description |
|:--------------|:----------------------------------------------------------------------------------------------------------------------------------------------|
| mailfrom_host | The hostname to update to. Must be in lower case |
| message_ttl | Duration of the message retrieval TTL in seconds |
| smtp_password | Updates the domain's SMTP credentials with the given string |
| spam_action | Can be string with value `disabled`, `block`, or `tag`. If *disabled*, no spam filtering will occur for inbound messages. If `block`, inbound spam messages will not be delivered. If `tag`, inbound messages will be tagged with a spam header. See [Spam Filter](https://documentation.mailgun.com/en/latest/user_manual.html#um-spam-filter).|
| use_automatic_sender_security | enable or disable Automatic Sender Security. If enabled, requires setting DNS CNAME entries for DKIM keys instead of a TXT record. Domain must be reverified after changing this field. Defaults to `false`|
| web_scheme | Can be string with value `http` or `https`. Set your **open**, **click** and **unsubscribe** URLs to use `http` or `https`. The default is `http`|
| web_prefix | Web prefix to be used for tracking. Must be a valid atom. Nothing will be updated if omitted |
| wildcard | Can be string `'true'` or `'false'` or `boolean`. Determines whether the domain will accept email for sub-domains. The default is `false`.|
Promise returns:
```JS
{
name: 'foobar.example.com',
require_tls: false,
skip_verification: false,
state: 'unverified',
wildcard: true,
spam_action: 'disabled',
created_at: new Date('2025-01-08T12:52:29.000Z'),
smtp_password: undefined,
smtp_login: 'postmaster@foobar.example.com',
type: 'custom',
receiving_dns_records: [
{
is_active: true,
cached: [],
priority: '10',
record_type: 'MX',
valid: 'unknown',
value: 'receiving_dns_record_value'
},
...
],
sending_dns_records: [
{
is_active: true,
cached: [],
name: 'foobar.example.com',
record_type: 'TXT',
valid: 'unknown',
value: 'sending_dns_record_value'
},
...
],
id: '64a5880eere4eg7e1d85bc69',
is_disabled: false,
web_prefix: 'test',
web_scheme: 'https',
use_automatic_sender_security: true
}
```
- #### destroy
The domain must not be disabled or used as an authority for an other domain. Sandbox domain can't be deleted.
[API Reference](https://documentation.mailgun.com/docs/mailgun/api-reference/send/mailgun/domains/delete-v3-domains--name-)
`mg.domains.destroy(domainAddress)`
Example:
```JS
mg.domains.destroy('foobar.example.com')
.then(data => console.log(data)) // logs response data
.catch(err => console.error(err)); // logs any error
```
Promise returns message:
```JS
{
message: "Domain will be deleted in the background"
}
```
- #### getTracking
`domains.getTracking` method is deprecated, and will be removed. Please use `domains.domainTracking.getTracking` instead.
- #### updateTracking
`domains.updateTracking` method is deprecated, and will be removed. Please use `domains.domainTracking.updateTracking` instead.
- #### getConnection
***Deprecated, and will be removed in the future releases***
Returns domain's delivery connection settings.
[API Reference](https://mailgun-docs.redoc.ly/docs/mailgun/api-reference/domain/operation/httpapi.(*T).GetDomainConnection-fm-14-0/)
`mg.domains.getConnection(domainAddress)`
Example:
```JS
mg.domains.getConnection(domainAddress)
.then(data => console.log(data)) // logs response data
.catch(err => console.error(err)); // logs any error
```
Promise returns:
```JS
{
require_tls: false,
skip_verification: false
}
```
- #### updateConnection
***Deprecated, and will be removed in the future releases***
Update a domain's TLS connection settings.
[API Reference](https://mailgun-docs.redoc.ly/docs/mailgun/api-reference/domain/operation/httpapi.(*T).UpdateDomainConnection-fm-15-0/)
`mg.domains.updateConnection(domainAddress, data)`
Example:
```JS
mg.domains.updateConnection(domainAddress, {
require_tls: true;
skip_verification: false;
})
.then(data => console.log(data)) // logs response data
.catch(err => console.error(err)); // logs any error
```
Promise returns:
```JS
{
message: 'Domain connection settings have been updated, may take 10 minutes to fully propagate',
require_tls: false,
skip_verification: false
}
```
- #### updateDKIMAuthority
`domains.updateDKIMAuthority` method is deprecated, and will be removed. Please use `domains.domainKeys.updateDKIMAuthority` [instead](#updatedkimauthority-1).
- #### updateDKIMSelector
`domains.updateDKIMSelector` method is deprecated, and will be removed. Please use `domains.domainKeys.updateDKIMSelector` [instead](#updatedkimselector-1).
- #### getIps
***Deprecated, and will be removed in the future releases***
`mg.domains.getIps(domain)`
Example:
```js
mg.domains.getIps('foobar.example.com')
.then(msg => console.log(msg)) // logs response data
.catch(err => console.error(err)); // logs any error
```
Promise returns:
```JS
["192.168.0.1", "192.168.0.2"]
```
- #### assignIp
***Deprecated, and will be removed in the future releases***
`mg.domains.assignIp(domain, ip)`
Example:
```JS
mg.domains.assignIp('foobar.example.com', "192.168.0.3")
.then(msg => console.log(msg)) // logs response data
.catch(err => console.error(err)); // logs any error
```
```JS
{
message: 'success',
status: 200,
}
```
- #### deleteIp
**Deprecated, and will be removed in the future releases**
`mg.domains.deleteIp(domain, ip)`
Example:
```JS
mg.domains.deleteIp('foobar.example.com', "192.168.0.3")
.then(msg => console.log(msg)) // logs response data
.catch(err => console.error(err)); // logs any error
```
```JS
{
message: 'success'
}
```
### Domain templates
- #### list
Returns a list of templates for the domain.
[API Reference](https://documentation.mailgun.com/docs/mailgun/api-reference/send/mailgun/templates/get-v3--domain-name--templates)
`mg.domains.domainTemplates.list('domainId', query)`
Example:
```js
mg.domains.domainTemplates.list('domainId',{
limit: 10
})
.then(domainTemplates => console.log(domainTemplates)) // logs array of domain templates
.catch(err => console.error(err)); // logs any error
```
Query data object may have next properties:
| Property | Description |
|:----------|:------------------------------------------------------|
| limit | Maximum number of records to return. (100 by default) |
| page | params from previous response's 'paging' object. Value must be stringified as query params. e.g. '?page=first','?page=next&p=name-of-last-item'|
Promise returns: object with domain's templates
```JS
{
items: [
{
name: 'template_name',
description: 'template description ',
createdAt: new Date('2021-08-24T22:26:55.000Z'),
createdBy: '',
id: '48d63154-8c8f-4104-ab14-687d01dbf296'
},
...
]
}
```
- #### get
Returns metadata information about the stored template specified in the url. If the active flag is provided, the content of the active version of the template is returned.
[API Reference](https://documentation.mailgun.com/docs/mailgun/api-reference/send/mailgun/templates/get-v3--domain-name--templates--template-name-)
`mg.domains.domainTemplates.get('domainId', 'templateName', query)`
Example:
```js
mg.domains.domainTemplates.get('domainId', 'template_name', {
active: 'yes'
}).then(data => console.log(data)) // logs template
.catch(err => console.error(err)); // logs any error
```
Query data object may have next properties:
| Property | Description |
|:----------|:------------------------------------------------------|
| active | If this flag is set to yes the active version of the template is included in the response. |
Promise returns: object with domain template and active version
```JS
{
name: 'template_name',
description: 'This is the description of the template',
createdAt: new Date('2021-08-24T22:26:55.000Z'),
createdBy: '',
id: '46565d87-68b6-4edb-8b3c-34554af4bb77'
version: {
tag: 'tag',
template: '<html>template content</html>',
engine: 'handlebars',
mjml: '',
createdAt: new Date('2021-08-22T22:26:55.000Z'),
comment: 'Version comment',
active: true,
id: '3efd2b85-0f41-4a1d-9898-05d7e7459c4a',
headers: {
From: 'from value'
}
}
}
```
- #### create
Store a new template, including its name, description and (optionally) the template content.
If the template content is provided, a new version is automatically created and becomes the active version.
[API Reference](https://documentation.mailgun.com/docs/mailgun/api-reference/send/mailgun/templates/post-v3--domain-name--templates)
`mg.domains.domainTemplates.create(domainId, templateData)`
Example:
```js
mg.domains.domainTemplates.create('domainId', {
name: 'template_name',
createdBy: '',
tag: 'tag',
template: '<html>template content</html>',
description: 'template description',
comment: 'Version comment',
headers: JSON.stringify({
From: 'from value'
}),
engine: 'handlebars'
}).then(data => console.log(data)) // logs created template
.catch(err => console.error(err)); // logs any error
```
Template data object may have next properties:
| Property | Description |
|:----------|:------------------------------------------------------|
| name (required) | Name of the template being stored. Supports utf-8 characters and name will be down cased. |
| createdBy | Optional metadata field api user can indicate who created the template. |
| tag | Initial tag of the created version. If the template parameter is provided and the tag is missing, the default value **initial** is used. |
| template | Content of the template. |
| description | Description of the template being stored |
| comment | Version comment. This is valid only if a new version is being created. (template parameter is provided.) |
| headers | Key Value json dictionary of headers to be stored with the template. Where key is the header name and value is the header value. The header names **From**, **Subject**, and **Reply-To** are the only ones currently supported. These headers will be inserted into the mime at the time we attempt delivery.Headers set at the message level will override headers set on the template. e.g. Setting the From header at the time of sending will override the From header saved on the template. Additionally, headers generated by templates are not reflected on the accepted event as they are not prepended to the message until the message is prepped for delivery. if a From header is not provided either in the message or template, we will default to postmaster@your-sending-domain.tld |
| engine | The template engine to be used when rendering the template. Supported value are handlebars and go (golang template). The default if parameter is not provided is handlebars. |
Promise returns: created domain template and active version
```JS
{
name: 'template_name',
description: 'template description',
createdAt: new Date('2025-01-03T12:33:10.000Z'),
createdBy: '',
id: '46565d87-68b6-4edb-8b3c-34554af4bb77',
version: {
tag: 'tag',
template: '<html>template content</html>',
engine: 'handlebars',
mjml: '',
createdAt: new Date('2025-01-03T12:33:10.000Z'),
comment: 'Version comment',
active: true,
id: '3efd2b85-0f41-4a1d-9898-05d7e7459c4a',
headers: { From: 'from value' }
}
}
```
- #### update
Update the description of a template.
[API Reference](https://documentation.mailgun.com/docs/mailgun/api-reference/send/mailgun/templates/put-v3--domain-name--templates--template-name-)
`mg.domains.domainTemplates.update('domainId', 'templateName', data)`
Example:
```js
mg.domains.domainTemplates.update('domainId', 'templateName', {
description: 'new template description',
}).then(data => console.log(data)) // logs data
.catch(err => console.error(err)); // logs any error
```
Data object may have next properties:
| Property | Description |
|:----------|:------------------------------------------------------|
| description | Update description of the template being updated. |
Promise returns:
```JS
{
status: 200,
message: 'template has been updated',
templateName: 'template_name'
}
```
- #### destroy
Delete the template specified in the url. NOTE: This method deletes all versions of the specified template.
[API Reference](https://documentation.mailgun.com/docs/mailgun/api-reference/send/mailgun/templates/delete-v3--domain-name--templates--template-name-)
`mg.domains.domainTemplates.destroy('domainId', 'templateName')`
Example:
```js
mg.domains.domainTemplates.destroy('domainId', 'templateName')
.then(data => console.log(data)) // logs data
.catch(err => console.error(err)); // logs any error
```
Promise returns:
```JS
{
status: 200,
message: 'template has been deleted',
templateName: 'template_name'
}
```
- #### destroyAll
Delete all templates and their versions for the domain.
[API Reference](https://documentation.mailgun.com/docs/mailgun/api-reference/send/mailgun/templates/delete-v3--domain-name--templates)
`mg.domains.domainTemplates.destroyAll('domainId')`
Example:
```js
mg.domains.domainTemplates.destroyAll('domainId')
.then(data => console.log(data)) // logs data
.catch(err => console.error(err)); // logs any error
```
Promise returns:
```JS
{
status: 200,
message: "templates have been deleted"
}
```
- #### listVersions
Returns a paginated list of template versions.
[API Reference](https://documentation.mailgun.com/docs/mailgun/api-reference/send/mailgun/templates/get-v3--domain-name--templates--template-name--versions)
`mg.domains.domainTemplates.listVersions('domainId', 'template_name', queryData)`
Example:
```js
mg.domains.domainTemplates.listVersions('domainId', 'template_name', {
limit: 10,
})
.then(data => console.log(data)) // logs data
.catch(err => console.error(err)); // logs any error
```
Query data object may have next properties:
| Property | Description |
|:----------|:------------------------------------------------------|
| limit | Maximum number of records to return. (100 by default) |
| page | params from previous response's 'paging' object. Value must be stringified as query params. e.g. '?page=first','?page=next&p=name-of-last-item'|
Promise returns:
```JS
{
template: {
name: 'template_name',
description: 'template description',
createdAt: new Date('2025-01-03T12:33:10.000Z'),
createdBy: '',
id: '46565d87-68b6-4edb-8b3c-34554af4bb77',
versions: [
{
tag: 'tag',
engine: 'handlebars',
mjml: '',
createdAt: new Date('2025-01-03T12:33:10.000Z'),
comment: 'Version comment',
active: true,
id: 'b3f09533-a03f-4e10-9aac-a91115297b6c'
}
]
}
}
```
- #### getVersion
Retrieve the information and content of the specified version of a template.
[API Reference](https://documentation.mailgun.com/docs/mailgun/api-reference/send/mailgun/templates/get-v3--domain-name--templates--template-name--versions--version-name-)
`mg.domains.domainTemplates.getVersion('domainId', 'template_name', 'tag')`
Example:
```js
mg.domains.domainTemplates.getVersion('domainId', 'template_name','tag')
.then(data => console.log(data)) // logs data
.catch(err => console.error(err)); // logs any error
```
Promise returns:
```JS
{
template: {
name: 'template_name',
description: 'template description',
createdAt: new Date('2025-01-03T12:33:10.000Z'),
createdBy: '',
id: '46565d87-68b6-4edb-8b3c-34554af4bb77',
versions: [
{
tag: 'tag',
template: '<html>template content</html>',
engine: 'handlebars',
mjml: '',
createdAt: new Date('2025-01-03T12:33:10.000Z'),
comment: 'Version comment',
active: true,
id: 'b3f09533-a03f-4e10-9aac-a91115297b6c',
headers: {
From: 'from value'
}
}
]
}
}
```
- #### createVersion
Adds a new template version. If the template doesn’t contain any other versions, the first version becomes active. A template can store up to 40 versions.
[API Reference](https://documentation.mailgun.com/docs/mailgun/api-reference/send/mailgun/templates/post-v3--domain-name--templates--template-name--versions)
`mg.domains.domainTemplates.createVersion('domainId', 'template_name', versionData)`
Example:
```js
mg.domains.domainTemplates.createVersion('domainId', 'template_name',{
{
template: `<html>template content</html>`,
tag: 'v1',
engine: 'handlebars',
comment: 'comment',
active: 'yes',
headers: JSON.stringify({
From: 'from value'
})
}
})
.then(data => console.log(data)) // logs data
.catch(err => console.error(err)); // logs any error
```
Template version data object may have next properties:
| Property | Description |
|:----------|:------------------------------------------------------|
| template | Content of the template. |
| tag | Initial tag of the created version. If the template parameter is provided and the tag is missing, the default value **initial** is used. |
| engine | The template engine to be used when rendering the template. Supported value are handlebars and go (golang template). The default if parameter is not provided is handlebars. |
| comment | Version comment. This is valid only if a new version is being created. (template parameter is provided.) |
| active | If this flag is set to yes, this version becomes active. |
| headers | Key Value json dictionary of headers to be stored with the template. Where key is the header name and value is the header value. The header names **From**, **Subject**, and **Reply-To** are the only ones currently supported. These headers will be inserted into the mime at the time we attempt delivery.Headers set at the message level will override headers set on the template. e.g. Setting the From header at the time of sending will override the From header saved on the template. Additionally, headers generated by templates are not reflected on the accepted event as they are not prepended to the message until the message is prepped for delivery. if a From header is not provided either in the message or template, we will default to postmaster@your-sending-domain.tld |
Promise returns:
```JS
{
status: 200,
message: 'new version of the template has been stored',
template: l {
name: 'template_name',
description: 'new template description',
createdAt: new Date('2025-01-03T12:33:10.000Z'),
createdBy: '',
id: '46565d87-68b6-4edb-8b3c-34554af4bb77',
version: {
tag: 'v1',
template: '<html>template content</html>',
engine: 'handlebars',
mjml: '',
createdAt: new Date('2025-01-03T13:41:26.000Z'),
comment: 'comment',
active: true,
id: '3efd2b85-0f41-4a1d-9898-05d7e7459c4a',
headers: [Object]
}
}
}
```
- #### updateVersion
Update information or content of the specific template version.
Existing fields not included in the request will not be changed
[API Reference](https://documentation.mailgun.com/docs/mailgun/api-reference/send/mailgun/templates/put-v3--domain-name--templates--template-name--versions--version-name-)
`mg.domains.domainTemplates.updateVersion('domainId', 'template_name', 'tag' , versionData)`
Example:
```js
mg.domains.domainTemplates.updateVersion('domainId', 'template_name', 'v1',{
{
template: `<html>template content</html>`,
engine: 'handlebars',
comment: 'comment',
active: 'yes',
headers: JSON.stringify({
From: 'from value'
})
}
})
.then(data => console.log(data)) // logs data
.catch(err => console.error(err)); // logs any error
```
Template version data object may have next properties:
| Property | Description |
|:----------|:------------------------------------------------------|
| template | Content of the template. |
| engine | The template engine to be used when rendering the template. Supported value are handlebars and go (golang template). The default if parameter is not provided is handlebars. |
| comment | Version comment. This is valid only if a new version is being created. (template parameter is provided.) |
| active | If this flag is set to yes, this version becomes active. |
| headers | Key Value json dictionary of headers to be stored with the template. Where key is the header name and value is the header value. The header names **From**, **Subject**, and **Reply-To** are the only ones currently supported. These headers will be inserted into the mime at the time we attempt delivery.Headers set at the message level will override headers set on the template. e.g. Setting the From header at the time of sending will override the From header saved on the template. Additionally, headers generated by templates are not reflected on the accepted event as they are not prepended to the message until the message is prepped for delivery. if a From header is not provided either in the message or template, we will default to postmaster@your-sending-domain.tld |
Promise returns:
```JS
{
status: 200,
message: 'version has been updated',
templateName: 'template_name',
templateVersion: {
tag: 'v1'
}
}
```
- #### destroyVersion
Delete a specific template version.
[API Reference](https://documentation.mailgun.com/docs/mailgun/api-reference/send/mailgun/templates/delete-v3--domain-name--templates--template-name--versions--version-name-)
`mg.domains.domainTemplates.destroyVersion(domainId, templateName, tag)`
Example:
```js
mg.domains.domainTemplates.destroyVersion('domainId', 'template_name', 'v1')
.then(data => console.log(data)) // logs data
.catch(err => console.error(err)); // logs any error
```
Promise returns:
```JS
{
status: 200,
message: 'version has been deleted',
templateName: 'template_name',
templateVersion: {
tag:'v1'
}
}
```
### Domain tracking
- #### getTracking
Mailgun offers tracking for clicks, unsubscribes, and opens, with optional HTTPS protocol support on tracking URLs. To enable HTTPS, Mailgun uses Let’s Encrypt with HTTP-01 challenges through your existing tracking CNAME record to issue a TLS certificate. This setup also includes support for HTTP Strict Transport Security (HSTS) for enhanced security.
[API Reference](https://documentation.mailgun.com/docs/mailgun/api-reference/send/mailgun/domain-tracking/get-v3-domains--name--tracking)
`mg.domains.domainTracking.getTracking(domainAddress)`
Example:
```JS
mg.domains.domainTracking.getTracking('foobar.example.com')
.then(msg => console.log(msg)) // logs response data
.catch(err => console.error(err)); // logs any error
```
Promise returns:
```JS
{
"click": {
"active": false
},
"open": {
"active": false
},
"unsubscribe": {
"active": false,
"html_footer": "\n<br>\n<p><a href=\"%unsubscribe_url%\">unsubscribe</a></p>\n",
"text_footer": "\n\nTo unsubscribe click: <%unsubscribe_url%>\n\n"
}
}
```
- #### updateTracking
A common method to turn on/off the click, open, and unsubscribe tracking at the domain level.
`mg.domains.domainTracking.updateTracking(domain, trackingType, data)`
- Open Tracking Example:
[API Reference](https://documentation.mailgun.com/docs/mailgun/api-reference/send/mailgun/domain-tracking/put-v3-domains--name--tracking-open)
```js
mg.domains.domainTracking.updateTracking('foobar.example.com', 'open', {
active: true,
place_at_the_top: true,
})
.then(msg => console.log(msg)) // logs response data
.catch(err => console.error(err)); // logs any error
```
Open tracking data object properties:
| Property | Description |
|:----------|:-------------------------------------------|
| active | Boolean, enables or disables open tracking |
| place_at_the_top| Setting this param to true will place the open tracking pixel at the top of the HTML body when inserted into the email mime. Omit this param to keep current setting. |
Promise returns:
```JS
{
message: 'Tracking settings have been updated',
open: {
active: true,
place_at_the_top: true,
}
}
```
- Click Tracking Example:
[API Reference](https://documentation.mailgun.com/docs/mailgun/api-reference/send/mailgun/domain-tracking/put-v3-domains--name--tracking-click)
```JS
mg.domains.domainTracking.updateTracking('foobar.example.com', 'click', {active: true})
.then(msg => console.log(msg)) // logs response data
.catch(err => console.error(err)); // logs any error
```
Click tracking data object properties:
| Property | Description |
|:----------|:--------------------------------------------|
| active | Boolean, enables or disables click tracking |
Promise returns:
```JS
{
message: 'Tracking settings have been updated',
click: {
active: true
}
}
```
- Unsubscribe Tracking Example
[API Reference](https://documentation.mailgun.com/docs/mailgun/api-reference/send/mailgun/domain-tracking/put-v3-domains--name--tracking-unsubscribe)
```js
mg.domains.domainTracking.updateTracking('foobar.example.com', 'unsubscribe', {
active: true,
html_footer: "\n<br>\n<p><a href=\"%unsubscribe_url%\">unsubscribe</a></p>\n",
text_footer: "\n\nTo unsubscribe click: <%unsubscribe_url%>\n\n"
})
.then(msg => console.log(msg)) // logs response data
.catch(err => console.error(err)); // logs any error
```
Unsubscribe Tracking data object properties:
| Property | Description |
|:------------|:--------------------------------------------------------------|
| active | Boolean, enables or disables unsubscribe tracking |
| html_footer | string appended to html emails for managing unsubscribe links |
| text_footer | string appended to html emails for managing unsubscribe links |
Promise returns:
```JS
{
message: 'Tracking settings have been updated',
unsubscribe: {
active: true,
html_footer: '\n<br>\n<p><a href=\'%unsubscribe_url%\">unsubscribe</a></p>\n',
text_footer: '\n\nTo unsubscribe click: <%unsubscribe_url%>\n\n'
}
}
```
- #### get
Get x509 TLS certificate and status
[API Reference](https://documentation.mailgun.com/docs/mailgun/api-reference/send/mailgun/domain-tracking/get-v2-x509--domain--status)
`mg.domains.domainTracking.get(domainAddress)`
Example:
```JS
mg.domains.domainTracking.get('foobar.example.com')
.then(msg => console.log(msg)) // logs response data
.catch(err => console.error(err)); // logs any error
```
Promise returns:
```JS
{
responseStatusCode: 200,
status: 'expired',
error: 'x509 certificate has expired',
certificate: '{CERT}';
}
```
- #### generate
Initiates generation of a TLS certificate for the tracking domain in a background task. Once generation is enqueued, you may poll the status endpoint in location field to check for success. Domain address must be formatted as `webPrefix.domainName` from domains settings
[API Reference](https://documentation.mailgun.com/docs/mailgun/api-reference/send/mailgun/domain-tracking/post-v2-x509--domain-)
`mg.domains.domainTracking.generate(domainAddress)`
Example:
```JS
mg.domains.domainTracking.generate('email.foobar.example.com')
.then(msg => console.log(msg)) // logs response data
.catch(err => console.error(err)); // logs any error
```
Promise returns:
```JS
{
message: 'Initiated x509 key pair generation',
location: '/v2/x509/example.com/status',
status: 202,
}
```
- #### regenerate
Initiates regeneration of an expired TLS certificate for the tracking domain in a background task. Once generation is enqueued, you may poll status endpoint in location field to check for success. This will not regenerate an existing certificate that is still valid. Domain address must be formatted as `webPrefix.domainName` from domains settings
[API Reference](https://documentation.mailgun.com/docs/mailgun/api-reference/send/mailgun/domain-tracking/put-v2-x509--domain-)
`mg.domains.domainTracking.regenerate(domainAddress)`
Example:
```JS
mg.domains.domainTracking.regenerate('email.foobar.example.com')
.then(msg => console.log(msg)) // logs response data
.catch(err => console.error(err)); // logs any error
```
Promise returns:
```JS
{
message: 'Initiated x509 key pair generation',
location: '/v2/x509/example.com/status',
status: 202,
}
```
### Domain Keys
- #### list
List all domain keys for your domain, including active/inactive and valid/invalid ones.
`mg.domains.domainKeys.list(domainAddress, data)`
[API Reference](https://documentation.mailgun.com/docs/mailgun/api-reference/send/mailgun/domain-keys/get-v4-domains--authority-name--keys)
Example:
```JS
mg.domains.domainKeys.list(domainAddress)
.then(data => console.log(data)) // logs response data
.catch(err => console.error(err)); // logs any error
```
Promise returns:
```JS
{
items: [
{
signing_domain: 'authority.domain.tld',
selector: 's1',
dns_record: {
is_active: true,
cached: [],
name: 's1._domainkey.authority.domain.tld',
record_type: 'TXT',
valid: 'unknown',
value: 'expected dns value'
}
},
],
status: 200
}
```
- #### listAll
List domain keys, and optionally filter by signing domain or selector. The page & limit data is only required when paging through the data.
`mg.domains.domainKeys.listAll(filterData)`
[API Reference](https://documentation.mailgun.com/docs/mailgun/api-reference/send/mailgun/domain-keys/get-v1-dkim-keys)
Example:
```JS
mg.domains.domainKeys.listAll(
{
signingDomain: 'authority.domain.tld', // optional
selector: 's1', // optional
}
)
.then(data => console.log(data)) // logs response data
.catch(err => console.error(err)); // logs any error
```
Promise returns:
```JS
{
items: [
{
signing_domain: 'authority.domain.tld',
selector: 's1',
dns_record: {
is_active: true,
cached: [],
name: 's1._domainkey.authority.domain.tld',
record_type: 'TXT',
valid: 'unknown',
value: 'expected dns value'
}
},
],
status: 200
}
```
- #### create
Create a domain key.
*Note that once private keys are created or imported they are never exported. Alternatively, you can import an existing PEM file containing a RSA private key in PKCS #1, ASn.1 DER format. Note, the pem can be passed as a file attachment or as a form-string parameter.*
`mg.domains.domainKeys.create(newKeyData)`
[API Reference](https://documentation.mailgun.com/docs/mailgun/api-reference/send/mailgun/domain-keys/post-v1-dkim-keys)
Example:
```JS
mg.domains.domainKeys.create(
{
signingDomain: 'authority.domain.tld',
selector: 's1',
bits: '2048' // optional
}
)
.then(data => console.log(data)) // logs response data
.catch(err => console.error(err)); // logs any error
```
Promise returns:
```JS
{
signing_domain: 'authority.domain.tld',
selector: 's1',
dns_record: {
is_active: true,
cached: [],
name: 's1._domainkey.authority.domain.tld',
record_type: 'TXT',
valid: 'unknown',
value: 'expected dns value'
},
status: 200
}
```
- #### activate
Activate a key to be used to DKIM sign emails with.
*Note: dns records must be valid for a domain key to be activated*
`mg.domains.domainKeys.activate(domainAddress, selector)`
[API Reference](https://documentation.mailgun.com/docs/mailgun/api-reference/send/mailgun/domain-keys/put-v4-domains--authority-name--keys--selector--activate)
Example:
```JS
mg.domains.domainKeys.activate('authority.domain.tld', 's1')
.then(data => console.log(data)) // logs response data
.catch(err => console.error(err)); // logs any error
```
Promise returns:
```JS
{
message: 'domain key activated',
authority: 'authority.domain.tld',
selector: 's1',
active: true,
status: 200,
}
```
- #### deactivate
Deactivating for a specified authority and/or selector means a key won't be used for signing email anymore, even if they are valid.
`mg.domains.domainKeys.deactivate(domainAddress, selector)`
[API Reference](https://documentation.mailgun.com/docs/mailgun/api-reference/send/mailgun/domain-keys/put-v4-domains--authority-name--keys--selector--deactivate)
Example:
```JS
mg.domains.domainKeys.deactivate('authority.domain.tld', 's1')
.then(data => console.log(data)) // logs response data
.catch(err => console.error(err)); // logs any error
```
Promise returns:
```JS
{
message: 'domain key deactivated',
authority: 'authority.domain.tld',
selector: 's1',
active: true,
status: 200,
}
```
- #### destroy
Delete a key.
**Domain keys are not recoverable after deletion so use with care**
`mg.domains.domainKeys.destroy(domainAddress, selector)`
[API Reference](https://documentation.mailgun.com/docs/mailgun/api-reference/send/mailgun/domain-keys/delete-v1-dkim-keys)
Example:
```JS
mg.domains.domainKeys.destroy('authority.domain.tld', 's1')
.then(data => console.log(data)) // logs response data
.catch(err => console.error(err)); // logs any error
```
Promise returns:
```JS
{
message: 'success'
}
```
- #### updateDKIMAuthority
You can delegate the domain authority to an other domain. Domain's authority is set to itself by default.
[API Reference](https://documentation.mailgun.com/docs/mailgun/api-reference/send/mailgun/domain-keys/put-v3-domains--name--dkim-authority)
`mg.domains.domainKeys.updateDKIMAuthority(domainAddress, data)`
Example:
```JS
mg.domains.domainKeys.updateDKIMAuthority(domainAddress, {
self: true
})
.then(data => console.log(data)) // logs response data
.catch(err => console.error(err)); // logs any error
```
Data object accepts next properties:
| Property | Description |
|:--------------|:----------------------------------------------------------------------------------------------------------------------------------------------|
| self | Change the DKIM authority for a domain. If set to true, the domain will be the DKIM authority for itself even if the root domain is registered on the same mailgun account If set to false, the domain will have the same DKIM authority as the root domain registered on the same mailgun account |
Promise returns:
```JS
{
message: 'Domain DKIM authority has been changed',
sending_dns_records: [
{
is_active: true,
cached: [],
name: 'sending_dns_record_name',
record_type: 'TXT',
valid: 'unknown',
value: 'sending_dns_record_value'
},
...
],
changed: true
}
```
- #### updateDKIMSelector
Selector is the unique identifier of your key. It has to be different from other keys selector.
[API Reference](https://documentation.mailgun.com/docs/mailgun/api-reference/send/mailgun/domain-keys/put-v3-domains--name--dkim-selector)
`mg.domains.domainKeys.updateDKIMSelector(domainAddress, data)`
Example:
```JS
mg.domains.domainKeys.updateDKIMSelector(domainAddress, {
dkimSelector: 'dkimSelector_value'
})
.then(data => console.log(data)) // logs response data
.catch(err => console.error(err)); // logs any error
```
Data object accepts next properties:
| Property | Description |
|:--------------|:----------------------------------------------------------------------------------------------------------------------------------------------|
| dkimSelector | Selector is the unique identifier of your key. It has to be different from other keys selector. |
Promise returns:
```JS
{
message: 'DKIM selector changed',
status: 200
}
```
### Events
- #### get
***Deprecated, and will be removed in the future releases. Use [Logs](#logs) instead**
[API Reference](https://documentation.mailgun.com/docs/mailgun/api-reference/send/mailgun/events)
`mg.events.get(domain, data)`
Example:
```js
mg.events.get('foobar.example.com', {
page: 'mypageid',
event: 'opened'
}).then(data => console.log(data.items)) // logs array of event objects
.catch(err => console.error(err)); // logs any error
```
Options:
| Parameter | Description |
|:----------|:--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| page | Fetches the specified page of log records, assuming that the URL was returned by the previous request |
| begin | The beginning of the search time range. It can be specified as a string (see Date Format) or linux epoch seconds. Refer to Time Range for details. |
| end | The end of the search time range. It can be specified as a string (see Date Format) or linux epoch seconds. Refer to Time Range for details. |
| ascending | Defines the direction of the search time range if the range end time is not specified. Can be either yes or no. Refer to Time Range for details. |
| limit | Number of entries to return. (300 max) |
| **field** | **field** is the name of the *[Filter Field](https://mailgun-docs.redoc.ly/docs/mailgun/user-manual/events/#filter-field)*. The value of the parameter should be a valid Filter Expression. Several field filters can be specified in one request. If the same field is mentioned, more then once, then all its filter expressions are combined with AND operator. |
- #### Example with Date and *Filter field*
```js
const date = new Date(2023, 7, 2, 0, 0, 0, 0); // Wed Aug 02 2023 00:00:00 GMT+0300
const events = await mg.events.get('foobar.example.com', {
begin: date.toUTCString(), // 'Tue, 01 Aug 2023 21:00:00 GMT'
ascending: 'yes',
limit: 5,
event: 'delivered'
});
```
Promise returns: items (array of event objects), pages (paging keys grouped by id)
```JS
{
items: [{
type: 'accepted',
summary: 'got it',
content: { more: 'data' },
timestamp: Wed Nov 19 2014 10:32:57 GMT-0800 (PST) },
}],
pages: {
first: { id: 'first', number: 'W3siYSI6IGZhbHNlLC', url: 'apiurl' },
last: { id: 'last', number: 'W3siYSI6IGZhbHNlLC', url: 'apiurl' },
next: { id: 'next', number: W3siYSI6IGZhbHNlLC'', url: 'apiurl' },
previous: { id: 'previous', number: 'W3siYSI6IGZhbHNlLC', url: 'apiurl' }
}
}
```
### Logs
Mailgun keeps track of every inbound and outbound message event and stores this log data. This data can be queried and filtered to provide insights into the health of your email infrastructure.
- #### list
Gets customer event logs for an account
[API Reference](https://documentation.mailgun.com/docs/mailgun/api-reference/send/mailgun/stats)
```mg.logs.list(query)```
Example:
```JS
mg.logs.list({
start: new Date('2025-11-17T13:00:00Z'), // required
end: new Date('2025-11-30T13:05:00Z'), // required
include_totals: true,
events: ['accepted'], // opened, delivered, etc.
include_subaccounts: false,
pagination: {
token: 'page token from response',
limit: 5,
sort: 'timestamp:asc'
},
filter: {
AND: [
{
attribute: 'domain',
comparator: '=',
values: [
{
label: 'example.com',
value: 'example.com'
}
]
}
]
}
}).then(data => console.log(data)) // logs response
.catch(err => console.error(err)); // logs any error
```
Promise returns:
```JS
{
start: new Date('2025-11-17T13:00:00.000Z'),
end: new Date('2025-11-30T13:05:00.000Z'),
status: 200,
pagination: {
next: 'page token for next page',
last: 'page token for last page'
},
items: [
{
id: 'JDhSWf9mT5OFxCkZfpDU5d',
event: 'accepted',
'@timestamp': new Date('2024-07-08T16:30:18.530Z'),
account: {
id: '12345'
},
delivery-status: {
message: 'Turret client: server connection failed',
'attempt-no': 5,
code: 680,
'session-seconds': 15.026,
'retry-seconds': 145
},
domain: {
name: 'example.com'
},
recipient: 'example@gmail.com',
'recipient-domain': 'gmail.com',
'recipient-provider': 'Gmail',
envelope: {
sender: 'bob@example.com',
transport: 'smtp',
'sending-ip': '198.52.100.1',
targets: 'bob@example.com'
}
},
...
],
aggregates: {}
}
```
### Stats
***Deprecated, and will be removed in the future releases***
[API Reference](https://documentation.mailgun.com/docs/mailgun/api-reference/send/mailgun/stats)
- #### Stats Options
| Parameter | Description |
|:-----------|:---------------------------------------------------------------------------------------------------------------------------|
| event | The type of the event. For a complete list of all events written to the log see the `Event Types` table below. (Required) |
| start | The starting time. Should be in :rfc:`2822#page-14` or unix epoch format. Default: 7 days from the current time. |
| end | The ending date. Should be in :rfc:`2822#page-14` or unix epoch format. Default: current time. |
| resolution | Can be either ``hour``, ``day`` or ``month``. Default: ``day`` |
| duration | Period of time with resolution encoded. If provided, overwrites the start date. See list below. |
Duration is a string that represents a period of time with some resolution. It has a format `[0-9]+[m,d,h]` where
- `h` - an hour
- `d` - a day
- `m` - a month
Examples:
- `24h` - a period of 24 hours (a day) with hourly resolution
- `1d` - a period of 1 day with daily resolution
- `2m` - a period of 2 months with monthly resolution
Event Types
| Event Type | Description |
|:-------------|:----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| accepted | Mailgun accepted the request to send/forward the email and the message has been placed in queue. |
| delivered | Mailgun sent the email and it was accepted by the recipient email server. |
| failed | Mailgun could not deliver the email to the recipient email server. |
| opened | The email recipient opened the email and enabled image viewing. Open tracking must be enabled in the Mailgun control panel, and the CNAME record must be pointing to mailgun.org. |
| clicked | The email recipient clicked on a link in the email. Click tracking must be enabled in the Mailgun control panel, and the CNAME record must be pointing to mailgun.org. |
| unsubscribed | The email recipient clicked on the unsubscribe link. Unsubscribe tracking must be enabled in the Mailgun control panel. |
| complained | The email recipient clicked on the spam complaint button within their email client. Feedback loops enable the notification to be received by Mailgun. |
| stored | Mailgun has stored an incoming message
- #### getDomain
[API Reference](https://mailgun-docs.redoc.ly/docs/mailgun/api-reference/openapi-final/tag/Stats/#tag/Stats/operation/GET-v3--domain--stats-total)
`mg.stats.getDomain(domain, query)`
Example:
```js
mg.stats.getDomain('foobar.example.com', {event: ['delivered', 'accepted', 'failed', 'complained']})
.then(msg => console.log(msg)) // logs response data
.catch(err => console.error(err)); // logs any error
```
Promise returns:
```JS
{
start: Sun Mar 15 2015 17:00:00 GMT-0700 (PDT),
end: Sun Mar 22 2015 17:00:00 GMT-0700 (PDT),
resolution: 'day',
stats: [{
time: Sun Mar 15 2015 17:00:00 GMT-0700 (PDT),
delivered: { smtp: 2, http: 1, total: 3 }
}]
}
```
- #### getAccount
[API Reference](https://mailgun-docs.redoc.ly/docs/mailgun/api-reference/openapi-final/tag/Stats/#tag/Stats/operation/GET-v3-stats-total)
`mg.stats.getDomain(domain, query)`
Example:
```js
mg.stats.getDomain('foobar.example.com', {event: ['delivered', 'accepted', 'failed', 'complained']})
.then(msg => console.log(msg)) // logs response data
.catch(err => console.error(err)); // logs any error
```
Promise returns:
```JS
{
start: Sun Mar 15 2015 17:00:00 GMT-0700 (PDT),
end: Sun Mar 22 2015 17:00:00 GMT-0700 (PDT),
resolution: 'day',
stats: [{
time: Sun Mar 15 2015 17:00:00 GMT-0700 (PDT),
delivered: { smtp: 2, http: 1, total: 3 }
}]
}
```
```
### Metrics
Mailgun collects many different events and generates event metrics which are available in your Control Panel. This data is also available via our analytics metrics [API Reference](https://documentation.mailgun.com/docs/mailgun/api-reference/send/mailgun/metrics).
- #### getAccount
Gets filtered metrics for an account
[API Reference](https://documentation.mailgun.com/docs/mailgun/api-reference/send/mailgun/metrics/post-v1-analytics-metrics)
`mg.metrics.getAccount(MetricsQuery);`
Example:
```JS
mg.metrics.getAccount({
start: '2024-12-16T10:47:51.661Z',
end: '2024-12-23T10:47:51.661Z',
resolution: 'hour',
metrics: ['opened_count'],
filter: {
AND: [{
attribute: 'domain',
comparator: 'contains',
values: [{
value: 'mailgun'
}]
}]
},
include_subaccounts: true,
include_aggregates: true
})
.then(data => console.log(data)) // logs response data
.catch(err => console.error(err)); //logs any error
```
*getAccount* method accepts data object with next properties:
| Property | Type |Description |
|:--------------|:-----|:-----------------------------------------------------------------------------------------------------------------------------------|
| start | String that contains date in RFC 2822 format: https://datatracker.ietf.org/doc/html/rfc2822.html#page-14 or JS Date object | A start date (default: 7 days before current time)|
| end | String that contains date in RFC 2822 format: https://datatracker.ietf.org/doc/html/rfc2822.html#page-14 or JS Date object | An end date (default: current time)|
| resolution | String | A resolution in the format of 'day' 'hour' 'month'. Default is day.|
| duration | String | A duration in the format of '1d' '2h' '2m'. If duration is provided then it is calculated from the end date and overwrites the start date.|
| dimensions | Array of strings | Attributes of the metric data such as 'subaccount'.|
| metrics | Array of strings | Name of the metrics to receive the stats for such as 'processed_count'.|
| filter | object | Filters to apply to the query. The 'AND' property is required and should contains array of filters objects. See this [document](https://documentation.mailgun.com/docs/mailgun/api-reference/send/mailgun/metrics/post-v1-analytics-metrics#metrics/post-v1-analytics-metrics/t=request&path=filter) for an object shape. |
| include_subaccounts | Boolean | Include stats from all subaccounts. |
| include_aggregates | Boolean | Include top-level aggregate metrics.|
Promise returns: MetricsResult
```JS
{
start: new Date('2024-12-16T01:00:00.000Z'),
end: new Date('2024-12-23T00:00:00.000Z'),
resolution: 'hour',
dimensions: [ 'time' ],
pagination: { sort: '', skip: 0, limit: 1500, total: 1 },
items: [
{
dimensions: [{
{
dimension: 'time',
value: 'Sat, 21 Dec 2024 17:00:00 +0000',
display_value: 'Sat, 21 Dec 2024 17:00:00 +0000'
}
}],
metrics: { opened_count: 1 }
},
...
],
aggregates: { metrics: { opened_count: 1 } },
status: 200
}
```
- #### getAccountUsage
Gets filtered **usage metrics** for an account
[API Reference](https://documentation.mailgun.com/docs/mailgun/api-reference/send/mailgun/metrics/post-v1-analytics-usage-metrics)
`mg.metrics.getAccountUsage(MetricsQuery);`
Example:
```JS
mg.metrics.getAccountUsage({
start: '2024-12-16T10:47:51.661Z',
end: '2024-12-23T10:47:51.661Z',
resolution: 'hour',
metrics: ['opened_count'],
filter: {
AND: [{
attribute: 'domain',
comparator: 'contains',
values: [{
value: 'mailgun'
}]
}]
},
include_subaccounts: true,
include_aggregates: true
})
.then(data => console.log(data)) // logs response data
.catch(err => console.error(err)); //logs any error
```
*getAccountUsage* method accepts data object with next properties:
| Property | Type |Description |
|:--------------|:-----|:-----------------------------------------------------------------------------------------------------------------------------------|
| start | String that contains date in RFC 2822 format: https://datatracker.ietf.org/doc/html/rfc2822.html#page-14 or JS Date object | A start date (default: 7 days before current time)|
| end | String that contains date in RFC 2822 format: https://datatracker.ietf.org/doc/html/rfc2822.html#page-14 or JS Date object | An end date (default: current time)|
| resolution | String | A resolution in the format of 'day' 'hour' 'month'. Default is day.|
| duration | String | A duration in the format of '1d' '2h' '2m'. If duration is provided then it is calculated from the end date and overwrites the start date.|
| dimensions | Array of strings | Attributes of the metric data such as 'subaccount'.|
| metrics | Array of strings | Name of the metrics to receive the stats for such as 'processed_count'.|
| filter | object | Filters to apply to the query. The 'AND' property is required and should contains array of filters objects. See this [document](https://documentation.mailgun.com/docs/mailgun/api-reference/send/mailgun/metrics/post-v1-analytics-metrics#metrics/post-v1-analytics-metrics/t=request&path=filter) for an object shape. |
| include_subaccounts | Boolean | Include stats from all subaccounts. |
| include_aggregates | Boolean | Include top-level aggregate metrics.|
Promise returns: MetricsResult
```JS
{
start: new Date('2024-12-16T01:00:00.000Z'),
end: new Date('2024-12-23T00:00:00.000Z'),
resolution: 'hour',
dimensions: [ 'time' ],
pagination: { sort: '', skip: 0, limit: 1500, total: 1 },
items: [
{
dimensions: [{
{
dimension: 'time',
value: 'Sat, 21 Dec 2024 17:00:00 +0000',
display_value: 'Sat, 21 Dec 2024 17:00:00 +0000'
}
}],
metrics: { opened_count: 1 }
},
...
],
aggregates: { metrics: { opened_count: 1 } },
status: 200
}
```
### Suppressions
- #### list
`mg.suppressions.list(domain, suppressionType, query?)`
- #### Bounces Example:
[API Reference](https://documentation.mailgun.com/docs/mailgun/api-reference/send/mailgun/bounces/get-v3--domainid--bounces)
```js
mg.suppressions.list('foobar.example.com', 'bounces')
.then(msg => console.log(msg)) // logs response data
.catch(err => console.error(err)); // logs any error
```
- #### Unsubscribes Example:
[API Reference](https://documentation.mailgun.com/docs/mailgun/api-reference/send/mailgun/unsubscribe/get-v3--domainid--unsubscribes)
```js
mg.suppressions.list('foobar.example.com', 'unsubscribes')
.then(msg => console.log(msg)) // logs response data
.catch(err => console.error(err)); // logs any error
```
- #### Complaints Example:
[API Reference](https://documentation.mailgun.com/docs/mailgun/api-reference/send/mailgun/complaints/get-v3--domainid--complaints)
```js
mg.suppressions.list('foobar.example.com', 'complaints')
.then(msg => console.log(msg)) // logs response data
.catch(err => console.error(err)); // logs any error
```
Promise returns:
```JS
{
items: [
{
type: "bounces",
address: "unknown@unknown.com",
code: 550,
error: "No such mailbox",
created_at: Fri Oct 21 2011 04:02:55 GMT-0700 (PDT)
}],
pages: {
first: { id: "first", page: "", address: "", url: "apiurl" },
last: { id: "last", page: "", address: "", url: "apiurl" },
next: { id: "next", page: "", address: "", url: "apiurl" },
previous: { id: "prev", page: "", address: "", url: "apiurl" }
}
}
```
- #### get
`mg.suppressions.get(domain, suppressionType, address)`
- #### Bounces Example:
[API Reference](https://documentation.mailgun.com/docs/mailgun/api-reference/send/mailgun/bounces/get-v3--domainid--bounces--address-)
```js
mg.suppressions.get('foobar.example.com', 'bounces', 'address@example.com')
.then(msg => console.log(msg)) // logs response data
.catch(err => console.error(err)); // logs any error
```
- #### Unsubscribes Example:
[API Reference](https://documentation.mailgun.com/docs/mailgun/api-reference/send/mailgun/unsubscribe/get-v3--domainid--unsubscribes--address-)
```js
mg.suppressions.get('foobar.example.com', 'unsubscribes', 'address@example.com')
.then(msg => console.log(msg)) // logs response data
.catch(err => console.error(err)); // logs any error
```
- #### Complaints Example:
[API Reference](https://documentation.mailgun.com/docs/mailgun/api-reference/send/mailgun/complaints/get-v3--domainid--complaints--address-)
```js
mg.suppressions.get('foobar.example.com', 'complaints', 'address@example.com')
.then(msg => console.log(msg)) // logs response data
.catch(err => console.error(err)); // logs any error
```
Response example:
```JS
{
type: "bounces",
address: "address?@unknown.com",
tags: [ "*" ],
created_at: Fri Oct 21 2011 05:02:55 GMT-0700 (PDT)
}
```
- #### create
`mg.suppressions.create(domain, suppressionType, data || data[])`
- #### Bounces Example:
[API Reference](https://documentation.mailgun.com/docs/mailgun/api-reference/send/mailgun/bounces/post-v3--domainid--bounces)
```JS
mg.suppressions.create('foobar.example.com', 'bounces', [{address: 'bob@example.com'}])
.then(msg => console.log(msg)) // logs response data
.catch(err => console.error(err)); // logs any error
```
Bounces Options: Contains an array with the following object properties
| Parameter | Description |
|:-----------|:--------------------------------------------------------------------------------|
| address | Valid email address |
| code | Error code (optional, default: 550) |
| error | Error description (optional, default: empty string) |
| created_at | Timestamp of a bounce event in RFC2822 format (optional, default: current time) |
Promise returns:
```js
{
message: "1 address has been added to the bounces table"
}
```
- #### Unsubscribes Example:
[API Reference](https://documentation.mailgun.com/docs/mailgun/api-reference/send/mailgun/unsubscribe/post-v3--domainid--unsubscribes)
```js
mg.suppressions.create('foobar.example.com', 'unsubscribes', {address: 'bob@example.com'})
.then(msg => console.log(msg)) // logs response data
.catch(err => console.error(err)); // logs any error
```
Unsubscribes Options: Contains an array with the following object properties
| Parameter | Description |
|:-----------|:-----------------------------------------------------------------------------------------------------------------|
| address | Valid email address |
| tag | Tag to unsubscribe from, use * to unsubscribe an address from all domain’s correspondence (optional, default: *) |
| tags | Array with tags to unsubscribe from |
| created_at | Timestamp of a bounce event in RFC2822 format (optional, default: current time) |
Promise returns:
```JS
{
message: "1 address has been added to the unsubscribes table"
}
```
- #### Unsubscribe from one tag
```js
mg.suppressions.create('foobar.example.com', 'unsubscribes', {address: 'bob@example.com', tag: 'your_tag_to_unsubscribe']})
.then(msg => console.log(msg)) // logs response data
.catch(err => console.error(err)); // logs any error
```
Promise returns:
```JS
{
message: "1 address has been added to the unsubscribes table"
}
```
- #### Unsubscribe from particular tags
```js
mg.suppressions.create('foobar.example.com', 'unsubscribes', [{address: 'bob@example.com', tags: ['your_tag_to_unsubscribe', 'another_tag_to_unsubscribe']}])
.then(msg => console.log(msg)) // logs response data
.catch(err => console.error(err)); // logs any error
```
Promise returns:
```JS
{
message: "1 address has been added to the unsubscribes table"
}
```
- #### Complaints Example:
[API Reference](https://documentation.mailgun.com/docs/mailgun/api-reference/send/mailgun/complaints/post-v3--domainid--complaints)
```JS
mg.suppressions.create('foobar.example.com', 'complaints', [{address: 'bob@example.com'}])
.then(msg => console.log(msg)) // logs response data
.catch(err => console.error(err)); // logs any error
```
Complaints Options: Contains an array with the following object properties
| Parameter | Description |
|:-----------|:-----------------------------------------------------------------------------------------------------------------|
| address | Valid email address |
| created_at | Timestamp of a bounce event in RFC2822 format (optional, default: current time) |
Promise returns:
```JS
{
message: "1 address has been added to the complaints table"
}
```
- #### upload
`mg.suppressions.upload(domain, suppressionType, file)`
- #### Bounces file upload example:
[API Reference](https://documentation.mailgun.com/docs/mailgun/api-reference/send/mailgun/bounces/post-v3--domainid--bounces-import)
```JS
const fsPromises = require('fs').promises;
const path = require('path');
const filepath = path.resolve(__dirname, '../bounces-list.csv');
(async () =>{
try {
const file = {
filename: 'bounces-list.csv',
data: await fsPromises.readFile(filepath)
}
const result = mg.suppressions.upload('foobar.example.com', 'bounces', file)
console.log(result);
} catch (error) {
console.error(error);
}
})()
```
Example of `bounces-list.csv` file structure :
```CSV
address, code, error, created_at
bob@example.com,error code,error description,"Tue, 20 Jan 2026 14:00:00 +0000"
anotherBob@example.com,,,
```
Promise returns:
```JS
{
message: "file uploaded successfully for processing. standby..."
}
```
- #### Unsubscribes file upload example:
[API Reference](https://documentation.mailgun.com/docs/mailgun/api-reference/send/mailgun/unsubscribe/post-v3--domainid--unsubscribes-import)
```JS
const fsPromises = require('fs').promises;
const path = require('path');
const filepath = path.resolve(__dirname, '../unsubscribes-list.csv');
(async () =>{
try {
const file = {
filename: 'unsubscribes-list.csv',
data: await fsPromises.readFile(filepath)
}
const result = mg.suppressions.upload('foobar.example.com', 'unsubscribes', file)
console.log(result);
} catch (error) {
console.error(error);
}
})()
```
Example of `unsubscribes-list.csv` file structure :
```CSV
address, tags, created_at
bob@example.com,tag to unsubscribe from,"Tue, 20 Jan 2026 14:00:00 +0000"
anotherBob@example.com,,
```
Promise returns:
```JS
{
message: "file uploaded successfully for processing. standby..."
}
- #### Complaints file upload example:
[API Reference](https://documentation.mailgun.com/docs/mailgun/api-reference/send/mailgun/complaints/post-v3--domainid--complaints-import)
```JS
const fsPromises = require('fs').promises;
const path = require('path');
const filepath = path.resolve(__dirname, '../complaints-list.csv');
(async () =>{
try {
const file = {
filename: 'complaints-list.csv',
data: await fsPromises.readFile(filepath)
}
const result = mg.suppressions.upload('foobar.example.com', 'complaints', file)
console.log(result);
} catch (error) {
console.error(error);
}
})()
```
Example of `complaints-list.csv` file structure :
```CSV
address, created_at
bob@example.com,"Tue, 20 Jan 2026 14:00:00 +0000"
anotherBob@example.com,,
```
Promise returns:
```JS
{
message: "file uploaded successfully for processing. standby..."
}
- #### WhiteLists file upload example:
[API Reference](https://documentation.mailgun.com/docs/mailgun/api-reference/send/mailgun/allowlist)
```JS
const fsPromises = require('fs').promises;
const path = require('path');
const filepath = path.resolve(__dirname, '../whitelists-list.csv');
(async () =>{
try {
const file = {
filename: 'whitelists-list.csv',
data: await fsPromises.readFile(filepath)
}
const result = mg.suppressions.upload('foobar.example.com', 'whitelists', file)
console.log(result);
} catch (error) {
console.error(error);
}
})()
```
Example of `whitelists-list.csv` file structure :
```CSV
address, created_at
bob@example.com,"Tue, 20 Jan 2026 14:00:00 +0000"
anotherBob@example.com,,
```
Promise returns:
```JS
{
message: "file uploaded successfully for processing. standby..."
}
- #### destroy
`mg.suppressions.destroy(domain, suppressionType, address)`
- #### Bounces Example:
[API Reference](https://documentation.mailgun.com/docs/mailgun/api-reference/send/mailgun/bounces/delete-v3--domainid--bounces--address-)
```JS
mg.suppressions.destroy('foobar.example.com', 'bounces', 'bob@example.com')
.then(msg => console.log(msg)) // logs response data
.catch(err => console.error(err)); // logs any error
```
Promise returns:
```JS
{
message: "Bounced address has been removed",
value: "",
address: "bob@example.com",
status: 200
}
```
- #### Unsubscribes Example:
[API Reference](https://documentation.mailgun.com/docs/mailgun/api-reference/send/mailgun/unsubscribe/delete-v3--domainid--unsubscribes--address-)
```js
mg.suppressions.destroy('foobar.example.com', 'unsubscribes', 'bob@example.com')
.then(msg => console.log(msg)) // logs response data
.catch(err => console.error(err)); // logs any error
```
Promise returns:
```JS
{
message: 'Unsubscribe event has been removed',
value: '',
address: 'bob@example.com',
status: 200
}
```
- #### Complaints Example:
[API Reference](https://documentation.mailgun.com/docs/mailgun/api-reference/send/mailgun/complaints/delete-v3--domainid--complaints--address-)
```js
mg.suppressions.destroy('foobar.example.com', 'complaints', 'bob@example.com')
.then(msg => console.log(msg)) // logs response data
.catch(err => console.error(err)); // logs any error
```
Promise returns:
```JS
message: 'Spam complaint has been removed',
value: '',
address: 'bob@example.com',
status: 200
```
- #### destroyAll
`mg.suppressions.destroyAll(domain, suppressionType)`
- #### Bounces Example:
[API Reference](https://documentation.mailgun.com/docs/mailgun/api-reference/send/mailgun/bounces/delete-v3--domainid--bounces)
```js
mg.suppressions.destroyAll('foobar.example.com', 'bounces')
.then(msg => console.log(msg)) // logs response data
.catch(err => console.error(err)); // logs any error
```
Promise returns:
```JS
{
message: 'Bounced addresses for this domain have been removed',
status: 200
}
```
- #### Unsubscribes Example:
[API Reference](https://documentation.mailgun.com/docs/mailgun/api-reference/send/mailgun/unsubscribe/delete-v3--domainid--unsubscribes)
```js
mg.suppressions.destroyAll('foobar.example.com', 'unsubscribes')
.then(msg => console.log(msg)) // logs response data
.catch(err => console.error(err)); // logs any error
```
Promise returns:
```JS
{
message: 'Unsubscribe addresses for this domain have been removed',
status: 200
}
```
- #### Complaints Example:
[API Reference](https://documentation.mailgun.com/docs/mailgun/api-reference/send/mailgun/complaints/delete-v3--domainid--complaints)
```js
mg.suppressions.destroyAll('foobar.example.com', 'complaints')
.then(msg => console.log(msg)) // logs response data
.catch(err => console.error(err)); // logs any error
```
Promise returns:
```JS
{
message: 'Complaint addresses for this domain have been removed',
status: 200
}
```
- #### Whitelists Example:
[API Reference](https://documentation.mailgun.com/docs/mailgun/api-reference/send/mailgun/allowlist/delete-v3--domainid--whitelists)
```js
mg.suppressions.destroyAll('foobar.example.com', 'whitelists')
.then(msg => console.log(msg)) // logs response data
.catch(err => console.error(err)); // logs any error
```
Promise returns:
```JS
{
message: 'Allowlist addresses/domains for this domain have been removed',
status: 200
}
```
### Webhooks
- #### list
[API Reference](https://documentation.mailgun.com/docs/inboxready/api-reference/optimize/mailgun/webhooks/get-v3-domains--domain--webhooks)
`mg.webhooks.list(domain, query)`
Example:
```js
mg.webhooks.list('foobar.example.com')
.then(msg => console.log(msg)) // logs response data
.catch(err => console.error(err)); // logs any error
```
Promise returns:
```JS
{
open: { 'url': 'http://requestb.in' },
click: { 'url': 'http://requestb.in' },
bounce: { 'url': 'http://requestb.in' },
deliver: { 'url': 'http://requestb.in' },
drop: { 'url': 'http://requestb.in' },
spam: { 'url': 'http://requestb.in' },
unsubscribe: { 'url': 'http://requestb.in' },
click: { 'url': 'http://requestb.in' },
open: { 'url': 'http://requestb.in' },
}
```
- #### get
[API Reference](https://documentation.mailgun.com/docs/inboxready/api-reference/optimize/mailgun/webhooks/get-v3-domains--domain-name--webhooks--webhook-name-)
`mg.webhooks.get(domain, id)`
Example:
```js
mg.webhooks.get('foobar.example.com', 'open') // bounce, deliver, drop, spam, unsubscribe, click, open
.then(msg => console.log(msg)) // logs response data
.catch(err => console.error(err)); // logs any error
```
Promise returns:
```JS
{
'open': { 'url': 'http://requestb.in', 'urls': ['trackclick.com'] }
}
```
- #### create
[API Reference](https://documentation.mailgun.com/docs/inboxready/api-reference/optimize/mailgun/webhooks/post-v3-domains--domain--webhooks)
`mg.webhooks.create(domain, id, data, test)`
Example:
```js
mg.webhooks.create('foobar.example.com', 'open', 'http://requestb.in') // bounce, deliver, drop, spam, unsubscribe, click, open
.then(msg => console.log(msg)) // logs response data
.catch(err => console.error(err)); // logs any error
```
Promise returns:
```JS
{
'open': { 'url': 'http://requestb.in', 'urls': ['http://requestb.in'] }
}
```
Test Webhook Example:
```JS
mg.webhooks.get('foobar.example.com', 'open', 'http://requestb.in', true) // bounce, deliver, drop, spam, unsubscribe, click, open
.then(msg => console.log(msg)) // logs response data
.catch(err => console.error(err)); // logs any error
```
Promise returns:
```JS
{
'code': '500',
'message': 'Hi!'
}
```
- #### update
[API Reference](https://documentation.mailgun.com/docs/inboxready/api-reference/optimize/mailgun/webhooks/put-v3-domains--domain-name--webhooks--webhook-name-)
`mg.webhooks.update(domain, id, url, test)`
Example:
```js
mg.webhooks.update('foobar.example.com', 'open', 'http://requestb.in') // bounce, deliver, drop, spam, unsubscribe, click, open
.then(msg => console.log(msg)) // logs response data
.catch(err => console.error(err)); // logs any error
```
Promise returns:
```JS
{
'open': { 'url': 'http://requestb.in', 'urls': ['http://requestb.in'] }
}
```
```js
mg.webhooks.update('foobar.example.com', 'open', ['http://requestb.in', 'http://requestb1.in' ]) // bounce, deliver, drop, spam, unsubscribe, click, open
.then(msg => console.log(msg)) // logs response data
.catch(err => console.error(err)); // logs any error
```
Promise returns:
```JS
{
'open': { 'url': 'http://requestb.in', 'urls': ['http://requestb.in', 'http://requestb1.in'] }
}
```
- #### destroy
[API Reference](https://documentation.mailgun.com/docs/inboxready/api-reference/optimize/mailgun/webhooks/delete-v3-domains--domain-name--webhooks--webhook-name-)
`mg.webhooks.destroy(domain, id)`
Example:
```JS
mg.webhooks.update('foobar.example.com', 'open') // bounce, deliver, drop, spam, unsubscribe, click, open
.then(msg => console.log(msg)) // logs response data
.catch(err => console.error(err)); // logs any error
```
Promise returns:
```JS
{
'open': { 'url': 'http://requestb.in', 'urls': ['http://requestb.in']}
}
```
### Routes
- #### list
[API Reference](https://documentation.mailgun.com/docs/mailgun/api-reference/send/mailgun/routes/get-v3-routes)
`mg.routes.list(query)`
Example:
```JS
mg.routes.list()
.then(data => console.log(data)) // logs response body
.catch(err => console.error(err)); // logs any error
```
Promise returns:
```JS
[
{
actions: [ 'forward("http://myhost.com/messages/")', 'stop()' ],
created_at: 'Mon, 26 Oct 2015 03:56:51 GMT',
description: 'sample',
expression: 'match_recipient(".*@example.com")',
id: '562da483125730608a7d1719',
priority: 0
}
]
```
- #### get
[API Reference](https://documentation.mailgun.com/docs/mailgun/api-reference/send/mailgun/routes/get-v3-routes-id)
`mg.routes.get(id)`
Example:
```js
mg.routes.get('562da483125730608a7d1719')
.then(data => console.log(data)) // logs response body
.catch(err => console.error(err)); // logs any error
```
Promise returns: response body
```JS
{
actions: [ 'forward("http://myhost.com/messages/")', 'stop()' ],
created_at: 'Mon, 26 Oct 2015 03:56:51 GMT',
description: 'sample',
expression: 'match_recipient(".*@example.com")',
id: '562da483125730608a7d1719',
priority: 0
}
```
- #### create
[API Reference](https://documentation.mailgun.com/docs/mailgun/api-reference/send/mailgun/routes/post-v3-routes)
`mg.routes.create(options)`
Example:
```JS
mg.routes.create({
priority: 0,
description: 'sample',
expression: 'match_recipient(".*@example.org")',
action: ['forward("http://myhost.com/messages/")', 'stop()']
})
.then(data => console.log(data)) // logs response body
.catch(err => console.error(err)); // logs any error
```
Promise returns: response body
```js
{
actions: [ 'forward("http://myhost.com/messages/")', 'stop()' ],
created_at: 'Mon, 26 Oct 2015 03:56:51 GMT',
description: 'sample',
expression: 'match_recipient(".*@example.com")',
id: '562da483125730608a7d1719',
priority: 0
}
```
- #### update
[API Reference](https://documentation.mailgun.com/docs/mailgun/api-reference/send/mailgun/routes/put-v3-routes-id)
`mg.routes.update(id, options)`
Example:
```JS
mg.routes.update('562da483125730608a7d1719', {
priority: 0,
description: 'sample',
expression: 'match_recipient(".*@example.org")',
action: ['forward("http://myhost.com/messages/")', 'stop()']
})
.then(data => console.log(data)) // logs response body
.catch(err => console.error(err)); // logs any error
```
Promise returns: response body
```JS
{
actions: [ 'forward("http://myhost.com/messages/")', 'stop()' ],
created_at: 'Mon, 26 Oct 2015 03:56:51 GMT',
description: 'sample',
expression: 'match_recipient(".*@example.com")',
id: '562da483125730608a7d1719',
message: 'Route has been updated',
priority: 0
}
```
- #### destroy
[API Reference](https://documentation.mailgun.com/docs/mailgun/api-reference/send/mailgun/routes/delete-v3-routes-id)
`mg.routes.destroy(id)`
Example:
```js
mg.routes.destroy('562da483125730608a7d1719')
.then(data => console.log(data)) // logs response body
.catch(err => console.error(err)); // logs any error
```
Promise returns: response body
```JS
{
id: '562da483125730608a7d1719',
message: 'Route has been deleted'
}
```
- #### matchAddress
[API Reference](https://documentation.mailgun.com/docs/mailgun/api-reference/send/mailgun/routes/get-v3-routes-match)
`mg.routes.matchAddress(address)`
Example:
```js
mg.routes.matchAddress('test@example.com')
.then(data => console.log(data)) // logs response body
.catch(err => console.error(err)); // logs any error
```
Promise returns: response body
```JS
{
actions: [ 'forward("http://myhost.com/messages/")', 'stop()' ],
created_at: 'Mon, 26 Oct 2015 03:56:51 GMT',
description: 'sample',
expression: 'match_recipient(".*@example.com")',
id: '562da483125730608a7d1719',
priority: 0
}
```
### Validation
- #### get
[API Reference](https://documentation.mailgun.com/docs/validate/single-valid-ir)
`mg.validate.get(address)`
Example:
```JS
mg.validate.get('foo@mailgun.net')
.then(data => console.log(data)) // logs response body
.catch(err => console.error(err)); // logs any error
```
Promise returns: response body
```JS
{
address: 'alice@example.com',
did_you_mean: null,
is_valid: false,
parts: {
display_name: null,
domain: null,
local_part: null
}
}
```
### Multiple validation
[API Reference](https://documentation.mailgun.com/docs/validate/bulk-valid-ir)
- #### create
`mg.validate.multipleValidation.create('name_of_the_list', { file })`
```js
const fsPromises = require('fs').promises;
const filepath = path.resolve(__dirname, '../path_to_your_file_with_emails_list.csv');
...
(async () => {
try {
const file = {
filename: 'test.csv',
data: await fsPromises.readFile(filepath)
};
const validateBulkResult = await mg.validate.multipleValidation.create('name_of_the_list', { file });
console.log('validateBulkResult', validateBulkResult);
} catch (error) {
console.error(error);
}
})();
```
Response shape:
```JSON
{
"id": "name_of_the_list",
"message": "The validation job was submitted."
}
```
- #### list
`mg.validate.multipleValidation.list()`
```js
mg.validate.multipleValidation.list()
.then(data => console.log(data)) // logs response body
.catch(err => console.error(err)); // logs any error
```
Response shape:
```JSON
{
"jobs": [
{
"created_at": 1643965937,
"download_url": {
"csv": "csv-url",
"json": "json-url"
},
"id": "name_of_the_list",
"quantity": 40,
"records_processed": 40,
"status": "uploaded",
"summary": {
"result": {
"catch_all": 0,
"deliverable": 0,
"do_not_send": 0,
"undeliverable": 0,
"unknown": 40
},
"risk": { "high": 0, "low": 0, "medium": 0, "unknown": 40 }
}
}
],
"paging": {
"first": "https://api.mailgun.net/v4/address/validate/bulk?limit=100&page=first&pivot=",
"last": "https://api.mailgun.net/v4/address/validate/bulk?limit=100&page=last&pivot=",
"next": "https://api.mailgun.net/v4/address/validate/bulk?limit=100&page=next&pivot=b4808b5b-1111-2222-3333-6cd0b63f41ea",
"prev": "https://api.mailgun.net/v4/address/validate/bulk?limit=100&page=prev&pivot="
},
"total": 1
}
```
- #### get
`mg.validate.multipleValidation.get('name_of_the_list')`
```js
mg.validate.multipleValidation.get('name_of_the_list')
.then(data => console.log(data)) // logs response body
.catch(err => console.error(err)); // logs any error
```
Response shape:
```JSON
{
"created_at": 1643965937,
"download_url": {
"csv": "csv-url",
"json": "json-url"
},
"id": "name_of_the_list",
"quantity": 40,
"records_processed": 40,
"responseStatusCode": 200,
"status": "uploaded",
"summary": {
"result": {
"catch_all": 0,
"deliverable": 0,
"do_not_send": 0,
"undeliverable": 0,
"unknown": 40
},
"risk": { "high": 0, "low": 0, "medium": 0, "unknown": 40 }
}
}
```
- #### destroy
`mg.validate.multipleValidation.destroy('name_of_the_list');`
cancels bulk validation job
```JS
mg.validate.multipleValidation.destroy('name_of_the_list');
.then(data => console.log(data)) // logs response body
.catch(err => console.error(err)); // logs any error
```
Response shape:
```JS
{
body: "Validation job canceled.",
status: 200
}
```
### Mailing lists
A client to manage mailing lists.
- #### list
[API Reference](https://documentation.mailgun.com/docs/mailgun/api-reference/send/mailgun/mailing-lists/get-v3-lists)
`mg.lists.list(query?)`
Example:
```js
mg.lists.list()
.then(data => console.log(data)) // logs response body
.catch(err => console.error(err)); // logs any error
```
Example with query:
```js
mg.lists.list({ page: '?page=first', limit: 10 })
.then(data => console.log(data))
.catch(err => console.error(err));
```
Allowed query properties:
- `limit`
- `page`
Promise returns: response body
```JS
[
{
access_level: 'readonly',
address: 'noreply@sample.com',
created_at: 'Wed, 27 Oct 2021 21:59:21 -0000',
description: '',
members_count: 0,
name: '',
reply_preference: 'list'
}
]
```
- #### listByAddress
[API Reference](https://documentation.mailgun.com/docs/mailgun/api-reference/send/mailgun/mailing-lists/get-v3-lists)
`mg.lists.listByAddress(query)`
Example:
```js
mg.lists.listByAddress({
address: 'test@example.com',
skip: 2,
limit: 10
})
.then(data => console.log(data))
.catch(err => console.error(err));
```
Allowed query properties:
- `address`
- `skip`
- `limit`
Promise returns: response body
```JS
{
items: [
{
access_level: 'readonly',
address: 'noreply@sample.com',
created_at: 'Wed, 27 Oct 2021 21:59:21 -0000',
description: '',
members_count: 0,
name: '',
reply_preference: 'list'
}
],
status: 200
}
```
- #### get
[API Reference](https://documentation.mailgun.com/docs/mailgun/api-reference/send/mailgun/mailing-lists/get-v3-lists-address)
`mg.lists.get(mailListAddress)`
Example:
```JS
mg.lists.get('noreply@sample.com')
.then(data => console.log(data)) // logs response body
.catch(err => console.error(err)); // logs any error
```
Promise returns:
```JS
{
access_level: 'readonly',
address: 'noreply@sample.com',
created_at: 'Thu, 28 Oct 2021 00:16:56 -0000',
description: '',
members_count: 0,
name: '',
reply_preference: 'list'
}
```
- #### create
[API Reference](https://documentation.mailgun.com/docs/mailgun/api-reference/send/mailgun/mailing-lists/post-v3-lists)
`mg.lists.create(data)`
Example:
```js
mg.lists.create({
address: 'reply@sample.com',
name: 'Reply Address', // optional, modifiable on website
description: 'Mailing lists for repliable address', // optional, modifiable on website
access_level: 'readonly', // optional, modifiable on website
reply_preference: 'list', // optional, modifiable on website
})
.then(data => console.log(data)) // logs response body
.catch(err => console.error(err)); // logs any error
```
Promise returns:
```JS
{
access_level: 'readonly',
address: 'reply@sample.com',
created_at: 'Thu, 28 Oct 2021 03:12:17 -0000',
description: 'Mailing lists for repliable address',
members_count: 0,
name: 'Reply Address',
reply_preference: 'list'
}
```
- #### update
[API Reference](https://documentation.mailgun.com/docs/mailgun/api-reference/send/mailgun/mailing-lists/put-v3-lists-address)
`mg.lists.update(mailListAddress)`
Example:
```js
mg.lists.update('reply@sample.com', {
address: 'foo@sample.com',
name: 'Foo', // optional, modifiable on website
description: 'Foo bar bat', // optional, modifiable on website
access_level: 'members', // optional, modifiable on website
reply_preference: 'sender', // optional, modifiable on website
})
.then(data => console.log(data)) // logs response body
.catch(err => console.error(err)); // logs any error
```
Promise returns:
```JS
{
access_level: 'members',
address: 'foo@sample.com',
created_at: 'Thu, 28 Oct 2021 03:21:15 -0000',
description: 'Foo bar bat',
members_count: 0,
name: 'Foo',
reply_preference: 'sender'
}
```
- #### destroy
[API Reference](https://documentation.mailgun.com/docs/mailgun/api-reference/send/mailgun/mailing-lists/delete-v3-lists-address)
`mg.lists.destroy(mailListAddress)`
Example:
```js
mg.lists.destroy('foo@sample.com')
.then(data => console.log(data)) // logs response body
.catch(err => console.error(err)); // logs any error
```
Promise returns: response body
```JS
{
address: 'foo@sample.com',
message: 'Mailing list has been removed'
}
```
### Mailing list members
A client to manage members within a specific mailing list.
- #### listMembers
[API Reference](https://documentation.mailgun.com/docs/mailgun/api-reference/send/mailgun/mailing-lists/get-lists-string:list_address-members)
`mg.lists.members.listMembers(mailListAddress)`
Example:
```js
mg.lists.members.listMembers('reply@sample.com')
.then(data => console.log(data)) // logs response body
.catch(err => console.error(err)); // logs any error
```
Promise returns:
```JS
[
{
address: 'foo@bar.com',
name: 'Jane Doe',
subscribed: true,
vars: { age: 50 }
}
]
```
- #### listMembersByAddress
[API Reference](https://documentation.mailgun.com/docs/mailgun/api-reference/send/mailgun/mailing-lists/get-v3-lists)
`mg.lists.members.listMembersByAddress(mailListAddress, query)`
Example:
```js
mg.lists.members.listMembersByAddress('reply@sample.com', {
address: 'foo@bar.com',
skip: 0,
limit: 10
})
.then(data => console.log(data))
.catch(err => console.error(err));
```
Promise returns:
```JS
{
items: [
{
address: 'foo@bar.com',
name: 'Jane Doe',
subscribed: true,
vars: { age: 50 }
}
],
total_count: 1,
status: 200
}
```
- #### getMember
[API Reference](https://documentation.mailgun.com/docs/mailgun/api-reference/send/mailgun/mailing-lists/get-lists-list_address-members-member_address)
`mg.lists.members.getMember(mailListAddress, mailListMemberAddress)`
Example:
```JS
mg.lists.members.getMember('reply@sample.com', 'foo@bar.com')
.then(data => console.log(data)) // logs response body
.catch(err => console.error(err)); // logs any error
```
Promise returns:
```JS
{
address: 'foo@bar.com',
name: 'Jane Doe',
subscribed: true,
vars: { age: 50 }
}
```
- #### createMember
[API Reference](https://documentation.mailgun.com/docs/mailgun/api-reference/send/mailgun/mailing-lists/post-lists-string:list_address-members)
`mg.lists.members.createMember(mailListAddress, data)`
Example:
```JS
mg.lists.members.createMember('reply@sample.com', {
address: 'bat@bar.com',
name: 'John Smith', // optional, modifiable on website
vars: {hobby: "chess"}, // optional, modifiable on website
subscribed: 'no', // optional, modifiable on website
upsert: 'yes', // optional, choose yes to insert if not exist, or update it exist
})
.then(data => console.log(data)) // logs response body
.catch(err => console.error(err)); // logs any error
```
Promise returns: response body
```JS
{
address: 'bat@bar.com',
name: 'John Smith',
subscribed: false,
vars: { hobby: 'chess' }
}
```
- #### createMembers
[API Reference](https://documentation.mailgun.com/docs/mailgun/api-reference/send/mailgun/mailing-lists/post-lists-list_address-members.json)
`mg.lists.members.createMembers(mailListAddress, data)`
Example:
```JS
mg.lists.members.createMembers('reply@sample.com', {
members: [
{
address: "bot1@foobar.com",
name: "Bot1 Superbot",
vars: {location: "loc1"},
subscribed: true,
},
{
address: "bot2@foobar.com",
name: "Bot2 Superbot",
vars: {location: "loc2"},
subscribed: false,
},
],
upsert: "yes",
})
.then(data => console.log(data)) // logs response body
.catch(err => console.error(err)); // logs any error
```
Promise returns:
```JS
{
list: {
access_level: 'readonly',
address: 'reply@sample.com',
created_at: 'Thu, 28 Oct 2021 03:21:15 -0000',
description: 'For reply purpose',
members_count: 2,
name: 'Reply',
reply_preference: 'list'
},
message: 'Mailing list has been updated',
'task-id': '575b943c37a211ec8a520242ac11000a'
}
```
- #### updateMember
[API Reference](https://documentation.mailgun.com/docs/mailgun/api-reference/send/mailgun/mailing-lists/put-lists-list_address-members-member_address)
`mg.lists.members.updateMember(mailListAddress, mailListMemberAddress, data)`
Example:
```JS
mg.lists.members.updateMember('reply@sample.com', 'bot1@foobar.com', {
address: 'bot0@barfoo.com',
name: 'Bot0 Normalbot', // optional, modifiable on website
vars: {location: "space"},
subscribed: false,
})
.then(data => console.log(data)) // logs response body
.catch(err => console.error(err)); // logs any error
```
Promise returns: response body
```JS
{
address: 'bot0@barfoo.com',
name: 'Bot0 Normalbot',
subscribed: false,
vars: { location: 'space' }
}
```
- #### destroyMember
[API Reference](https://documentation.mailgun.com/docs/mailgun/api-reference/send/mailgun/mailing-lists/delete-lists-list_address-members-member_address)
`mg.lists.members.destroyMember(mailListAddress, mailListMemberAddress)`
Example:
```JS
mg.lists.members.destroyMember('reply@sample.com', 'bot2@foobar.com')
.then(data => console.log(data)) // logs response body
.catch(err => console.error(err)); // logs any error
```
Promise returns: response body
```JS
{
member: { address: 'bot2@foobar.com' },
message: 'Mailing list member has been deleted'
}
```
### Subaccounts
A client to manage subaccounts.
- #### list
[API Reference](https://documentation.mailgun.com/docs/mailgun/api-reference/send/mailgun/subaccounts/get-v5-accounts-subaccounts)
`mg.subaccounts.list(query)`
Example:
```js
mg.subaccounts.list()
.then(subaccounts => console.log(subaccounts)) // logs array of subaccounts
.catch(err => console.error(err)); // logs any error
```
Promise returns: array of Subaccounts instances
```JS
[
{ id: "XYZ", name: "test.subaccount1", status: "open" },
{ id: "YYY", name: "test.subaccount2", status: "open" }
]
```
Query data may have next properties:
| Property | Description |
|:---------|:-----------------------------------------------------------------------|
| limit | Maximum number of records to return. (10 by default) |
| skip | Number of records to skip. (0 by default) |
| sort | "asc" or "desc". |
| enabled | Returns all enabled/disabled subaccounts. (Defaults to all if omitted) |
- #### get
[API Reference](https://documentation.mailgun.com/docs/mailgun/api-reference/send/mailgun/subaccounts/get-v5-accounts-subaccounts-subaccount_id)
`mg.subaccounts.get(subaccount_id)`
Example:
```JS
mg.subaccounts.get('123')
.then(subaccount => console.log(subaccount)) // logs subaccount object
.catch(err => console.error(err)); // logs any error
```
Promise returns: Subaccount instance
```JS
{ id: "123", name: "test.subaccount1", status: "open" }
```
- #### create
[API Reference](https://documentation.mailgun.com/docs/mailgun/api-reference/send/mailgun/subaccounts/post-v5-accounts-subaccounts)
`mg.subaccounts.create(name)`
Example:
```js
mg.subaccounts.create('foobar')
.then(msg => console.log(msg)) // logs response data
.catch(err => console.error(err)); // logs any error
```
Promise returns: Subaccount instance
```JS
{ id: "123", name: "foobar", status: "open" }
```
Create method accepts data object with next properties:
| Parameter | Description |
|-------------|-----------------------------------------------------------|
| name | Name of the subaccount being created (ex. 'mysubaccount') |
- #### enable
[API Reference](https://documentation.mailgun.com/docs/mailgun/api-reference/send/mailgun/subaccounts/post-v5-accounts-subaccounts-subaccount_id-enable)
`mg.subaccounts.enable(subaccount_id)`
Example:
```js
mg.subaccounts.enable('123')
.then(msg => console.log(msg)) // logs response data
.catch(err => console.error(err)); // logs any error
```
Promise returns: Subaccount instance
```JS
{ id: "123", name: "foobar", status: "open" }
```
- #### disable
[API Reference](https://documentation.mailgun.com/docs/mailgun/api-reference/send/mailgun/subaccounts/post-v5-accounts-subaccounts-subaccount_id-disable)
`mg.subaccounts.disable(subaccount_id)`
Example:
```js
mg.subaccounts.disable('123')
.then(msg => console.log(msg)) // logs response data
.catch(err => console.error(err)); // logs any error
```
Promise returns: Subaccount instance
```JS
{ id: "123", name: "foobar", status: "disabled" }
```
- #### destroy
[API Reference](https://documentation.mailgun.com/docs/mailgun/api-reference/send/mailgun/subaccounts/delete-v5-accounts-subaccounts-subaccount_id)
`mg.subaccounts.destroy(subaccount_id)`
Example:
```js
mg.subaccounts.destroy('123')
.then(msg => console.log(msg)) // logs response data
.catch(err => console.error(err)); // logs any error
```
Promise returns: Result message
```JS
{ message: 'Subaccount successfully deleted' }
```
- #### setMonthlySendingLimit
[API Reference](https://documentation.mailgun.com/docs/mailgun/api-reference/send/mailgun/subaccounts/put-v5-accounts-subaccounts-subaccount_id-limit-custom-monthly)
`mg.subaccounts.setMonthlySendingLimit(subaccount_id, limit)`
Example:
```js
mg.subaccounts.setMonthlySendingLimit('123', 5000)
.then(msg => console.log(msg)) // logs response data
.catch(err => console.error(err)); // logs any error
```
Promise returns: Status message
```JS
{ success: true }
```
- #### getMonthlySendingLimit
[API Reference](https://documentation.mailgun.com/docs/mailgun/api-reference/send/mailgun/subaccounts/get-v5-accounts-subaccounts-subaccount_id-limit-custom-monthly)
`mg.subaccounts.getMonthlySendingLimit(subaccount_id)`
Example:
```js
mg.subaccounts.getMonthlySendingLimit('123')
.then(msg => console.log(msg)) // logs response data
.catch(err => console.error(err)); // logs any error
```
Promise returns: Details of custom sending limit on the account
```JS
{ current: 0, limit: 5000, period: '1m' }
```
- #### updateSubaccountFeature
[API Reference](https://documentation.mailgun.com/docs/mailgun/api-reference/send/mailgun/subaccounts/put-v5-accounts-subaccounts-subaccount_id-features)
`mg.subaccounts.updateSubaccountFeature(subaccount_id, featuresValues)`
Example:
```js
mg.subaccounts.updateSubaccountFeature('123', {
email_preview: false,
inbox_placement: false,
sending: false,
validations: false,
validations_bulk: false
})
.then(msg => console.log(msg)) // logs response data
.catch(err => console.error(err)); // logs any error
```
Promise returns: Successfully updated subaccount features
```JS
{
features: {
email_preview: { enabled: false },
inbox_placement: { enabled: false },
sending: { enabled: true },
validations: { enabled: false },
validations_bulk: { enabled: false }
}
}
```
### Inbox Placements
A client to allows you to see the likely deliverability of your email campaigns.
- #### SeedsLists
- #### list
[API Reference](https://documentation.mailgun.com/docs/inboxready/api-reference/optimize/inboxready/inbox-placement/get-v4-inbox-seedlists)
`mg.inboxPlacements.seedsLists.list()`
Example:
```JS
mg.inboxPlacements.seedsLists.list()
.then(data => console.log(data)) // logs response data
.catch(err => console.error(err)); //logs any error
```
Promise returns: available SeedsLists
```JS
{
status: 200,
items: [
{
kid: 'kid',
ID: 'ID',
AccountID: 'AccountID',
created_at: new Date('2024-08-09T14:32:57.183Z'),
updated_at: new Date('2024-08-09T14:33:57.183Z'),
last_result_at: new Date('2024-08-09T14:32:57.183Z'),
Seeds: [
{
AccountID: 'acount id',
id: 'seed id',
token: 'token',
email: 'email',
provider: 'provider',
sync_state: 'sync_state',
local_state: 'local_state',
created_at: new Date('2024-08-09T14:32:57.183Z'),
updated_at: new Date('2024-08-09T14:32:57.183Z'),
message_count: 0,
max_email_count_hit_at: new Date('2024-08-09T14:32:57.183Z'),
total_msgs: 0,
matched_msgs: 0,
spam_message: 0,
expected_msgs: 0,
last_sent_to_at: new Date('2024-08-09T14:32:57.183Z'),
last_delivered_at: new Date('2024-08-09T14:32:57.183Z'),
account_quality: 0,
quality_label: 'quality_label',
password: 'password',
phone_number: 'phone_number',
attributes: {},
totp: {
secret: 'secret',
}
},
...
],
target_email: 'test_email@test.com',
sending_domains: ['test_domain.com'],
has_results: true,
name: 'test name',
seed_filter: 'test filter',
mailing_list: 'test mailing_list',
CreatedTS: 1723214101728,
tags: {
sfmc_remote_id: 'test sfmc_remote_id',
},
delivery_stats: {
all: {
delivered: 0,
missing: 0,
pending: 0,
spam: 0,
inbox: 0,
total: 0,
provider: 'test provider',
categories: {
primary: 0,
promotions: 0,
updates: 0,
}
}
},
SeedQuality: 1,
is_auto_generated: true,
},
...
],
paging: {
first: 'first_page_link',
last: 'last_page_link',
next: 'next_page_link',
previous: 'previous_page_link',
}
}
```
- #### get
[API Reference](https://documentation.mailgun.com/docs/inboxready/api-reference/optimize/inboxready/inbox-placement/get-v4-inbox-seedlists--address-)
`mg.inboxPlacements.seedsLists.get(seedsListId)`
Example:
```JS
mg.inboxPlacements.seedsLists.get(seedsListId);
.then(data => console.log(data)) // logs response data
.catch(err => console.error(err)); //logs any error
```
Promise returns: SeedsLists item by id
```JS
{
status: 200,
kid: 'kid',
ID: 'ID',
AccountID: 'AccountID',
created_at: new Date('2024-08-09T14:32:57.183Z'),
updated_at: new Date('2024-08-09T14:33:57.183Z'),
last_result_at: new Date('2024-08-09T14:32:57.183Z'),
Seeds: [
{
AccountID: 'acount id',
id: 'seed id',
token: 'token',
email: 'email',
provider: 'provider',
sync_state: 'sync_state',
local_state: 'local_state',
created_at: new Date('2024-08-09T14:32:57.183Z'),
updated_at: new Date('2024-08-09T14:32:57.183Z'),
message_count: 0,
max_email_count_hit_at: new Date('2024-08-09T14:32:57.183Z'),
total_msgs: 0,
matched_msgs: 0,
spam_message: 0,
expected_msgs: 0,
last_sent_to_at: new Date('2024-08-09T14:32:57.183Z'),
last_delivered_at: new Date('2024-08-09T14:32:57.183Z'),
account_quality: 0,
quality_label: 'quality_label',
password: 'password',
phone_number: 'phone_number',
attributes: {},
totp: {
secret: 'secret',
}
},
...
],
target_email: 'test_email@test.com',
sending_domains: ['test_domain.com'],
has_results: true,
name: 'test name',
seed_filter: 'test filter',
mailing_list: 'test mailing_list',
CreatedTS: 1723214101728,
tags: {
sfmc_remote_id: 'test sfmc_remote_id',
},
delivery_stats: {
all: {
delivered: 0,
missing: 0,
pending: 0,
spam: 0,
inbox: 0,
total: 0,
provider: 'test provider',
categories: {
primary: 0,
promotions: 0,
updates: 0,
}
}
},
SeedQuality: 1,
is_auto_generated: true,
}
```
- #### create
[API Reference](https://documentation.mailgun.com/docs/inboxready/api-reference/optimize/inboxready/inbox-placement/post-v4-inbox-seedlists)
```js
mg.inboxPlacements.seedsLists.create({
name: 'seedLists name',
sending_domains: 'your_sending_domain',
seed_filter: 'seed filter',
remote_id: 'remote_id'
})
```
Example:
```JS
mg.inboxPlacements.seedsLists.create({
sending_domains: 'your_sending_domain',
name: 'seedLists name';
seed_filter: 'seed filter';
remote_id: 'remote_id';
});
.then(data => console.log(data)) // logs response data
.catch(err => console.error(err)); //logs any error
```
Promise returns: created SeedsLists item
```JS
{
kid: 'kid',
created_at: new Date('2024-08-09T14:32:57.183Z'),
updated_at: new Date('2024-08-09T14:32:57.183Z'),
last_result_at: new Date('2024-08-09T14:32:57.183Z'),
target_email: 'test_email@test.com',
sending_domains: [ 'your_sending_domain' ],
has_results: false,
name: 'seedLists name',
seed_filter: 'seed filter',
provider_filter: [],
mailing_list: 'test_email@test.com',
previous_mailing_list: '',
tags: {
sfmc_remote_id: 'remote_id'
},
delivery_stats: {
all: {
delivered: 0,
missing: 0,
pending: 0,
spam: 0,
inbox: 0,
total: 0,
provider: 'all',
categories: {}
}
},
is_auto_generated: false,
version: 2,
Seeds: null,
status: 200
}
```
- #### update
[API Reference](https://documentation.mailgun.com/docs/inboxready/api-reference/optimize/inboxready/inbox-placement/put-v4-inbox-seedlists--address-)
```JS
mg.inboxPlacements.seedsLists.update(seedsListId,{
name: 'new seedLists name', // optional
provider_filter: 'provider_filter', // optional
shuffle: true, // optional
sending_domains: 'your_sending_domain' // optional
})
```
Example:
```JS
mg.inboxPlacements.seedsLists.update(seedsListId,{
name: 'new seedLists name',
provider_filter: 'gmail.com',
sending_domains: 'your_sending_domain'
})
.then(data => console.log(data)) // logs response data
.catch(err => console.error(err)); //logs any error
```
Promise returns: updated SeedsLists item
```JS
{
kid: '674dcab31169b0619005a9f8',
created_at: new Date('2024-08-09T14:32:57.183Z'),
updated_at: 2024-12-02T14:59:42.231Z,
last_result_at: new Date('2024-08-09T14:32:57.183Z'),
target_email: 'test_email@test.com',
sending_domains: [ 'your_sending_domain' ],
has_results: false,
name: 'seedLists name',
seed_filter: '.*',
provider_filter: ['gmail.com'],
mailing_list: 'test_email@test.com',
previous_mailing_list: '',
tags: {
sfmc_remote_id: 'remote_id'
},
delivery_stats: {
all: {
delivered: 0,
missing: 0,
pending: 0,
spam: 0,
inbox: 0,
total: 0,
provider: 'all',
categories: {}
}
},
is_auto_generated: false,
version: 2,
Seeds: null,
status: 200
}
```
- #### destroy
[API Reference](https://documentation.mailgun.com/docs/inboxready/api-reference/optimize/inboxready/inbox-placement/delete-v4-inbox-seedlists--address-)
```js
mg.inboxPlacements.seedsLists.destroy(seedsListId)
```
Example:
```JS
mg.inboxPlacements.seedsLists.destroy(seedsListId)
.then(data => console.log(data)) // logs response data
.catch(err => console.error(err)); //logs any error
```
Promise returns: status object
```JS
{
status: 200,
body: null
}
```
- #### Attributes
- #### list
[API Reference](https://documentation.mailgun.com/docs/inboxready/api-reference/optimize/inboxready/inbox-placement/get-v4-inbox-seedlists-a)
`mg.inboxPlacements.seedsLists.attributes.list()`
Example:
```JS
mg.inboxPlacements.seedsLists.attributes.list()
.then(data => console.log(data)) // logs response data
.catch(err => console.error(err)); //logs any error
```
Promise returns: SeedsLists attributes
```JS
{
status: 200,
items:[{
attribute: 'available attribute',
values: ['attribute_value', ...]
}, ...]
}
```
- #### get
[API Reference](https://documentation.mailgun.com/docs/inboxready/api-reference/optimize/inboxready/inbox-placement/get-v4-inbox-seedlists-a--attribute-)
`mg.inboxPlacements.seedsLists.attributes.get('attribute_name');`
Example:
```JS
mg.inboxPlacements.seedsLists.attributes.get('attribute_name')
.then(data => console.log(data)) // logs response data
.catch(err => console.error(err)); //logs any error
```
Promise returns: SeedsLists attribute
```JS
{
status: 200,
items: {
attribute: 'attribute_name',
values: ['attribute_value', ...]
}
}
```
- #### Filters
- #### list
[API Reference](https://documentation.mailgun.com/docs/inboxready/api-reference/optimize/inboxready/inbox-placement/get-v4-inbox-seedlists--filters)
`mg.inboxPlacements.seedsLists.filters.list()`
Example:
```JS
mg.inboxPlacements.seedsLists.filters.list()
.then(data => console.log(data)) // logs response data
.catch(err => console.error(err)); //logs any error
```
Promise returns: SeedsLists filters
```JS
{
status: 200,
supported_filters:{
filters: [
{
parameter: 'parameter_name',
description: 'parameter_description'
}, ....
]
}
}
```
- #### Providers
- #### list
[API Reference](https://documentation.mailgun.com/docs/inboxready/api-reference/optimize/inboxready/inbox-placement/get-v4-inbox-providers)
List all available email providers.
`mg.inboxPlacements.providers.list()`
Example:
```JS
mg.inboxPlacements.providers.list()
.then(data => console.log(data)) // logs response data
.catch(err => console.error(err)); //logs any error
```
Promise returns: providers list
```JS
{
items: [
{
domain: 'something.com',
region: 'provider region',
display_name: 'provider name',
created_at: new Date('2024-08-09T14:32:57.183Z'),
updated_at: new Date('2024-08-09T14:32:59.183Z')
},
...
]
}
```
- #### Results
- #### list
[API Reference](https://documentation.mailgun.com/docs/inboxready/api-reference/optimize/inboxready/inbox-placement/get-v4-inbox-results)
Get the details for all placement test results.
```js
mg.inboxPlacements.results.list({
'sender': 'sender value', // optional
'subject': 'subject value', // optional
'provider': 'provider value', // optional
'target_email': 'target_email value', // optional
'time_after': new Date('2024-08-09T14:32:57.183Z'), // optional
'time_before': new Date('2024-08-11T14:32:57.183Z'), // optional
'cursor': '', // optional
'sort': '', // optional
'offset': 1, // optional
'ascending': true, // optional
'limit': 5, // optional
})
```
Example:
```JS
mg.inboxPlacements.results.list({
'sender': 'sender value', // optional
'subject': 'subject value', // optional
})
.then(data => console.log(data)) // logs response data
.catch(err => console.error(err)); //logs any error
```
Promise returns: results list
```JS
{
status: 200,
items: [
{
rid: 'rid_value',
result_id: 'result_id_value',
AccountID: 'AccountID_value',
KeyBoxID: 'KeyBoxID_value',
keybox_email: 'keybox_email_value',
subject: 'subject_value',
sender: 'sender_value',
seedlist_name: 'seedlist_name_value',
created_at: new Date('2024-08-09T14:32:57.183Z'),
updated_at: new Date('2024-08-11T14:32:57.183Z'),
status: 'status_value',
CreatedTS: 1723214101728,
attributes: {
attribute_value: 'attribute_value_value'
},
campaign_id: 'campaign_id_value',
sharing_enabled: true,
sharing_id: 'sharing_id_value',
sharing_expires_at: new Date('2024-08-14T14:32:57.183Z'),
Box: {
Id: 'box_Id_value',
kid: 'box_kid_value',
AccountID: 'box_AccountID_value',
created_at: new Date('2024-08-11T14:32:57.183Z'),
updated_at: new Date('2024-08-12T14:32:57.183Z'),
last_result_at: new Date('2024-08-13T14:32:57.183Z'),
Seeds: null,
target_email: 'box_target_email_value',
sending_domains: null,
has_results: true,
name: 'box_name_value',
seed_filter: 'box_seed_filter_value',
mailing_list: 'box_mailing_list_value',
CreatedTS: 1723214101728,
tags: ['tag_value'],
SeedQuality: 100,
is_auto_generated: true,
},
seed_results: [{
email: 'seed_result_email_value',
provider: 'seed_result_provider_value',
destination: 'seed_result_destination_value',
state: 'seed_result_state_value',
originating_ip: 'seed_result_originating_ip_value',
tags: ['seed_result_tag_value'],
dkim: 'seed_result_dkim_value',
spf: 'seed_result_spf_value',
dmarc: 'seed_result_dmarc_value',
headers: [{
key: 'seed_result_header_key_value',
value: 'seed_result_header_value_value',
}],
extensions: {
category: 'seed_result_extensions_category_value',
}
}],
spamassassin: {
is_spam: false,
score: 1,
required: 1,
rules: [{
name: 'rule_name_value',
points: 100,
short_description: 'short_description_value',
long_description: 'long_description_value',
}],
},
delivery_stats: {
test_delivery_stat: {
delivered: 1,
missing: 0,
pending: 0,
spam: 0,
inbox: 0,
total: 1,
provider: 'provider_value',
categories: {
primary: 1,
updates: 0,
}
}
}
}
],
pages: {
first: '?page=first',
last: '?page=last',
next: '?page=next',
previous: '?page=previous',
},
}
```
- #### get
Get the details for a single result.
[API Reference](https://documentation.mailgun.com/docs/inboxready/api-reference/optimize/inboxready/inbox-placement/get-v4-inbox-results--result-)
`mg.inboxPlacements.results.get(IBPResultId)`
Example:
```JS
mg.inboxPlacements.results.get(IBPResultId);
.then(data => console.log(data)) // logs response data
.catch(err => console.error(err)); //logs any error
```
Promise returns: Inbox Placement result item
```JS
{
status: 200,
inboxPlacementResult: {
rid: 'rid_value',
result_id: 'result_id_value',
AccountID: 'AccountID_value',
KeyBoxID: 'KeyBoxID_value',
keybox_email: 'keybox_email_value',
subject: 'subject_value',
sender: 'sender_value',
seedlist_name: 'seedlist_name_value',
created_at: new Date('2024-08-09T14:32:57.183Z'),
updated_at: new Date('2024-08-11T14:32:57.183Z'),
status: 'status_value',
CreatedTS: 1723214101728,
attributes: {
attribute_value: 'attribute_value_value'
},
campaign_id: 'campaign_id_value',
sharing_enabled: true,
sharing_id: 'sharing_id_value',
sharing_expires_at: new Date('2024-08-14T14:32:57.183Z'),
Box: {
Id: 'box_Id_value',
kid: 'box_kid_value',
AccountID: 'box_AccountID_value',
created_at: new Date('2024-08-11T14:32:57.183Z'),
updated_at: new Date('2024-08-12T14:32:57.183Z'),
last_result_at: new Date('2024-08-13T14:32:57.183Z'),
Seeds: null,
target_email: 'box_target_email_value',
sending_domains: null,
has_results: true,
name: 'box_name_value',
seed_filter: 'box_seed_filter_value',
mailing_list: 'box_mailing_list_value',
CreatedTS: 1723214101728,
tags: ['tag_value'],
SeedQuality: 100,
is_auto_generated: true,
},
seed_results: [{
email: 'seed_result_email_value',
provider: 'seed_result_provider_value',
destination: 'seed_result_destination_value',
state: 'seed_result_state_value',
originating_ip: 'seed_result_originating_ip_value',
tags: ['seed_result_tag_value'],
dkim: 'seed_result_dkim_value',
spf: 'seed_result_spf_value',
dmarc: 'seed_result_dmarc_value',
headers: [{
key: 'seed_result_header_key_value',
value: 'seed_result_header_value_value',
}],
extensions: {
category: 'seed_result_extensions_category_value',
}
}],
spamassassin: {
is_spam: false,
score: 1,
required: 1,
rules: [{
name: 'rule_name_value',
points: 100,
short_description: 'short_description_value',
long_description: 'long_description_value',
}],
},
delivery_stats: {
test_delivery_stat: {
delivered: 1,
missing: 0,
pending: 0,
spam: 0,
inbox: 0,
total: 1,
provider: 'provider_value',
categories: {
primary: 1,
updates: 0,
}
}
}
}
}
```
- #### destroy
[API Reference](https://documentation.mailgun.com/docs/inboxready/api-reference/optimize/inboxready/inbox-placement/delete-v4-inbox-results--result-)
Delete the result and all associated information.
`mg.inboxPlacements.results.destroy(IBPResultId)`
Example:
```JS
mg.inboxPlacements.results.destroy(IBPResultId)
.then(data => console.log(data)) // logs response data
.catch(err => console.error(err)); //logs any error
```
Promise returns: status object
```JS
{
status: 200,
message: 'deleted'
}
```
- #### getResultByShareId
Get a result by the share ID.
[API Reference](https://documentation.mailgun.com/docs/inboxready/api-reference/optimize/inboxready/inbox-placement/get-v4-inbox-sharing-public--shareid-)
```js
mg.inboxPlacements.results.getResultByShareId('result_sharing_id')
```
Example:
```JS
mg.inboxPlacements.results.getResultByShareId('result_sharing_id')
.then(data => console.log(data)) // logs response data
.catch(err => console.error(err)); //logs any error
```
Promise returns: Inbox Placement result item
```JS
{
status: 200,
inboxPlacementResult: {
rid: 'rid_value',
result_id: 'result_id_value',
AccountID: 'AccountID_value',
KeyBoxID: 'KeyBoxID_value',
keybox_email: 'keybox_email_value',
subject: 'subject_value',
sender: 'sender_value',
seedlist_name: 'seedlist_name_value',
created_at: new Date('2024-08-09T14:32:57.183Z'),
updated_at: new Date('2024-08-11T14:32:57.183Z'),
status: 'status_value',
CreatedTS: 1723214101728,
attributes: {
attribute_value: 'attribute_value_value'
},
campaign_id: 'campaign_id_value',
sharing_enabled: true,
sharing_id: 'sharing_id_value',
sharing_expires_at: new Date('2024-08-14T14:32:57.183Z'),
Box: {
Id: 'box_Id_value',
kid: 'box_kid_value',
AccountID: 'box_AccountID_value',
created_at: new Date('2024-08-11T14:32:57.183Z'),
updated_at: new Date('2024-08-12T14:32:57.183Z'),
last_result_at: new Date('2024-08-13T14:32:57.183Z'),
Seeds: null,
target_email: 'box_target_email_value',
sending_domains: null,
has_results: true,
name: 'box_name_value',
seed_filter: 'box_seed_filter_value',
mailing_list: 'box_mailing_list_value',
CreatedTS: 1723214101728,
tags: ['tag_value'],
SeedQuality: 100,
is_auto_generated: true,
},
seed_results: [{
email: 'seed_result_email_value',
provider: 'seed_result_provider_value',
destination: 'seed_result_destination_value',
state: 'seed_result_state_value',
originating_ip: 'seed_result_originating_ip_value',
tags: ['seed_result_tag_value'],
dkim: 'seed_result_dkim_value',
spf: 'seed_result_spf_value',
dmarc: 'seed_result_dmarc_value',
headers: [{
key: 'seed_result_header_key_value',
value: 'seed_result_header_value_value',
}],
extensions: {
category: 'seed_result_extensions_category_value',
}
}],
spamassassin: {
is_spam: false,
score: 1,
required: 1,
rules: [{
name: 'rule_name_value',
points: 100,
short_description: 'short_description_value',
long_description: 'long_description_value',
}],
},
delivery_stats: {
test_delivery_stat: {
delivered: 1,
missing: 0,
pending: 0,
spam: 0,
inbox: 0,
total: 1,
provider: 'provider_value',
categories: {
primary: 1,
updates: 0,
}
}
}
}
}
```
- #### Attributes
- #### list
[API Reference](https://documentation.mailgun.com/docs/inboxready/api-reference/optimize/inboxready/inbox-placement/get-v4-inbox-results-a)
`mg.inboxPlacements.results.attributes.list()`
Example:
```JS
mg.inboxPlacements.results.attributes.list()
.then(data => console.log(data)) // logs response data
.catch(err => console.error(err)); //logs any error
```
Promise returns: results attributes
```JS
{
status: 200,
items:[{
attribute: 'available attribute',
values: ['attribute_value', ...]
}, ...]
}
```
- #### get
[API Reference](https://documentation.mailgun.com/docs/inboxready/api-reference/optimize/inboxready/inbox-placement/get-v4-inbox-results-a--attribute-)
`mg.inboxPlacements.attributes.get('attribute_name');`
Example:
```JS
mg.inboxPlacements.results.attributes.get('attribute_name')
.then(data => console.log(data)) // logs response data
.catch(err => console.error(err)); //logs any error
```
Promise returns: results attribute
```JS
{
status: 200,
items: {
attribute: 'attribute_name',
values: ['attribute_value', ...]
}
}
```
- #### Filters
- #### list
[API Reference](https://documentation.mailgun.com/docs/inboxready/api-reference/optimize/inboxready/inbox-placement/get-v4-inbox-results--filters)
`mg.inboxPlacements.results.filters.list()`
Example:
```JS
mg.inboxPlacements.results.filters.list()
.then(data => console.log(data)) // logs response data
.catch(err => console.error(err)); //logs any error
```
Promise returns: SeedsLists filters
```JS
{
status: 200,
supported_filters:{
filters: [
{
parameter: 'parameter_name',
description: 'parameter_description'
}, ....
]
}
}
```
- #### Sharing
- #### get
The sharing status of a result.
[API Reference](https://documentation.mailgun.com/docs/inboxready/api-reference/optimize/inboxready/inbox-placement/get-v4-inbox-sharing--result-)
`mg.inboxPlacements.results.sharing.get('result_id');`
Example:
```JS
mg.inboxPlacements.results.sharing.get('result_id');
.then(data => console.log(data)) // logs response data
.catch(err => console.error(err)); //logs any error
```
Promise returns: IPRSharingResult
```JS
{
status: 200,
result_id: 'result_id',
expires_at: new Date('2024-08-12T14:32:57.183Z'),
enabled: true,
url_id: 'result_sharing_id',
url: 'url-to-shared-result-page',
api_url: 'url-shared-result-page-in-json'
}
```
- #### update
Change the sharing status of a result or create a new share URL
[API Reference](https://documentation.mailgun.com/docs/inboxready/api-reference/optimize/inboxready/inbox-placement/put-v4-inbox-sharing--result-)
`mg.inboxPlacements.results.sharing.update('result_id', IPRSharingUpdateData);`
Example:
```JS
mg.inboxPlacements.results.sharing.update('result_id', { enabled: false });
.then(data => console.log(data)) // logs response data
.catch(err => console.error(err)); //logs any error
```
Promise returns: IPRSharingResult
```JS
{
status: 200,
result_id: 'result_id',
expires_at: new Date('2024-08-12T14:32:57.183Z'),
enabled: false,
url_id: 'result_sharing_id',
url: '',
api_url: ''
}
```
- #### Run test
Create and run a new inbox placement test.
Either 'html' or 'template_name' field should be provided.
'variables' are Template variables, which could be used in html or template. You can use next recipient variables inside Template variables, which will be filled for every seed automatically: %recipient.first_name%, %recipient.last_name%.
[API Reference](https://documentation.mailgun.com/docs/inboxready/api-reference/optimize/inboxready/inbox-placement/post-v4-inbox-tests)
`mg.inboxPlacements.runTest(InboxPlacementsData);`
Example:
```JS
mg.inboxPlacements.runTest({
from: 'Excited User <mailgun@sandbox-123.mailgun.org>',
subject: 'Subject of test email',
provider_filter: ['o365.mailgun.email'],
html: `<html><body>
<h4>Waiting for inbox placements support in mailgun.js SDK?</h4>
<h3>We are working on this </h3>
</body></html>`,
template_name: 'name-of-the-template-you-made-in-mailgun-web-portal';
variables: JSON.stringify({
'template_variable_name': 'template_variable_value'
},
seed_list: 'previously-generated-seed-list',
})
.then(data => console.log(data)) // logs response data
.catch(err => console.error(err)); //logs any error
```
Promise returns: InboxPlacementsTestResult
```JS
{
status: 200,
result_id: 'result_id',
links: {
results: 'link to result page',
}
}
### DKIM Management
- #### update
Updates DKIM key rotation configuration for a domain
[API Reference](https://documentation.mailgun.com/docs/mailgun/api-reference/send/mailgun/dkim-security/put-v1-dkim-management-domains--name--rotation)
`mg.dkimManagement.update(domain_name, configurationData)`
Example:
```JS
mg.dkimManagement.update('foobar.example.com', {
rotation_enabled: true,
rotation_interval: '120h0m0s'
})
.then(data => console.log(data)) // logs response data
.catch(err => console.error(err)); //logs any error
```
Promise returns: DKIMUpdateRotationResult
```JS
{
domain: {
id: 'domain_id',
account_id: 'account_id',
sid: 'sid',
name: 'foobar.example.com',
state: 'active',
active_selector: 'active_selector',
rotation_enabled: 'true',
rotation_interval: '120h0m0s',
records: [
{
name: 'record name',
type: 'CNAME',
identifier: 'DKIM',
value: 'record value',
comment: 'Customer DKIM CNAME Record'
},
....
]
}
}
```
- #### rotateImmediately
Immediately rotate your DKIM key. This will trigger a rotation even if auto-rotation is disabled on the domain.
[API Reference](https://documentation.mailgun.com/docs/mailgun/api-reference/send/mailgun/dkim-security/post-v1-dkim-management-domains--name--rotate)
`mg.dkimManagement.rotateImmediately(domain_name)`
Example:
```JS
mg.dkimManagement.rotateImmediately('foobar.example.com')
.then(data => console.log(data)) // logs response data
.catch(err => console.error(err)); //logs any error
```
Promise returns: DKIMRotateImmediatelyResult
```JS
{
message: "ok";
}
```
### Bounce Classification
- #### list
Returns bounce classification entities
[API Reference](https://documentation.mailgun.com/docs/mailgun/api-reference/send/mailgun/bounce-classification/post-v2-bounce-classification-metrics)
`mg.bounceClassification.list(query)`
Example:
```JS
mg.bounceClassification.bounceClassification({
start: new Date('2025-12-01T13:00:00Z'),
end: new Date('2025-12-31T13:05:00Z'),
include_subaccounts: true,
resolution: 'day',
duration: '48h',
dimensions: [
'entity-name',
'domain.name'
],
metrics: [
'critical_bounce_count',
'non_critical_bounce_count',
'critical_delay_count',
'non_critical_delay_count',
'delivered_smtp_count',
'classified_failures_count',
'critical_bounce_rate',
'non_critical_bounce_rate',
'critical_delay_rate',
'non_critical_delay_rate'
],
filter: {
AND: [
{
attribute: 'domain.name',
comparator: '=',
values: [
{
value: 'example.com'
}
]
}
]
},
pagination: {
limit: 25,
skip: 0,
sort: 'entity-name:asc'
}
})
.then(data => console.log(data)) // logs response data
.catch(err => console.error(err)); //logs any error
```
Promise returns: BounceClassificationResult
```JS
{
start: new Date('2025-12-01T13:00:00.000Z'),
end: new Date('2025-12-31T13:05:00.000Z'),
resolution: 'day',
duration: '720h5m0s',
dimensions: [ 'entity-name', 'domain.name' ],
pagination: { sort: 'entity-name:asc', skip: 0, limit: 25, total: 1 },
items: [
{
'account.name': 'subaccount name',
'entity-name': 'Gmail',
'domain.name': 'example.com',
'envelope.i-ip-pool-name': 'default',
'envelope.sending-ip': '1.2.3.4',
timestamp: 'Tue, 02 Dec 2025 22:04:05 +0000',
tags: 'daily, campaign1',
metrics: {
'critical_bounce_count': 10,
'non_critical_bounce_count': 20,
'critical_delay_count': 30,
'non_critical_delay_count': 40,
'classified_failures_count': 100,
'delivered_smtp_count': 1000,
'critical_bounce_rate': 1,
'non_critical_bounce_rate': 2,
'critical_delay_rate': 3,
'non_critical_delay_rate': 4
}
}
]
}
```
### Tags
Mailgun allows you to tag your email with unique identifiers. Tags are visible via our analytics tags API endpoint.
- #### list
Gets the list of all tags, or filtered by tag prefix, for an account
[API Reference](https://documentation.mailgun.com/docs/mailgun/api-reference/send/mailgun/tags-new/post-v1-analytics-tags)
`mg.tags.list(query)`
Example:
```JS
mg.tags.list({
// tag: '<tag_name>'
include_subaccounts: true,
include_metrics: true,
pagination: {
include_total: true
sort: 'lastseen:asc',
// skip: 1
// limit: 10
}
})
.then(data => console.log(data)) // logs response data
.catch(err => console.error(err)); //logs any error
```
Promise returns: TagsListResult
```JS
{
items: [
{
account_id: "12345",
parent_account_id: "12345",
tag: "tag1",
description: "tag used to identify campaign 1",
first_seen: new Date('2026-01-08T13:00:00Z'),
last_seen: new Date('2026-01-08T13:00:00Z'),
metrics: {},
account_name: "account1"
},
...
],
pagination: {
"sort": "lastseen:asc",
"total": 10,
}
}
```
- #### limits
Gets the tag limit and current number of unique tags for an account
[API Reference](https://documentation.mailgun.com/docs/mailgun/api-reference/send/mailgun/tags-new/get-v1-analytics-tags-limits)
`mg.tags.limits()`
Example:
```JS
mg.tags.limits()
.then(data => console.log(data)) // logs response data
.catch(err => console.error(err)); //logs any error
```
Promise returns: TagLimitsResult
```JS
{
limit: 0,
count: 0,
limit_reached: true
}
```
- #### update
Updates the tag description for an account
[API Reference](https://documentation.mailgun.com/docs/mailgun/api-reference/send/mailgun/tags-new/put-v1-analytics-tags)
`mg.tags.update(tagName, description)`
Example:
```JS
mg.tags.update('<tag_name>', 'description text')()
.then(data => console.log(data)) // logs response data
.catch(err => console.error(err)); //logs any error
```
Promise returns: MessageResponse
```JS
{
message: 'Tag updated'
}
```
- #### destroy
Deletes the tag for an account
[API Reference](https://documentation.mailgun.com/docs/mailgun/api-reference/send/mailgun/tags-new/delete-v1-analytics-tags)
`mg.tags.destroy(tagName)`
Example:
```JS
mg.tags.destroy('<tag_name>')()
.then(data => console.log(data)) // logs response data
.catch(err => console.error(err)); //logs any error
```
Promise returns: MessageResponse
```JS
{
message: 'Tag updated'
}
```
### Custom Message Limit
The custom message limit imposes a hard limit on how many messages your account can send during a calendar month.
- #### get
Fetch the details of custom sending limit on the account
[API Reference](https://documentation.mailgun.com/docs/mailgun/api-reference/send/mailgun/custom-message-limit/get-v5-accounts-limit-custom-monthly)
`mg.customMessageLimit.get()`
Example:
```JS
mg.customMessageLimit.get()
.then(data => console.log(data)) // logs response data
.catch(err => console.error(err)); //logs any error
```
Promise returns: SendingLimitResult
```JS
{
current: 0,
limit: 2000,
period: '1m'
}
```
- #### set
Set a custom sending limit
[API Reference](https://documentation.mailgun.com/docs/mailgun/api-reference/send/mailgun/custom-message-limit/put-v5-accounts-limit-custom-monthly)
`mg.customMessageLimit.set(limit:number)`
Example:
```JS
mg.customMessageLimit.set(2001)
.then(data => console.log(data)) // logs response data
.catch(err => console.error(err)); //logs any error
```
Promise returns: SuccessResult
```JS
{
success: true
}
```
- #### destroy
Delete a custom sending limit
[API Reference](https://documentation.mailgun.com/docs/mailgun/api-reference/send/mailgun/custom-message-limit/delete-v5-accounts-limit-custom-monthly)
`mg.customMessageLimit.destroy()`
Example:
```JS
mg.customMessageLimit.destroy()
.then(data => console.log(data)) // logs response data
.catch(err => console.error(err)); //logs any error
```
Promise returns: SuccessResult
```JS
{
success: true
}
```
- #### enable
Re-enable an account that was disabled for reaching the custom sending limit
[API Reference](https://documentation.mailgun.com/docs/mailgun/api-reference/send/mailgun/custom-message-limit/put-v5-accounts-limit-custom-enable)
`mg.customMessageLimit.enable()`
Example:
```JS
mg.customMessageLimit.enable()
.then(data => console.log(data)) // logs response data
.catch(err => console.error(err)); //logs any error
```
Promise returns: SuccessResult
```JS
{
success: true
}
```
### Account Management
Perform account-level CRUD operations.
[API Reference](https://documentation.mailgun.com/docs/mailgun/api-reference/send/mailgun/account-management)
- #### updateAccountSettings
Updates variable account settings
[API Reference](https://documentation.mailgun.com/docs/mailgun/api-reference/send/mailgun/account-management/put-v5-accounts)
`mg.accountManagement.updateAccountSettings(settingsObj)`
Example:
```js
mg.accountManagement.updateAccountSettings({
name: 'meta test account',
inactive_session_timeout: 64800,
absolute_session_timeout: 64800,
logout_redirect_url: 'http://example.com/logout'
})
.then(msg => console.log(msg)) // logs response data
.catch(err => console.error(err)); // logs any error
```
Promise returns:
```JS
{
status: 200,
message: 'Account: 123456 info has been updated.'
}
```
- #### getWebhookSigningKey
Get webhook signing key saved on the account
[API Reference](https://documentation.mailgun.com/docs/mailgun/api-reference/send/mailgun/account-management/get-v5-accounts-http_signing_key)
`mg.accountManagement.getWebhookSigningKey()`
Example:
```js
mg.accountManagement.getWebhookSigningKey()
.then(msg => console.log(msg)) // logs response data
.catch(err => console.error(err)); // logs any error
```
Promise returns:
```JS
{
status: 200,
http_signing_key: '12345'
}
```
- #### createWebhookSigningKey
Create or regenerate webhook signing key on an account
[API Reference](https://documentation.mailgun.com/docs/mailgun/api-reference/send/mailgun/account-management/post-v5-accounts-http_signing_key)
`mg.accountManagement.createWebhookSigningKey()`
Example:
```js
mg.accountManagement.createWebhookSigningKey()
.then(msg => console.log(msg)) // logs response data
.catch(err => console.error(err)); // logs any error
```
Promise returns:
```JS
{
status: 200,
http_signing_key: '123654',
message: 'regenerated HTTP signing key for account: 1234'
}
```
- #### getSandboxAuthorizedRecipients
Get authorized email recipients for a sandbox domain
[API Reference](https://documentation.mailgun.com/docs/mailgun/api-reference/send/mailgun/account-management/get-v5-sandbox-auth_recipients)
`mg.accountManagement.getSandboxAuthorizedRecipients()`
Example:
```js
mg.accountManagement.getSandboxAuthorizedRecipients()
.then(msg => console.log(msg)) // logs response data
.catch(err => console.error(err)); // logs any error
```
Promise returns:
```JS
{
status: 200,
limit: 5,
recipients: [
{
email: 'authorized@example.com',
activated: true,
}
]
}
```
- #### addSandboxAuthorizedRecipient
Add authorized email recipient for a sandbox domain
[API Reference](https://documentation.mailgun.com/docs/mailgun/api-reference/send/mailgun/account-management/post-v5-sandbox-auth_recipients)
`mg.accountManagement.addSandboxAuthorizedRecipient(email)`
Example:
```js
mg.accountManagement.addSandboxAuthorizedRecipient('newuser@example.com')
.then(msg => console.log(msg)) // logs response data
.catch(err => console.error(err)); // logs any error
```
Promise returns:
```JS
{
status: 200,
recipient: {
email: 'newuser@example.com',
activated: false,
}
}
```
- #### removeSandboxAuthorizedRecipient
Remove an authorized sandbox domain email recipient
[API Reference](https://documentation.mailgun.com/docs/mailgun/api-reference/send/mailgun/account-management/delete-v5-sandbox-auth_recipients-email)
`mg.accountManagement.removeSandboxAuthorizedRecipient(email)`
Example:
```js
mg.accountManagement.removeSandboxAuthorizedRecipient('olduser@example.com')
.then(msg => console.log(msg)) // logs response data
.catch(err => console.error(err)); // logs any error
```
Promise returns:
```JS
{
status: 200,
message: 'Sandbox recipient olduser@example.com deleted.'
}
```
- #### resendActivationEmail
Resend account activation email to the account owner
[API Reference](https://documentation.mailgun.com/docs/mailgun/api-reference/send/mailgun/account-management/post-v5-accounts-resend_activation_email)
`mg.accountManagement.resendActivationEmail()`
Example:
```js
mg.accountManagement.resendActivationEmail()
.then(msg => console.log(msg)) // logs response data
.catch(err => console.error(err)); // logs any error
```
Promise returns:
```JS
{
success: true
}
```
- #### updateAccountFeature
Update account feature
[API Reference](https://documentation.mailgun.com/docs/mailgun/api-reference/send/mailgun/account-management/put-v5-accounts-features)
`mg.accountManagement.updateAccountFeature(featureData)`
Example:
```js
mg.accountManagement.updateAccountFeature({
ai_insights: { enabled: true },
webhooks_redact_pii: { enabled: false }
})
.then(msg => console.log(msg)) // logs response data
.catch(err => console.error(err)); // logs any error
```
Promise returns:
```JS
{
success: true
}
```
## Pagination
Most of the methods that return items in a list support pagination.
There are two ways to receive part of the list:
1. Provide properties `limit` and `page` in the query.
This way uses more frequently in the SDK and works for the next methods:
- `mg.domains.domainTags.list()`
- `mg.domains.domainTemplates.list()`
- `mg.domains.domainTemplates.listVersions()`
- `mg.events.get()`
- `mg.lists.list()`
- `mg.lists.members.listMembers()`
- `mg.validate.list()`
- `mg.suppressions.list()`
The general idea is that after you made the first call with a limit property in the query you will receive a response with `pages` property in it. This property implements the next interface:
```TS
{
previous: {
id: string;
page: string;
iteratorPosition: string | undefined;
url: string
};
first: {
id: string;
page: string;
iteratorPosition: string | undefined;
url: string
};
last: {
id: string;
page: string;
iteratorPosition: string | undefined;
url: string
};
next: {
id: string;
page: string;
iteratorPosition: string | undefined;
url: string
};
}
```
To receive the next page you need to add the `page` property to the query argument. This property should contain a string value from `page` property in response.pages.(previous/first/last/next).
Example:
```Js
// first call
const listMembers = await mg.lists.members.listMembers('your_mailing_list', { limit: 2 });
/* response
{
items: [
{
address: 'test-0@example.com',
name: 'test name 0',
subscribed: true,
vars: [Object]
},
{
address: 'test-1@example.com',
name: 'test name 1',
subscribed: true,
vars: [Object]
}
],
pages: {
first: {
id: 'first',
page: '?page=first&limit=2',
iteratorPosition: undefined,
url: 'https://your_domain/v3/lists/your_mailing_list/members/pages?page=first&limit=2'
},
last: {
id: 'last',
page: '?page=last&limit=2',
iteratorPosition: undefined,
url: 'https://your_domain/v3/lists/your_mailing_list/members/pages?page=last&limit=2'
},
next: {
id: 'next',
page: '?page=next&address=test-1%40example.com&limit=2',
iteratorPosition: 'test-1@example.com',
url: 'https://your_domain/v3/lists/your_mailing_list/members/pages?page=next&address=test-1%40example.com&limit=2'
},
previous: {
id: 'previous',
page: '?page=prev&address=test-0%40example.com&limit=2',
iteratorPosition: 'test-0@example.com',
url: 'https://your_domain/v3/lists/your_mailing_list/members/pages?page=prev&address=test-0%40example.com&limit=2'
}
}
}
*/
// second call
const listMembers = await mg.lists.members.listMembers(
'your_mailing_list',
{
limit: 2,
page: '?page=next&address=test-1%40example.com&limit=2'
}
);
/* response
{
items: [
{
address: 'test-2@example.com',
name: 'test name 2',
subscribed: true,
vars: [Object]
},
{
address: 'test-3@example.com',
name: 'test name 3',
subscribed: true,
vars: [Object]
}
],
pages: {
first: {
id: 'first',
page: '?page=first&limit=2',
iteratorPosition: undefined,
url: 'https://your_domain/v3/lists/your_mailing_list/members/pages?page=first&limit=2'
},
last: {
id: 'last',
page: '?page=last&limit=2',
iteratorPosition: undefined,
url: 'https://your_domain/v3/lists/your_mailing_list/members/pages?page=last&limit=2'
},
next: {
id: 'next',
page: '?page=next&address=test-3%40example.com&limit=2',
iteratorPosition: 'test-3@example.com',
url: 'https://your_domain/v3/lists/your_mailing_list/members/pages?page=next&address=test-3%40example.com&limit=2'
},
previous: {
id: 'previous',
page: '?page=prev&address=test-2%40example.com&limit=2',
iteratorPosition: 'test-2@example.com',
url: 'https://your_domain/v3/lists/your_mailing_list/members/pages?page=prev&address=test-2%40example.com&limit=2'
}
}
}
*/
```
2. The second option of navigation is to provide properties `limit` and `skip` in the query. Currently this way is being used only in a few places:
- `mg.domains.list()`
- `mg.domains.domainCredentials.list()`
- `mg.routes.list()`
- `mg.webhooks.list()`
The main idea here is quite simple, you just need to provide how many records from the start of a list you want to skip and how many to receive. You can do it with the query parameter in each method.
Example:
```js
const listDomainCredentials = await client.domains.domainCredentials.list(
'your_domain_name',
{
skip: 10,
limit: 1
}
);
```
## Browser Demo
For this demo to work, you'll need to install and run `http-proxy` locally. Install it with:
```sh
npm install -g http-proxy
```
Then run the following command from the mailgun-js directory:
```sh
http-server -p 4001 --proxy="https://api.mailgun.net"
```
Demo should be up and running at http://0.0.0.0:4001/examples/
# Development
## Requirements
- Requires node.js >= 18.x
Install node dependencies with:
```sh
npm install
```
## Build
Build for dev purposes(without minimizing)
```sh
npm run build
```
Build for release purposes(include minimizing)
```sh
npm run build:release
```
## Merging changes
Before PR merge check that commits info will be correctly added to the CHANGELOG.md file:
'npm run release -- --dry-run'
> CI process isn't working currently, so please manually run ```npm run test```
## Tests
```sh
npm run tests
```
Watch tests with
```sh
npm run watch-tests
```
To test new functionality locally using ```npm link``` please use npm script ```npm run link```.
This is needed for correct exporting d.ts files.
## Release Process
Releases occur after feature branches have been tested and merged into master.
First, checkout master and pull the latest commits.
```sh
git checkout master
git pull
```
Next, run ```npm run release```.
After that, `cd ./dist` and then run ```npm login``` and ```npm publish``` to publish changes on npm.next-auth
Version 4.24.14
ISC
Published by Iain Collins (me@iaincollins.com)
View License Text
ISC License Copyright (c) 2018-2021, Iain Collins Copyright (c) 2021-2025, Better Auth Inc. Permission to use, copy, modify, and/or distribute this software for any purpose with or without fee is hereby granted, provided that the above copyright notice and this permission notice appear in all copies. THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
next
Version 16.2.9
MIT
View License Text
The MIT License (MIT) Copyright (c) 2025 Vercel, Inc. Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
pg-query-stream
Version 4.15.0
MIT
Published by Brian M. Carlson
View License Text
The MIT License (MIT) Copyright (c) 2013 Brian M. Carlson Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
pg
Version 8.21.0
MIT
Published by Brian Carlson (brian.m.carlson@gmail.com)
View License Text
MIT License Copyright (c) 2010 - 2021 Brian Carlson Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
react-day-picker
Version 10.0.1
MIT
Published by Giampaolo Bellavite (io@gpbl.dev)
View License Text
The MIT License (MIT) Copyright (c) 2014-2026 Giampaolo Bellavite <io@gpbl.dev> and contributors Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
react-dom
Version 19.2.7
MIT
View License Text
MIT License Copyright (c) Meta Platforms, Inc. and affiliates. Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
react-hook-form
Version 7.79.0
MIT
Published by Beier (bluebill1049@hotmail.com)
View License Text
MIT License Copyright (c) 2019-present Beier(Bill) Luo Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
react-intersection-observer
Version 10.0.3
MIT
Published by Daniel Schmidt
View License Text
The MIT License (MIT) Copyright (c) 2025 React Intersection Observer authors Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
react
Version 19.2.7
MIT
View License Text
MIT License Copyright (c) Meta Platforms, Inc. and affiliates. Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
redis
Version 6.0.0
MIT
View License Text
# Node-Redis
[](https://github.com/redis/node-redis/actions/workflows/tests.yml)
[](https://codecov.io/gh/redis/node-redis)
[](https://github.com/redis/node-redis/blob/master/LICENSE)
[](https://discord.gg/redis)
[](https://www.twitch.tv/redisinc)
[](https://www.youtube.com/redisinc)
[](https://twitter.com/redisinc)
node-redis is a modern, high performance [Redis](https://redis.io) client for Node.js.
## How do I Redis?
[Learn for free at Redis University](https://university.redis.com/)
[Build faster with the Redis Launchpad](https://launchpad.redis.com/)
[Try the Redis Cloud](https://redis.com/try-free/)
[Dive in developer tutorials](https://developer.redis.com/)
[Join the Redis community](https://redis.com/community/)
[Work at Redis](https://redis.com/company/careers/jobs/)
## Installation
Start a redis via docker:
```bash
docker run -p 6379:6379 -d redis:8.0-rc1
```
To install node-redis, simply:
```bash
npm install redis
```
> "redis" is the "whole in one" package that includes all the other packages. If you only need a subset of the commands,
> you can install the individual packages. See the list below.
## Packages
| Name | Description |
| ---------------------------------------------- | ------------------------------------------------------------------------------------------- |
| [`redis`](https://github.com/redis/node-redis/tree/master/packages/redis) | The client with all the ["redis-stack"](https://github.com/redis-stack/redis-stack) modules |
| [`@redis/client`](https://github.com/redis/node-redis/tree/master/packages/client) | The base clients (i.e `RedisClient`, `RedisCluster`, etc.) |
| [`@redis/bloom`](https://github.com/redis/node-redis/tree/master/packages/bloom) | [Redis Bloom](https://redis.io/docs/data-types/probabilistic/) commands |
| [`@redis/json`](https://github.com/redis/node-redis/tree/master/packages/json) | [Redis JSON](https://redis.io/docs/data-types/json/) commands |
| [`@redis/search`](https://github.com/redis/node-redis/tree/master/packages/search) | [RediSearch](https://redis.io/docs/interact/search-and-query/) commands |
| [`@redis/time-series`](https://github.com/redis/node-redis/tree/master/packages/time-series) | [Redis Time-Series](https://redis.io/docs/data-types/timeseries/) commands |
| [`@redis/entraid`](https://github.com/redis/node-redis/tree/master/packages/entraid) | Secure token-based authentication for Redis clients using Microsoft Entra ID |
> Looking for a high-level library to handle object mapping?
> See [redis-om-node](https://github.com/redis/redis-om-node)!
## Usage
### Basic Example
```typescript
import { createClient } from "redis";
const client = await createClient()
.on("error", (err) => console.log("Redis Client Error", err))
.connect();
await client.set("key", "value");
const value = await client.get("key");
client.destroy();
```
The above code connects to localhost on port 6379. To connect to a different host or port, use a connection string in
the format `redis[s]://[[username][:password]@][host][:port][/db-number]`:
```typescript
createClient({
url: "redis://alice:foobared@awesome.redis.server:6380",
});
```
You can also use discrete parameters, UNIX sockets, and even TLS to connect. Details can be found in
the [client configuration guide](https://github.com/redis/node-redis/blob/master/docs/client-configuration.md).
To check if the the client is connected and ready to send commands, use `client.isReady` which returns a boolean.
`client.isOpen` is also available. This returns `true` when the client's underlying socket is open, and `false` when it
isn't (for example when the client is still connecting or reconnecting after a network error).
### Redis Commands
There is built-in support for all of the [out-of-the-box Redis commands](https://redis.io/commands). They are exposed
using the raw Redis command names (`HSET`, `HGETALL`, etc.) and a friendlier camel-cased version (`hSet`, `hGetAll`,
etc.):
```typescript
// raw Redis commands
await client.HSET("key", "field", "value");
await client.HGETALL("key");
// friendly JavaScript commands
await client.hSet("key", "field", "value");
await client.hGetAll("key");
```
Modifiers to commands are specified using a JavaScript object:
```typescript
await client.set("key", "value", {
EX: 10,
NX: true,
});
```
Replies will be transformed into useful data structures:
```typescript
await client.hGetAll("key"); // { field1: 'value1', field2: 'value2' }
await client.hVals("key"); // ['value1', 'value2']
```
`Buffer`s are supported as well:
```typescript
const client = createClient().withTypeMapping({
[RESP_TYPES.BLOB_STRING]: Buffer
});
await client.hSet("key", "field", Buffer.from("value")); // 'OK'
await client.hGet("key", "field"); // { field: <Buffer 76 61 6c 75 65> }
```
For commands that return serialized binary payloads, such as `DUMP`, map blob strings to `Buffer` before using the result with commands like `RESTORE`:
```typescript
const binaryClient = createClient().withTypeMapping({
[RESP_TYPES.BLOB_STRING]: Buffer
});
const dump = await binaryClient.dump("source");
await binaryClient.restore("destination", 0, dump);
```
### Unsupported Redis Commands
If you want to run commands and/or use arguments that Node Redis doesn't know about (yet!) use `.sendCommand()`:
```typescript
await client.sendCommand(["SET", "key", "value", "NX"]); // 'OK'
await client.sendCommand(["HGETALL", "key"]); // ['key1', 'field1', 'key2', 'field2']
```
### Transactions (Multi/Exec)
Start a [transaction](https://redis.io/topics/transactions) by calling `.multi()`, then chaining your commands. When
you're done, call `.exec()` and you'll get an array back with your results:
```typescript
await client.set("another-key", "another-value");
const [setKeyReply, otherKeyValue] = await client
.multi()
.set("key", "value")
.get("another-key")
.exec(); // ['OK', 'another-value']
```
You can also [watch](https://redis.io/topics/transactions#optimistic-locking-using-check-and-set) keys by calling
`.watch()`. Your transaction will abort if any of the watched keys change.
### Blocking Commands
In v4, `RedisClient` had the ability to create a pool of connections using an "Isolation Pool" on top of the "main"
connection. However, there was no way to use the pool without a "main" connection:
```javascript
const client = await createClient()
.on("error", (err) => console.error(err))
.connect();
await client.ping(client.commandOptions({ isolated: true }));
```
In v5 we've extracted this pool logic into its own class—`RedisClientPool`:
```javascript
const pool = await createClientPool()
.on("error", (err) => console.error(err))
.connect();
await pool.ping();
```
### Pub/Sub
See the [Pub/Sub overview](https://github.com/redis/node-redis/blob/master/docs/pub-sub.md).
### Scan Iterator
[`SCAN`](https://redis.io/commands/scan) results can be looped over
using [async iterators](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Symbol/asyncIterator):
```typescript
for await (const key of client.scanIterator()) {
// use the key!
await client.get(key);
}
```
This works with `HSCAN`, `SSCAN`, and `ZSCAN` too:
```typescript
for await (const { field, value } of client.hScanIterator("hash")) {
}
for await (const member of client.sScanIterator("set")) {
}
for await (const { score, value } of client.zScanIterator("sorted-set")) {
}
```
You can override the default options by providing a configuration object:
```typescript
client.scanIterator({
TYPE: "string", // `SCAN` only
MATCH: "patter*",
COUNT: 100,
});
```
### Disconnecting
The `QUIT` command has been deprecated in Redis 7.2 and should now also be considered deprecated in Node-Redis. Instead
of sending a `QUIT` command to the server, the client can simply close the network connection.
`client.QUIT/quit()` is replaced by `client.close()`. and, to avoid confusion, `client.disconnect()` has been renamed to
`client.destroy()`.
```typescript
client.destroy();
```
### Client Side Caching
Node Redis v5 adds support for [Client Side Caching](https://redis.io/docs/manual/client-side-caching/), which enables clients to cache query results locally. The Redis server will notify the client when cached results are no longer valid.
```typescript
// Enable client side caching with RESP3
const client = createClient({
RESP: 3,
clientSideCache: {
ttl: 0, // Time-to-live (0 = no expiration)
maxEntries: 0, // Maximum entries (0 = unlimited)
evictPolicy: "LRU" // Eviction policy: "LRU" or "FIFO"
}
});
```
See the [V5 documentation](https://github.com/redis/node-redis/blob/master/docs/v5.md#client-side-caching) for more details and advanced usage.
### Auto-Pipelining
Node Redis will automatically pipeline requests that are made during the same "tick".
```typescript
client.set("Tm9kZSBSZWRpcw==", "users:1");
client.sAdd("users:1:tokens", "Tm9kZSBSZWRpcw==");
```
Of course, if you don't do something with your Promises you're certain to
get [unhandled Promise exceptions](https://nodejs.org/api/process.html#process_event_unhandledrejection). To take
advantage of auto-pipelining and handle your Promises, use `Promise.all()`.
```typescript
await Promise.all([
client.set("Tm9kZSBSZWRpcw==", "users:1"),
client.sAdd("users:1:tokens", "Tm9kZSBSZWRpcw=="),
]);
```
### Programmability
See the [Programmability overview](https://github.com/redis/node-redis/blob/master/docs/programmability.md).
### Clustering
Check out the [Clustering Guide](https://github.com/redis/node-redis/blob/master/docs/clustering.md) when using Node Redis to connect to a Redis Cluster.
### Events
The Node Redis client class is an Nodejs EventEmitter and it emits an event each time the network status changes:
| Name | When | Listener arguments |
| ----------------------- | ---------------------------------------------------------------------------------- | --------------------------------------------------------- |
| `connect` | Initiating a connection to the server | _No arguments_ |
| `ready` | Client is ready to use | _No arguments_ |
| `end` | Connection has been closed (via `.disconnect()`) | _No arguments_ |
| `error` | An error has occurred—usually a network issue such as "Socket closed unexpectedly" | `(error: Error)` |
| `reconnecting` | Client is trying to reconnect to the server | _No arguments_ |
| `sharded-channel-moved` | See [here](https://github.com/redis/node-redis/blob/master/docs/pub-sub.md#sharded-channel-moved-event) | See [here](https://github.com/redis/node-redis/blob/master/docs/pub-sub.md#sharded-channel-moved-event) |
> :warning: You **MUST** listen to `error` events. If a client doesn't have at least one `error` listener registered and
> an `error` occurs, that error will be thrown and the Node.js process will exit. See the [ > `EventEmitter` docs](https://nodejs.org/api/events.html#events_error_events) for more details.
> The client will not emit [any other events](https://github.com/redis/node-redis/blob/master/docs/v3-to-v4.md#all-the-removed-events) beyond those listed above.
## Supported Redis versions
Node Redis is supported with the following versions of Redis:
| Version | Supported |
| ------- | ------------------ |
| 8.0.z | :heavy_check_mark: |
| 7.4.z | :heavy_check_mark: |
| 7.2.z | :heavy_check_mark: |
| < 7.2 | :x: |
> Node Redis should work with older versions of Redis, but it is not fully tested and we cannot offer support.
## Migration
- [From V3 to V4](https://github.com/redis/node-redis/blob/master/docs/v3-to-v4.md)
- [From V4 to V5](https://github.com/redis/node-redis/blob/master/docs/v4-to-v5.md)
- [V5](https://github.com/redis/node-redis/blob/master/docs/v5.md)
## Contributing
If you'd like to contribute, check out the [contributing guide](https://github.com/redis/node-redis/blob/master/CONTRIBUTING.md).
Thank you to all the people who already contributed to Node Redis!
[](https://github.com/redis/node-redis/graphs/contributors)
## License
This repository is licensed under the "MIT" license. See [LICENSE](https://github.com/redis/node-redis/blob/master/LICENSE).server-only@0.0.1
Version 0.0.1
MIT
tailwind-merge
Version 3.6.0
MIT
Published by Dany Castillo
View License Text
MIT License Copyright (c) 2021 Dany Castillo Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
uuid
Version 14.0.0
MIT
View License Text
The MIT License (MIT) Copyright (c) 2010-2020 Robert Kieffer and other contributors Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
zod
Version 4.4.3
MIT
Published by Colin McDonnell (zod@colinhacks.com)
View License Text
MIT License Copyright (c) 2025 Colin McDonnell Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
zustand
Version 5.0.14
MIT
Published by Paul Henschel
View License Text
MIT License Copyright (c) 2019 Paul Henschel Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
This page lists dependencies with licenses that require attribution or disclosure. Each package is listed with its license type, version, and links to source repositories where available.