commit 2538df7342660fccc027614f771f9d528c1b6b44
parent 72c7134ae6a136dab9e555a7195b27258caa5870
Author: Jaromil <jaromil@dyne.org>
Date: Thu, 5 Dec 2013 20:32:09 +0100
documentation for the 1.3 release
Diffstat:
4 files changed, 62 insertions(+), 32 deletions(-)
diff --git a/ChangeLog.txt b/ChangeLog.txt
@@ -1,3 +1,11 @@
+Jaro Mail 1.3 - 5 December 2013
+ Major fixes for the new OSX Application packaging implying a
+ rather important refactoring: during its operation JaroMail will
+ not write into $WORKDIR anymore, but only into $MAILDIR, where
+ most user generated files are now moved.
+
+ Includes bugfixes for the build on Fedora.
+
Jaro Mail 1.2 - 14 September 2013
Several usability improvements and bugfixes both for usage on
GNU/Linux and Apple/OSX systems. The latter has now a different
diff --git a/README.txt b/README.txt
@@ -6,7 +6,7 @@
88 88. .88 88 88. .88 88 88 88 88. .88 88 88
88 `88888P8 dP `88888P' dP dP dP `88888P8 dP dP
88~ooooooooooooooooooooooooooooooooooooooooooooooooooooo
- odP your humble and faithful electronic postman v 1.2
+ odP your humble and faithful electronic postman v 1.3
A commandline tool to easily and privately handle your e-mail
@@ -29,6 +29,7 @@ open source tools working since more than 10 years:
- Procmail :: Filtering Agent
- MSmtp :: the mini SMTP
- Mairix :: search engine
+- ABook :: addressbook
- Z Shell :: scripting language
A round-up on Jaro Mail features follows:
@@ -37,7 +38,7 @@ A round-up on Jaro Mail features follows:
- Targets intensive usage of mailinglists
- Does whitelisting and integrates addressbooks
- Can do search and backup by expressions
-- Automatically generates filtering rules (procmail and sieve)
+- Automatically generates filter rules (procmail and sieve)
- Computes and shows statistics on mail traffic (experimental)
- Secure password storage (native, OSX and Gnome keyrings)
- Stores e-mails locally in a reliable format (maildir)
@@ -56,6 +57,11 @@ Bare in mind you need to read the Manual: this software is not
graphical, yet has a high productive potential.
JaroMail is operated via Terminal, configured in plain text and overall
made by geeks for geeks. Beware.
+When started JaroMail opens a Terminal window preconfigured with its
+environment, to activate it for any terminal add this to ~/.profile:
+export PATH=/Applications/JaroMail.app/Contents/Resources/jaro/bin:$PATH
+
+
GNU/Linux users can use the build/build-gnu.sh script to install
dependencies and build all necessary binaries. This is still dirty, it
@@ -101,7 +107,7 @@ We are all idling artists.
Money donations are very welcome and well needed, they will encourage
further development even beyond my own needs for this software.
- https://dyne.org/donate
+ https://www.dyne.org/donate
diff --git a/doc/jaromail-manual.org b/doc/jaromail-manual.org
@@ -140,17 +140,23 @@ and actions involved in managing one's email communication:
* Configuration
+ The place where Jaro Mail is installed (*$HOME/Mail* by default)
+ contains all configuration files.
+
+ For Apple/OSX users, this directory is inside their *$HOME/Library*
+ and then *Application Support/JaroMail*.
+
+ From now own, we will call this place the *Mail directory*.
+
** Receive mail
- The place where Jaro Mail is installed ($HOME/Mail by default)
- contains a *jaro* folder where all configuration files are found.
- There, inside the directory *Accounts*, are some brief instructions
- and some default templates which can be filled in with Imap or Pop
- account configuration to fetch mail. A default template will be
- found in fresh installations: *Accounts/imap.default.txt*. The
- configuration can be edited with one's favourite text editor, the
- format of the file is pretty self-explanatory.
+ Inside the Mail directory is found the folder *Accounts* with brief
+ instructions and default templates to fill with Imap or Pop account
+ configurations to fetch mail. A default template will be found in
+ fresh installations: *Accounts/imap.default.txt*. The configuration
+ can be edited with one's favourite text editor, the format of the
+ file is pretty self-explanatory.
It is possible to have more than one account and in fact when
retreiving e-mails using the *jaro fetch* command all accounts will
@@ -161,18 +167,20 @@ and actions involved in managing one's email communication:
** Send mail
- Also inside the *jaro/Accounts* directory is found the
- *smtp.default.txt* file that configures how to send mail.
+ Also inside the *Accounts* directory is found
+ the *smtp.default.txt* file that configures how to send mail.
When no special account is specified using the *-a* option, then
the file named *smtp.default.txt* into the Accounts folder will be
used. To fix a selection it is also possible to use a symbolic
link.
- There is also a file *jaro/Mutt.txt* that can be configured with
- some customized settings for the mail transport agent, such as
- custom headers appearing in composed e-mails and the default GPG[fn:gpg]
- key to be used when signing and encrypting them.
+ Mutt users might want to customize settings by creating
+ a *Mutt.txt* file inside the Mail directory: it will be included
+ automatically if present and can contain any mutt configuration
+ directives for the mail transport agent, such as custom headers
+ appearing in composed e-mails and the default GPG[fn:gpg] key to be
+ used when signing and encrypting them.
[fn:gpg] GPG stands for GNU Privacy Guard, a system to securely
encrypt and decrypt messages and files so that noone can read their
@@ -180,13 +188,15 @@ content, even when intercepting the communication.
** Filter mail
- The file *jaro/Filters.txt* can be edited to configure mailinglist
- and other filters referencing the contents of the *From:* or *To:*
- fields of each e-mail that is fetched.
+ In the mail directory a file named *Filters.txt* can be created and
+ filled in with rules referencing the contents of the *From:*
+ or *To:* fields of each e-mail that is fetched. The mails matching
+ will be then saved in the indicated maildirs (created if not
+ existing) to keep a bit of order, especially useful for mailinglist
+ users.
The format of the filters configurarion is pretty easy and self
- explanatory, those rules will be applied to mails saved on the
- local filesystem in maildirs that will be created when needed.
+ explanatory, an example is found in the appendix of this manual.
@@ -265,9 +275,9 @@ to spam than the rest, the most infamous *zz.blacklist/* folder.
What we call addressbook here basically consists of both the whitelist
and the blacklist. We store both lists in a unique database file in
-*Mail/jaro/addressbook*[fn:sqlite]. In future we may add similar
-support for other addressbook formats that people use (GnuPG keyring,
-Evolution etc.)[fn:appleaddr]
+the Mail dir called *Addressbook*[fn:sqlite]. In future we may add
+similar support for other addressbook formats that people use (GnuPG
+keyring, Evolution etc.)[fn:appleaddr]
[fn:sqlite] Jaro Mail uses sqlite3 as its own database storage
@@ -543,13 +553,19 @@ of a password input every time e-mails are being checked.
On *Apple/OSX* the default internal keyring is being used.
-On *GNU/Linux* only the gnome-keyring is supported for now.
+On *GNU/Linux* gnome-keyring is supported if found, else JaroMail will
+revert to use its own encrypted[fn:keyringenc] database called *keyring*. Every time
+a password will be retrieved or saved, the keyring password will be
+asked.
+
+[fn:keyringenc] The keyring is encrypted using weak symmetric
+encryption via GnuPG, the only protection for the data inside then is
+the password memorized by the used.
To explicitly change a password one can operate the default keyring
manager or use the command *jaro passwd -a imap.default* (or other
accounts) which will prompt to set for a new password even if an old
-one is known. If left blank, it will simply erase the password saved
-for the account.
+one is known.
** Temporary directory
@@ -717,9 +733,9 @@ the affected folders to remove the duplicates.
1) Start Automator
2) Choose the Service template
- 3) In the dropdown boxes that appear choose “files or folders” and “Finder”
+ 3) In the dropdown boxes that appear choose "files or folders" and "Finder"
4) Look for "Run Applescript" in the Library tree
- 5) Drag "Run Applectript" in the workflow area and paste this script into it:
+ 5) Drag "Run Applescript" in the workflow area and paste this script into it:
#+BEGIN_EXAMPLE
on run {input, parameters}
diff --git a/src/jaro b/src/jaro
@@ -20,8 +20,8 @@
# this source code; if not, write to:
# Free Software Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
-VERSION=1.2
-DATE=Sept/2013
+VERSION=1.3
+DATE=Dec/2013
JAROMAILEXEC=$0
typeset -a OLDARGS
for arg in ${argv}; do OLDARGS+=($arg); done
