<pre>Network Working Group                                           G. Klyne
Request for Comments: 3862                                  Nine by Nine
Category: Standards Track                                      D. Atkins
                                                        IHTFP Consulting
                                                             August 2004


      <span class="h1">Common Presence and Instant Messaging (CPIM): Message Format</span>

Status of this Memo

   This document specifies an Internet standards track protocol for the
   Internet community, and requests discussion and suggestions for
   improvements.  Please refer to the current edition of the "Internet
   Official Protocol Standards" (STD 1) for the standardization state
   and status of this protocol.  Distribution of this memo is unlimited.

Copyright Notice

   Copyright (C) The Internet Society (2004).

Abstract

   This memo defines the MIME content type 'Message/CPIM', a message
   format for protocols that conform to the Common Profile for Instant
   Messaging (CPIM) specification.

























<span class="grey">Klyne &amp; Atkins              Standards Track                     [Page 1]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-2" ></span>
<span class="grey"><a href="./rfc3862">RFC 3862</a>                  CPIM: Message Format               August 2004</span>


Table of Contents

   <a href="#section-1">1</a>.  Introduction . . . . . . . . . . . . . . . . . . . . . . . . .  <a href="#page-3">3</a>
       <a href="#section-1.1">1.1</a>.  Motivation . . . . . . . . . . . . . . . . . . . . . . .  <a href="#page-3">3</a>
       <a href="#section-1.2">1.2</a>.  Background . . . . . . . . . . . . . . . . . . . . . . .  <a href="#page-3">3</a>
       <a href="#section-1.3">1.3</a>.  Goals  . . . . . . . . . . . . . . . . . . . . . . . . .  <a href="#page-4">4</a>
       <a href="#section-1.4">1.4</a>.  Terminology and Conventions  . . . . . . . . . . . . . .  <a href="#page-5">5</a>
   <a href="#section-2">2</a>.  Overall Message Structure  . . . . . . . . . . . . . . . . . .  <a href="#page-5">5</a>
       <a href="#section-2.1">2.1</a>.  Message/CPIM MIME Headers  . . . . . . . . . . . . . . .  <a href="#page-6">6</a>
       <a href="#section-2.2">2.2</a>.  Message Headers  . . . . . . . . . . . . . . . . . . . .  <a href="#page-6">6</a>
       <a href="#section-2.3">2.3</a>.  Character Escape Mechanism . . . . . . . . . . . . . . .  <a href="#page-8">8</a>
             <a href="#section-2.3.1">2.3.1</a>.  Escape Mechanism Usage . . . . . . . . . . . . .  <a href="#page-8">8</a>
       <a href="#section-2.4">2.4</a>.  Message Content  . . . . . . . . . . . . . . . . . . . .  <a href="#page-9">9</a>
   <a href="#section-3">3</a>.  Message Header Syntax  . . . . . . . . . . . . . . . . . . . . <a href="#page-10">10</a>
       <a href="#section-3.1">3.1</a>.  Header Names . . . . . . . . . . . . . . . . . . . . . . <a href="#page-10">10</a>
       <a href="#section-3.2">3.2</a>.  Header Value . . . . . . . . . . . . . . . . . . . . . . <a href="#page-10">10</a>
       <a href="#section-3.3">3.3</a>.  Language tagging . . . . . . . . . . . . . . . . . . . . <a href="#page-10">10</a>
       <a href="#section-3.4">3.4</a>.  Namespaces for Header Name Extensibility . . . . . . . . <a href="#page-11">11</a>
       <a href="#section-3.5">3.5</a>.  Mandatory-to-Recognize Features  . . . . . . . . . . . . <a href="#page-13">13</a>
       <a href="#section-3.6">3.6</a>.  Collected Message Header Syntax  . . . . . . . . . . . . <a href="#page-14">14</a>
   <a href="#section-4">4</a>.  Header Definitions . . . . . . . . . . . . . . . . . . . . . . <a href="#page-16">16</a>
       <a href="#section-4.1">4.1</a>.  The 'From' Header  . . . . . . . . . . . . . . . . . . . <a href="#page-16">16</a>
       <a href="#section-4.2">4.2</a>.  The 'To' Header  . . . . . . . . . . . . . . . . . . . . <a href="#page-17">17</a>
       <a href="#section-4.3">4.3</a>.  The 'cc' Header  . . . . . . . . . . . . . . . . . . . . <a href="#page-18">18</a>
       <a href="#section-4.4">4.4</a>.  The 'DateTime' Header  . . . . . . . . . . . . . . . . . <a href="#page-18">18</a>
       <a href="#section-4.5">4.5</a>.  The 'Subject' Header . . . . . . . . . . . . . . . . . . <a href="#page-19">19</a>
       <a href="#section-4.6">4.6</a>.  The 'NS' Header  . . . . . . . . . . . . . . . . . . . . <a href="#page-20">20</a>
       <a href="#section-4.7">4.7</a>.  The 'Require' Header . . . . . . . . . . . . . . . . . . <a href="#page-20">20</a>
   <a href="#section-5">5</a>.  Examples . . . . . . . . . . . . . . . . . . . . . . . . . . . <a href="#page-21">21</a>
       <a href="#section-5.1">5.1</a>.  An Example Message/CPIM Message  . . . . . . . . . . . . <a href="#page-21">21</a>
       <a href="#section-5.2">5.2</a>.  An Example Esing MIME multipart/signed . . . . . . . . . <a href="#page-22">22</a>
   <a href="#section-6">6</a>.  Application Design Considerations  . . . . . . . . . . . . . . <a href="#page-22">22</a>
   <a href="#section-7">7</a>.  IANA Considerations  . . . . . . . . . . . . . . . . . . . . . <a href="#page-23">23</a>
       <a href="#section-7.1">7.1</a>.  Registration for Message/CPIM Content Type . . . . . . . <a href="#page-24">24</a>
       <a href="#section-7.2">7.2</a>.  Registration for urn:ietf:params:cpim-headers  . . . . . <a href="#page-25">25</a>
   <a href="#section-8">8</a>.  Internationalization Considerations  . . . . . . . . . . . . . <a href="#page-26">26</a>
   <a href="#section-9">9</a>.  Security Considerations  . . . . . . . . . . . . . . . . . . . <a href="#page-26">26</a>
   <a href="#section-10">10</a>. Acknowledgements . . . . . . . . . . . . . . . . . . . . . . . <a href="#page-26">26</a>
   <a href="#section-11">11</a>. References . . . . . . . . . . . . . . . . . . . . . . . . . . <a href="#page-26">26</a>
       <a href="#section-11.1">11.1</a>.  Normative References. . . . . . . . . . . . . . . . . . <a href="#page-26">26</a>
       <a href="#section-11.2">11.2</a>.  Informative References. . . . . . . . . . . . . . . . . <a href="#page-27">27</a>
   <a href="#section-12">12</a>. Authors' Addresses . . . . . . . . . . . . . . . . . . . . . . <a href="#page-29">29</a>
   <a href="#section-13">13</a>. Full Copyright Statement . . . . . . . . . . . . . . . . . . . <a href="#page-30">30</a>








<span class="grey">Klyne &amp; Atkins              Standards Track                     [Page 2]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-3" ></span>
<span class="grey"><a href="./rfc3862">RFC 3862</a>                  CPIM: Message Format               August 2004</span>


<span class="h2"><a class="selflink" id="section-1" href="#section-1">1</a>.  Introduction</span>

   This memo defines the MIME content type 'Message/CPIM', a message
   format for protocols that conform to the Common Profile for Instant
   Messaging (CPIM) specification.  This is a common message format for
   CPIM-compliant messaging protocols [<a href="#ref-26" title="&quot;Common Profile for Instant Messaging (CPIM)&quot;">26</a>].

   While being prepared for CPIM, this format is quite general and may
   be reused by other applications with similar requirements.
   Application specifications that adopt this as a base format should
   address the questions raised in <a href="#section-6">section 6</a> of this document.

<span class="h3"><a class="selflink" id="section-1.1" href="#section-1.1">1.1</a>.  Motivation</span>

   The Common Profile for Instant Messaging (CPIM) [<a href="#ref-26" title="&quot;Common Profile for Instant Messaging (CPIM)&quot;">26</a>] specification
   defines a number of operations to be supported and criteria to be
   satisfied for interworking between diverse instant messaging
   protocols.  The intent is to allow a variety of different protocols
   interworking through gateways to support cross-protocol messaging
   that meets the requirements of <a href="./rfc2779">RFC 2779</a> [<a href="#ref-20" title="&quot;Instant Messaging / Presence Protocol Requirements&quot;">20</a>].

   To adequately meet the security requirements of <a href="./rfc2779">RFC 2779</a>, a common
   message format is needed so that end-to-end signatures and encryption
   may be applied.  This document describes a common canonical message
   format that must be used by any CPIM-compliant message transfer
   protocol, whereby signatures are calculated for end-to-end security.

   The design of this message format is intended to enable security to
   be applied, while itself remaining agnostic about the specific
   security mechanisms that may be appropriate for a given application.
   For CPIM instant messaging and presence, specific security protocols
   are specified by the CPIM instant messaging [<a href="#ref-26" title="&quot;Common Profile for Instant Messaging (CPIM)&quot;">26</a>] and CPIM presence
   [<a href="#ref-27" title="&quot;Common Profile for Presence (CPP)&quot;">27</a>] specifications.

   Also note that the message format described here is not itself a MIME
   data format, although it may be contained within a MIME object, and
   may contain MIME objects.  See <a href="#section-2">section 2</a> for more details.

