README.md (6768B)
1 oo oo dP 2 88 3 dP .d8888b. 88d888b. .d8888b. 88d8b.d8b. .d8888b. dP 88 4 88 88' `88 88' `88 88' `88 88'`88'`88 88' `88 88 88 5 88 88. .88 88 88. .88 88 88 88 88. .88 88 88 6 88 `88888P8 dP `88888P' dP dP dP `88888P8 dP dP 7 88~ooooooooooooooooooooooooooooooooooooooooooooooooooooo 8 odP your humble and faithful electronic postman 9 10 *A commandline tool to easily and privately handle your e-mail* 11 12 [](http://www.dyne.org) 13 14 [](https://travis-ci.org/dyne/JaroMail) 15 16 17 Updates on: http://dyne.org/software/jaro-mail 18 19 # INTRODUCTION 20 21 Jaro Mail is an integrated suite of interoperable tools for GNU/Linux 22 and Apple/OSX to manage e-mail communication in a private and efficient 23 way, without relying too much on on-line services, in fact encouraging 24 users to store e-mail locally. 25 26 Rather than reinventing the wheel, Jaro Mail reuses some existing free 27 and open source tools working since more than 10 years, generating 28 their configurations and setting up integrations automatically. 29 30 executable | function 31 ---------- | -------------------- 32 ZShell | Scripting language 33 Mutt | Mail User Agent 34 Fetchmail | Mail Transport (fetch) 35 Vim | Mail editor 36 GnuPG | Content encryption 37 Mixmaster | Anonymous emails 38 MSmtp | Mail Transport (send) 39 Notmuch | Search engine 40 ABook | Addressbook 41 Elinks | HTML rendering 42 43 A round-up on Jaro Mail features follows: 44 45  46 47 * Minimalistic and efficient interface with message threading 48 * Targets intensive usage of e-mails and mailinglists 49 * Stores e-mails locally in a reliable format (maildir) 50 * Integrates whitelisting and blacklisting, local and remote 51 * Can do search and backup by advanced expressions 52 * Automatically generates filter rules (sieve) 53 * Imports and exports VCard contacts to addressbook 54 * Computes and shows statistics on mail traffic 55 * Encrypted password storage using OS native keyrings 56 * Advanced maildir tools (merge, backup, address extraction) 57 * Defers connections for off-line operations 58 * Checks SSL/TLS certificates when fetching and sending mails 59 * Supports strong encryption messaging (GnuPG) 60 * Can send anonymous emails (Mixmaster) 61 * Many languages! so exotic! such UTF-8! 62 * Multi platform: GNU/Linux/BSD, Apple/OSX 63 * Old school, used by its author for the past 10 years 64 65 # INSTALL 66 67 If building and installing from Git source, please run `git submodule 68 init; git submodule update` after cloning to initialize and clone the 69 submodules used as part of Jaro Mail's tree. 70 71 **GNU/Linux** users can run `make` to install all needed components 72 (done automatically, requires root) and compile auxiliary 73 tools. Once compiled then `sudo make install` will put Jaro Mail in 74 `/usr/local`. Or To install it as user into a self-contained place: 75 76 ``` 77 PREFIX=$HOME/Postbox make install 78 ``` 79 80 Will create the directory `Postbox` in your home directory and install 81 Jaro Mail inside it, with the `jaro` executable in `Postbox/bin`. 82 83 When Jaro Mail is installed system-wide, the `JAROMAILDIR` 84 environmental variable can be changed to point to where all emails 85 will be stored, by default it is `$HOME/Mail`. 86 87 The dependencies to be installed on the system for Jaro Mail are 88 * build: `make gcc libglib2.0-dev libgnome-keyring-dev libxapian-dev libgmime-2.6-dev libtalloc-dev zlib1g-dev libgpgme11-dev` 89 * run: `fetchmail msmtp mutt-kz notmuch pinentry-curses abook wipe netcat` 90 91 Keep in mind **you need to read the Manual**: this software is not 92 graphical, it is not meant to be intuitive, does not contains 93 eyecandies (except for stats on mail traffic). Jaro Mail is operated 94 via Terminal, configured in plain text and overall made by geeks for 95 geeks. 96 97 98 **Apple/OSX** Jaro Mail 3q.0 has not yet been updated to Apple/OSX. With 99 2.0 users can simply drag Jaro Mail into /Applications When started 100 Jaro Mail opens a Terminal window preconfigured with its environment, 101 to activate it for any terminal add this to `~/.profile`: 102 ``` 103 export PATH=/Applications/JaroMail.app/Contents/Resources/jaro/bin:$PATH 104 ``` 105 106 # USAGE MANUAL 107 108 For a brief overview see the commandline help: 109 ``` 110 jaro -h 111 ``` 112 When in doubt, make sure you read the User's Manual, it is important. 113 114 Download the PDF: https://files.dyne.org/jaromail/jaromail-manual.pdf 115 116 Or browse online the latest version: 117 https://github.com/dyne/JaroMail/blob/master/doc/jaromail-manual.org 118 119 It is recommended that you read the user manual: you won’t get far unless you know what you are doing. Even for experienced Mutt users: keys will be familiar, but there are things to learn in the manual on how Jaro Mail redesigns the e-mail workflow for instance with whitelisting and remote sieve folders. 120 121 # DEVELOPERS 122 123 All revisioned in Git, see: https://github.com/dyne/JaroMail 124 125 Remember to do `git submodules update --init` after a fresh clone. 126 127 Pull requests and patches welcome, for an overview of current plans 128 see [TODO](TODO.md) 129 130 Our chat channel is **#dyne** on https://irc.dyne.org 131 132 Make sure to idle in that channel, answers take some time to come. 133 134 We are all idling artists. 135 136 # DONATE 137 138 Donations are very welcome and well needed. 139 140 By donating you will encourage further development. 141 142 https://www.dyne.org/donate 143 144 # ACKNOWLEDGEMENTS 145 146 The Jaro Mail software and user's manual is conceived, designed and put 147 together with a substantial amount of ZShell scripts and some C code 148 by Denis Roio aka [Jaromil](http://jaromil.dyne.org). 149 150 Jaro Mail would have never been possible without the incredible amount of Love shared by the free and open source community, a more complete list of contributors is included in the [user manual](https://files.dyne.org/jaromail/jaromail-manual.pdf) in the `Acknowledgments` section. 151 152 Jaro Mail is Copyright (C) 2010-2016 Denis Roio <jaromil@dyne.org> 153 154 This source code is free software; you can redistribute it and/or 155 modify it under the terms of the GNU Public License as published by 156 the Free Software Foundation; either version 3 of the License, or (at 157 your option) any later version. 158 159 This source code is distributed in the hope that it will be useful, 160 but WITHOUT ANY WARRANTY; without even the implied warranty of 161 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. Please refer to 162 the GNU Public License for more details. 163 164 You should have received a copy of the GNU Public License along with 165 this source code; if not, write to: Free Software Foundation, Inc., 166 675 Mass Ave, Cambridge, MA 02139, USA.