matrixmailer/README.md

# matrixmailer
This project has come to finally end email notifications for system administrators!

## Configuration
Have a look at the simple and the more advanced configuration file, it should be self-explanatory and easy.

The (absolute) path to your configuration file must be supplied as command line argument when starting the program.

A directory for client sessions will be created in the directory your config file is in. However, the files in there are rotated so you always have access to the previous 9 versions of the file.

## How to use
Just invite the bot accounts to the rooms they should post in, and enter the room IDs of those rooms in the config file. They will join when the first email arrives.
**Hint:** Encryption works flawlessly when the bot account has logged in once before, there can be minor issues otherwise. You can just do a dry run of matrixmailer with the clients already specified in the configuration file to do that.

## How it works
matrixmailer spins up a minimalistic SMTP server which receives any email (except you use the receiver_allowlist feature, see sample configs),

## Contributing
Feel free to join #matrixmailer:a-0.me to ask questions and discuss, or even to just leave feedback!

You can build the code using cargo, as usual. Make sure to install `openssl`, `openssl-devel` and `cmake` packages (naming may be different on your Linux distro), they are required to build the matrix-rust-sdk.
Initial commit 2022-08-29 21:28:00 +02:00			`# matrixmailer`
			`This project has come to finally end email notifications for system administrators!`

			`## Configuration`
			`Have a look at the simple and the more advanced configuration file, it should be self-explanatory and easy.`
deleted debug line, improved README formatting 2022-09-06 19:35:55 +02:00
Initial commit 2022-08-29 21:28:00 +02:00			`The (absolute) path to your configuration file must be supplied as command line argument when starting the program.`
deleted debug line, improved README formatting 2022-09-06 19:35:55 +02:00
Client sessions are not persisted in main config file any more. 2022-09-06 20:36:52 +02:00			`A directory for client sessions will be created in the directory your config file is in. However, the files in there are rotated so you always have access to the previous 9 versions of the file.`
Initial commit 2022-08-29 21:28:00 +02:00
			`## How to use`
			`Just invite the bot accounts to the rooms they should post in, and enter the room IDs of those rooms in the config file. They will join when the first email arrives.`
			`Hint: Encryption works flawlessly when the bot account has logged in once before, there can be minor issues otherwise. You can just do a dry run of matrixmailer with the clients already specified in the configuration file to do that.`

			`## How it works`
Removed term 'whitelist' 2022-09-02 14:54:57 +02:00			`matrixmailer spins up a minimalistic SMTP server which receives any email (except you use the receiver_allowlist feature, see sample configs),`
Initial commit 2022-08-29 21:28:00 +02:00
			`## Contributing`
			`Feel free to join #matrixmailer:a-0.me to ask questions and discuss, or even to just leave feedback!`

			You can build the code using cargo, as usual. Make sure to install `openssl`, `openssl-devel` and `cmake` packages (naming may be different on your Linux distro), they are required to build the matrix-rust-sdk.