<span class="h3"><a class="selflink" id="section-1.2" href="#section-1.2">1.2</a>.  Background</span>

   <a href="./rfc2779">RFC 2779</a> requires that an instant message can carry a MIME payload
   [<a href="#ref-1" title="&quot;Multipurpose Internet Mail Extensions (MIME) Part One: Format of Internet Message Bodies&quot;">1</a>][2]; thus some level of support for MIME will be a common element
   of any CPIM compliant protocol.  Therefore it seems reasonable that a
   common message format should use a <a href="./rfc2822">RFC2822</a>/MIME-like syntax [<a href="#ref-9" title="&quot;Internet Message Format&quot;">9</a>], as
   protocol implementations must already contain code to parse this.

   Unfortunately, using pure <a href="./rfc2822">RFC2822</a>/MIME can be problematic:




<span class="grey">Klyne &amp; Atkins              Standards Track                     [Page 3]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-4" ></span>
<span class="grey"><a href="./rfc3862">RFC 3862</a>                  CPIM: Message Format               August 2004</span>


   o  Irregular lexical structure -- <a href="./rfc2822">RFC2822</a>/MIME allows a number of
      optional encodings and multiple ways to encode a particular value.
      For example, <a href="./rfc2822">RFC2822</a>/MIME comments may be encoded in multiple
      ways.  For security purposes, a single encoding method must be
      defined as a basis for computing message digest values.  Protocols
      that transmit data in a different format would otherwise lose
      information needed to verify a signature.

   o  Weak internationalization -- <a href="./rfc2822">RFC2822</a>/MIME requires header values
      to use 7-bit ASCII, which is problematic for encoding
      international character sets.  Mechanisms for language tagging in
      <a href="./rfc2822">RFC2822</a>/MIME headers [<a href="#ref-16" title="&quot;MIME Parameter Value and Encoded Word Extensions: Character Sets, Languages, and Continuations&quot;">16</a>] are awkward to use and have limited
      applicability.

   o  Mutability -- addition, modification or removal of header
      information.  Because it is not explicitly forbidden, many
      applications that process MIME content (e.g., MIME gateways)
      rebuild or restructure messages in transit.  This obliterates most
      attempts at achieving security (e.g., signatures), leaving
      receiving applications unable to verify the data received.

   o  Message and payload separation -- there is not a clear syntactic
      distinction between message metadata and message content.

   o  Limited extensibility.  (X-headers are problematic because they
      may not be standardized; this leads to situations where a header
      starts out as experimental but then finds widespread application,
      resulting in a common usage that cannot be standardized.)

   o  No support for structured information (text string values only).

   o  Some processors impose line length limitations.

   The message format defined by this memo overcomes some of these
   difficulties by having a simplified syntax that is generally
   compatible with the format accepted by <a href="./rfc2822">RFC2822</a>/MIME parsers and
   having a stricter syntax.  It also defines mechanisms to support some
   desired features not covered by the <a href="./rfc2822">RFC2822</a>/MIME format
   specifications.

<span class="h3"><a class="selflink" id="section-1.3" href="#section-1.3">1.3</a>.  Goals</span>

   This specification aims to satisfy the following goals:

   o  a securable end-to-end format for a message (a canonical message
      format to serve as a basis for signature calculation, rather than
      specified security mechanisms).




<span class="grey">Klyne &amp; Atkins              Standards Track                     [Page 4]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-5" ></span>
<span class="grey"><a href="./rfc3862">RFC 3862</a>                  CPIM: Message Format               August 2004</span>


   o  independence of any specific application

   o  capability of conveying a range of different address types

   o  assumption of an 8-bit clean message-transfer protocol

   o  evolvable:  extensible by multiple parties

   o  a clear separation of message metadata from message content

   o  a simple, regular, easily parsed syntax

   o  a compact, low-overhead format for simple messages

<span class="h3"><a class="selflink" id="section-1.4" href="#section-1.4">1.4</a>.  Terminology and Conventions</span>

   The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT",
   "SHOULD", "SHOULD NOT", "RECOMMENDED", "MAY", and "OPTIONAL" in this
   document are to be interpreted as described in <a href="https://www.rfc-editor.org/bcp/bcp14">BCP 14</a>, <a href="./rfc2119">RFC 2119</a> [<a href="#ref-4" title="&quot;Key words for use in RFCs to Indicate Requirement Levels&quot;">4</a>].

   NOTE: Comments like this provide additional nonessential information
   about the rationale behind this document.  Such information is not
   needed for building a conformant implementation, but may help those
   who wish to understand the design in greater depth.

<span class="h2"><a class="selflink" id="section-2" href="#section-2">2</a>.  Overall Message Structure</span>

   The CPIM message format encapsulates arbitrary MIME message content,
   together with message- and content-related metadata.  This can
   optionally be signed or encrypted using MIME security multiparts in
   conjunction with an appropriate security scheme.

   A Message/CPIM object is a two-part entity, where the first part
   contains the message metadata and the second part is the message
   content.  The two parts are separated from the enclosing MIME header
   fields and also from each other by blank lines.  The message metadata
   header information obeys more stringent syntax rules than the MIME
   message content headers that may be carried within the message.

   A complete message looks something like this:

      m: Content-type: Message/CPIM
      s:
      h: (message-metadata-headers)
      s:
      e: (encapsulated MIME message-body)





<span class="grey">Klyne &amp; Atkins              Standards Track                     [Page 5]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-6" ></span>
<span class="grey"><a href="./rfc3862">RFC 3862</a>                  CPIM: Message Format               August 2004</span>


   The end of the message body is defined by the framing mechanism of
   the protocol used.  The tags 'm:', 's:', 'h:', 'e:', and 'x:' are not
   part of the message format and are used here to indicate the
   different parts of the message, thus:

      m:  MIME headers for the overall message
      s:  a blank separator line
      h:  message headers
      e:  encapsulated MIME object containing the message content
      x:  MIME security multipart message wrapper

<span class="h3"><a class="selflink" id="section-2.1" href="#section-2.1">2.1</a>.  Message/CPIM MIME Headers</span>

   The message MIME headers identify the message as a CPIM-formatted
   message.

   The only required MIME header is:

      Content-type: Message/CPIM

   Other MIME headers may be used as appropriate for the message
   transfer environment.

<span class="h3"><a class="selflink" id="section-2.2" href="#section-2.2">2.2</a>.  Message Headers</span>

   Message headers carry information relevant to the end-to-end transfer
   of the message from sender to receiver.  Message headers MUST NOT be
   modified, reformatted or reordered in transit, but in some
   circumstances they MAY be examined by a CPIM message transfer
   protocol.

   The message headers serve a similar purpose to <a href="./rfc2822">RFC 2822</a> message
   headers in email [<a href="#ref-9" title="&quot;Internet Message Format&quot;">9</a>], and have a similar but restricted allowable
   syntax.

   The basic header syntax is:

      Key: Value

   where "Key" is a header name and "Value" is the corresponding header
   value.

   The following considerations apply:

   o  The entire header MUST be contained on a single line.  The line
      terminator is not considered part of the header value.





<span class="grey">Klyne &amp; Atkins              Standards Track                     [Page 6]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-7" ></span>
<span class="grey"><a href="./rfc3862">RFC 3862</a>                  CPIM: Message Format               August 2004</span>


   o  Only one header per line.  Multiple headers MUST NOT be included
      on a single line.

   o  Processors SHOULD NOT impose any line-length limitations.

   o  There MUST NOT be any whitespace at the beginning or end of a
      line.

   o  UTF-8 character encoding [<a href="#ref-13" title="&quot;UTF-8, a transformation format of ISO 10646&quot;">13</a>] MUST be used throughout.

   o  The character sequence CR,LF (13,10) MUST be used to terminate
      each line.

   o  The header name contains only US-ASCII characters (see <a href="#section-3.1">section 3.1</a>
      and <a href="#section-3.6">section 3.6</a> for the specific syntax).

   o  The header MUST NOT contain any control characters (0-31).  If a
      header value needs to represent control characters then the escape
      mechanism described below MUST be used.

   o  There MUST be a single space character (32) following the header
      name and colon.

   o  Multiple headers using the same key (header name) are allowed.
      (Specific header semantics may dictate only one occurrence of any
      particular header.)

   o  Header names MUST match exactly (i.e., "From:" and "from:" are
      different headers).

   o  If a header name is not recognized or not understood, the header
      should be ignored.  But see also the "Require:" header (<a href="#section-4.7">section</a>
      <a href="#section-4.7">4.7</a>).

   o  Interpretation (e.g., equivalence) of header values is dependent
      on the particular header definition.  Message processors MUST
      preserve all octets of all headers (both name and value) exactly.

   o  Message processors MUST NOT change the order of message headers.

   Examples:

      To: Pooh Bear &lt;im:pooh@100akerwood.com&gt;
      From: &lt;im:piglet@100akerwood.com&gt;
      DateTime: 2001-02-02T10:48:54-05:00






