summaryrefslogtreecommitdiff
path: root/notmuch.1
diff options
context:
space:
mode:
authorDavid Edmondson <dme@dme.org>2010-03-24 07:21:20 +0000
committerDavid Edmondson <dme@dme.org>2010-04-02 09:43:03 +0100
commit2e9c7aba99598eafd7b5fc52897da14ea13af216 (patch)
tree51a832c9dd92319c81735db321d35e13018ccb79 /notmuch.1
parent930a47935fcd87ff4ae6c0c14279fd136f5bd78b (diff)
notmuch: Add a 'part' subcommand
A new 'part' subcommand allows the user to extract a single part from a MIME message. Usage: notmuch part --part=<n> <search terms> The search terms must match only a single message (e.g. id:foo@bar.com). The part number specified refers to the part identifiers output by `notmuch show'. The content of the part is written the stdout with no formatting or identification marks. It is not JSON formatted.
Diffstat (limited to 'notmuch.1')
-rw-r--r--notmuch.126
1 files changed, 26 insertions, 0 deletions
diff --git a/notmuch.1 b/notmuch.1
index e573749..9d0473d 100644
--- a/notmuch.1
+++ b/notmuch.1
@@ -353,6 +353,32 @@ So if you've previously been using sup for mail, then the
.B "notmuch restore"
command provides you a way to import all of your tags (or labels as
sup calls them).
+.RE
+
+The
+.B part
+command can used to output a single part of a multi-part MIME message.
+
+.RS 4
+.TP 4
+.BR part " --part=<part-number> <search-term>..."
+
+Output a single MIME part of a message.
+
+A single decoded MIME part, with no encoding or framing, is output to
+stdout. The search terms must match only a single message, otherwise
+this command will fail.
+
+The part number should match the part "id" field output by the
+"--format=json" option of "notmuch show". If the message specified by
+the search terms does not include a part with the specified "id" there
+will be no output.
+
+See the
+.B "SEARCH SYNTAX"
+section below for details of the supported syntax for <search-terms>.
+.RE
+
.SH SEARCH SYNTAX
Several notmuch commands accept a common syntax for search terms.