Posture is a simple configurable mock SMTP server to test your emails built with Deno. It is not meant to actually deliver anything. This server was designed only for receiving and saving SMTP commands for development or testing purposes.
The SMTP server of this project implements the relevant parts of RFC 2821 to the best of my capacity/desire to for this project. To see what is implemented, you can peep the implementation list. If there are certain parts of the standard that you need that aren't supported or don't work as they should, feel free to make a PR or file an issue!
$ deno install --allow-net --allow-read --allow-write --allow-env --allow-plugin --unstable path/to/repo/app.tsI don't think I need to tell you why we need net access. As for the other ones:
- read for the config file and SQLite if you happen to use that and serving static files for the front-end app;
- write to use SQLite or MongoDB (Because of the MongoDB plugin that needs to be written to disk);
- env to allow access to environment variables;
- unstable for plugins for MongoDB (deno_mongo through denodb) and for bundling the client app;
- plugin for MongoDB plugin (deno_mongo through denodb);
Feel free to restrict allows such as read, write, env and plugin to the necessary paths.
- MongoDB
- PostgreSQL
- MySQL
- SQLite3
A simple Denon config is available to run the project in development. It was only tested with Denon@2.4.7.
denon startTODO
TODO
Here's a list of the tasks that are planned for each release to do:
The MVP for the Posture SMTP server allows basic testing of SMTP clients and validate sent emails during local development
- 4.5.3.1 - Size limits and minimums
- Tests
- Documentation
- Tests
- Documentation
- Data fetching mechanisms
- List view of sent emails
- Detail view of emails
- Tests
- Documentation
- Default config when nothing is provided.
The V2 of the Posture SMTP server allows authentication for securing online servers and includes SMTP over SSL.
- Handle commands that seem to require lookups
- EHLO
- VRFY
- EXPN
- Auth
- SSL
- Secure API (Optional)
- Add login (Optional)
Handle the remaining items to complete the initial ideas behind Posture
- Implement some kind of communication system when new messages are added to the Database that the server could listen to.
- CI/CD?
- Websocket or long polling connections to clients, SMTP Server or DB needs to implement some form of communication first
- CI/CD?
- Server-side rendering if the chosen framework can handle it
- CI/CD?
- Make a site branch with a nice little documentation (Could be docusaurus)
- CI/CD?
This is my foray into actual FOSS I want to put out into the world. I'm super open to PRs and/or suggestions on how to properly maintain and collaborate on these kinds of things. If you see something in this README that doesn't make sense, feel free to create an issue with your recommendations!
I chose the name Posture because this is a tool written with Deno to test part of a communication system and dinosaurs used their posture to communicate certain things.[citation needed] The word Posture also includes "Post" as in mail, so there's that. Yeah.
Copyright © 2020 William Théroux