<span class="grey">Klyne &amp; Atkins              Standards Track                     [Page 7]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-8" ></span>
<span class="grey"><a href="./rfc3862">RFC 3862</a>                  CPIM: Message Format               August 2004</span>


<span class="h3"><a class="selflink" id="section-2.3" href="#section-2.3">2.3</a>.  Character Escape Mechanism</span>

   This mechanism MUST be used to code control characters in a header,
   having Unicode code points in the range U+0000 to U+001f or U+007f.
   (Rather than invent something completely new, the escape mechanism
   has been adopted from that used by the Java programming language.)

   Note that the escape mechanism is applied to a UCS-2 character, NOT
   to the octets of its UTF-8 coding.  Mapping from/to UTF-8 coding is
   performed without regard for escape sequences or character coding.
   (The header syntax is defined so that octets corresponding to control
   characters other than CR and LF do not appear in the output.)

   An arbitrary UCS-2 character is escaped using the form:

      \uxxxx

   where:

      \     is U+005c (backslash)
      u     is U+0075 (lower case letter U)
      xxxx  is a sequence of exactly four hexadecimal digits
            (0-9, a-f or A-F) or
            (U+0030-U+0039, U+0041-U+0046, or U+0061-0066)

   The hexadecimal number 'xxxx' is the UCS code-point value of the
   escaped character.

   Further, the following special sequences introduced by "\" are used:

      \\    for \ (backslash, U+005c)
      \"    for " (double quote, U+0022)
      \'    for ' (single quote, U+0027)
      \b    for backspace (U+0008)
      \t    for tab (U+0009)
      \n    for linefeed (U+000a)
      \r    for carriage return (U+000d)

<span class="h4"><a class="selflink" id="section-2.3.1" href="#section-2.3.1">2.3.1</a>.  Escape Mechanism Usage</span>

   When generating messages conformant with this specification:

   o  The special sequences listed above MUST be used to encode any
      occurrence of the following characters that appear anywhere in a
      header: backslash (U+005c), backspace (U+0008), tab (U+0009),
      linefeed (U+000a) or carriage return (U+000d).





