From: Mark Walters Date: Fri, 18 Apr 2014 19:23:29 +0000 (+0100) Subject: Re: [PATCH 1/4] doc: Clarify notmuch show --format=raw description X-Git-Url: http://git.tremily.us/?a=commitdiff_plain;h=2e2c45f4d2018f79ad8b3752e0fcad1c5261ddd6;p=notmuch-archives.git Re: [PATCH 1/4] doc: Clarify notmuch show --format=raw description --- diff --git a/01/5d71defb7efb5adfda3dca179c9f810715b6a7 b/01/5d71defb7efb5adfda3dca179c9f810715b6a7 new file mode 100644 index 000000000..cb13b0b86 --- /dev/null +++ b/01/5d71defb7efb5adfda3dca179c9f810715b6a7 @@ -0,0 +1,146 @@ +Return-Path: +X-Original-To: notmuch@notmuchmail.org +Delivered-To: notmuch@notmuchmail.org +Received: from localhost (localhost [127.0.0.1]) + by olra.theworths.org (Postfix) with ESMTP id D6D03431FB6 + for ; Fri, 18 Apr 2014 12:23:57 -0700 (PDT) +X-Virus-Scanned: Debian amavisd-new at olra.theworths.org +X-Spam-Flag: NO +X-Spam-Score: -1.098 +X-Spam-Level: +X-Spam-Status: No, score=-1.098 tagged_above=-999 required=5 + tests=[DKIM_ADSP_CUSTOM_MED=0.001, FREEMAIL_FROM=0.001, + NML_ADSP_CUSTOM_MED=1.2, RCVD_IN_DNSWL_MED=-2.3] autolearn=disabled +Received: from olra.theworths.org ([127.0.0.1]) + by localhost (olra.theworths.org [127.0.0.1]) (amavisd-new, port 10024) + with ESMTP id QS+epAFk+cSY for ; + Fri, 18 Apr 2014 12:23:48 -0700 (PDT) +Received: from mail2.qmul.ac.uk (mail2.qmul.ac.uk [138.37.6.6]) + (using TLSv1 with cipher DHE-RSA-AES256-SHA (256/256 bits)) + (No client certificate requested) + by olra.theworths.org (Postfix) with ESMTPS id 0CA22431FAF + for ; Fri, 18 Apr 2014 12:23:47 -0700 (PDT) +Received: from smtp.qmul.ac.uk ([138.37.6.40]) + by mail2.qmul.ac.uk with esmtp (Exim 4.71) + (envelope-from ) + id 1WbENv-0006er-U2; Fri, 18 Apr 2014 20:23:42 +0100 +Received: from 94.196.126.238.threembb.co.uk ([94.196.126.238] helo=localhost) + by smtp.qmul.ac.uk with esmtpsa (TLSv1:AES128-SHA:128) (Exim 4.71) + (envelope-from ) + id 1WbENu-0001Mx-Gw; Fri, 18 Apr 2014 20:23:39 +0100 +From: Mark Walters +To: Austin Clements , notmuch@notmuchmail.org +Subject: Re: [PATCH 1/4] doc: Clarify notmuch show --format=raw description +In-Reply-To: <1397834332-25175-2-git-send-email-amdragon@mit.edu> +References: <1397834332-25175-1-git-send-email-amdragon@mit.edu> + <1397834332-25175-2-git-send-email-amdragon@mit.edu> +User-Agent: Notmuch/0.15.2+615~g78e3a93 (http://notmuchmail.org) Emacs/23.4.1 + (x86_64-pc-linux-gnu) +Date: Fri, 18 Apr 2014 20:23:29 +0100 +Message-ID: <87lhv2h26m.fsf@qmul.ac.uk> +MIME-Version: 1.0 +Content-Type: text/plain; charset=us-ascii +X-Sender-Host-Address: 94.196.126.238 +X-QM-Geographic: According to ripencc, + this message was delivered by a machine in Britain (UK) (GB). +X-QM-SPAM-Info: Sender has good ham record. :) +X-QM-Body-MD5: e36223e3c6ba0d2ff1b732c0c6ce3690 (of first 20000 bytes) +X-SpamAssassin-Score: 0.0 +X-SpamAssassin-SpamBar: / +X-SpamAssassin-Report: The QM spam filters have analysed this message to + determine if it is + spam. We require at least 5.0 points to mark a message as spam. + This message scored 0.0 points. Summary of the scoring: + * 0.0 FREEMAIL_FROM Sender email is commonly abused enduser mail + provider * (markwalters1009[at]gmail.com) +X-QM-Scan-Virus: ClamAV says the message is clean +X-BeenThere: notmuch@notmuchmail.org +X-Mailman-Version: 2.1.13 +Precedence: list +List-Id: "Use and development of the notmuch mail system." + +List-Unsubscribe: , + +List-Archive: +List-Post: +List-Help: +List-Subscribe: , + +X-List-Received-Date: Fri, 18 Apr 2014 19:23:58 -0000 + + +On Fri, 18 Apr 2014, Austin Clements wrote: +> In addition to being generally more precise, this is explicit that +> there is no charset conversion. +> --- +> doc/man1/notmuch-show.rst | 36 ++++++++++++++++++++---------------- +> 1 file changed, 20 insertions(+), 16 deletions(-) +> +> diff --git a/doc/man1/notmuch-show.rst b/doc/man1/notmuch-show.rst +> index bad868b..2c0f64c 100644 +> --- a/doc/man1/notmuch-show.rst +> +++ b/doc/man1/notmuch-show.rst +> @@ -76,22 +76,26 @@ Supported options for **show** include +> +> http://homepage.ntlworld.com/jonathan.deboynepollard/FGA/mail-mbox-formats.html +> +> - **raw** (default for a single part, see --part) +> - For a message or an attached message part, the original, raw +> - content of the email message is output. Consumers of this +> - format should expect to implement MIME decoding and similar +> - functions. +> - +> - For a single part (--part) the raw part content is output +> - after performing any necessary MIME decoding. Note that +> - messages with a simple body still have two parts: part 0 is +> - the whole message and part 1 is the body. +> - +> - For a multipart part, the part headers and body (including +> - all child parts) is output. +> - +> - The raw format must only be used with search terms matching +> - single message. +> + **raw** (default if --part is given) +> + Write the raw bytes of the given MIME part of a message to +> + standard out. For this format, it is an error to specify a +> + query that matches more than one message. +> + +> + If the specified part is a leaf part, this outputs the +> + body of the part after performing content transfer +> + decoding (but no charset conversion). This is suitable for +> + saving attachments, for example. +> + +> + For a multipart or message part, the output includes the +> + part headers as well as the body (including all child +> + parts). No decoding is performed because multipart and +> + message parts cannot have non-trivial content transfer +> + encoding. Consumers of this may need to implement MIME +> + decoding and similar functions. +> + +> + Note that even a message with a simple body has two parts: +> + part 0 is the whole message and part 1 is the body of the +> + message. + +Generally this looks good. I wonder whether the paragraph above could be +expanded slightly: my (quite possibly flawed) understanding is that +simple messages don't need to be MIME encoded (at least some messages +don't contain any mention of MIME). If this is correct then I think it +would be worth clarifying that this paragraph applies even to non-MIME +encoded messages. + +Best wishes + +Mark + + + +> +> ``--format-version=N`` +> Use the specified structured output format version. This is +> -- +> 1.9.1 +> +> _______________________________________________ +> notmuch mailing list +> notmuch@notmuchmail.org +> http://notmuchmail.org/mailman/listinfo/notmuch