1 .TH "MYMAIL" "0.9.1" "February 2013" "Francois Fleuret" "User Commands"
3 \" This man page was written by Francois Fleuret <francois@fleuret.org>
4 \" and is distributed under a Creative Commons Attribution-Share Alike
9 mymail \- A simple command line utility for indexing and searching mbox files
13 \fBmymail\fP [\fIoptions\fR] [\fI<mbox dir1>\fR [\fI<mbox dir2>\fR ... ]|\fI<db file1>\fR [\fI<db file2>\fR ... ]]\n");
17 \fBmymail\fP is a command line utility to index mbox files and perform
18 quick searches based on sender, subject, etc.
20 It is similar in spirit to other existing software such as mu or
21 notmuch, but does not use a real database backend to store and query
26 \fB-h\fR, \fB--help\fR
29 \fB-v\fR, \fB--version\fR
30 print the version number
32 \fB-q\fR, \fB--quiet\fR
33 do not write information during the search
35 \fB-p <db filename pattern>\fR, \fB--db-pattern <db filename pattern>\fR
36 set the db filename pattern for recursive search
38 \fB-r <db root path>\fR, \fB--db-root <db root path>\fR
39 set the db root path for recursive search
41 \fB-l <db filename list>\fR, \fB--db-list <db filename list>\fR
42 set the semicolon-separated list of db files for search
44 \fB-s <search pattern>\fR, \fB--search <search pattern>\fR
45 search for matching mails in the db file
47 \fB-d <db filename>\fR, \fB--db-file <db filename>\fR
48 set the db filename for indexing
50 \fB-i\fR, \fB--index\fR
51 index mails in the mailboxes located recursively anywhere in the
52 directories following the options on the command lines
54 \fB-o <output filename>\fR, \fB--output <output filename>\fR
55 set the db filename pattern for recursive search
57 \fB-a <search field>\fR, \fB--default-search <search field>\fR
58 set the default search field: If a search request is not understood,
59 it is interpreted as the regexp with this default search field
61 .SH "ENVIRONMENT VARIABLES"
64 \fBMYMAIL_DB_PATTERN\fR
65 defaut value for the --db-pattern argument
68 defaut value for the --db-root argument
71 defaut value for the --db-list argument
74 defaut value for the --db-file argument
78 The search conditions take the form of a single letter followed by a
79 space and a regexp, which can itself contain spaces. If the condition
80 is prefaced by the character "!" it is negated, and has to be false
81 for a mail to be selected.
84 \fBf <regexp>\fR (from) selects mails whose leading line From, or
85 fields From:, or Reply-To: matches the regexp.
87 \fBt <regexp>\fR (to) selects mails whose field To:, Cc:, or Bcc: matches the regexp.
89 \fBp <regexp>\fR (participant) selects mails whose leading line From,
90 or fields From:, Reply-To:, To:, Cc:, or Bcc: matches the regexp.
92 \fBs <regexp>\fR (subject) selects mails whose field Subject: matches the regexp.
94 \fBd <regexp>\fR (date) selects mails whose field Date: matches the regexp.
96 \fBb <regexp>\fR (body) selects mails whose body matches the
97 regexp. Evaluatin such a condition requires to read the original
98 mboxes completely, which can be slow. However, header conditions are
99 checked first to read the bodies only for mails which fulfill them
102 \fB8h\fR selects mails received during the last 8 hours.
104 \fBtoday\fR, \fB24h\fR, \fBweek\fR, and \fBmonth\fR selects mails received during the last 24, 7 * 24 hours or 31 * 24 hours.
106 \fByesterday\fR selects mails received between 48h and 24h ago.
108 \fBmonday\fR, \fBtuesday\fR, ..., \fBsunday\fR selects mails received
109 the most recent such day
113 To index all the mbox files present in the directories
114 ~/archives/mails/2010 and ~/archives/mails/2011 (recursively) and
115 create a database file /tmp/mymail/2010-2011/mymail.db
119 mymail --db-file /tmp/mymail/2010-2011/mymail.db --index ~/archives/mails/2010 ~/archives/mails/2011
123 To search in all the database files *.db located (recursively) in
124 /tmp/mymail, for all the mails having bob.something as sender or
125 recipient, without "spam" in the subject, and create a result mbox
126 file /tmp/mymail/mbox
130 mymail --db-pattern '\\.db$' --db-root /tmp/mymail --search 'p bob.something' --search '!s spam' > /tmp/mymail.mbox
136 The search in the mail bodies does not decode mimencoding mails, hence
137 will not catch patterns in encoded text.
141 Written by Francois Fleuret <francois@fleuret.org> and distributed
142 under the terms of the GNU General Public License version 3 as
143 published by the Free Software Foundation. This is free software: you
144 are free to change and redistribute it. There is NO WARRANTY, to the
145 extent permitted by law.