<span class="grey">Klyne &amp; Atkins              Standards Track                     [Page 8]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-9" ></span>
<span class="grey"><a href="./rfc3862">RFC 3862</a>                  CPIM: Message Format               August 2004</span>


   o  The special sequence \" MUST be used for any occurrence of a
      double quote (U+0022) that appears within a string delimited by
      double quotes.

   o  The special sequence \' MUST be used for any occurrence of a
      single quote (U+0027) that appears within a string delimited by
      single quotes.

   o  Single- or double-quote characters that delimit a string value
      MUST NOT be escaped.

   o  The general escape sequence \uxxxx MUST be used for any other
      control character (U+0000 to U+0007, U+000b to U+000c, U+000e to
      U+001f or u+007f) that appears anywhere in a header.

   o  All other characters MUST NOT be represented using an escape
      sequence.

   When processing a message based on this specification, the escape
   sequence usage described above MUST be recognized.

   Further, any other occurrence of an escape sequence described above
   SHOULD be recognized and treated as an occurrence of the
   corresponding Unicode character.

   Any backslash ('\') character SHOULD be interpreted as introducing an
   escape sequence.  Any unrecognized escape sequence SHOULD be treated
   as an instance of the character following the backslash character.
   An isolated backslash that is the last character of a header SHOULD
   be ignored.

<span class="h3"><a class="selflink" id="section-2.4" href="#section-2.4">2.4</a>.  Message Content</span>

   The final section of a Message/CPIM is the MIME-encapsulated message
   content, which follows standard MIME formatting rules [<a href="#ref-1" title="&quot;Multipurpose Internet Mail Extensions (MIME) Part One: Format of Internet Message Bodies&quot;">1</a>][2].

   The MIME content headers MUST include at least a Content-Type header.
   The content may be any MIME type.

   Example:

      e: Content-Type: text/plain; charset=utf-8
      e: Content-ID: &lt;1234567890@foo.com&gt;
      e:
      e: This is my encapsulated text message content






<span class="grey">Klyne &amp; Atkins              Standards Track                     [Page 9]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-10" ></span>
<span class="grey"><a href="./rfc3862">RFC 3862</a>                  CPIM: Message Format               August 2004</span>


<span class="h2"><a class="selflink" id="section-3" href="#section-3">3</a>.  Message Header Syntax</span>

   A header contains two parts, a name and a value, separated by a colon
   character (':') and single space (32).  It is terminated by the
   sequence CR,LF (13,10).

   Headers use UTF-8 character encoding throughout, per <a href="./rfc3629">RFC 3629</a> [<a href="#ref-13" title="&quot;UTF-8, a transformation format of ISO 10646&quot;">13</a>].

   NOTE: in the descriptions that follow, header field names and other
   specified text values MUST be used exactly as given, using exactly
   the indicated upper- and lower- case letters.  In this respect, the
   ABNF usage differs from <a href="./rfc2234">RFC 2234</a> [<a href="#ref-6" title="&quot;Augmented BNF for Syntax Specifications: ABNF&quot;">6</a>].

<span class="h3"><a class="selflink" id="section-3.1" href="#section-3.1">3.1</a>.  Header Names</span>

   The header name is a sequence of US-ASCII characters, excluding
   control, SPACE or separator characters.  Use of the character "." in
   a header name is reserved for a namespace prefix separator.

   Separator characters are:

      SEPARATORS   = "(" / ")" / "&lt;" / "&gt;" / "@"
                   / "," / ";" / ":" / "\" / DQUOTE
                   / "/" / "[" / "]" / "?" / "="
                   / "{" / "}" / SP

   NOTE: The range of allowed characters was determined by examination
   of HTTP and <a href="./rfc2822">RFC 2822</a> header name formats and choosing the more
   restricted.  The intent is to allow CPIM headers to follow a syntax
   that is compatible with the allowed syntax for both <a href="./rfc2822">RFC 2822</a> [<a href="#ref-9" title="&quot;Internet Message Format&quot;">9</a>] and
   HTTP [<a href="#ref-18" title="&quot;Hypertext Transfer Protocol -- HTTP/1.1&quot;">18</a>] (including HTTP-derived protocols such as SIP [<a href="#ref-21" title="&quot;SIP: Session Initiation Protocol&quot;">21</a>]).

<span class="h3"><a class="selflink" id="section-3.2" href="#section-3.2">3.2</a>.  Header Value</span>

   A header value has a structure defined by the corresponding header
   specification.  Implementations that use a particular header must
   adhere to the format and usage rules thus defined when creating or
   processing a message containing that header.

   The other general constraints on header formats MUST also be followed
   (one line, UTF-8 character encoding, no control characters, etc.)

<span class="h3"><a class="selflink" id="section-3.3" href="#section-3.3">3.3</a>.  Language tagging</span>

   Full internationalization of a protocol requires that a language can
   be indicated for any human-readable text [<a href="#ref-15" title="&quot;The Report of the IAB Character Set Workshop held 29 February - 1 March, 1996&quot;">15</a>][7].





<span class="grey">Klyne &amp; Atkins              Standards Track                    [Page 10]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-11" ></span>
<span class="grey"><a href="./rfc3862">RFC 3862</a>                  CPIM: Message Format               August 2004</span>


   A message header may indicate a language for its value by including
   ';lang=tag' after the header name and colon, where 'tag' is a
   language identifying token per <a href="./rfc3066">RFC 3066</a> [<a href="#ref-10" title="&quot;Tags for the Identification of Languages&quot;">10</a>].

   Example:

      Subject:;lang=fr Objet de message

   If the language parameter is not applied a header, any human-readable
   text is assumed to use the language identified as 'i-default' [<a href="#ref-7" title="&quot;IETF Policy on Character Sets and Languages&quot;">7</a>].

<span class="h3"><a class="selflink" id="section-3.4" href="#section-3.4">3.4</a>.  Namespaces for Header Name Extensibility</span>

   NOTE: This section defines a framework for header extensibility whose
   use is optional.  If no header extensions are allowed by an
   application then these structures may never be used.

   An application that uses this message format is expected to define
   the set of headers that are required and allowed for that
   application.  This section defines a header extensibility framework
   that can be used with any application.

   The extensibility framework is based on that provided for XML [<a href="#ref-22" title="&quot;Extensible Markup Language (XML) 1.0 (2nd ed)&quot;">22</a>] by
   XML namespaces [<a href="#ref-23" title="&quot;Namespaces in XML&quot;">23</a>].  All headers are associated with a "namespace",
   which is in turn associated with a globally unique URI.

   Within a particular message instance, header names are associated
   with a particular namespace through the presence or absence of a
   namespace prefix, which is a leading part of the header name followed
   by a period ("."); e.g.,

      prefix.header-name: header-value

   Here, 'prefix' is the header name prefix, 'header-name' is the header
   name within the namespace associated with 'prefix', and 'header-
   value' is the value for this header.

      header-name: header-value

   In this case, the header name prefix is absent, and the given
   'header-name' is associated with a default namespace.

   The Message/CPIM media type registration designates a default
   namespace for any headers that are not more explicitly associated
   with any namespace.  In most cases, this default namespace is all
   that is needed.





<span class="grey">Klyne &amp; Atkins              Standards Track                    [Page 11]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-12" ></span>
<span class="grey"><a href="./rfc3862">RFC 3862</a>                  CPIM: Message Format               August 2004</span>


   A namespace is identified by a URI.  In this usage, the URI is used
   simply as a globally unique identifier, and there is no requirement
   that it can be used for any other purpose.  Any legal globally unique
   URI MAY be used to identify a namespace.  (By "globally unique", we
   mean constructed according to some set of rules so that it is
   reasonable to expect that nobody else will use the same URI for a
   different purpose.)  A URI used as an identifier MUST be a full
   absolute-URI, per <a href="./rfc2396">RFC 2396</a> [<a href="#ref-8" title="&quot;Uniform Resource Identifiers (URI): Generic Syntax&quot;">8</a>].  (Relative URIs and URI-references
   containing fragment identifiers MUST NOT be used for this purpose.)

   Within a specific message, an 'NS' header is used to declare a
   namespace prefix and associate it with a URI that identifies a
   namespace.  Following that declaration, within the scope of that
   message, the combination of namespace prefix and header name
   indicates a globally unique identifier for the header (consisting of
   the namespace URI and header name).

   For example:

      NS: MyFeatures &lt;mid:MessageFeatures@id.foo.com&gt;
      MyFeatures.WackyMessageOption: Use-silly-font

   This defines a namespace prefix 'MyFeatures' associated with the
   namespace identifier 'mid:MessageFeatures@id.foo.com'.  Subsequently,
   the prefix indicates that the WackyMessageOption header name
   referenced is associated with the identified namespace.

   A namespace prefix declaration MUST precede any use of that prefix.

   With the exception of any application-specific predefined namespace
   prefixes (see <a href="#section-6">section 6</a>), a namespace prefix is strictly local to the
   message in which it occurs.  The actual prefix used has no global
   significance.  This means that the headers:

      xxx.name: value
      yyy.name: value

   in two different messages may have exactly the same effect if
   namespace prefixes 'xxx' and 'yyy' are associated with the same
   namespace URI.  Thus the following have exactly the same meaning:

      NS: acme &lt;<a href="http://id.acme.widgets/wily-headers/">http://id.acme.widgets/wily-headers/</a>&gt;
      acme.runner-trap: set

   and

      NS: widget &lt;<a href="http://id.acme.widgets/wily-headers/">http://id.acme.widgets/wily-headers/</a>&gt;
      widget.runner-trap: set



<span class="grey">Klyne &amp; Atkins              Standards Track                    [Page 12]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-13" ></span>
<span class="grey"><a href="./rfc3862">RFC 3862</a>                  CPIM: Message Format               August 2004</span>


   A 'NS' header without a header prefix name specifies a default
   namespace for subsequent headers; that is a namespace that is
   associated with header names not having a prefix.  For example:

      NS: &lt;<a href="http://id.acme.widgets/wily-headers/">http://id.acme.widgets/wily-headers/</a>&gt;
      runner-trap: set

   has the same meaning as the previous examples.

   This framework allows different implementers to create extension
   headers without the worry of header name duplication; each defines
   headers within their own namespace.

<span class="h3"><a class="selflink" id="section-3.5" href="#section-3.5">3.5</a>.  Mandatory-to-Recognize Features</span>

   Sometimes it is necessary for the sender of a message to insist that
   some functionality is understood by the recipient.  By using the
   mandatory-to-recognize indicator, a sender is notifying the recipient
   that it MUST understand the named header or feature in order to
   properly understand the message.

   A header or feature is indicated as being mandatory-to-recognize by a
   'Require:' header.  For example:

      Require: MyFeatures.VitalMessageOption
      MyFeatures.VitalMessageOption: Confirmation-requested

   Multiple required header names may be listed in a single 'Require'
   header, separated by commas.

   NOTE: Indiscriminate use of 'Require:' headers could harm
   interoperability.  It is suggested that any implementer who defines
   required headers also publish the header specifications so other
   implementations can successfully interoperate.

   The 'Require:' header MAY also be used to indicate that some non-
   header semantics must be implemented by the recipient, even when it
   does not appear as a header.  For example:

      Require: Locale.MustRenderKanji

   might be used to indicate that message content includes characters
   from the Kanji repertoire, which must be rendered for proper
   understanding of the message.  In this case, the header name is just
   a token (using header name syntax and namespace association) that
   indicates some desired behaviour.





<span class="grey">Klyne &amp; Atkins              Standards Track                    [Page 13]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-14" ></span>
<span class="grey"><a href="./rfc3862">RFC 3862</a>                  CPIM: Message Format               August 2004</span>


<span class="h3"><a class="selflink" id="section-3.6" href="#section-3.6">3.6</a>.  Collected Message Header Syntax</span>

   The following description of message header syntax uses ABNF, per <a href="./rfc2234">RFC</a>
   <a href="./rfc2234">2234</a> [<a href="#ref-6" title="&quot;Augmented BNF for Syntax Specifications: ABNF&quot;">6</a>].  Most of this syntax can be interpreted as defining UCS
   character sequences or UTF-8 octet sequences.  Alternate productions
   at the end allow for either interpretation.

   NOTE: Specified text values MUST be used as given, using exactly the
   indicated upper- and lower-case letters.  In this respect, the ABNF
   usage here differs from <a href="./rfc2234">RFC 2234</a> [<a href="#ref-6" title="&quot;Augmented BNF for Syntax Specifications: ABNF&quot;">6</a>].

   Collected syntax:

   Header       = Header-name ":" *( ";" Parameter ) SP
                  Header-value
                  CRLF

   Header-name  = [ Name-prefix "." ] Name
   Name-prefix  = Name

   Parameter    = Lang-param / Ext-param
   Lang-param   = "lang=" Language-tag
   Ext-param    = Param-name "=" Param-value
   Param-name   = Name
   Param-value  = Token / Number / String

   Header-value = *HEADERCHAR

   Name         = 1*NAMECHAR
   Token        = 1*TOKENCHAR
   Number       = 1*DIGIT
   String       = DQUOTE *( Str-char / Escape ) DQUOTE
   Str-char     = %x20-21 / %x23-5B / %x5D-7E / UCS-high
   Escape       = "\" ( "u" 4(HEXDIG)    ; UCS codepoint
                      / "b"              ; Backspace
                      / "t"              ; Tab
                      / "n"              ; Linefeed
                      / "r"              ; Return
                      / DQUOTE           ; Double quote
                      / "'"              ; Single quote
                      / "\" )            ; Backslash

   Formal-name  = 1*( Token SP ) / String
   URI          = &lt;defined as absolute-URI by <a href="./rfc2396">RFC 2396</a>&gt;
   Language-tag = &lt;defined by <a href="./rfc3066">RFC 3066</a>&gt;

                ; Any UCS character except CTLs, or escape
   HEADERCHAR   = UCS-no-CTL / Escape



<span class="grey">Klyne &amp; Atkins              Standards Track                    [Page 14]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-15" ></span>
<span class="grey"><a href="./rfc3862">RFC 3862</a>                  CPIM: Message Format               August 2004</span>


                ; Any US-ASCII char except ".", CTLs or SEPARATORS:
   NAMECHAR     = %x21 / %x23-27 / %x2a-2b / %x2d
                / %x5e-60 / %x7c / %x7e
                / ALPHA / DIGIT

                ; Any UCS char except CTLs or SEPARATORS:
   TOKENCHAR    = NAMECHAR / "." / UCS-high

   SEPARATORS   = "(" / ")" / "&lt;" / "&gt;" / "@"    ; 28/29/3c/3e/40
                / "," / ";" / ":" / "\" / DQUOTE ; 2c/3b/3a/5c/22
                / "/" / "[" / "]" / "?" / "="    ; 2f/5b/5d/3f/3d
                / "{" / "}" / SP                 ; 7b/7d/20
   CTL          = &lt;Defined by <a href="./rfc2234">RFC 2234</a> -- %x0-%x1f, %x7f&gt;
   CRLF         = &lt;Defined by <a href="./rfc2234">RFC 2234</a> -- CR, LF&gt;
   SP           = &lt;defined by <a href="./rfc2234">RFC 2234</a> -- %x20&gt;
   DIGIT        = &lt;defined by <a href="./rfc2234">RFC 2234</a> -- '0'-'9'&gt;
   HEXDIG       = &lt;defined by <a href="./rfc2234">RFC 2234</a> -- '0'-'9', 'A'-'F', 'a'-'f'&gt;
   ALPHA        = &lt;defined by <a href="./rfc2234">RFC 2234</a> -- 'A'-'Z', 'a'-'z'&gt;
   DQUOTE       = &lt;defined by <a href="./rfc2234">RFC 2234</a> -- %x22&gt;

   To interpret the syntax in a general UCS character environment, use
   the following productions:

   UCS-no-CTL   = %x20-7e / UCS-high
   UCS-high     = %x80-7fffffff

   To interpret the syntax as defining UTF-8 coded octet sequences, use
   the following productions:

   UCS-no-CTL   = UTF8-no-CTL
   UCS-high     = UTF8-multi
   UTF8-no-CTL  = %x20-7e / UTF8-multi
   UTF8-multi   = %xC0-DF %x80-BF
                / %xE0-EF %x80-BF %x80-BF
                / %xF0-F7 %x80-BF %x80-BF %x80-BF
                / %xF8-FB %x80-BF %x80-BF %x80-BF %x80-BF
                / %xFC-FD %x80-BF %x80-BF %x80-BF %x80-BF %x80-BF

   NOTE: the above syntax comes from an older version of UTF-8, and is
   included for compatibility with UTF-8 software based on the earlier
   specifications.  Applications generating this message format SHOULD
   generate UTF-8 that matches the more restricted specification in <a href="./rfc3629">RFC</a>
   <a href="./rfc3629">3629</a> [<a href="#ref-13" title="&quot;UTF-8, a transformation format of ISO 10646&quot;">13</a>].








<span class="grey">Klyne &amp; Atkins              Standards Track                    [Page 15]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-16" ></span>
<span class="grey"><a href="./rfc3862">RFC 3862</a>                  CPIM: Message Format               August 2004</span>


<span class="h2"><a class="selflink" id="section-4" href="#section-4">4</a>.  Header Definitions</span>

   This specification defines a core set of headers that are available
   for use by applications:  an application specification must indicate
   the headers that may be used, those that must be recognized and those
   that must appear in any message (see <a href="#section-6">section 6</a>).

   The header definitions that follow fall into two categories:

   a) those that are part of the CPIM format extensibility framework,
      and

   b) those that have been based on similar headers in <a href="./rfc2822">RFC 2822</a> [<a href="#ref-9" title="&quot;Internet Message Format&quot;">9</a>],
      specified here with corresponding semantics.

   Header names and syntax are described without a namespace
   qualification, and the associated namespace URI is listed as part of
   the header specification.  Any of the namespace associations already
   mentioned (implied default namespace, explicit default namespace or
   implied namespace prefix or explicit namespace prefix declaration)
   may be used to identify the namespace.

   all headers defined here are associated with the namespace uri
   &lt;urn:ietf:params:cpim-headers:&gt;, which is defined according to [<a href="#ref-12" title="&quot;An IETF URN Sub-namespace for Registered Protocol Parameters&quot;">12</a>].

   NOTE: Header names and other text MUST be used as given, using
   exactly the indicated upper- and lower-case letters.  In this
   respect, the ABNF usage here differs from <a href="./rfc2234">RFC 2234</a> [<a href="#ref-6" title="&quot;Augmented BNF for Syntax Specifications: ABNF&quot;">6</a>].

