A mail formatter.
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

README.md 1.9 KiB

  1. fmail - Incenp.org’s mail formatter
  2. ===================================
  3. Description
  4. -----------
  5. Fmail is a mail formatter. It reads a draft message on its standard
  6. input and writes to its standard output a suitably formatted message
  7. ready to be sent to a mail submission agent.
  8. The name “fmail” stands for something like “Formatting MAIL”.
  9. The main feature of Fmail is its ability to add attachments to the input
  10. message and to sign and/or encrypt the whole message (including
  11. attachments) using [PGP/MIME](https://tools.ietf.org/html/rfc3156).
  12. The signing feature makes Fmail usable as a “signing filter”,
  13. taking a complete (but unsigned) mail on its standard input and
  14. emitting a PGP/MIME-signed message on its standard output (ready to
  15. be sent to a mail submission agent such as `/usr/sbin/sendmail`).
  16. Install
  17. -------
  18. Fmail depends on the following libraries:
  19. - [libgpgme](http://www.gnupg.org/gpgme.html), to sign and encrypt
  20. messages.
  21. - [libmagic](http://www.darwinsys.com/file/), to guess file type and
  22. encoding of attachments.
  23. I expect Fmail to compile cleanly (and behave correctly) on most POSIX
  24. systems, although I have only tested it on my GNU/Linux box. Should you
  25. find a portability issue on your system, please let me know.
  26. Run the provided `configure` script to prepare the sources for build;
  27. run `configure --help` to know the available configuration parameters.
  28. Then run `make` to effectively build the program, and `make install` to
  29. install it on your system.
  30. Copying
  31. -------
  32. Fmail is distributed under the terms of the GNU General Public License,
  33. version 3 or higher. The full text of the license is included in the
  34. [COPYING file](COPYING) of the source distribution.
  35. Homepage and repository
  36. -----------------------
  37. The project is located at https://incenp.org/dvlpt/fmail.html. The
  38. latest source code is available at https://git.incenp.org/damien/fmail.