73/09b7fc09bf01aca729ff7f7977ae778615064f

   1 Return-Path: <m.walters@qmul.ac.uk>\r
   2 X-Original-To: notmuch@notmuchmail.org\r
   3 Delivered-To: notmuch@notmuchmail.org\r
   4 Received: from localhost (localhost [127.0.0.1])\r
   5         by olra.theworths.org (Postfix) with ESMTP id 0F6CB431FB6\r
   6         for <notmuch@notmuchmail.org>; Fri, 18 Apr 2014 12:37:31 -0700 (PDT)\r
   7 X-Virus-Scanned: Debian amavisd-new at olra.theworths.org\r
   8 X-Spam-Flag: NO\r
   9 X-Spam-Score: 0.148\r
  10 X-Spam-Level: \r
  11 X-Spam-Status: No, score=0.148 tagged_above=-999 required=5\r
  12         tests=[DKIM_ADSP_CUSTOM_MED=0.001, FREEMAIL_FROM=0.001,\r
  13         NML_ADSP_CUSTOM_MED=1.2, RCVD_IN_BL_SPAMCOP_NET=1.246,\r
  14         RCVD_IN_DNSWL_MED=-2.3] autolearn=disabled\r
  15 Received: from olra.theworths.org ([127.0.0.1])\r
  16         by localhost (olra.theworths.org [127.0.0.1]) (amavisd-new, port 10024)\r
  17         with ESMTP id L1KW8qD6ee+S for <notmuch@notmuchmail.org>;\r
  18         Fri, 18 Apr 2014 12:37:24 -0700 (PDT)\r
  19 Received: from mail1.qmul.ac.uk (mail1.qmul.ac.uk [138.37.6.7])\r
  20         (using TLSv1 with cipher DHE-RSA-AES256-SHA (256/256 bits))\r
  21         (No client certificate requested)\r
  22         by olra.theworths.org (Postfix) with ESMTPS id D4A4F431FAF\r
  23         for <notmuch@notmuchmail.org>; Fri, 18 Apr 2014 12:37:23 -0700 (PDT)\r
  24 Received: from smtp.qmul.ac.uk ([138.37.6.40])\r
  25         by mail1.qmul.ac.uk with esmtp (Exim 4.71)\r
  26         (envelope-from <m.walters@qmul.ac.uk>)\r
  27         id 1WbEb7-00026m-Bd; Fri, 18 Apr 2014 20:37:17 +0100\r
  28 Received: from 94.196.126.238.threembb.co.uk ([94.196.126.238] helo=localhost)\r
  29         by smtp.qmul.ac.uk with esmtpsa (TLSv1:AES128-SHA:128) (Exim 4.71)\r
  30         (envelope-from <m.walters@qmul.ac.uk>)\r
  31         id 1WbEb4-0003zI-M4; Fri, 18 Apr 2014 20:37:17 +0100\r
  32 From: Mark Walters <markwalters1009@gmail.com>\r
  33 To: Austin Clements <amdragon@MIT.EDU>\r
  34 Subject: Re: [PATCH 1/4] doc: Clarify notmuch show --format=raw description\r
  35 In-Reply-To: <20140418193315.GB9395@mit.edu>\r
  36 References: <1397834332-25175-1-git-send-email-amdragon@mit.edu>\r
  37         <1397834332-25175-2-git-send-email-amdragon@mit.edu>\r
  38         <87lhv2h26m.fsf@qmul.ac.uk> <20140418193315.GB9395@mit.edu>\r
  39 User-Agent: Notmuch/0.15.2+615~g78e3a93 (http://notmuchmail.org) Emacs/23.4.1\r
  40         (x86_64-pc-linux-gnu)\r
  41 Date: Fri, 18 Apr 2014 20:37:06 +0100\r
  42 Message-ID: <87ha5qh1jx.fsf@qmul.ac.uk>\r
  43 MIME-Version: 1.0\r
  44 Content-Type: text/plain; charset=us-ascii\r
  45 X-Sender-Host-Address: 94.196.126.238\r
  46 X-QM-Geographic: According to ripencc,\r
  47         this message was delivered by a machine in Britain (UK) (GB).\r
  48 X-QM-SPAM-Info: Sender has good ham record.  :)\r
  49 X-QM-Body-MD5: 9bda0c47e6979e815fea960225ca9a48 (of first 20000 bytes)\r
  50 X-SpamAssassin-Score: 0.0\r
  51 X-SpamAssassin-SpamBar: /\r
  52 X-SpamAssassin-Report: The QM spam filters have analysed this message to\r
  53         determine if it is\r
  54         spam. We require at least 5.0 points to mark a message as spam.\r
  55         This message scored 0.0 points. Summary of the scoring: \r
  56         * 0.0 FREEMAIL_FROM Sender email is commonly abused enduser mail\r
  57         provider *      (markwalters1009[at]gmail.com)\r
  58         * -0.0 AWL AWL: From: address is in the auto white-list\r
  59 X-QM-Scan-Virus: ClamAV says the message is clean\r
  60 Cc: notmuch@notmuchmail.org\r
  61 X-BeenThere: notmuch@notmuchmail.org\r
  62 X-Mailman-Version: 2.1.13\r
  63 Precedence: list\r
  64 List-Id: "Use and development of the notmuch mail system."\r
  65         <notmuch.notmuchmail.org>\r
  66 List-Unsubscribe: <http://notmuchmail.org/mailman/options/notmuch>,\r
  67         <mailto:notmuch-request@notmuchmail.org?subject=unsubscribe>\r
  68 List-Archive: <http://notmuchmail.org/pipermail/notmuch>\r
  69 List-Post: <mailto:notmuch@notmuchmail.org>\r
  70 List-Help: <mailto:notmuch-request@notmuchmail.org?subject=help>\r
  71 List-Subscribe: <http://notmuchmail.org/mailman/listinfo/notmuch>,\r
  72         <mailto:notmuch-request@notmuchmail.org?subject=subscribe>\r
  73 X-List-Received-Date: Fri, 18 Apr 2014 19:37:31 -0000\r
  74 \r
  75 On Fri, 18 Apr 2014, Austin Clements <amdragon@MIT.EDU> wrote:\r
  76 > Quoth Mark Walters on Apr 18 at  8:23 pm:\r
  77 >> \r
  78 >> On Fri, 18 Apr 2014, Austin Clements <amdragon@MIT.EDU> wrote:\r
  79 >> > In addition to being generally more precise, this is explicit that\r
  80 >> > there is no charset conversion.\r
  81 >> > ---\r
  82 >> >  doc/man1/notmuch-show.rst | 36 ++++++++++++++++++++----------------\r
  83 >> >  1 file changed, 20 insertions(+), 16 deletions(-)\r
  84 >> >\r
  85 >> > diff --git a/doc/man1/notmuch-show.rst b/doc/man1/notmuch-show.rst\r
  86 >> > index bad868b..2c0f64c 100644\r
  87 >> > --- a/doc/man1/notmuch-show.rst\r
  88 >> > +++ b/doc/man1/notmuch-show.rst\r
  89 >> > @@ -76,22 +76,26 @@ Supported options for **show** include\r
  90 >> >  \r
  91 >> >        http://homepage.ntlworld.com/jonathan.deboynepollard/FGA/mail-mbox-formats.html\r
  92 >> >  \r
  93 >> > -        **raw** (default for a single part, see --part)\r
  94 >> > -            For a message or an attached message part, the original, raw\r
  95 >> > -            content of the email message is output. Consumers of this\r
  96 >> > -            format should expect to implement MIME decoding and similar\r
  97 >> > -            functions.\r
  98 >> > -\r
  99 >> > -            For a single part (--part) the raw part content is output\r
 100 >> > -            after performing any necessary MIME decoding. Note that\r
 101 >> > -            messages with a simple body still have two parts: part 0 is\r
 102 >> > -            the whole message and part 1 is the body.\r
 103 >> > -\r
 104 >> > -            For a multipart part, the part headers and body (including\r
 105 >> > -            all child parts) is output.\r
 106 >> > -\r
 107 >> > -            The raw format must only be used with search terms matching\r
 108 >> > -            single message.\r
 109 >> > +        **raw** (default if --part is given)\r
 110 >> > +            Write the raw bytes of the given MIME part of a message to\r
 111 >> > +            standard out. For this format, it is an error to specify a\r
 112 >> > +            query that matches more than one message.\r
 113 >> > +\r
 114 >> > +            If the specified part is a leaf part, this outputs the\r
 115 >> > +            body of the part after performing content transfer\r
 116 >> > +            decoding (but no charset conversion). This is suitable for\r
 117 >> > +            saving attachments, for example.\r
 118 >> > +\r
 119 >> > +            For a multipart or message part, the output includes the\r
 120 >> > +            part headers as well as the body (including all child\r
 121 >> > +            parts). No decoding is performed because multipart and\r
 122 >> > +            message parts cannot have non-trivial content transfer\r
 123 >> > +            encoding. Consumers of this may need to implement MIME\r
 124 >> > +            decoding and similar functions.\r
 125 >> > +\r
 126 >> > +            Note that even a message with a simple body has two parts:\r
 127 >> > +            part 0 is the whole message and part 1 is the body of the\r
 128 >> > +            message.\r
 129 >> \r
 130 >> Generally this looks good. I wonder whether the paragraph above could be\r
 131 >> expanded slightly: my (quite possibly flawed) understanding is that\r
 132 >> simple messages don't need to be MIME encoded (at least some messages\r
 133 >> don't contain any mention of MIME). If this is correct then I think it\r
 134 >> would be worth clarifying that this paragraph applies even to non-MIME\r
 135 >> encoded messages.\r
 136 >\r
 137 > It's true that even "non-MIME" messages have two MIME parts.  Are you\r
 138 > thinking something like\r
 139 >\r
 140 > Note that even a message with no MIME structure or a single body part\r
 141 > still has two MIME parts: part 0 is the whole message (headers and\r
 142 > body) and part 1 is just the body.\r
 143 >\r
 144 \r
 145 That sounds great.\r
 146 \r
 147 > ?\r
 148 >\r
 149 > I wonder if this would be better in the documentation for --part.\r
 150 \r
 151 I think that would make sense.\r
 152 \r
 153 Best wishes\r
 154 \r
 155 Mark\r