<span class="h3"><a class="selflink" id="section-4.1" href="#section-4.1">4.1</a>.  The 'From' Header</span>

   Indicates the sender of a message.

   Header name: From

   Namespace URI:
      &lt;urn:ietf:params:cpim-headers:&gt;

   Syntax:
      (see also <a href="#section-3.6">section 3.6</a>)

      From-header = "From" ": " [ Formal-name ] "&lt;" URI "&gt;"
                        ; "From" is case-sensitive

   Description:
      Indicates the sender or originator of a message.





<span class="grey">Klyne &amp; Atkins              Standards Track                    [Page 16]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-17" ></span>
<span class="grey"><a href="./rfc3862">RFC 3862</a>                  CPIM: Message Format               August 2004</span>


      If present, the 'Formal-name' identifies the person or "real
      world" name for the originator.

      The URI indicates an address for the originator.

   Examples:

      From: Winnie the Pooh &lt;im:pooh@100akerwood.com&gt;

      From: &lt;im:tigger@100akerwood.com&gt;

<span class="h3"><a class="selflink" id="section-4.2" href="#section-4.2">4.2</a>.  The 'To' Header</span>

   Specifies an intended recipient of a message.

   Header name: To

   Namespace URI:
      &lt;urn:ietf:params:cpim-headers:&gt;

   Syntax:
      (see also <a href="#section-3.6">section 3.6</a>)

      To-header = "To" ": " [ Formal-name ] "&lt;" URI "&gt;"
                        ; "To" is case-sensitive

   Description:
      Indicates the recipient of a message.

      If present, the 'Formal-name' identifies the person or "real
      world" name for the recipient.

      The URI indicates an address for the recipient.

      Multiple recipients may be indicated by including multiple 'To'
      headers.

   Examples:

      To: Winnie the Pooh &lt;im:pooh@100akerwood.com&gt;

      To: &lt;im:tigger@100akerwood.com&gt;









<span class="grey">Klyne &amp; Atkins              Standards Track                    [Page 17]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-18" ></span>
<span class="grey"><a href="./rfc3862">RFC 3862</a>                  CPIM: Message Format               August 2004</span>


<span class="h3"><a class="selflink" id="section-4.3" href="#section-4.3">4.3</a>.  The 'cc' Header</span>

   Specifies a non-primary recipient ("courtesy copy") for a message.

   Header name: cc

   Namespace URI:
      &lt;urn:ietf:params:cpim-headers:&gt;

   Syntax:
      (see also <a href="#section-3.6">section 3.6</a>)

      Cc-header   = "cc" ": " [ Formal-name ] "&lt;" URI "&gt;"
                        ; "cc" is case-sensitive

   Description:
      Indicates a courtesy copy recipient of a message.

      If present, the 'Formal-name' identifies the person or "real
      world" name for the recipient.

      The URI indicates an address for the recipient.

      Multiple courtesy copy recipients may be indicated by including
      multiple 'cc' headers.

   Examples:

      cc: Winnie the Pooh &lt;im:pooh@100akerwood.com&gt;

      cc: &lt;im:tigger@100akerwood.com&gt;

<span class="h3"><a class="selflink" id="section-4.4" href="#section-4.4">4.4</a>.  The 'DateTime' Header</span>

   Specifies the date and time a message was sent.

   Header name: DateTime

   Namespace URI:
      &lt;urn:ietf:params:cpim-headers:&gt;

   Syntax:
      (see also <a href="#section-3.6">section 3.6</a>)

      DateTime-header = "DateTime" ": " date-time
                        ; "DateTime" is case-sensitive





<span class="grey">Klyne &amp; Atkins              Standards Track                    [Page 18]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-19" ></span>
<span class="grey"><a href="./rfc3862">RFC 3862</a>                  CPIM: Message Format               August 2004</span>


      (where the syntax of 'date-time' is a profile of ISO8601 [<a href="#ref-24" title="&quot;Data elements and interchange formats - Information interchange - Representation of dates and times&quot;">24</a>]
      defined in "Date and Time on the Internet" [<a href="#ref-11" title="&quot;Date and Time on the Internet: Timestamps&quot;">11</a>])

   Description:
      The 'DateTime' header supplies the date and time at which the
      sender sent the message.

      One purpose of the this header is to provide for protection
      against a replay attack, by allowing the recipient to know when
      the message was intended to be sent.  The value of the date header
      is the senders's current time when the message was transmitted,
      using ISO 8601 [<a href="#ref-24" title="&quot;Data elements and interchange formats - Information interchange - Representation of dates and times&quot;">24</a>] date and time format as profiled in "Date and
      Time on the Internet: Timestamps" [<a href="#ref-11" title="&quot;Date and Time on the Internet: Timestamps&quot;">11</a>].

   Example:

      DateTime: 2001-02-01T12:16:49-05:00

<span class="h3"><a class="selflink" id="section-4.5" href="#section-4.5">4.5</a>.  The 'Subject' Header</span>

   Contains a description of the topic of the message.

   Header name: Subject

   Namespace URI:
      &lt;urn:ietf:params:cpim-headers:&gt;

   Syntax:
      (see also <a href="#section-3.6">section 3.6</a>)

      Subject-header = "Subject" ":" [ ";" Lang-param ] SP *HEADERCHAR
                        ; "Subject" is case-sensitive

   Description:
      The 'Subject' header supplies the sender's description of the
      topic or content of the message.

      The sending agent should specify the language parameter if it has
      any reasonable knowledge of the language used by the sender to
      indicate the message subject.

   Example:

      Subject:;lang=en Eeyore's feeling very depressed today







