Skip to content

Latest commit

 

History

History
40 lines (25 loc) · 1.51 KB

File metadata and controls

40 lines (25 loc) · 1.51 KB

@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🪶