Skip to content

anonacy/api

Repository files navigation

@anonacy/api

api image

About

Anonacy's v2 api enables simplified control over a Postal open-source mail server.

It is designed for email aliasing and can be easily deployed using docker on the same machine as Postal.

You can use the @anonacy/app project as a UI for the api.

Features

Available Planned
βœ… Email Alias Routing πŸ•‘ URL Endpoints
βœ… Address Endpoints πŸ•‘ User Authentication
βœ… Domain Management πŸ•‘ Org & Server Management
βœ… DNS Record Setup
βœ… Delivery Status Logs
βœ… Webhooks

Authorization

Uses the credentials system within postal to generate api keys. These automatically scope to the org & server within postal. Use header: Authorization: Bearer APIKEY or the @anonacy/app

Documentation

Full api documentation can be found here: https://api2.anonacy.com/docs/ or by running your own instance and navigating to the /docs route in a browser.

Installation

  • To deploy the api yourself, follow the guide in install.md
  • To contribute to the api or run locally, follow the guide in contributing.md

Built by hewπŸͺΆ

About

No description, website, or topics provided.

Resources

License

Security policy

Stars

Watchers

Forks

Packages

No packages published