<span class="grey">Klyne &amp; Atkins              Standards Track                    [Page 19]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-20" ></span>
<span class="grey"><a href="./rfc3862">RFC 3862</a>                  CPIM: Message Format               August 2004</span>


<span class="h3"><a class="selflink" id="section-4.6" href="#section-4.6">4.6</a>.  The 'NS' Header</span>

   Declare a local namespace prefix.

   Header name: NS

   Namespace URI:
      &lt;urn:ietf:params:cpim-headers:&gt;

   Syntax:
      (see also <a href="#section-3.6">section 3.6</a>)

      NS-header = "NS" ": " [ Name-prefix ] "&lt;" URI "&gt;"
                        ; "NS" is case-sensitive

   Description:
      Declares a namespace prefix that may be used in subsequent header
      names.  See <a href="#section-3.4">section 3.4</a> for more details.

   Example:

      NS: MyAlias &lt;mid:MessageFeatures@id.foo.com&gt;
      MyAlias.MyHeader: private-extension-data

<span class="h3"><a class="selflink" id="section-4.7" href="#section-4.7">4.7</a>.  The 'Require' Header</span>

   Specify a header or feature that must be implemented by the receiver
   for correct message processing.

   Header name: Require

   Namespace URI:
      &lt;urn:ietf:params:cpim-headers:&gt;

   Syntax:
      (see also <a href="#section-3.6">section 3.6</a>)

      Require-header = "Require" ": " Header-name *( "," Header-name )
                        ; "Require" is case-sensitive

   Description:
      Indicates a header or feature that must be implemented or
      understood by the receiver for correct message processing.  See
      <a href="#section-3.5">section 3.5</a> for more details.







<span class="grey">Klyne &amp; Atkins              Standards Track                    [Page 20]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-21" ></span>
<span class="grey"><a href="./rfc3862">RFC 3862</a>                  CPIM: Message Format               August 2004</span>


      Note that the required header or feature does not have to be used
      in the message, but for brevity it is recommended that an
      implementation does not issue the 'Required' header for unused
      features.

   Example:

      Require: MyAlias.VitalHeader

<span class="h2"><a class="selflink" id="section-5" href="#section-5">5</a>.  Examples</span>

   The examples in the following sections use the per-line tags below to
   indicate different parts of the overall message format:

      m:  MIME headers for the overall message
      s:  a blank separator line
      h:  message headers
      e:  encapsulated MIME object containing the message content
      x:  MIME security multipart message wrapper

   The following examples also assume &lt;urn:ietf:params:cpim-headers:&gt; is
   the implied default namespace for the application.

<span class="h3"><a class="selflink" id="section-5.1" href="#section-5.1">5.1</a>.  An Example Message/CPIM Message</span>

   The following example shows a Message/CPIM message:

      m: Content-type: Message/CPIM
      s:
      h: From: MR SANDERS &lt;im:piglet@100akerwood.com&gt;
      h: To: Depressed Donkey &lt;im:eeyore@100akerwood.com&gt;
      h: DateTime: 2000-12-13T13:40:00-08:00
      h: Subject: the weather will be fine today
      h: Subject:;lang=fr beau temps prevu pour aujourd'hui
      h: NS: MyFeatures &lt;mid:MessageFeatures@id.foo.com&gt;
      h: Require: MyFeatures.VitalMessageOption
      h: MyFeatures.VitalMessageOption: Confirmation-requested
      h: MyFeatures.WackyMessageOption: Use-silly-font
      s:
      e: Content-type: text/xml; charset=utf-8
      e: Content-ID: &lt;1234567890@foo.com&gt;
      e:
      e: &lt;body&gt;
      e: Here is the text of my message.
      e: &lt;/body&gt;






<span class="grey">Klyne &amp; Atkins              Standards Track                    [Page 21]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-22" ></span>
<span class="grey"><a href="./rfc3862">RFC 3862</a>                  CPIM: Message Format               August 2004</span>


<span class="h3"><a class="selflink" id="section-5.2" href="#section-5.2">5.2</a>.  An Example Esing MIME multipart/signed</span>

   In order to secure a Message/CPIM, an application or implementation
   may use <a href="./rfc1847">RFC 1847</a> [<a href="#ref-14" title="&quot;Security Multiparts for MIME: Multipart/Signed and Multipart/Encrypted&quot;">14</a>], and some appropriate security protocols (e.g.,
   S/MIME [<a href="#ref-19" title="&quot;S/MIME Version 3 Message Specification&quot;">19</a>] or openPGP [<a href="#ref-17" title="&quot;OpenPGP Message Format&quot;">17</a>]), and cryptographic scheme.

   Using S/MIME [<a href="#ref-19" title="&quot;S/MIME Version 3 Message Specification&quot;">19</a>] and pkcs7, the above message would look like this:

      x: Content-Type: multipart/signed; boundary=next;
                       micalg=sha1;
                       protocol=application/pkcs7-signature
      x:
      x: --next
      m: Content-Type: Message/CPIM
      s:
      h: From: MR SANDERS &lt;im:piglet@100akerwood.com&gt;
      h: To: Dopey Donkey &lt;im:eeyore@100akerwood.com&gt;
      h: DateTime: 2000-12-13T13:40:00-08:00
      h: Subject: the weather will be fine today
      h: Subject:;lang=fr beau temps prevu pour aujourd'hui
      h: NS: MyFeatures &lt;mid:MessageFeatures@id.foo.com&gt;
      h: Require: MyFeatures.VitalMessageOption
      h: MyFeatures.VitalMessageOption: Confirmation-requested
      h: MyFeatures.WackyMessageOption: Use-silly-font
      s:
      e: Content-type: text/xml; charset=utf-8
      e: Content-ID: &lt;1234567890@foo.com&gt;
      e:
      e: &lt;body&gt;
      e: Here is the text of my message.
      e: &lt;/body&gt;
      x: --next
      x: Content-Type: application/pkcs7-signature
      x:
      x: (signature stuff)
          :
      x: --next--

<span class="h2"><a class="selflink" id="section-6" href="#section-6">6</a>.  Application Design Considerations</span>

   As defined, the 'Message/CPIM' content type uses a default namespace
   URI 'urn:ietf:params-cpim-headers:', and does not define any other
   implicit namespace prefixes.  Applications that have different
   requirements should define and register a different MIME media type,
   specify the required default namespace URI and define any implied
   namespace prefixes as part of the media type specification.





<span class="grey">Klyne &amp; Atkins              Standards Track                    [Page 22]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-23" ></span>
<span class="grey"><a href="./rfc3862">RFC 3862</a>                  CPIM: Message Format               August 2004</span>


   Applications using this specification must also specify:

   o  all headers that must be recognized by implementations of the
      application

   o  any headers that must be present in all messages created by that
      application.

   o  any headers that may appear more than once in a message, and how
      they are to be interpreted (e.g., how to interpret multiple
      'Subject:' headers with different language parameter values).

   o  Security mechanisms and crytography schemes to be used with the
      application, including any mandatory-to-implement security
      provisions.

   The goal of providing a definitive message format to which security
   mechanisms can be applied places some constraints on the design of
   applications that use this message format:

   o  Within a network of message transfer agents, an intermediate
      gateway MUST NOT change the Message/CPIM content in any way.  This
      implies that headers cannot be changed or reordered, transfer
      encoding cannot be changed, languages cannot be changed, etc.

   o  Because Message/CPIM messages are immutable, any transfer agent
      that wants to modify the message should create a new Message/CPIM
      message with the modified header and with the original message as
      its content.  (This approach is similar to real-world bill-of-
      lading handling, where each person in the chain attaches a new
      sheet to the message.  Then anyone can validate the original
      message and see what has changed and who changed it by following
      the trail of amendments.  Another metaphor is including the old
      message in a new envelope.)

   In chosing security mechanisms for an applications, the following IAB
   survey documents may be helpful:

   o  Security Mechanisms for the Internet [<a href="#ref-28" title="&quot;Security Mechanisms for the Internet&quot;">28</a>]

   o  A Survey of Authentication Mechanisms [<a href="#ref-29" title="&quot;A Survey of Authentication Mechanisms&quot;">29</a>].

<span class="h2"><a class="selflink" id="section-7" href="#section-7">7</a>.  IANA Considerations</span>

   This memo calls for two new IANA registrations:

   o  A new MIME content-type value, Message/CPIM, per <a href="./rfc2048">RFC 2048</a> [<a href="#ref-3" title="&quot;Multipurpose Internet Mail Extensions (MIME) Part Four: Registration Procedures&quot;">3</a>].
      The registration template can be found in <a href="#section-7.1">section 7.1</a> below.



