Re: [ietf-smtp] Proper definition of the term "email payload".

Barry Warsaw <barry@python.org> Mon, 01 April 2019 00:09 UTC

Return-Path: <barry@python.org>
X-Original-To: ietf-smtp@ietfa.amsl.com
Delivered-To: ietf-smtp@ietfa.amsl.com
Received: from localhost (localhost [127.0.0.1]) by ietfa.amsl.com (Postfix) with ESMTP id D35331201D0 for <ietf-smtp@ietfa.amsl.com>; Sun, 31 Mar 2019 17:09:38 -0700 (PDT)
X-Virus-Scanned: amavisd-new at amsl.com
X-Spam-Flag: NO
X-Spam-Score: -1.901
X-Spam-Level:
X-Spam-Status: No, score=-1.901 tagged_above=-999 required=5 tests=[BAYES_00=-1.9, RCVD_IN_DNSWL_NONE=-0.0001, SPF_PASS=-0.001] autolearn=ham autolearn_force=no
Received: from mail.ietf.org ([4.31.198.44]) by localhost (ietfa.amsl.com [127.0.0.1]) (amavisd-new, port 10024) with ESMTP id i0-G9VOVhEWN for <ietf-smtp@ietfa.amsl.com>; Sun, 31 Mar 2019 17:09:36 -0700 (PDT)
Received: from mail.wooz.org (mail.wooz.org [216.15.33.194]) (using TLSv1.2 with cipher AECDH-AES256-SHA (256/256 bits)) (No client certificate requested) by ietfa.amsl.com (Postfix) with ESMTPS id B6E621201A3 for <ietf-smtp@ietf.org>; Sun, 31 Mar 2019 17:09:36 -0700 (PDT)
Received: from localhost (localhost [127.0.0.1]) by mail.wooz.org (Postfix) with ESMTP id 53BC9142FF5; Sun, 31 Mar 2019 20:09:35 -0400 (EDT)
X-Virus-Scanned: Debian amavisd-new at mail.wooz.org
Received: from mail.wooz.org ([127.0.0.1]) by localhost (mail.wooz.org [127.0.0.1]) (amavisd-new, port 10024) with ESMTP id rjN8ZASjOKO8; Sun, 31 Mar 2019 20:09:34 -0400 (EDT)
Received: from [192.168.1.64] (76-253-0-158.lightspeed.sntcca.sbcglobal.net [76.253.0.158]) by mail.wooz.org (Postfix) with ESMTPSA id 8728E140397; Sun, 31 Mar 2019 20:09:33 -0400 (EDT)
Content-Type: multipart/signed; boundary="Apple-Mail=_94F69295-FC64-4F88-BF15-F053017A1E59"; protocol="application/pgp-signature"; micalg="pgp-sha256"
Mime-Version: 1.0 (Mac OS X Mail 12.4 \(3445.104.8\))
From: Barry Warsaw <barry@python.org>
In-Reply-To: <CAOEezJRM8ZVaWK6rtvP4ZH9CbN-itVof9_Zi8hf+wVym0cAxzA@mail.gmail.com>
Date: Sun, 31 Mar 2019 17:09:30 -0700
Cc: ietf-smtp@ietf.org, "R. David Murray" <rdmurray@bitdance.com>, Mark Sapiro <msapiro@value.net>
X-Mao-Original-Outgoing-Id: 575770169.6934789-8c1ebcde10fe2757445c99afa8d5e67f
Message-Id: <553DAEA9-DCF1-461A-9908-20465882AEFB@python.org>
References: <CAOEezJRM8ZVaWK6rtvP4ZH9CbN-itVof9_Zi8hf+wVym0cAxzA@mail.gmail.com>
To: Viruthagiri Thirumavalavan <giri@dombox.org>
X-Mailer: Apple Mail (2.3445.104.8)
Archived-At: <https://mailarchive.ietf.org/arch/msg/ietf-smtp/XspME17bRCs6nGByqg-YgQBdoDc>
X-Mailman-Approved-At: Sun, 31 Mar 2019 19:46:31 -0700
Subject: Re: [ietf-smtp] Proper definition of the term "email payload".
X-BeenThere: ietf-smtp@ietf.org
X-Mailman-Version: 2.1.29
Precedence: list
List-Id: "Discussion of issues related to Simple Mail Transfer Protocol \(SMTP\) \[RFC 821, RFC 2821, RFC 5321\]" <ietf-smtp.ietf.org>
List-Unsubscribe: <https://www.ietf.org/mailman/options/ietf-smtp>, <mailto:ietf-smtp-request@ietf.org?subject=unsubscribe>
List-Archive: <https://mailarchive.ietf.org/arch/browse/ietf-smtp/>
List-Post: <mailto:ietf-smtp@ietf.org>
List-Help: <mailto:ietf-smtp-request@ietf.org?subject=help>
List-Subscribe: <https://www.ietf.org/mailman/listinfo/ietf-smtp>, <mailto:ietf-smtp-request@ietf.org?subject=subscribe>
X-List-Received-Date: Mon, 01 Apr 2019 00:22:28 -0000

