idnits 2.17.1 draft-ietf-sipping-mwi-01.txt: Checking boilerplate required by RFC 5378 and the IETF Trust (see https://trustee.ietf.org/license-info): ---------------------------------------------------------------------------- ** Looks like you're using RFC 2026 boilerplate. This must be updated to follow RFC 3978/3979, as updated by RFC 4748. Checking nits according to https://www.ietf.org/id-info/1id-guidelines.txt: ---------------------------------------------------------------------------- == No 'Intended status' indicated for this document; assuming Proposed Standard Checking nits according to https://www.ietf.org/id-info/checklist : ---------------------------------------------------------------------------- ** There is 1 instance of too long lines in the document, the longest one being 3 characters in excess of 72. ** There are 10 instances of lines with control characters in the document. Miscellaneous warnings: ---------------------------------------------------------------------------- == The copyright year in the RFC 3978 Section 5.4 Copyright Line does not match the current year -- The document seems to lack a disclaimer for pre-RFC5378 work, but may have content which was first submitted before 10 November 2008. If you have contacted all the original authors and they are all willing to grant the BCP78 rights to the IETF Trust, then this is fine, and you can ignore this comment. If not, you may need to add the pre-RFC5378 disclaimer. (See the Legal Provisions document at https://trustee.ietf.org/license-info for more information.) -- The document date (Oct 2002) is 7865 days in the past. Is this intentional? Checking references for intended status: Proposed Standard ---------------------------------------------------------------------------- (See RFCs 3967 and 4897 for information about using normative references to lower-maturity documents in RFCs) -- Looks like a reference, but probably isn't: 'Mahy' on line 701 == Unused Reference: '7' is defined on line 866, but no explicit reference was found in the text == Unused Reference: '8' is defined on line 869, but no explicit reference was found in the text == Unused Reference: '9' is defined on line 873, but no explicit reference was found in the text ** Obsolete normative reference: RFC 3265 (ref. '2') (Obsoleted by RFC 6665) == Outdated reference: A later version (-10) exists of draft-ietf-sip-callerprefs-06 ** Obsolete normative reference: RFC 2234 (ref. '5') (Obsoleted by RFC 4234) -- Obsolete informational reference (is this intentional?): RFC 2421 (ref. '7') (Obsoleted by RFC 3801) -- Obsolete informational reference (is this intentional?): RFC 2822 (ref. '9') (Obsoleted by RFC 5322) Summary: 5 errors (**), 0 flaws (~~), 6 warnings (==), 5 comments (--). Run idnits with the --verbose option for more detailed information about the items above. -------------------------------------------------------------------------------- 2 SIPPING WG R. Mahy 3 Internet-Draft Cisco Systems, Inc. 4 Expires: April 1, 2003 Oct 2002 6 A Message Summary and Message Waiting Indication Event Package for 7 the Session Initiation Protocol (SIP) 8 draft-ietf-sipping-mwi-01.txt 10 Status of this Memo 12 This document is an Internet-Draft and is in full conformance with 13 all provisions of Section 10 of RFC2026. 15 Internet-Drafts are working documents of the Internet Engineering 16 Task Force (IETF), its areas, and its working groups. Note that 17 other groups may also distribute working documents as Internet- 18 Drafts. 20 Internet-Drafts are draft documents valid for a maximum of six months 21 and may be updated, replaced, or obsoleted by other documents at any 22 time. It is inappropriate to use Internet-Drafts as reference 23 material or to cite them other than as "work in progress." 25 The list of current Internet-Drafts can be accessed at http:// 26 www.ietf.org/ietf/1id-abstracts.txt. 28 The list of Internet-Draft Shadow Directories can be accessed at 29 http://www.ietf.org/shadow.html. 31 This Internet-Draft will expire on April 1, 2003. 33 Copyright Notice 35 Copyright (C) The Internet Society (2002). All Rights Reserved. 37 Abstract 39 This draft proposes a SIP event package to carry message waiting 40 status and message summaries from a messaging system to an interested 41 User Agent. 43 Table of Contents 45 1. Conventions . . . . . . . . . . . . . . . . . . . . . . . . 3 46 2. Background and Appropriateness . . . . . . . . . . . . . . . 3 47 3. Event Package Formal Definition . . . . . . . . . . . . . . 4 48 3.1 Event Package Name . . . . . . . . . . . . . . . . . . . . . 4 49 3.2 Event Package Parameters . . . . . . . . . . . . . . . . . . 4 50 3.3 SUBSCRIBE Bodies . . . . . . . . . . . . . . . . . . . . . . 4 51 3.4 Subscription Duration . . . . . . . . . . . . . . . . . . . 4 52 3.5 NOTIFY Bodies . . . . . . . . . . . . . . . . . . . . . . . 4 53 3.6 Subscriber generation of SUBSCRIBE requests . . . . . . . . 6 54 3.7 Notifier processing of SUBSCRIBE requests . . . . . . . . . 6 55 3.8 Notifier generation of NOTIFY requests . . . . . . . . . . . 7 56 3.9 Subscriber processing of NOTIFY requests . . . . . . . . . . 7 57 3.10 Handling of Forked Requests . . . . . . . . . . . . . . . . 7 58 3.11 Rate of notifications . . . . . . . . . . . . . . . . . . . 7 59 3.12 State Agents . . . . . . . . . . . . . . . . . . . . . . . . 8 60 3.13 Behavior of a Proxy Server . . . . . . . . . . . . . . . . . 8 61 4. Examples of Usage . . . . . . . . . . . . . . . . . . . . . 8 62 4.1 Example Message Flow . . . . . . . . . . . . . . . . . . . . 8 63 4.2 Example Usage with Caller Preferences . . . . . . . . . . . 14 64 5. Formal Syntax . . . . . . . . . . . . . . . . . . . . . . . 14 65 5.1 New event-package definition . . . . . . . . . . . . . . . . 14 66 5.2 Body Format Syntax . . . . . . . . . . . . . . . . . . . . . 15 67 6. Security Considerations . . . . . . . . . . . . . . . . . . 15 68 7. IANA Considerations . . . . . . . . . . . . . . . . . . . . 15 69 7.1 SIP Event Package Registration for message-summary . . . . . 16 70 7.2 MIME Registration for application/simple-message-summary . . 16 71 8. Revision history . . . . . . . . . . . . . . . . . . . . . . 16 72 8.1 Open Issues . . . . . . . . . . . . . . . . . . . . . . . . 17 73 8.2 Changes from draft-ietf-sipping-mwi-00 . . . . . . . . . . . 17 74 8.3 Changes from draft-mahy-sipping-mwi-00 . . . . . . . . . . . 17 75 8.4 Changes from draft-mahy-sip-mwi-01 . . . . . . . . . . . . . 18 76 8.5 Changes from draft-mahy-sip-mwi-00 . . . . . . . . . . . . . 18 77 9. Contributors . . . . . . . . . . . . . . . . . . . . . . . . 19 78 10. Acknowledgments . . . . . . . . . . . . . . . . . . . . . . 19 79 Normative References . . . . . . . . . . . . . . . . . . . . 19 80 Informational References . . . . . . . . . . . . . . . . . . 19 81 Author's Address . . . . . . . . . . . . . . . . . . . . . . 20 82 Full Copyright Statement . . . . . . . . . . . . . . . . . . 21 84 1. Conventions 86 The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", 87 "SHOULD", "SHOULD NOT", "RECOMMENDED", "MAY", and "OPTIONAL" in this 88 document are to be interpreted as described in RFC-2119 [3]. 90 2. Background and Appropriateness 92 Messaging Waiting Indication is a common feature of telephone 93 networks. It typically involves an audible or visible indication 94 that messages are waiting, such as playing a special dial tone 95 (called message-waiting dial tone), lighting a light or indicator on 96 the phone, displaying icons or text, or some combination. Message- 97 waiting dial tone is similar but distinct from stutter dial tone. 98 Both are defined in GR-506 [10]. 100 The methods in the SIP [1] base specification were only designed to 101 solve the problem of session initiation for multimedia sessions, and 102 rendezvous. Since Message Waiting Indication is really status 103 information orthogonal to a session, it was not clear how an IP 104 telephone acting as a SIP User Agent would implement comparable 105 functionality. Members of the telephony community viewed this as a 106 shortcoming of SIP. 108 Users want the useful parts of the functionality they have using 109 traditional analog, mobile, and PBX telephones. It is also desirable 110 to provide comparable functionality in a flexible way that allows for 111 more customization and new features. 113 SIP Specific Event Notification (RFC 3265 -- SIP Events) [2] is an 114 appropriate mechanism to use in this environment, as it preserves the 115 user mobility and rendezvous features which SIP provides. 117 Using SIP-Specific Event Notification, A Subscriber User Agent 118 (typically an IP phone or SIP software User Agent) subscribes to the 119 status of their messages. A SIP User Agent acting on behalf of the 120 user's messaging system then notifies the Subscriber whenever the 121 messaging account's messages have changed. The Notifier sends this 122 message summary information in the body of the NOTIFY, encoded in a 123 new MIME type defined later in this draft. A User Agent can also 124 explicitly fetch the current status. 126 A SIP User Agent MAY subscribe to multiple accounts (distinguished by 127 the Request URI). Multiple SIP User Agents MAY subscribe to the same 128 account. 130 Before any subscriptions or notifications are sent, each interested 131 User Agent must be made aware of its messaging server(s). This MAY 132 be manually configured on interested User Agents, manually configured 133 on an appropriate SIP Proxy, or dynamically discovered using caller 134 preferences [4]. (For more information on usage with caller 135 preferences, see Section 4.2) 137 3. Event Package Formal Definition 139 3.1 Event Package Name 141 This document defines a SIP Event Package as defined in RFC 3265 [2]. 142 The event-package token name for this package is: 144 "message-summary" 146 3.2 Event Package Parameters 148 This package does not define any event package parameters. 150 3.3 SUBSCRIBE Bodies 152 This package does not define any SUBSCRIBE bodies. 154 3.4 Subscription Duration 156 Subscriptions to this event package MAY range from minutes to weeks. 157 Subscriptions in hours or days are more typical and are RECOMMENDED. 159 3.5 NOTIFY Bodies 161 A simple text-based format is proposed to prevent an undue burden on 162 low-end user agents, for example, inexpensive IP phones with no 163 display. Although this format is text-based, it is intended for 164 machine consumption only. 166 A future extension MAY define other NOTIFY bodies. If no "Accept" 167 header is present in the SUBSCRIBE, the body type defined in this 168 document MUST be assumed. 170 The format specified in this proposal attempts to separate orthogonal 171 attributes of messages as much as possible. Messages are separated 172 by message-context-class (for example: voice-message, fax-message, 173 pager-message, multimedia-message, text-message, and none); by 174 message status (new and old); and by urgent and non-urgent type. 176 The text format begins with a simple status line, and optionally a 177 summary line per message-context-class. Message-context-classes are 178 defined in [6]. For each message-context-class, the total number of 179 new and old messages is reported in the new and old fields. 181 In some cases, detailed message summaries are not available. The 182 status line allows messaging systems or messaging gateways to provide 183 the traditional boolean message waiting notification. 185 Messages-Waiting: yes 187 If the Request-URI or To header in a message-summary subscription 188 corresponds to a group or collection of individual messaging 189 accounts, the notifier MUST specify to which account the message- 190 summary body corresponds. Note that the account URI MUST NOT be 191 delimited with angle brackets ("<" and ">"). 193 Message-Account: sip:alice@example.com 195 In the example that follows, more than boolean message summary 196 information is available to the User Agent. There are two new and 197 four old fax messages. 199 Fax-Message: 2/4 201 After the summary, the format can optionally list a summary count of 202 urgent messages. In the next example there are one new and three old 203 voice messages, none of the new messages are urgent, but one of the 204 old messages is. All counters have a maximum value of 4,294,967,295 205 ((2^32) - 1). Notifiers MUST NOT generate a request with a larger 206 value. Subscribers MUST treat a larger value as 2^32-1. 208 Voice-Message: 1/3 (0/1) 210 Optionally, after the summary counts, the messaging systems MAY 211 append RFC 2822 [9]-style message headers, which further describe 212 newly added messages. Message headers MUST NOT be included in an 213 initial NOTIFY, as new messages could be essentially unbounded in 214 size. Message headers included in subsequent notifications MUST only 215 correspond to messages added since the previous notification for that 216 subscription. A messaging system which includes message headers in a 217 NOTIFY, MUST provide an administrator configurable mechanism for 218 selecting which headers are sent. Likely headers for inclusion 219 include To, From, Date, Subject, and Message-ID. Note that the 220 formatting of these headers is identical to that of SIP extension- 221 headers, not the (similar) format defined in RFC 2822. 223 Implementations which generate large notifications are reminded to 224 follow the message size restrictions for unreliable transports 225 articulated in Section 18.1.1 of SIP. 227 Mapping local message state to new/old message status and urgency is 228 an implementation issue of the messaging system. However, the 229 messaging system MUST NOT consider a message "old" merely because it 230 generated a notification , as this could prevent another subscription 231 from accurately receiving message-summary notifications. Likewise, 232 the messaging system MAY use any suitable algorithm to determine that 233 a message is "urgent". 235 Messaging systems MAY use any algorithm for determining the 236 approporiate message-context-class for a specific message. Systems 237 which use Internet Mail SHOULD use the contents of the Message- 238 Context header [6] if present as a hint to make a context 239 determination. Note that a messaging system does not need to support 240 a given context in order to generate notifications identified with 241 that context. 243 3.6 Subscriber generation of SUBSCRIBE requests 245 Subscriber User Agents will typically SUBSCRIBE to message summary 246 information for a period of hours or days, and automatically attempt 247 to re-SUBSCRIBE well before the subscription is completely expired. 248 If re-subscription fails, the Subscriber SHOULD periodically retry 249 again until a subscription is successful, taking care to backoff to 250 avoid network congestion. If a subscription has expired, new re- 251 subscriptions MUST use a new Call-ID. 253 The Subscriber SHOULD SUBSCRIBE to that user's message summaries 254 whenever a new user becomes associated with the device (a new login). 255 The Subscriber MAY also explicitly fetch the current status at any 256 time. The subscriber SHOULD renew its subscription immediately after 257 a reboot, or when the subscriber's network connectivity has just been 258 re-established. 260 The Subscriber MUST be prepared to receive and process a NOTIFY with 261 new state immediately after sending a new SUBSCRIBE, a SUBSCRIBE, 262 renewal, an unSUBSCRIBE or a fetch; or at any time during the 263 subscription. 265 When a user de-registers from a device (logoff, power down of a 266 mobile device, etc.), subscribers SHOULD unsubscribe by sending a 267 SUBSCRIBE message with an Expires header of zero. 269 3.7 Notifier processing of SUBSCRIBE requests 271 When a SIP Messaging System receives SUBSCRIBE messages with the 272 message-summary event-type, it SHOULD authenticate the subscription 273 request. If authentication is successful, the Notifier MAY limit the 274 duration of the subscription to an administrator defined amount of 275 time as described in SIP Events. 277 3.8 Notifier generation of NOTIFY requests 279 Immediately after a subscription is accepted, the Notifier MUST send 280 a NOTIFY with the current message summary information. This allows 281 the Subscriber to resynchronize its state. This initial 282 synchronization NOTIFY MUST NOT include the optional message headers. 284 When the status of the messages changes sufficiently for a messaging 285 account to change the number of new or old messages, the Notifier 286 SHOULD send a NOTIFY message to all active subscribers to that 287 account. NOTIFY messages sent to subscribers of a group or alias, 288 MUST contain the message account name in the notification body. 290 A Messaging System MAY send a NOTIFY with an "Expires" header of "0" 291 and a "Subscription-State" header of "terminated" before a graceful 292 shutdown. 294 3.9 Subscriber processing of NOTIFY requests 296 Upon receipt of a valid NOTIFY request, the subscriber SHOULD 297 immediately render the message status and summary information to the 298 end user in an implementation specific way. 300 The Subscriber MUST be prepared to receive NOTIFYs from different 301 Contacts corresponding to the same SUBSCRIBE. (the SUBSCRIBE may 302 have been forked). 304 3.10 Handling of Forked Requests 306 Forked requests are allowed for this event type and may install 307 multiple subscriptions. The Subscriber MAY render multiple summaries 308 which correspond to the same account directly to the user, or MAY 309 merge them as described below. 311 If any of the "Messages-Waiting" status lines report "yes", then the 312 merged state is "yes"; otherwise the merged state is "no". 314 The Subscriber MAY merge summary lines in an implementation-specific 315 way if all notifications contain at least one msg-summary line. 317 3.11 Rate of notifications 319 A Notifier MAY choose to hold NOTIFY requests in "quarantine" for a 320 short administrator-defined period (seconds or minutes) when the 321 message status is changing rapidly. Requests in the quarantine which 322 become invalid are replaced by newer notifications, thus reducing the 323 total volume of notifications. This behavior is encouraged for 324 implementations with heavy interactive use. Note that timely 325 notification which results in a change of overall state (messages 326 waiting or not), and notification of newly added messages is probably 327 more significant to the end user than a notification of newly deleted 328 messages which do not affect the overall message waiting state (e.g. 329 there are still new messages). 331 Notifiers SHOULD NOT generate NOTIFY requests more frequently than 332 once per second. 334 3.12 State Agents 336 A Subscriber MAY use an "alias" or "group" in the Request-URI of a 337 subscription if that name is significant to the messaging system. 338 Implementers MAY create a service which consolidates and summarizes 339 NOTIFYs from many Contacts. This document does not preclude 340 implementations from building state agents which support this event 341 package. 343 3.13 Behavior of a Proxy Server 345 There are no additional requirements on a SIP Proxy, other than to 346 transparently forward the SUBSCRIBE and NOTIFY methods as required in 347 SIP. However, Proxies SHOULD allow non-SIP URLs. Proxies and 348 Redirect servers SHOULD be able to direct the SUBSCRIBE request to an 349 appropriate messaging server User Agent. Proxies are encouraged to 350 support routing to Contacts based on the the method of the request 351 and the existence of a feature="voice-mail" parameter in an Accept- 352 Contact header (as specified in the caller preferences 353 specification). 355 4. Examples of Usage 357 4.1 Example Message Flow 359 The examples shown below are for informational purposes only. For a 360 normative description of the event package, please see sections 3 and 361 5 of this document. 363 In the example call flow below, Alice's IP phone subscribes to the 364 status of Alice's messages. Via headers are omitted for clarity. 366 Subscriber Notifier 367 | | 368 | A1: SUBSCRIBE (new) | 369 |---------------------->| 370 | A2: 200 OK | 371 |<----------------------| 372 | | 373 | A3: NOTIFY (sync) | 374 |<----------------------| 375 | A4: 200 OK | 376 |---------------------->| 377 | | 378 | | 379 | A5: NOTIFY (change) | 380 |<----------------------| 381 | A6: 200 OK | 382 |---------------------->| 383 | | 384 | | 385 | A7: (re)SUBSCRIBE | 386 |---------------------->| 387 | A8: 200 OK | 388 |<----------------------| 389 | | 390 | A9: NOTIFY (sync) | 391 |<----------------------| 392 | A10: 200 OK | 393 |---------------------->| 394 | | 395 | | 396 | A11: (un)SUBSCRIBE | 397 |---------------------->| 398 | A12: 200 OK | 399 |<----------------------| 400 | | 401 | A13: NOTIFY (sync) | 402 |<----------------------| 403 | A14: 200 OK | 404 |---------------------->| 406 A1: Subscriber (Alice's phone) -> 407 Notifier (Alice's voicemail gateway) 408 Subscribe to Alice's message summary status for 1 day. 410 SUBSCRIBE sip:alice@vmail.example.com SIP/2.0 411 To: 412 From: ;tag=78923 413 Date: Mon, 10 Jul 2000 03:55:06 GMT 414 Call-Id: 1349882@alice-phone.example.com 415 CSeq: 4 SUBSCRIBE 416 Contact: 417 Event: message-summary 418 Expires: 86400 419 Accept: application/simple-message-summary 420 Content-Length: 0 422 A2: Notifier -> Subscriber 424 SIP/2.0 200 OK 425 To: ;tag=4442 426 From: ;tag=78923 427 Date: Mon, 10 Jul 2000 03:55:07 GMT 428 Call-Id: 1349882@alice-phone.example.com 429 CSeq: 4 SUBSCRIBE 430 Expires: 86400 431 Content-Length: 0 433 A3: Notifier -> Subscriber 434 (immediate synchronization of current state: 435 2 new and 8 old [2 urgent] messages) 437 NOTIFY sip:alice@alice-phone.example.com SIP/2.0 438 To: ;tag=78923 439 From: ;tag=4442 440 Date: Mon, 10 Jul 2000 03:55:07 GMT 441 Call-Id: 1349882@alice-phone.example.com 442 CSeq: 20 NOTIFY 443 Contact: 444 Event: message-summary 445 Subscription-State: active 446 Content-Type: application/simple-message-summary 447 Content-Length: 99 449 Messages-Waiting: yes 450 Message-Account: sip:alice@vmail.example.com 451 Voice-Message: 2/8 (0/2) 453 A4: Subscriber -> Notifier 455 SIP/2.0 200 OK 456 To: ;tag=78923 457 From: ;tag=4442 458 Date: Mon, 10 Jul 2000 03:55:08 GMT 459 Call-Id: 1349882@alice-phone.example.com 460 CSeq: 20 NOTIFY 461 Content-Length: 0 463 A5: Notifier -> Subscriber 464 This is a notification of new messages. 465 Some headers from each of the new messages are appended. 467 NOTIFY sip:alice@alice-phone.example.com SIP/2.0 468 To: ;tag=78923 469 From: ;tag=4442 470 Date: Mon, 10 Jul 2000 04:28:53 GMT 471 Contact: 472 Call-ID: 1349882@alice-phone.example.com 473 CSeq: 31 NOTIFY 474 Event: message-summary 475 Subscription-State: active 476 Content-Type: application/simple-message-summary 477 Content-Length: 503 479 Messages-Waiting: yes 480 Message-Account: sip:alice@vmail.example.com 481 Voice-Message: 4/8 (1/2) 483 To: 484 From: 485 Subject: carpool tomorrow? 486 Date: Sun, 09 Jul 2000 21:23:01 -0700 487 Priority: normal 488 Message-ID: 13784434989@vmail.example.com 490 To: 491 From: 492 Subject: HELP! at home ill, present for me please 493 Date: Sun, 09 Jul 2000 21:25:12 -0700 494 Priority: urgent 495 Message-ID: 13684434990@vmail.example.com 497 A6: Subscriber -> Notifier 499 SIP/2.0 200 OK 500 To: ;tag=78923 501 From: ;tag=4442 502 Date: Mon, 10 Jul 2000 04:28:53 GMT 503 Call-ID: 1349882@alice-phone.example.com 504 CSeq: 31 NOTIFY 505 Content-Length: 0 507 A7: Subscriber -> Notifier 508 Refresh subscription. 510 SUBSCRIBE sip:alice@vmail.example.com SIP/2.0 511 To: ;tag=4442 512 From: ;tag=78923 513 Date: Mon, 10 Jul 2000 15:55:06 GMT 514 Call-Id: 1349882@alice-phone.example.com 515 CSeq: 8 SUBSCRIBE 516 Contact: 517 Event: message-summary 518 Expires: 86400 519 Accept: application/simple-message-summary 520 Content-Length: 0 522 A8: Notifier -> Subscriber 524 SIP/2.0 200 OK 525 To: ;tag=4442 526 From: ;tag=78923 527 Date: Mon, 10 Jul 2000 15:55:07 GMT 528 Call-Id: 1349882@alice-phone.example.com 529 CSeq: 8 SUBSCRIBE 530 Contact: 531 Expires: 86400 532 Content-Length: 0 534 A9: Notifier -> Subscriber 535 (immediate synchronization of current state) 537 NOTIFY sip:alice@alice-phone.example.com SIP/2.0 538 To: ;tag=78923 539 From: ;tag=4442 540 Date: Mon, 10 Jul 2000 15:55:07 GMT 541 Call-Id: 1349882@alice-phone.example.com 542 CSeq: 47 NOTIFY 543 Contact: 544 Event: message-summary 545 Subscription-State: active 546 Content-Type: application/simple-message-summary 547 Content-Length: 99 549 Messages-Waiting: yes 550 Message-Account: sip:alice@vmail.example.com 551 Voice-Message: 4/8 (1/2) 553 A10: Subscriber -> Notifier 555 SIP/2.0 200 OK 556 To: ;tag=78923 557 From: ;tag=4442 558 Date: Mon, 10 Jul 2000 15:55:08 GMT 559 Call-Id: 1349882@alice-phone.example.com 560 CSeq: 47 NOTIFY 561 Contact: 562 A11: Subscriber -> Notifier 563 Un-subscribe after "alice" logs out. 565 SUBSCRIBE sip:alice@vmail.example.com SIP/2.0 566 To: ;tag=4442 567 From: ;tag=78923 568 Date: Mon, 10 Jul 2000 19:35:06 GMT 569 Call-Id: 1349882@alice-phone.example.com 570 CSeq: 17 SUBSCRIBE 571 Contact: 572 Event: message-summary 573 Expires: 0 574 Accept: application/simple-message-summary 575 Content-Length: 0 577 A12: Notifier -> Subscriber 579 SIP/2.0 200 OK 580 To: ;tag=4442 581 From: ;tag=78923 582 Date: Mon, 10 Jul 2000 19:35:07 GMT 583 Call-Id: 1349882@alice-phone.example.com 584 CSeq: 17 SUBSCRIBE 585 Contact: 586 Expires: 0 587 Content-Length: 0 589 A13: Notifier -> Subscriber 590 (immediate synchronization of current state, 591 which the subscriber can now ignore) 593 NOTIFY sip:alice@alice-phone.example.com SIP/2.0 594 To: ;tag=78923 595 From: ;tag=4442 596 Date: Mon, 10 Jul 2000 19:35:07 GMT 597 Call-Id: 1349882@alice-phone.example.com 598 CSeq: 56 NOTIFY 599 Contact: 600 Event: message-summary 601 Subscription-State: terminated;reason=timeout 602 Content-Type: application/simple-message-summary 603 Content-Length: 99 605 Messages-Waiting: yes 606 Message-Account: sip:alice@vmail.example.com 607 Voice-Message: 4/8 (1/2) 609 A10: Subscriber -> Notifier 611 SIP/2.0 200 OK 612 To: ;tag=78923 613 From: ;tag=4442 614 Date: Mon, 10 Jul 2000 19:35:08 GMT 615 Call-Id: 1349882@alice-phone.example.com 616 CSeq: 56 NOTIFY 617 Event: message-summary 618 Content-Length: 0 620 4.2 Example Usage with Caller Preferences 622 The use of caller preferences is optional but encouraged. If caller 623 preferences is used, a messaging server MAY REGISTER a Contact with 624 an appropriate methods and events tag as shown in the example below. 625 To further distinguish itself, the messaging server MAY also REGISTER 626 as a Contact with the feature="voice-mail" tag. An example of this 627 kind of registration follows below. 629 REGISTER sip:sip3-sj.example.com SIP/2.0 630 To: 631 From: ;tag=4442 632 ... 633 Contact: 634 ;feature="voice-mail";methods="SUBSCRIBE" 635 ;events="message-summary" 637 The following SUBSCRIBE message would find the Contact which 638 registered in the example above. 640 SUSBCRIBE sip:alice@example.com SIP/2.0 641 ... 642 Accept: application/simple-message-summary 643 Event: message-summary 644 Accept-Contact: *;feature="voice-mail" 646 5. Formal Syntax 648 The following syntax specification uses the augmented Backus-Naur 649 Form (BNF) as described in RFC-2234 [5]. 651 5.1 New event-package definition 653 This document defines a new event-package with the package name: 655 message-summary 657 5.2 Body Format Syntax 659 The formal syntax for application/simple-message-summary is below: 661 messsage-summary = msg-status-line CRLF 662 [msg-account CRLF] 663 [*(msg-summary-line CRLF)] 664 [ *opt-msg-headers ] 666 msg-status-line = "Messages-Waiting" HCOLON msg-status 667 msg-status = "yes" / "no" 668 msg-account = "Message-Account" HCOLON Account-URI 669 Account-URI = SIP-URI / SIPS-URI / absoluteURI 671 msg-summary-line = message-context-class HCOLON newmsgs SLASH oldmsgs 672 [ LPAREN new-urgentmsgs SLASH old-urgentmsgs RPAREN ] 674 opt-msg-headers = CRLF 1*(extension-header CRLF) 676 newmsgs = msgcount 677 oldmsgs = msgcount 678 new-urgentmsgs = msgcount 679 old-urgentmsgs = msgcount 680 msgcount = 1*DIGIT ; MUST NOT exceed 2^32-1 682 6. Security Considerations 684 Message Summaries and optional message bodies contain information 685 which is typically very privacy sensitive. At minimum, subscriptions 686 to this event package SHOULD be authenticated and properly 687 authorized. Furthermore, notifications SHOULD be encrypted and 688 integrity protected using either end-to-end mechanisms, or the hop- 689 by-hop protection afforded messages sent to SIPS URIs. 691 Additional security considerations are covered in SIP [1] and SIP 692 Events [2]. 694 7. IANA Considerations 695 7.1 SIP Event Package Registration for message-summary 697 Package name: message-summary 699 Type: package 701 Contact: [Mahy] 703 Published Specification: This document. 705 7.2 MIME Registration for application/simple-message-summary 707 MIME media type name: application 709 MIME subtype name: simple-message-summary 711 Required parameters: none. 713 Optional parameters: none. 715 Encoding considerations: This type is only defined for transfer 716 via SIP [1]. 718 Security considerations: See the "Security Considerations" 719 section in this document. 721 Interoperability considerations: none 723 Published specification: This document. 725 Applications which use this media: The simple-message-summary 726 application subtype supports the exchange of message waiting and 727 message summary information in SIP networks. 729 Additional information: 731 1. Magic number(s): N/A 733 2. File extension(s): N/A 735 3. Macintosh file type code: N/A 737 8. Revision history 738 8.1 Open Issues 740 1. Need to update the caller-preference section to reflect whatever 741 the replacement will be for feature="voice-mail". 743 2. Would be nice to add a pointer to the "collections" work 745 8.2 Changes from draft-ietf-sipping-mwi-00 747 1. Replaced the "media types" concept with message contexts. This 748 is a better semantic match than what was in the draft before, and 749 also controls extensibility and change control in a single 750 document. The list of valid message-context-classes are voice- 751 message, fax-message, pager-message, multimedia-message, text- 752 message, and none. 754 2. Completely updated the syntax to follow that of SIP instead of 755 the previously more restrictive (and somewhat arbitrary) syntax. 756 The SIP syntax adds line folding, for example. The optional 757 message-headers borrow the "extension-header" syntax and explicit 758 whitespace separators defined in SIP (ex: HCOLON, SLASH). 760 3. Added a Message-Account field in the body format to provide the 761 specific account name which corresponds to the notification when 762 forking or state agents are used with group aliases (or 763 collections). 765 4. Changed caller preferences example to exclude methods="SUBSCRIBE" 766 in the SUBSCRIBE request (removed redundant information). 768 5. Changed examples to be consistent with IESG recommendations 770 8.3 Changes from draft-mahy-sipping-mwi-00 772 1. Updated references and split into normative and informational 774 2. Removed normative behavior now specified in Events 776 3. Updated to address the event package sections now specified in 777 Events. 779 4. Added the Subscription-State header field to the examples and 780 removed the Event header field from responses. 782 5. Removed redundant BNF 783 6. Simplified text on how to choose the media type. For Internet 784 Mail, this now references the Message-Context header. 786 8.4 Changes from draft-mahy-sip-mwi-01 788 1. This document is now formatted as a SIP Event Package as defined 789 in Section 4 of RFC 3265 (SIP Events) [2]. 791 2. The event-package name is now "message-summary", to allow for 792 other bodies to extend the package. 794 3. The "urgent" token was missing from the BNF. 796 8.5 Changes from draft-mahy-sip-mwi-00 798 This draft greatly simplifies and shortens the -00 version. 800 1. The generic behavior of SUBSCRIBE/NOTIFY is now greatly clarified 801 in SIP Events [2] and made consistent with PINT and SIP for 802 presence. This message waiting draft is now consistent with SIP 803 Events. 805 2. The XML format has been removed due to lack of immediate 806 interest. At a future date, similar functionality may be added 807 as another body definition with an appropriate MIME type. 809 3. An IANA Considerations section was added to register the new 810 "application/simple-message-summary" MIME type and the "simple- 811 message-summary" SIP event package. 813 4. The "flag-list" was removed due to lack of interest and to 814 encourage simplicity. 816 5. Due to synchronization issues, and the recommendation of the VPIM 817 Working Group, support for message count "deltas" was removed. 819 6. The Messages-Waiting line in the body is now mandatory. 821 7. This version of the draft clarifies the role of caller 822 preferences as optional but encouraged. 824 8. A set of SMTP-like headers from the triggering messages may now 825 optionally follow the message summaries, provided that the 826 resulting NOTIFY on UDP fits in a single datagram. 828 9. Contributors 830 Ilya Slain came up with the initial format of the text body contained 831 in this document. He was previously listed as a co-author, however, 832 he is no longer reachable. 834 10. Acknowledgments 836 Thanks to Dan Wing, Dave Oran, Bill Foster, Steve Levy, Denise 837 Caballero-McCann, Jeff Michel, Priti Patil, Satyender Khatter, Bich 838 Nguyen, Manoj Bhatia, David Williams, and Bryan Byerly of Cisco; and 839 Jonathan Rosenberg and Adam Roach of Dynamicsoft. 841 Normative References 843 [1] Rosenberg, J., Schulzrinne, H., Camarillo, G., Johnston, A., 844 Peterson, J., Sparks, R., Handley, M. and E. Schooler, "SIP: 845 Session Initiation Protocol", RFC 3261, June 2002. 847 [2] Roach, A., "Session Initiation Protocol (SIP)-Specific Event 848 Notification", RFC 3265, June 2002. 850 [3] Bradner, S., "Key words for use in RFCs to Indicate Requirement 851 Levels", BCP 14, RFC 2119, March 1997. 853 [4] Rosenberg, J. and H. Schulzrinne, "Session Initiation Protocol 854 (SIP) Caller Preferences and Callee Capabilities", draft-ietf- 855 sip-callerprefs-06 (work in progress), July 2002. 857 [5] Crocker, D. and P. Overell, "Augmented BNF for Syntax 858 Specifications: ABNF", RFC 2234, November 1997. 860 [6] Klyne, G., Burger, E., Candell, E. and C. Eliot, "Message 861 Context for Internet Mail", draft-ietf-vpim-hint-08 (work in 862 progress), June 2002. 864 Informational References 866 [7] Vaudreuil, G. and G. Parsons, "Voice Profile for Internet Mail 867 - version 2", RFC 2421, September 1998. 869 [8] Freed, N. and N. Borenstein, "Multipurpose Internet Mail 870 Extensions (MIME) Part Two: Media Types", RFC 2046, November 871 1996. 873 [9] Resnick, P., "Internet Message Format", RFC 2822, April 2001. 875 [10] Telcordia, "GR-506: Signaling for Analog Interfaces, Issue 1, 876 Revision 1", Nov 1996. 878 Author's Address 880 Rohan Mahy 881 Cisco Systems, Inc. 882 101 Cooper Street 883 Santa Cruz, CA 95060 884 USA 886 EMail: rohan@cisco.com 888 Full Copyright Statement 890 Copyright (C) The Internet Society (2002). All Rights Reserved. 892 This document and translations of it may be copied and furnished to 893 others, and derivative works that comment on or otherwise explain it 894 or assist in its implementation may be prepared, copied, published 895 and distributed, in whole or in part, without restriction of any 896 kind, provided that the above copyright notice and this paragraph are 897 included on all such copies and derivative works. However, this 898 document itself may not be modified in any way, such as by removing 899 the copyright notice or references to the Internet Society or other 900 Internet organizations, except as needed for the purpose of 901 developing Internet standards in which case the procedures for 902 copyrights defined in the Internet Standards process must be 903 followed, or as required to translate it into languages other than 904 English. 906 The limited permissions granted above are perpetual and will not be 907 revoked by the Internet Society or its successors or assigns. 909 This document and the information contained herein is provided on an 910 "AS IS" basis and THE INTERNET SOCIETY AND THE INTERNET ENGINEERING 911 TASK FORCE DISCLAIMS ALL WARRANTIES, EXPRESS OR IMPLIED, INCLUDING 912 BUT NOT LIMITED TO ANY WARRANTY THAT THE USE OF THE INFORMATION 913 HEREIN WILL NOT INFRINGE ANY RIGHTS OR ANY IMPLIED WARRANTIES OF 914 MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE. 916 Acknowledgement 918 Funding for the RFC Editor function is currently provided by the 919 Internet Society.