<span class="grey">Klyne &amp; Atkins              Standards Track                    [Page 23]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-24" ></span>
<span class="grey"><a href="./rfc3862">RFC 3862</a>                  CPIM: Message Format               August 2004</span>


   o  A new IANA URN sub-namespace, urn:ietf:params:cpim-headers:, per
      <a href="./rfc3553">RFC 3553</a> [<a href="#ref-12" title="&quot;An IETF URN Sub-namespace for Registered Protocol Parameters&quot;">12</a>].  The registration template can be found in <a href="#section-7.2">section</a>
      <a href="#section-7.2">7.2</a> below.

<span class="h3"><a class="selflink" id="section-7.1" href="#section-7.1">7.1</a>.  Registration for Message/CPIM Content Type</span>

      To: ietf-types@iana.org

      Subject: Registration of MIME media type Message/CPIM

      MIME media type name: message

      MIME subtype name: CPIM

      Required parameters: (None)

      Optional parameters: (None)

   Encoding considerations:
      Intended to be used in 8-bit clean environments, with non-
      transformative encoding (8-bit or binary, according to the content
      contained within the message;  the CPIM message headers can be
      handled in an 8-bit text environment).

      This content type could be used with a 7-bit transfer environment
      if appropriate transfer encoding is used.  NOTE that for this
      purpose, enclosed MIME content MUST BE treated as opaque data and
      encoded accordingly.  Any encoding must be reversed before any
      enclosed MIME content can be accessed.

   Security considerations:
      The content may contain signed data, so any transfer encoding MUST
      BE exactly reversed before the content is processed.

      See also the security considerations for email messages (<a href="./rfc2822">RFC 2822</a>
      [<a href="#ref-9" title="&quot;Internet Message Format&quot;">9</a>]).

   Interoperability considerations:
      This content format is intended to be used to exchange possibly-
      secured messages between different instant messaging protocols.
      Very strict adherence to the message format (including whitespace
      usage) may be needed to achieve interoperability.

   Published specification: <a href="./rfc3862">RFC 3862</a>

   Applications which use this media type: Instant messaging





<span class="grey">Klyne &amp; Atkins              Standards Track                    [Page 24]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-25" ></span>
<span class="grey"><a href="./rfc3862">RFC 3862</a>                  CPIM: Message Format               August 2004</span>


   Additional information:
      The default namespace URI associated with this content-type is
      'urn:ietf:params:cpim-headers:'.  (See <a href="./rfc3862">RFC 3862</a> for further
      details.)

      See also the Common Profile for Instant Messaging (CPIM) [<a href="#ref-26" title="&quot;Common Profile for Instant Messaging (CPIM)&quot;">26</a>].

   Person &amp; email address to contact for further information:
      G. Klyne, &lt;GK-IETF@ninebynine.org&gt;

   Intended usage: LIMITED USE

   Author/Change controller: IETF

<span class="h3"><a class="selflink" id="section-7.2" href="#section-7.2">7.2</a>.  Registration for urn:ietf:params:cpim-headers</span>

   Registry name: cpim-headers

   Specification:
      <a href="./rfc3862">RFC 3862</a>.  Additional values may be defined by standards track
      RFCs that update or obsolete <a href="./rfc3862">RFC 3862</a>.

   Repository:
      <a href="http://www.iana.org/assignments/cpim-headers">http://www.iana.org/assignments/cpim-headers</a>

   Index value:
      The index value is a CPIM message header name, which may consist
      of a sequence from a restricted set of US-ASCII characters, as
      defined above.

   URN Formation:
      The URI for a header is formed from its name by:

      a) replacing any non-URN characters (as defined by <a href="./rfc2141">RFC 2141</a> [<a href="#ref-5" title="&quot;URN Syntax&quot;">5</a>])
         with the corresponding '%hh' escape sequence (per <a href="./rfc2396">RFC 2396</a>
         [<a href="#ref-8" title="&quot;Uniform Resource Identifiers (URI): Generic Syntax&quot;">8</a>]); and

      b) prepending the resulting string with 'urn:ietf:params:cpim-
         headers:'.

      Thus, the URI corresponding to the CPIM message header 'From:'
      would be 'urn:ietf:params:cpim-headers:From'.  The URI
      corresponding to the (putative) CPIM message header 'Top&amp;Tail'
      would be 'urn:ietf:params:cpim-headers:Top%26Tail'.







<span class="grey">Klyne &amp; Atkins              Standards Track                    [Page 25]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-26" ></span>
<span class="grey"><a href="./rfc3862">RFC 3862</a>                  CPIM: Message Format               August 2004</span>


<span class="h2"><a class="selflink" id="section-8" href="#section-8">8</a>.  Internationalization Considerations</span>

   Message headers use UTF-8 character encoding throughout; hence, they
   can convey the full UCS-4 (Unicode [<a href="#ref-30" title="&quot;The Unicode Standard, Version 4.0&quot;">30</a>], ISO/IEC 10646 [<a href="#ref-25" title="&quot;Information Technology - Universal Multiple-octet coded Character Set (UCS) - Part 1: Architecture and Basic Multilingual Plane&quot;">25</a>])
   character repertoire.

   Language tagging is provided for message headers using the "Lang"
   parameter (<a href="#section-3.3">section 3.3</a>).

   Message content is any MIME-encapsulated content, and normal MIME
   content internationalization considerations apply.

<span class="h2"><a class="selflink" id="section-9" href="#section-9">9</a>.  Security Considerations</span>

   The Message/CPIM format is designed with security in mind.  In
   particular it is designed to be used with MIME security multiparts
   for signatures and encryption.  To this end, Message/CPIM messages
   must be considered immutable once created.

   Because Message/CPIM messages are binary messages (due to UTF-8
   encoding), if they are transmitted across non-8-bit-clean transports
   then the transfer agent must tunnel the entire message.  Changing the
   message data encoding is not an option.  This implies that the
   Message/CPIM must be encapsulated by the message transfer system and
   unencapsulated at the receiving end of the tunnel.

   The resulting message must not have data loss due to the encoding and
   unencoding of the message.  For example, an application may choose to
   apply the MIME base64 content-transfer-encoding to the Message/CPIM
   object to meet this requirement.

<span class="h2"><a class="selflink" id="section-10" href="#section-10">10</a>.  Acknowledgements</span>

   The authors thank the following for their helpful comments: Harald
   Alvestrand, Walter Houser, Leslie Daigle, Mark Day, Brian Raymor.

<span class="h2"><a class="selflink" id="section-11" href="#section-11">11</a>.  References</span>

<span class="h3"><a class="selflink" id="section-11.1" href="#section-11.1">11.1</a>.  Normative References</span>

   [<a id="ref-1">1</a>]  Freed, N. and N. Borenstein, "Multipurpose Internet Mail
        Extensions (MIME) Part One: Format of Internet Message Bodies",
        <a href="./rfc2045">RFC 2045</a>, November 1996.

   [<a id="ref-2">2</a>]  Freed, N. and N. Borenstein, "Multipurpose Internet Mail
        Extensions (MIME) Part Two: Media Types", <a href="./rfc2046">RFC 2046</a>, November
        1996.




<span class="grey">Klyne &amp; Atkins              Standards Track                    [Page 26]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-27" ></span>
<span class="grey"><a href="./rfc3862">RFC 3862</a>                  CPIM: Message Format               August 2004</span>


   [<a id="ref-3">3</a>]  Freed, N., Klensin, J., and J. Postel, "Multipurpose Internet
        Mail Extensions (MIME) Part Four: Registration Procedures", <a href="https://www.rfc-editor.org/bcp/bcp13">BCP</a>
        <a href="https://www.rfc-editor.org/bcp/bcp13">13</a>, <a href="./rfc2048">RFC 2048</a>, November 1996.

   [<a id="ref-4">4</a>]  Bradner, S., "Key words for use in RFCs to Indicate Requirement
        Levels", <a href="https://www.rfc-editor.org/bcp/bcp14">BCP 14</a>, <a href="./rfc2119">RFC 2119</a>, March 1997.

   [<a id="ref-5">5</a>]  Moats, R., "URN Syntax", <a href="./rfc2141">RFC 2141</a>, May 1997.

   [<a id="ref-6">6</a>]  Crocker, D. and P. Overell, "Augmented BNF for Syntax
        Specifications: ABNF", <a href="./rfc2234">RFC 2234</a>, November 1997.

   [<a id="ref-7">7</a>]  Alvestrand, H., "IETF Policy on Character Sets and Languages",
        <a href="https://www.rfc-editor.org/bcp/bcp18">BCP 18</a>, <a href="./rfc2277">RFC 2277</a>, January 1998.

   [<a id="ref-8">8</a>]  Berners-Lee, T., Fielding, R., and L. Masinter, "Uniform
        Resource Identifiers (URI): Generic Syntax", <a href="./rfc2396">RFC 2396</a>, August
        1998.

   [<a id="ref-9">9</a>]  Resnick, P., "Internet Message Format", <a href="./rfc2822">RFC 2822</a>, April 2001.

   [<a id="ref-10">10</a>] Alvestrand, H., "Tags for the Identification of Languages", <a href="https://www.rfc-editor.org/bcp/bcp47">BCP</a>
        <a href="https://www.rfc-editor.org/bcp/bcp47">47</a>, <a href="./rfc3066">RFC 3066</a>, January 2001.

   [<a id="ref-11">11</a>] Klyne, G. and C. Newman, "Date and Time on the Internet:
        Timestamps", <a href="./rfc3339">RFC 3339</a>, July 2002.

   [<a id="ref-12">12</a>] Mealling, M., Masinter, L., Hardie, T., and G. Klyne, "An IETF
        URN Sub-namespace for Registered Protocol Parameters", <a href="https://www.rfc-editor.org/bcp/bcp73">BCP 73</a>,
        <a href="./rfc3553">RFC 3553</a>, June 2003.

   [<a id="ref-13">13</a>] Yergeau, F., "UTF-8, a transformation format of ISO 10646", STD
        63, <a href="./rfc3629">RFC 3629</a>, November 2003.