Hi, I hope you (and they!) don’t mind me CCing two other people who have worked extensively on Python’s email library, and in fact much more than myself in the recent years.  RDM has done the bulk of the work on the new-in-Python-3 APIs, and Mark is a long time core developer on GNU Mailman (the project that spawned Python’s email library).

There are two ways I think about this, and I’ll use the original RFC numbers to clarify.  There’s RFC 821, which describes the on-the-wire protocol for SMTP transfers, embodied in Python’s smtplib library.  Then there’s RFC 822, which describes the format of the content of that SMTP transfer, but not the protocol itself.  Of course there are lots of developments along the way, but that’s unimportant for the way I think about these things.

What I think you are describing, where the headers are part of the payload, is more akin to RFC 821.  That’s the payload as far as the actual bytes-on-the-wire are concerned.  Python’s email library is for RFC 822 (and the many, many elaborations thereof), so in that case, the payload is the body of the message.  On more practical terms, the implementation makes this clear, and the APIs you use to change headers are different in form and function than the ones you use to change the body of the message.

I think the Python documentation is fairly clear about this distinction.  At least, I don’t remember seeing any feedback to the contrary, although RDM may have a better sense of that.  Of course, we are always open to improvements in Python’s documentation.

Cheers,
-Barry

> On Mar 31, 2019, at 10:57, Viruthagiri Thirumavalavan <giri@dombox.org> wrote:
> 
> Hello IETF,
> 
> I need some clarification about the term "email payload".
> 
> Wikipedia says
> 
> In computing and telecommunications, the payload is the part of transmitted data that is the actual intended message. Headers and metadata are sent only to enable payload delivery
> 
> Python email library documentation says this.
> 
> An email message consists of headers and a payload (which is also referred to as the content). Headers are RFC 5322 or RFC 6532 style field names and values, where the field name and value are separated by a colon. The colon is not part of either the field name or the field value. The payload may be a simple text message, or a binary object, or a structured sequence of sub-messages each with their own set of headers and their own payload. The latter type of payload is indicated by the message having a MIME type such as multipart/* or message/rfc822.
> 
> It looks like Python email library author "Barry Warsaw" followed similar definition found in wikipedia when defining his library functions. But I feel like calling ONLY the email "Body Part" as "payload" is wrong. The term "payload" should refer to the entire "Message Part" in Email. i.e. Both Headers and Body.
> 
> When you place an order for a "box of beer", you are not paying only for the "beer cans", but also paying for the "container box". So the payload here is the entire box.
> 
> HTTP Example:
> 
> HTTP/1.1 200 OK
> Date: Sun, 10 Oct 2010 23:26:07 GMT
> Content-Type: text/html
> Content-Length: 1234
> 
> <html>
> 
> <head>
> <title>Hello World!</title>
> </head>
> 
> <body>
> (more contents)
>   .
>   .
>   .
> </body>
> </html>
> 
> 
> If you take a closer look at this HTTP example, the headers are only just instructions for the client. The end user doesn't need to worry about any piece of information found in those headers. So wikipedia definition perfectly suited for applications like HTTP.
> 
> But in Email, When a mail get transferred from Hop A to Hop C via Hop B, the user in Hop A actually wants to deliver the whole "message part" to Hop C. If Hop B, strips the headers and transfer only the "Body" part, then it becomes an "Anonymous" message. So the end user requires the information found in the "Headers" too. e.g. From, Subject, Date etc. [In HTTP, title tag is equivalent to Subject and it's found in the "head" Markup, not in the HTTP Headers]
> 
> As you can see, the user is interested in the "entire message". So the term "actual intended message" should refer to the "whole message" extracted from the DATA command. The "actual intended message" should be pictured like this in email.
> 
> Also note that, when you migrate your mails to another mail service, you need the whole message with Headers, not just the body.
> 
> Based on my points, I believe calling only the "Body" part as "Payload" is wrong. I would love to hear your thoughts on this. If Barry Warsaw is here, would love to know your opinion too.
> 
> PS: I did actually ask this question 2 years back in a stackexchange website. I wasn't satisfied with the answer I got there. I don't want to use the term incorrectly in my application. That's why I'm posting it here.
> 
> Thanks
> --
> Best Regards,
> 
> Viruthagiri Thirumavalavan
> Dombox, Inc.