.TH "MYMAIL" "0.9.5" "February 2013" "Francois Fleuret" "User Commands" \" This man page was written by Francois Fleuret \" and is distributed under a Creative Commons Attribution-Share Alike \" 3.0 License. .SH "NAME" mymail \- A simple command line utility for indexing and searching mbox files .SH "SYNOPSIS" \fBmymail\fP [\fIoptions\fR] [\fI\fR [\fI\fR ... ]|\fI\fR [\fI\fR ... ]] .SH "DESCRIPTION" \fBmymail\fP is a command line utility to index mbox files, search for mails based on sender, subject, etc. and generate result mbox files. It is similar in spirit to other tools such as mu or notmuch, but is overall simpler. .SH "OPTIONS" .TP \fB-h\fR, \fB--help\fR display help and exit .TP \fB-v\fR, \fB--version\fR print the version number .TP \fB-q\fR, \fB--quiet\fR do not write information during the search .TP \fB-t\fR, \fB--use-leading-time\fR use the time stamp from the leading line of each mail and not the Date: field .TP \fB-p \fR, \fB--db-pattern \fR set the db filename pattern for recursive search .TP \fB-r \fR, \fB--db-root \fR set the db root path for recursive search .TP \fB-l \fR, \fB--db-list \fR set the semicolon-separated list of db files for search .TP \fB-m \fR, \fB--mbox-pattern \fR set the mbox filename pattern for recursive search .TP \fB-s \fR, \fB--search \fR search for matching mails in the db file. Multiple search requests can be combined, and only mails fulfilling all of them will be extracted. .TP \fB-d \fR, \fB--db-file-generate \fR set the db filename for indexing .TP \fB-i\fR, \fB--index\fR index mails in the mailboxes located recursively anywhere in the directories following the options on the command lines .TP \fB-o \fR, \fB--output \fR set the result mbox filename. If it is not set, the standard output is used .TP \fB-a \fR, \fB--default-search \fR set the default search key. If a search request is not understood, it is interpreted as the regexp with this default search key .SH "ENVIRONMENT VARIABLES" .TP \fBMYMAIL_DB_PATTERN\fR defaut value for the --db-pattern argument .TP \fBMYMAIL_DB_ROOT\fR defaut value for the --db-root argument .TP \fBMYMAIL_DB_LIST\fR defaut value for the --db-list argument .TP \fBMYMAIL_DB_FILE\fR defaut value for the --db-file argument .SH "SEARCH SYNTAX" The search conditions take the form of a key which is a single letter, followed by a space and a regexp, which can itself contain spaces. If the condition is prefaced by the character "!" it is negated, and has to be false for a mail to be selected. The time-based conditions use as reference the time indicated in the heading From line, and not in the Date: field. .TP \fBf \fR (from) selects mails whose leading line From, or fields From:, Sender:, Reply-To:, or Return-Path: matches the regexp. .TP \fBt \fR (to) selects mails whose field To:, Cc:, or Bcc: matches the regexp. .TP \fBp \fR (participant) selects mails that would be selected by \fBf\fR or \fBt\fR. .TP \fBs \fR (subject) selects mails whose field Subject: matches the regexp. .TP \fBd \fR (date) selects mails whose field Date: matches the regexp. .TP \fBb \fR (body) selects mails whose body matches the regexp. Evaluating such a condition requires to read the original mboxes completely, which can be slow. However, header conditions are checked first to read the bodies only for mails which fulfill them entirely. .TP \fB8h\fR, \fBtoday\fR, \fB24h\fR, \fB48h\fR, \fBweek\fR, \fBmonth\fR, and \fByear\fR selects mails received during the last 8, 24, 24, 48, 7 * 24 hours, 31 * 24 hours, and 365 * 24 hours respectively. .TP \fByesterday\fR selects mails received between 48h and 24h ago. .TP \fBmonday\fR, \fBtuesday\fR, ..., \fBsunday\fR selects mails received the most recent such day of the week. .SH "EXAMPLES" The command .P .nf .B mymail --db-file /tmp/mymail/2010-2011/mymail.db \e .B \ \ \ \ \ \ \ --index \e .B \ \ \ \ \ \ \ ~/archives/mails/2010 ~/archives/mails/2011 .fi will index all the mbox files present in the directories ~/archives/mails/2010 and ~/archives/mails/2011 (recursively) and create an index file /tmp/mymail/2010-2011/mymail.db And .P .nf .B mymail --db-pattern '\.db$' --db-root /tmp/mymail \e .B \ \ \ \ \ \ \ --output /tmp/mymail.mbox \e .B \ \ \ \ \ \ \ --search 'p bob.something' \e .B \ \ \ \ \ \ \ --search '!s spam' \e .B \ \ \ \ \ \ \ --search 'month' .fi will search in all the database files *.db located (recursively) in /tmp/mymail, for all the mails having "bob.something" as sender or recipient, without "spam" in the subject, received over the last 31 days, and create an mbox file /tmp/mymail/mbox. .SH "BUGS" The search in the mail bodies does not decode mimencoding mails, hence will not catch patterns in encoded text. The mbox format is not clear for multipart messages, since the ^"From " lines are not always quoted properly (at least the ones I use for testing). .SH "AUTHOR" Written by Francois Fleuret and distributed under the terms of the GNU General Public License version 3 as published by the Free Software Foundation. This is free software: you are free to change and redistribute it. There is NO WARRANTY, to the extent permitted by law.