<span class="h3"><a class="selflink" id="section-11.2" href="#section-11.2">11.2</a>.  Informative References</span>

   [<a id="ref-14">14</a>] Galvin, J., Murphy, S., Crocker, S., and N. Freed, "Security
        Multiparts for MIME: Multipart/Signed and Multipart/Encrypted",
        <a href="./rfc1847">RFC 1847</a>, October 1995.

   [<a id="ref-15">15</a>] Weider, C., Preston, C., Simonsen, K., Alvestrand, H., Atkinson,
        R., Crispin, M., and P. Svanberg, "The Report of the IAB
        Character Set Workshop held 29 February - 1 March, 1996", <a href="./rfc2130">RFC</a>
        <a href="./rfc2130">2130</a>, April 1997.

   [<a id="ref-16">16</a>] Freed, N. and K. Moore, "MIME Parameter Value and Encoded Word
        Extensions: Character Sets, Languages, and Continuations", <a href="./rfc2231">RFC</a>
        <a href="./rfc2231">2231</a>, November 1997.



<span class="grey">Klyne &amp; Atkins              Standards Track                    [Page 27]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-28" ></span>
<span class="grey"><a href="./rfc3862">RFC 3862</a>                  CPIM: Message Format               August 2004</span>


   [<a id="ref-17">17</a>] Callas, J., Donnerhacke, L., Finney, H., and R. Thayer, "OpenPGP
        Message Format", <a href="./rfc2440">RFC 2440</a>, November 1998.

   [<a id="ref-18">18</a>] Fielding, R., Gettys, J., Mogul, J., Frystyk, H., Masinter, L.,
        Leach, P., and T. Berners-Lee, "Hypertext Transfer Protocol --
        HTTP/1.1", <a href="./rfc2616">RFC 2616</a>, June 1999.

   [<a id="ref-19">19</a>] Ramsdell, B., Ed., "S/MIME Version 3 Message Specification", <a href="./rfc2633">RFC</a>
        <a href="./rfc2633">2633</a>, June 1999.

   [<a id="ref-20">20</a>] Day, M., Aggarwal, S., Mohr, G., and J. Vincent, "Instant
        Messaging / Presence Protocol Requirements", <a href="./rfc2779">RFC 2779</a>, February
        2000.

   [<a id="ref-21">21</a>] Rosenberg, J., Schulzrinne, H., Camarillo, G., Johnston, A.,
        Peterson, J., Sparks, R., Handley, M., and E. Schooler, "SIP:
        Session Initiation Protocol", <a href="./rfc3261">RFC 3261</a>, June 2002.

   [<a id="ref-22">22</a>] Bray, T., Paoli, J., Sperberg-McQueen, C., and E. Maler,
        "Extensible Markup Language (XML) 1.0 (2nd ed)", W3C
        Recommendation xml, October 2000,
        &lt;<a href="http://www.w3.org/TR/2000/REC-xml-20001006">http://www.w3.org/TR/2000/REC-xml-20001006</a>&gt;.

   [<a id="ref-23">23</a>] Bray, T., Hollander, D., and A. Layman, "Namespaces in XML", W3C
        Recommendation xml-names, January 1999,
        &lt;<a href="http://www.w3.org/TR/REC-xml-names">http://www.w3.org/TR/REC-xml-names</a>&gt;.

   [<a id="ref-24">24</a>] International Organization for Standardization, "Data elements
        and interchange formats - Information interchange -
        Representation of dates and times", ISO Standard 8601, June
        1988.

   [<a id="ref-25">25</a>] International Organization for Standardization, "Information
        Technology - Universal Multiple-octet coded Character Set (UCS)
        - Part 1: Architecture and Basic Multilingual Plane", ISO
        Standard 10646-1, May 1993.

   [<a id="ref-26">26</a>] Peterson, J., "Common Profile for Instant Messaging (CPIM)", <a href="./rfc3860">RFC</a>
        <a href="./rfc3860">3860</a>, August 2004.

   [<a id="ref-27">27</a>] Peterson, J., "Common Profile for Presence (CPP)", <a href="./rfc3859">RFC 3859</a>,
        August 2004.

   [<a id="ref-28">28</a>] Bellovin, S., Kaufman, C., and J. Schiller, "Security Mechanisms
        for the Internet", <a href="./rfc3631">RFC 3631</a>, December 2003.

   [<a id="ref-29">29</a>] Rescorla, E., <a style="text-decoration: none" href='https://www.google.com/search?sitesearch=datatracker.ietf.org%2Fdoc%2Fhtml%2F&amp;q=inurl:draft-+%22A+Survey+of+Authentication+Mechanisms%22'>"A Survey of Authentication Mechanisms"</a>, Work in
        Progress, March 2004.



<span class="grey">Klyne &amp; Atkins              Standards Track                    [Page 28]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-29" ></span>
<span class="grey"><a href="./rfc3862">RFC 3862</a>                  CPIM: Message Format               August 2004</span>


   [<a id="ref-30">30</a>] The Unicode Consortium, "The Unicode Standard, Version 4.0",
        Addison-Wesley, Boston, MA. ISBN 0-321-18578-1, April 2003,
        &lt;<a href="http://www.unicode.org/unicode/standard/versions/enumeratedversions.html#Unicode_4_0_0">http://www.unicode.org/unicode/standard/versions/</a>
        <a href="http://www.unicode.org/unicode/standard/versions/enumeratedversions.html#Unicode_4_0_0">enumeratedversions.html#Unicode_4_0_0</a>&gt;.

<span class="h2"><a class="selflink" id="section-12" href="#section-12">12</a>.  Authors' Addresses</span>

   Graham Klyne
   Nine by Nine

   EMail: GK-IETF@ninebynine.org
   URI:   <a href="http://www.ninebynine.net/">http://www.ninebynine.net/</a>


   Derek Atkins
   IHTFP Consulting
   6 Farragut Ave
   Somerville, MA  02144
   USA

   Phone: +1 617 623 3745
   EMail: derek@ihtfp.com, warlord@alum.mit.edu





























<span class="grey">Klyne &amp; Atkins              Standards Track                    [Page 29]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-30" ></span>
<span class="grey"><a href="./rfc3862">RFC 3862</a>                  CPIM: Message Format               August 2004</span>


<span class="h2"><a class="selflink" id="section-13" href="#section-13">13</a>.  Full Copyright Statement</span>

   Copyright (C) The Internet Society (2004).  All Rights Reserved.

   This document and translations of it may be copied and furnished to
   others, and derivative works that comment on or otherwise explain it
   or assist in its implementation may be prepared, copied, published
   and distributed, in whole or in part, without restriction of any
   kind, provided that the above copyright notice and this paragraph are
   included on all such copies and derivative works.  However, this
   document itself may not be modified in any way, such as by removing
   the copyright notice or references to the Internet Society or other
   Internet organizations, except as needed for the purpose of
   developing Internet standards in which case the procedures for
   copyrights defined in the Internet Standards process must be
   followed, or as required to translate it into languages other than
   English.

   The limited permissions granted above are perpetual and will not be
   revoked by the Internet Society or its successors or assignees.

   This document and the information contained herein is provided on an
   "AS IS" basis and THE INTERNET SOCIETY AND THE INTERNET ENGINEERING
   TASK FORCE DISCLAIMS ALL WARRANTIES, EXPRESS OR IMPLIED, INCLUDING
   BUT NOT LIMITED TO ANY WARRANTY THAT THE USE OF THE INFORMATION
   HEREIN WILL NOT INFRINGE ANY RIGHTS OR ANY IMPLIED WARRANTIES OF
   MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE.

Acknowledgement

   Funding for the RFC Editor function is currently provided by the
   Internet Society.



















Klyne &amp; Atkins              Standards Track                    [Page 30]
</pre>