As per Relevance of the word parameter, we have this rfc below:
Network Working Group R. Gellens,
Request for Comments: 2646
Updates: 2046 August 1999
Category: Standards
The Text/Plain Format
Status of this
This document specifies an Internet standards track protocol for
Internet community, and requests discussion and suggestions
improvements. Please refer to the current edition of the "
Official Protocol Standards" (STD 1) for the standardization
and status of this protocol. Distribution of this memo is unlimited
Copyright
Copyright (C) The Internet Society (1999). All Rights Reserved
Table of
1. Abstract . . . . . . . . . . . . . . . . . . . . . . . . . . 2
2. Conventions Used in this Document . . . . . . . . . . . . . 2
3. The Problem . . . . . . . . . . . . . . . . . . . . . . . . 2
3.1. Paragraph Text . . . . . . . . . . . . . . . . . . . . 3
3.2. Embarrassing Line Wrap . . . . . . . . . . . . . . . . . 3
3.3. New Media Types . . . . . . . . . . . . . . . . . . . . 4
4. The Format Parameter to the Text/Plain Media Type . . . . . 4
4.1. Generating Format=Flowed . . . . . . . . . . . . . . . 5
4.2. Interpreting Format=Flowed . . . . . . . . . . . . . . . 6
4.3. Usenet Signature Convention . . . . . . . . . . . . . . 7
4.4. Space-Stuffing . . . . . . . . . . . . . . . . . . . . . 7
4.5. Quoting . . . . . . . . . . . . . . . . . . . . . . . . 8
4.6. Digital Signatures and Encryption . . . . . . . . . . . 9
4.7. Line Analysis Table . . . . . . . . . . . . . . . . . . 10
4.8. Examples . . . . . . . . . . . . . . . . . . . . . . . . 10
5. ABNF . . . . . . . . . . . . . . . . . . . . . . . . . . . 11
6. Failure Modes . . . . . . . . . . . . . . . . . . . . . . . 11
6.1. Trailing White Space Corruption . . . . . . . . . . . . 11
7. Security Considerations . . . . . . . . . . . . . . . . . . 12
8. IANA Considerations . . . . . . . . . . . . . . . . . . . . 12
9. Internationalization Considerations . . . . . . . . . . . . 12
10. Acknowledgments . . . . . . . . . . . . . . . . . . . . . . 12
11. References . . . . . . . . . . . . . . . . . . . . . . . . . 13
12. Editor's Address . . . . . . . . . . . . . . . . . . . . . 13
13. Full Copyright Statement . . . . . . . . . . . . . . . . . . 14
Gellens Standards Track [Page 1]
RFC 2646 The Text/Plain Format Parameter August 1999
1.
Interoperability problems have been observed with erroneous
of paragraph text as Text/Plain, and with various forms
"embarrassing line wrap." (See section 3.)
Attempts to deploy new media types, such as Text/Enriched [RICH]
Text/HTML [HTML] have suffered from a lack of backwards
and an often hostile user reaction at the receiving end
What is required is a format which is in all significant
Text/Plain, and therefore is quite suitable for display
Text/Plain, and yet allows the sender to express to the
which lines can be considered a logical paragraph, and thus
(wrapped and joined) as appropriate
This memo proposes a new parameter to be used with Text/Plain, and
in the presence of this parameter, the use of trailing whitespace
indicate flowed lines. This results in an encoding which appears
normal Text/Plain in older implementations, since it is in
normal Text/Plain
2. Conventions Used in this
The key words "REQUIRED", "MUST", "MUST NOT", "SHOULD", "SHOULD NOT",
and "MAY" in this document are to be interpreted as described in "
words for use in RFCs to Indicate Requirement Levels" [KEYWORDS].
3. The
The Text/Plain media type is the lowest common denominator
Internet email, with lines of no more than 997 characters (
convention usually no more than 80), and where the CRLF
represents a line break [MIME-IMT].
Text/Plain is usually displayed as preformatted text, often in
fixed font. That is, the characters start at the left margin of
display window, and advance to the right until a CRLF sequence
seen, at which point a new line is started, again at the left margin
When a line length exceeds the display window, some clients will
the line, while others invoke a horizontal scroll bar
Text which meets this description is defined by this memo as "fixed".
Some interoperability problems have been observed with this
type
Gellens Standards Track [Page 2]
RFC 2646 The Text/Plain Format Parameter August 1999
3.1. Paragraph
Many modern programs use a proportional-spaced font and CRLF
represent paragraph breaks. Line breaks are "soft", occurring
needed on display. That is, characters are grouped into a
until a CRLF sequence is seen, at which point a new paragraph
started. Each paragraph is displayed, starting at the left
(or paragraph indent), and continuing to the right until a word
encountered which does not fit in the remaining display width.
word is displayed at the left margin of the next line.
continues until the paragraph ends (a CRLF is seen). Extra
space is left between paragraphs
Text which meets this description is defined by this memo
"flowed".
Numerous software products erroneously label this media type
Text/Plain, resulting in much user discomfort
3.2. Embarrassing Line
As Text/Plain messages get quoted in replies or forwarded messages
the length of each line gradually increases, resulting
"embarrassing line wrap." This results in text which is at best
to read, and often confuses attributions
Example
>>>>>>This is a comment from the first message to show
>quoting example
>>>>>This is a comment from the second message to show
>quoting example
>>>>This is a comment from the third message
>>>This is a comment from the fourth message
It can be confusing to assign attribution to lines 2 and 4 above
In addition, as devices with display widths smaller than 80
characters become more popular, embarrassing line wrap has
even more prevalent, even with unquoted text
Gellens Standards Track [Page 3]
RFC 2646 The Text/Plain Format Parameter August 1999
Example
This is paragraph text that
meant to be flowed
several lines
However, the sending mailer
converting it to fixed text
a width of 72
characters, which causes it
look like this when shown on
PDA with
30 character lines
3.3. New Media
Attempts to deploy new media types, such as Text/Enriched [RICH]
Text/HTML [HTML] have suffered from a lack of backwards
and an often hostile user reaction at the receiving end
In particular, Text/Enriched requires that open angle brackets ("<")
and hard line breaks be doubled, with resulting user unhappiness
viewed as Text/Plain. Text/HTML requires even more alteration
text, with a corresponding increase in user complaints
A proposal to define a new media type to explicitly represent
paragraph form suffered from a lack of interoperability
currently deployed software. Some programs treat unknown subtypes
Text as an attachment
What is desired is a format which is in all significant
Text/Plain, and therefore is quite suitable for display
Text/Plain, and yet allows the sender to express to the
which lines can be considered a logical paragraph, and thus
(wrapped and joined) as appropriate
4. The Format Parameter to the Text/Plain Media
This document defines a new MIME parameter for use with Text/Plain
Name:
Value: Fixed,
(Neither the parameter name nor its value are case sensitive.)
If not specified, a value of Fixed is assumed. The semantics of
Fixed value are the usual associated with Text/Plain [MIME-IMT].
Gellens Standards Track [Page 4]
RFC 2646 The Text/Plain Format Parameter August 1999
A value of Flowed indicates that the definition of flowed text (
specified in this memo) was used on generation, and MAY be used
reception
This section discusses flowed text; section 5 provides a
definition
Because flowed lines are all-but-indistinguishable from fixed lines
currently deployed software treats flowed lines as normal Text/
(which is what they are). Thus, no interoperability problems
expected
Note that this memo describes an on-the-wire format. It does
address formats for local file storage
4.1. Generating Format=
When generating Format=Flowed text, lines SHOULD be shorter than 80
characters. As suggested values, any paragraph longer than 79
characters in total length could be wrapped using lines of 72
fewer characters. While the specific line length used is a matter
aesthetics and preference, longer lines are more likely to
rewrapping and to encounter difficulties with older mailers. It
been suggested that 66 character lines are the most readable
(The reason for the restriction to 79 or fewer characters
CRLFs on the wire is to ensure that all lines, even when displayed
a non-flowed-aware program, will fit in a standard 80-column
without having to be wrapped. The limit is 79, not 80, because
80 fit on a line, the last column is often reserved for a line-
indicator.)
When creating flowed text, the generating agent wraps, that is
inserts 'soft' line breaks as needed. Soft line breaks are
between words. Because a soft line break is a SP CRLF sequence,
generating agent creates one by inserting a CRLF after the
of a space
A generating agent SHOULD NOT insert white space into a word (
sequence of printable characters not containing spaces). If
with a word which exceeds 79 characters (but less than 998
characters, the [SMTP] limit on line length), the agent SHOULD
the word as is and exceed the 79-character limit on line length
Gellens Standards Track [Page 5]
RFC 2646 The Text/Plain Format Parameter August 1999
A generating agent SHOULD
1. Ensure all lines (fixed and flowed) are 79 characters
fewer in length, counting the trailing space but
counting the CRLF, unless a word by itself exceeds 79
characters
2. Trim spaces before user-inserted hard line breaks
3. Space-stuff lines which start with a space, "From ",
">".
In order to create messages which do not require space-stuffing,
are thus more aesthetically pleasing when viewed as Format=Fixed,
generating agent MAY avoid wrapping immediately before ">", "From ",
or space
(See sections 4.4 and 4.5 for more information on space-stuffing
quoting, respectively.)
A Format=Flowed message consists of zero or more paragraphs,
containing one or more flowed lines followed by one fixed line.
usual case is a series of flowed text lines with blank (empty)
lines between them
Any number of fixed lines can appear between paragraphs
[Quoted-Printable] encoding SHOULD NOT be used with Format=
unless absolutely necessary (for example, non-US-ASCII (8-bit
characters over a strictly 7-bit transport such as unextended SMTP).
In particular, a message SHOULD NOT be encoded in Quoted-
for the sole purpose of protecting the trailing space on flowed
unless the body part is cryptographically signed or encrypted (
Section 4.6).
The intent of Format=Flowed is to allow user agents to
flowed text which is non-obnoxious when viewed as pure,
Text/Plain (without any decoding); use of Quoted-Printable
this and may cause Format=Flowed to be rejected by end users
4.2. Interpreting Format=
If the first character of a line is a quote mark (">"), the line
considered to be quoted (see section 4.5). Logically, all
marks are counted and deleted, resulting in a line with a non-
quote depth, and content. (The agent is of course free to display
content with quote marks or excerpt bars or anything else.)
Logically, this test for quoted lines is done before any other
(that is, before checking for space-stuffed and flowed).
Gellens Standards Track [Page 6]
RFC 2646 The Text/Plain Format Parameter August 1999
If the first character of a line is a space, the line has
space-stuffed (see section 4.4). Logically, this leading space
deleted before examining the line further (that is, before
for flowed).
If the line ends in one or more spaces, the line is flowed
Otherwise it is fixed. Trailing spaces are part of the line'
content, but the CRLF of a soft line break is not
A series of one or more flowed lines followed by one fixed line
considered a paragraph, and MAY be flowed (wrapped and unwrapped)
appropriate on display and in the construction of new messages (
section 4.5).
A line consisting of one or more spaces (after deleting a
space) is considered a flowed line
4.3. Usenet Signature
There is a convention in Usenet news of using "-- " as the
line between the body and the signature of a message.
generating a Format=Flowed message containing a Usenet-
separator before the signature, the separator line is sent as-is
This is a special case; an (optionally quoted) line consisting
DASH DASH SP is not considered flowed
4.4. Space-
In order to allow for unquoted lines which start with ">", and
protect against systems which "From-munge" in-transit
(modifying any line which starts with "From " to ">From "),
Format=Flowed provides for space-stuffing
Space-stuffing adds a single space to the start of any line
needs protection when the message is generated. On reception, if
first character of a line is a space, it is logically deleted.
occurs after the test for a quoted line, and before the test for
flowed line
On generation, any unquoted lines which start with ">", and any
which start with a space or "From " SHOULD be space-stuffed.
lines MAY be space-stuffed as desired
(Note that space-stuffing is similar to dot-stuffing as specified
[SMTP].)
Gellens Standards Track [Page 7]
RFC 2646 The Text/Plain Format Parameter August 1999
If a space-stuffed message is received by an agent which
Format=Flowed, the space-stuffing is reversed and thus the
appears unchanged. An agent which is not aware of Format=Flowed
of course not undo any space-stuffing, thus Format=Flowed
may appear with a leading space on some lines (those which start
a space, ">" which is not a quote indicator, or "From ").
lines which require space-stuffing rarely occur, and the
consequences of unreversed space-stuffing are minimal, this is
expected to be a significant problem
4.5.
In Format=Flowed, the canonical quote indicator (or quote mark)
one or more close angle bracket (">") characters. Lines which
with the quote indicator are considered quoted. The number of ">"
characters at the start of the line specifies the quote depth
Flowed lines which are also quoted may require special handling
display and when copied to new messages
When creating quoted flowed lines, each such line starts with
quote indicator
Note that because of space-stuffing, the
>> Exit, Stage
>>Exit, Stage
are semantically identical; both have a quote-depth of two, and
content of "Exit, Stage Left".
However, the
> > Exit, Stage
is different. It has a quote-depth of one, and a content
"> Exit, Stage Left".
When generating quoted flowed lines, an agent needs to pay
to changes in quote depth. A sequence of quoted lines of the
quote depth SHOULD be encoded as a paragraph, with the last
generated as fixed and prior lines generated as flowed
If a receiving agent wishes to reformat flowed quoted lines (
and/or wrapping them) on display or when generating new messages,
lines SHOULD be de-quoted, reformatted, and then re-quoted.
de-quote, the number of close angle brackets in the quote
at the start of each line is counted. Consecutive lines with
same quoting depth are considered one paragraph and are
together. To re-quote after reformatting, a quote
containing the same number of close angle brackets originally
is prefixed to each line
Gellens Standards Track [Page 8]
RFC 2646 The Text/Plain Format Parameter August 1999
On reception, if a change in quoting depth occurs on a flowed line
this is an improperly formatted message. The receiver SHOULD
this error by using the 'quote-depth-wins' rule, which is to
the flowed indicator and treat the line as fixed. That is,
change in quote depth ends the paragraph
For example, consider the following sequence of lines (using '*'
indicate a soft line break, i.e., SP CRLF, and '#' to indicate a
line break, i.e., CRLF):
> Thou villainous ill-breeding spongy dizzy-eyed
> reeky elf-skinned pigeon-egg!* <--- problem ---<
>> Thou artless swag-bellied milk-livered
>> dismal-dreaming idle-headed scut!#
>>> Thou errant folly-fallen spleeny reeling-ripe
>>> unmuzzled ratsbane!#
>>>> Henceforth, the coding style is to be strictly
>>>> enforced, including the use of only upper case.#
>>>>> I've noticed a lack of adherence to the coding
>>>>> styles, of late.#
>>>>>> Any complaints?#
The second line ends in a soft line break, even though it is the
line of the one-deep quote block. The question then arises as to
this line should be interpreted, considering that the next line
the first line of the two-deep quote block
The example text above, when processed according to quote-depth wins
results in the first two lines being considered as one quoted,
section, with a quote depth of 1; the third and fourth lines become
quoted, flowed section, with a quote depth of 2.
A generating agent SHOULD NOT create this situation; a
agent SHOULD handle it using quote-depth wins
4.6. Digital Signatures and
If a message is digitally signed or encrypted it is important
cryptographic processing use the on-the-wire Format=Flowed format
That is, during generation the message SHOULD be prepared
transmission, including addition of soft line breaks, space-stuffing
and [Quoted-Printable] encoding (to protect soft line breaks)
being digitally signed or encrypted; similarly, on receipt
message SHOULD have the signature verified or be decrypted
[Quoted-Printable] decoding and removal of stuffed spaces, soft
breaks and quote marks, and reflowing
Gellens Standards Track [Page 9]
RFC 2646 The Text/Plain Format Parameter August 1999
4.7. Line Analysis
Lines contained in a Text/Plain body part with Format=Flowed can
analyzed by examining the start and end of the line. If the
starts with the quote indicator, it is quoted. If the line ends
one or more space characters, it is flowed. This is summarized
the following table
Starts Ends
with One or
Quote More Spaces
------ ----------- ---------------
no no unquoted,
yes no quoted,
no yes unquoted,
yes yes quoted,
4.8.
The following example contains three paragraphs
`Take some more tea,' the March Hare said to Alice,
earnestly
`I've had nothing yet,' Alice replied in an offended tone, `so
can't take more.'
`You mean you can't take LESS,' said the Hatter: `it's very
to take MORE than nothing.'
This could be encoded as follows (using '*' to indicate a soft
break, that is, SP CRLF sequence, and '#' to indicate a hard
break, that is, CRLF):
`Take some more tea,' the March Hare said to Alice, very
earnestly.*
#
`I've had nothing yet,' Alice replied in an offended tone, `so
I can't take more.'*
#
`You mean you can't take LESS,' said the Hatter: `it's very
easy to take MORE than nothing.'#
Gellens Standards Track [Page 10]
RFC 2646 The Text/Plain Format Parameter August 1999
To show an example of quoting, here we have the same exchange
presented as a series of direct quotes
>>>Take some more tea.#
>>I've had nothing yet, so I can't take more.#
>You mean you can't take LESS, it's very easy to take
>MORE than nothing.#
5.
The constructs used in Text/Plain; Format=Flowed body parts
described using [ABNF], including the Core Rules
paragraph = 1*flowed-line fixed-
fixed-line = fixed / sig-
fixed = [quote] [stuffing] *text-char non-sp
flowed-line = flow-qt / flow-
flow-qt = quote [stuffing] *text-char 1*SP
flow-unqt = [stuffing] *text-char 1*SP
non-sp = %x01-09 / %x0B / %x0C / %x0E-1F / %x21-7
; any 7-bit US-ASCII character,
; NUL, CR, LF, and
quote = 1*">"
sig-sep = [quote] "--" SP
stuffing = [SP] ; space-stuffed, added on generation
; needed, deleted on
text-char = non-sp /
6. Failure
6.1. Trailing White Space
There are systems in existence which alter trailing whitespace
messages which pass through them. Such systems may strip, or
rarer cases, add trailing whitespace, in violation of RFC 821 [SMTP
section 4.5.2.
Stripping trailing whitespace has the effect of converting
lines to fixed lines, which results in a message no worse than
Format=Flowed had not been used
Adding trailing whitespace to a Format=Flowed message may result in
malformed display or reply
Since most systems which add trailing white space do so to create
line which fills an internal record format, the result is
always a line which contains an even number of characters (
the added trailing white space).
Gellens Standards Track [Page 11]
RFC 2646 The Text/Plain Format Parameter August 1999
One possible avoidance, therefore, would be to define Format=
lines to use either one or two trailing space characters to
a flowed line, such that the total line length is odd. However
considering the scarcity of such systems today, it is not worth
added complexity
7. Security
This parameter introduces no security considerations beyond
which apply to Text/Plain
Section 4.6 discusses the interaction between Format=Flowed
digital signatures or encryption
8. IANA
IANA is requested to add a reference to this specification in
Text/Plain Media Type registration
9. Internationalization
The line wrap and quoting specifications of Format=Flowed may not
suitable for certain charsets, such as for Arabic and
characters that read from right to left. Care should be taken
applying format=flowed in these cases, as format=fixed combined
quoted-printable encoding may be more suitable
10.
This proposal evolved from a discussion of Chris Newman'
Text/Paragraph draft which took place on the IETF 822 mailing list
Special thanks to Ian Bell, Steve Dorner, Brian Kelley, Dan Kohn
Laurence Lundblade, and Dan Wing for their reviews, comments
suggestions, and discussions
11.
[ABNF] Crocker, D. and P. Overell, "Augmented BNF
Syntax Specifications: ABNF", RFC 2234,
1997.
[KEYWORDS] S. Bradner, "Key words for use in RFCs to
Requirement Levels", BCP 14, RFC 2119, March 1997.
[RICH] Resnick, P. and A. Walker, "The text/enriched
Content-type", RFC 1896, February 1996.
Gellens Standards Track [Page 12]
RFC 2646 The Text/Plain Format Parameter August 1999
[MIME-IMT] Freed, N. and N. Borenstein, "
Internet Mail Extensions (MIME) Part Two:
Types", RFC 2046, November 1996.
[Quoted-Printable] Freed, N. and N. Borenstein, "
Internet Mail Extensions (MIME) Part One:
of Internet Message Bodies", RFC 2045,
1996.
[SMTP] Postel, J., "Simple Mail Transfer Protocol",
10, RFC 821, August 1982.
[HTML] Berners-Lee, T. and D. Connolly, "Hypertext
Language -- 2.0", RFC 1866, November 1995.
12. Editor's
Randall
QUALCOMM
5775 Morehouse Dr
San Diego, CA 92121-2779
Phone: +1 619 651 5115
EMail: randy@qualcomm.
Gellens Standards Track [Page 13]
RFC 2646 The Text/Plain Format Parameter August 1999
13. Full Copyright
Copyright (C) The Internet Society (1999). All Rights Reserved
This document and translations of it may be copied and furnished
others, and derivative works that comment on or otherwise explain
or assist in its implementation may be prepared, copied,
and distributed, in whole or in part, without restriction of
kind, provided that the above copyright notice and this paragraph
included on all such copies and derivative works. However,
document itself may not be modified in any way, such as by
the copyright notice or references to the Internet Society or
Internet organizations, except as needed for the purpose
developing Internet standards in which case the procedures
copyrights defined in the Internet Standards process must
followed, or as required to translate it into languages other
English
The limited permissions granted above are perpetual and will not
revoked by the Internet Society or its successors or assigns
This document and the information contained herein is provided on
"AS IS" basis and THE INTERNET SOCIETY AND THE INTERNET
TASK FORCE DISCLAIMS ALL WARRANTIES, EXPRESS OR IMPLIED,
BUT NOT LIMITED TO ANY WARRANTY THAT THE USE OF THE
HEREIN WILL NOT INFRINGE ANY RIGHTS OR ANY IMPLIED WARRANTIES
MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE
Funding for the RFC Editor function is currently provided by
Internet Society
Gellens Standards Track [Page 14]
if you see any problems within the linking, don't worry be happy,
this is version 0.1 of the Relevance System and you gotta expect some crappy subroutines sometimes,
just be content we did not write this in Java, which would have made this "bigger and better" HAHAHHA.
RFC documents can be found at I.E.T.F.
Relevance System Copyright © 2002 Spectrum WorldResearch
other technical nosh by ServerMasters Corporation
collaboration of BobX
