mymail.1

   1 .TH "MYMAIL" "0.9.5" "February 2013" "Francois Fleuret" "User Commands"
   2
   3 \" This man page was written by Francois Fleuret <francois@fleuret.org>
   4 \" and is distributed under a Creative Commons Attribution-Share Alike
   5 \" 3.0 License.
   6
   7 .SH "NAME"
   8
   9 mymail \- A simple command line utility for indexing and searching mbox files
  10
  11 .SH "SYNOPSIS"
  12
  13 \fBmymail\fP [\fIoptions\fR] [\fI<mbox dir1>\fR [\fI<mbox dir2>\fR ... ]|\fI<db file1>\fR [\fI<db file2>\fR ... ]]
  14
  15 .SH "DESCRIPTION"
  16
  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.
  19
  20 It is similar in spirit to other tools such as mu or notmuch, but is
  21 overall simpler.
  22
  23 .SH "OPTIONS"
  24 .TP
  25 \fB-h\fR, \fB--help\fR
  26 display help and exit
  27 .TP
  28 \fB-v\fR, \fB--version\fR
  29 print the version number
  30 .TP
  31 \fB-q\fR, \fB--quiet\fR
  32 do not write information during the search
  33 .TP
  34 \fB-p <db filename pattern>\fR, \fB--db-pattern <db filename pattern>\fR
  35 set the db filename pattern for recursive search
  36 .TP
  37 \fB-r <db root path>\fR, \fB--db-root <db root path>\fR
  38 set the db root path for recursive search
  39 .TP
  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
  42 .TP
  43 \fB-m <mbox filename pattern>\fR, \fB--mbox-pattern <mbox filename pattern>\fR
  44 set the mbox filename pattern for recursive search
  45 .TP
  46 \fB-s <search pattern>\fR, \fB--search <search pattern>\fR search for
  47 matching mails in the db file. Multiple search requests can be
  48 combined, and only mails fulfilling all of them will be extracted.
  49 .TP
  50 \fB-d <db filename>\fR, \fB--db-file-generate <db filename>\fR
  51 set the db filename for indexing
  52 .TP
  53 \fB-i\fR, \fB--index\fR
  54 index mails in the mailboxes located recursively anywhere in the
  55 directories following the options on the command lines
  56 .TP
  57 \fB-o <output filename>\fR, \fB--output <output filename>\fR set the
  58 result mbox filename. If it is not set, the standard output is used
  59 .TP
  60 \fB-a <search key>\fR, \fB--default-search <search key>\fR
  61 set the default search key. If a search request is not understood,
  62 it is interpreted as the regexp with this default search key
  63
  64 .SH "ENVIRONMENT VARIABLES"
  65
  66 .TP
  67 \fBMYMAIL_DB_PATTERN\fR
  68 defaut value for the --db-pattern argument
  69 .TP
  70 \fBMYMAIL_DB_ROOT\fR
  71 defaut value for the --db-root argument
  72 .TP
  73 \fBMYMAIL_DB_LIST\fR
  74 defaut value for the --db-list argument
  75 .TP
  76 \fBMYMAIL_DB_FILE\fR
  77 defaut value for the --db-file argument
  78
  79 .SH "SEARCH SYNTAX"
  80
  81 The search conditions take the form of a key which is a single letter,
  82 followed by a space and a regexp, which can itself contain spaces. If
  83 the condition is prefaced by the character "!" it is negated, and has
  84 to be false for a mail to be selected.
  85
  86 The time-based conditions use as reference the time indicated in the
  87 heading From line, and not in the Date: field.
  88
  89 .TP
  90 \fBf <regexp>\fR (from)
  91 selects mails whose leading line From, or fields From:, Sender:,
  92 Reply-To:, or Return-Path: matches the regexp.
  93 .TP
  94 \fBt <regexp>\fR (to)
  95 selects mails whose field To:, Cc:, or Bcc: matches the regexp.
  96 .TP
  97 \fBp <regexp>\fR (participant)
  98 selects mails that would be selected by \fBf\fR or \fBt\fR.
  99 .TP
 100 \fBs <regexp>\fR (subject)
 101 selects mails whose field Subject: matches the regexp.
 102 .TP
 103 \fBd <regexp>\fR (date)
 104 selects mails whose field Date: matches the regexp.
 105 .TP
 106 \fBb <regexp>\fR (body)
 107 selects mails whose body matches the regexp. Evaluating such a
 108 condition requires to read the original mboxes completely, which can
 109 be slow. However, header conditions are checked first to read the
 110 bodies only for mails which fulfill them entirely.
 111 .TP
 112 \fB8h\fR, \fBtoday\fR, \fB24h\fR, \fB48h\fR, \fBweek\fR, \fBmonth\fR, and
 113 \fByear\fR
 114 selects mails received during the last 8, 24, 24, 48, 7 * 24 hours, 31 *
 115 24 hours, and 365 * 24 hours respectively.
 116 .TP
 117 \fByesterday\fR
 118 selects mails received between 48h and 24h ago.
 119 .TP
 120 \fBmonday\fR, \fBtuesday\fR, ..., \fBsunday\fR
 121 selects mails received the most recent such day of the week.
 122
 123 .SH "EXAMPLES"
 124
 125 The command
 126
 127 .P
 128 .nf
 129 .B mymail --db-file /tmp/mymail/2010-2011/mymail.db \e
 130 .B \ \ \ \ \ \ \ --index \e
 131 .B \ \ \ \ \ \ \ ~/archives/mails/2010 ~/archives/mails/2011
 132
 133 .fi
 134 will index all the mbox files present in the directories
 135 ~/archives/mails/2010 and ~/archives/mails/2011 (recursively) and
 136 create an index file /tmp/mymail/2010-2011/mymail.db
 137
 138 And
 139
 140 .P
 141 .nf
 142 .B mymail --db-pattern '\.db$' --db-root /tmp/mymail \e
 143 .B \ \ \ \ \ \ \ --output /tmp/mymail.mbox \e
 144 .B \ \ \ \ \ \ \ --search 'p bob.something' \e
 145 .B \ \ \ \ \ \ \ --search '!s spam' \e
 146 .B \ \ \ \ \ \ \ --search 'month'
 147
 148 .fi
 149 will search in all the database files *.db located (recursively) in
 150 /tmp/mymail, for all the mails having "bob.something" as sender or
 151 recipient, without "spam" in the subject, received over the last 31
 152 days, and create an mbox file /tmp/mymail/mbox.
 153
 154 .SH "BUGS"
 155
 156 The search in the mail bodies does not decode mimencoding mails, hence
 157 will not catch patterns in encoded text.
 158
 159 The mbox format is not clear for multipart messages, since the ^"From
 160 " lines are not always quoted properly (at least the ones I use for
 161 testing).
 162
 163 .SH "AUTHOR"
 164
 165 Written by Francois Fleuret <francois@fleuret.org> and distributed
 166 under the terms of the GNU General Public License version 3 as
 167 published by the Free Software Foundation. This is free software: you
 168 are free to change and redistribute it. There is NO WARRANTY, to the
 169 extent permitted by law.