1 .TH "MYMAIL" "0.9.2" "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 ... ]]
17 \fBmymail\fP is a command line utility to index mbox files, search for
18 mails based on sender, subject, etc. and generate result mbox files.
20 It is similar in spirit to other tools such as mu or notmuch, but is
25 \fB-h\fR, \fB--help\fR
28 \fB-v\fR, \fB--version\fR
29 print the version number
31 \fB-q\fR, \fB--quiet\fR
32 do not write information during the search
34 \fB-p <db filename pattern>\fR, \fB--db-pattern <db filename pattern>\fR
35 set the db filename pattern for recursive search
37 \fB-r <db root path>\fR, \fB--db-root <db root path>\fR
38 set the db root path for recursive search
40 \fB-l <db filename list>\fR, \fB--db-list <db filename list>\fR
41 set the semicolon-separated list of db files for search
43 \fB-s <search pattern>\fR, \fB--search <search pattern>\fR search for
44 matching mails in the db file. Multiple search requests can be
45 combined, and only mails fulfilling all of them will be extracted.
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 set the
55 result mbox filename. If it is not set, the standard output is used
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)
85 selects mails whose leading line From, or fields From:, Sender:,
86 Reply-To:, or Return-Path: matches the regexp.
89 selects mails whose field To:, Cc:, or Bcc: matches the regexp.
91 \fBp <regexp>\fR (participant)
92 selects mails that would be selected by \fBf\fR or \fBt\fR.
94 \fBs <regexp>\fR (subject)
95 selects mails whose field Subject: matches the regexp.
97 \fBd <regexp>\fR (date)
98 selects mails whose field Date: matches the regexp.
100 \fBb <regexp>\fR (body)
101 selects mails whose body matches the regexp. Evaluating such a
102 condition requires to read the original mboxes completely, which can
103 be slow. However, header conditions are checked first to read the
104 bodies only for mails which fulfill them entirely.
106 \fB8h\fR, \fBtoday\fR, \fB24h\fR, \fBweek\fR, \fBmonth\fR, and
108 selects mails received during the last 8, 24, 24, 7 * 24 hours, 31 *
109 24 hours, and 365 * 24 hours respectively.
112 selects mails received between 48h and 24h ago.
114 \fBmonday\fR, \fBtuesday\fR, ..., \fBsunday\fR
115 selects mails received the most recent such day of the week
123 .B mymail --db-file /tmp/mymail/2010-2011/mymail.db \e
124 .B \ \ \ \ \ \ \ --index \e
125 .B \ \ \ \ \ \ \ ~/archives/mails/2010 ~/archives/mails/2011
128 will index all the mbox files present in the directories
129 ~/archives/mails/2010 and ~/archives/mails/2011 (recursively) and
130 create an index file /tmp/mymail/2010-2011/mymail.db
136 .B mymail --db-pattern '\.db$' --db-root /tmp/mymail \e
137 .B \ \ \ \ \ \ \ --output /tmp/mymail.mbox \e
138 .B \ \ \ \ \ \ \ --search 'p bob.something' \e
139 .B \ \ \ \ \ \ \ --search '!s spam' \e
140 .B \ \ \ \ \ \ \ --search 'month'
143 will search in all the database files *.db located (recursively) in
144 /tmp/mymail, for all the mails having "bob.something" as sender or
145 recipient, without "spam" in the subject, received over the last 31
146 days, and create an mbox file /tmp/mymail/mbox.
150 The search in the mail bodies does not decode mimencoding mails, hence
151 will not catch patterns in encoded text.
153 The mbox format is not clear for multipart messages, since the ^"From
154 " lines are not always quoted properly (at least the ones I have to
159 Written by Francois Fleuret <francois@fleuret.org> and distributed
160 under the terms of the GNU General Public License version 3 as
161 published by the Free Software Foundation. This is free software: you
162 are free to change and redistribute it. There is NO WARRANTY, to the
163 extent permitted by law.