idnits 2.17.1 draft-ietf-sipping-mwi-03.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 9 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 == Line 124 has weird spacing: '...r sends messa...' -- 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 (June 28, 2003) is 7608 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 695 == Unused Reference: '7' is defined on line 869, but no explicit reference was found in the text == Unused Reference: '8' is defined on line 872, but no explicit reference was found in the text == Unused Reference: '9' is defined on line 876, 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 (-03) exists of draft-ietf-sip-callee-caps-00 ** 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) == Outdated reference: A later version (-07) exists of draft-ietf-simple-event-list-04 Summary: 5 errors (**), 0 flaws (~~), 8 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: December 27, 2003 June 28, 2003 6 A Message Summary and Message Waiting Indication Event Package for 7 the Session Initiation Protocol (SIP) 8 draft-ietf-sipping-mwi-03.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 other 17 groups may also distribute working documents as Internet-Drafts. 19 Internet-Drafts are draft documents valid for a maximum of six months 20 and may be updated, replaced, or obsoleted by other documents at any 21 time. It is inappropriate to use Internet-Drafts as reference 22 material or to cite them other than as "work in progress." 24 The list of current Internet-Drafts can be accessed at http:// 25 www.ietf.org/ietf/1id-abstracts.txt. 27 The list of Internet-Draft Shadow Directories can be accessed at 28 http://www.ietf.org/shadow.html. 30 This Internet-Draft will expire on December 27, 2003. 32 Copyright Notice 34 Copyright (C) The Internet Society (2003). All Rights Reserved. 36 Abstract 38 This document describes a SIP event package to carry message waiting 39 status and message summaries from a messaging system to an interested 40 User Agent. 42 Table of Contents 44 1. Conventions . . . . . . . . . . . . . . . . . . . . . . . . 3 45 2. Background and Appropriateness . . . . . . . . . . . . . . . 3 46 3. Event Package Formal Definition . . . . . . . . . . . . . . 4 47 3.1 Event Package Name . . . . . . . . . . . . . . . . . . . . . 4 48 3.2 Event Package Parameters . . . . . . . . . . . . . . . . . . 4 49 3.3 SUBSCRIBE Bodies . . . . . . . . . . . . . . . . . . . . . . 4 50 3.4 Subscription Duration . . . . . . . . . . . . . . . . . . . 4 51 3.5 NOTIFY Bodies . . . . . . . . . . . . . . . . . . . . . . . 4 52 3.6 Subscriber generation of SUBSCRIBE requests . . . . . . . . 6 53 3.7 Notifier processing of SUBSCRIBE requests . . . . . . . . . 6 54 3.8 Notifier generation of NOTIFY requests . . . . . . . . . . . 7 55 3.9 Subscriber processing of NOTIFY requests . . . . . . . . . . 7 56 3.10 Handling of Forked Requests . . . . . . . . . . . . . . . . 7 57 3.11 Rate of notifications . . . . . . . . . . . . . . . . . . . 7 58 3.12 State Agents and Lists . . . . . . . . . . . . . . . . . . . 8 59 3.13 Behavior of a Proxy Server . . . . . . . . . . . . . . . . . 8 60 4. Examples of Usage . . . . . . . . . . . . . . . . . . . . . 8 61 4.1 Example Message Flow . . . . . . . . . . . . . . . . . . . . 8 62 4.2 Example Usage with Callee Capabilities . . . . . . . . . . . 14 63 5. Formal Syntax . . . . . . . . . . . . . . . . . . . . . . . 14 64 5.1 New event-package definition . . . . . . . . . . . . . . . . 14 65 5.2 Body Format Syntax . . . . . . . . . . . . . . . . . . . . . 14 66 6. Security Considerations . . . . . . . . . . . . . . . . . . 15 67 7. IANA Considerations . . . . . . . . . . . . . . . . . . . . 15 68 7.1 SIP Event Package Registration for message-summary . . . . . 15 69 7.2 MIME Registration for application/simple-message-summary . . 16 70 8. Revision history . . . . . . . . . . . . . . . . . . . . . . 16 71 8.1 Changes from draft-ietf-sipping-mwi-01 and -02 . . . . . . . 16 72 8.2 Changes from draft-ietf-sipping-mwi-00 . . . . . . . . . . . 17 73 8.3 Changes from draft-mahy-sipping-mwi-00 . . . . . . . . . . . 17 74 8.4 Changes from draft-mahy-sip-mwi-01 . . . . . . . . . . . . . 17 75 8.5 Changes from draft-mahy-sip-mwi-00 . . . . . . . . . . . . . 18 76 9. Contributors . . . . . . . . . . . . . . . . . . . . . . . . 18 77 10. Acknowledgments . . . . . . . . . . . . . . . . . . . . . . 18 78 Normative References . . . . . . . . . . . . . . . . . . . . 19 79 Informational References . . . . . . . . . . . . . . . . . . 19 80 Author's Address . . . . . . . . . . . . . . . . . . . . . . 20 81 Intellectual Property and Copyright Statements . . . . . . . 21 83 1. Conventions 85 The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", 86 "SHOULD", "SHOULD NOT", "RECOMMENDED", "MAY", and "OPTIONAL" in this 87 document are to be interpreted as described in RFC-2119 [3]. 89 2. Background and Appropriateness 91 Messaging Waiting Indication is a common feature of telephone 92 networks. It typically involves an audible or visible indication 93 that messages are waiting, such as playing a special dial tone (which 94 in telephone networks is called message-waiting dial tone), lighting 95 a light or indicator on the phone, displaying icons or text, or some 96 combination. 98 Message-waiting dial tone is similar to but distinct from stutter 99 dial tone. Both are defined in GR-506 [11]. 101 The methods in the SIP [1] base specification were only designed to 102 solve the problem of session initiation for multimedia sessions, and 103 rendezvous. Since Message Waiting Indication is really status 104 information orthogonal to a session, it was not clear how an IP 105 telephone acting as a SIP User Agent would implement comparable 106 functionality. Members of the telephony community viewed this as a 107 shortcoming of SIP. 109 Users want the useful parts of the functionality they have using 110 traditional analog, mobile, and PBX telephones. It is also desirable 111 to provide comparable functionality in a flexible way that allows for 112 more customization and new features. SIP Specific Event Notification 113 (RFC 3265 -- SIP Events) [2] is an appropriate mechanism to use in 114 this environment, as it preserves the user mobility and rendezvous 115 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.(This Notifier could be 122 composed with a User Agent that provides a real-time media interface 123 to send or receive messages, or it could be a standalone entitiy.) 124 The Notifier sends message summary information in the body of a 125 NOTIFY, encoded in a new MIME type defined later in this document. A 126 User Agent can also explicitly fetch the current status. 128 A SIP User Agent MAY subscribe to multiple accounts (distinguished by 129 the Request URI). Multiple SIP User Agents MAY subscribe to the same 130 account. 132 Before any subscriptions or notifications are sent, each interested 133 User Agent must be made aware of its messaging notifier(s). This MAY 134 be manually configured on interested User Agents, manually configured 135 on an appropriate SIP Proxy, or dynamically discovered based on 136 registered callee capabilities [4]. (For more information on usage 137 with callee capabilities, see Section 4.2) 139 3. Event Package Formal Definition 141 3.1 Event Package Name 143 This document defines a SIP Event Package as defined in RFC 3265 [2]. 144 The event-package token name for this package is: 146 "message-summary" 148 3.2 Event Package Parameters 150 This package does not define any event package parameters. 152 3.3 SUBSCRIBE Bodies 154 This package does not define any SUBSCRIBE bodies. 156 3.4 Subscription Duration 158 Subscriptions to this event package MAY range from minutes to weeks. 159 Subscriptions in hours or days are more typical and are RECOMMENDED. 160 The default subscription duration for this event package is one hour. 162 3.5 NOTIFY Bodies 164 A simple text-based format is proposed to prevent an undue burden on 165 low-end user agents, for example, inexpensive IP phones with no 166 display. Although this format is text-based, it is intended for 167 machine consumption only. 169 A future extension MAY define other NOTIFY bodies. If no "Accept" 170 header is present in the SUBSCRIBE, the body type defined in this 171 document MUST be assumed. 173 The format specified in this proposal attempts to separate orthogonal 174 attributes of messages as much as possible. Messages are separated 175 by message-context-class (for example: voice-message, fax-message, 176 pager-message, multimedia-message, text-message, and none); by 177 message status (new and old); and by urgent and non-urgent type. 179 The text format begins with a simple status line, and optionally a 180 summary line per message-context-class. Message-context-classes are 181 defined in [6]. For each message-context-class, the total number of 182 new and old messages is reported in the new and old fields. 184 In some cases, detailed message summaries are not available. The 185 status line allows messaging systems or messaging gateways to provide 186 the traditional boolean message waiting notification. 188 Messages-Waiting: yes 190 If the Request-URI or To header in a message-summary subscription 191 corresponds to a group or collection of individual messaging 192 accounts, the notifier MUST specify to which account the 193 message-summary body corresponds. Note that the account URI MUST NOT 194 be delimited with angle brackets ("<" and ">"). 196 Message-Account: sip:alice@example.com 198 In the example that follows, more than boolean message summary 199 information is available to the User Agent. There are two new and 200 four old fax messages. 202 Fax-Message: 2/4 204 After the summary, the format can optionally list a summary count of 205 urgent messages. In the next example there are one new and three old 206 voice messages, none of the new messages are urgent, but one of the 207 old messages is. All counters have a maximum value of 4,294,967,295 208 ((2^32) - 1). Notifiers MUST NOT generate a request with a larger 209 value. Subscribers MUST treat a larger value as 2^32-1. 211 Voice-Message: 1/3 (0/1) 213 Optionally, after the summary counts, the messaging systems MAY 214 append RFC 2822 [9]-style message headers, which further describe 215 newly added messages. Message headers MUST NOT be included in an 216 initial NOTIFY, as new messages could be essentially unbounded in 217 size. Message headers included in subsequent notifications MUST only 218 correspond to messages added since the previous notification for that 219 subscription. A messaging system which includes message headers in a 220 NOTIFY, MUST provide an administrator configurable mechanism for 221 selecting which headers are sent. Likely headers for inclusion 222 include To, From, Date, Subject, and Message-ID. Note that the 223 formatting of these headers in this body is identical to that of SIP 224 extension-headers, not the (similar) format defined in RFC 2822. 226 Implementations which generate large notifications are reminded to 227 follow the message size restrictions for unreliable transports 228 articulated in Section 18.1.1 of SIP. 230 Mapping local message state to new/old message status and urgency is 231 an implementation issue of the messaging system. However, the 232 messaging notifier MUST NOT consider a message "old" merely because 233 it generated a notification, as this could prevent another 234 subscription from accurately receiving message-summary notifications. 235 Likewise, the messaging system MAY use any suitable algorithm to 236 determine that a message is "urgent". 238 Messaging systems MAY use any algorithm for determining the 239 approporiate message-context-class for a specific message. Systems 240 which use Internet Mail SHOULD use the contents of the 241 Message-Context header [6] (defined in RFC 3458) if present as a hint 242 to make a context determination. Note that a composed messaging 243 system does not need to support a given context in order to generate 244 notifications identified with that context. 246 3.6 Subscriber generation of SUBSCRIBE requests 248 Subscriber User Agents will typically SUBSCRIBE to message summary 249 information for a period of hours or days, and automatically attempt 250 to re-SUBSCRIBE well before the subscription is completely expired. 251 If re-subscription fails, the Subscriber SHOULD periodically retry 252 again until a subscription is successful, taking care to backoff to 253 avoid network congestion. If a subscription has expired, new 254 re-subscriptions MUST use a new Call-ID. 256 The Subscriber SHOULD SUBSCRIBE to that user's message summaries 257 whenever a new user becomes associated with the device (a new login). 258 The Subscriber MAY also explicitly fetch the current status at any 259 time. The subscriber SHOULD renew its subscription immediately after 260 a reboot, or when the subscriber's network connectivity has just been 261 re-established. 263 The Subscriber MUST be prepared to receive and process a NOTIFY with 264 new state immediately after sending a new SUBSCRIBE, a SUBSCRIBE 265 renewal, an unsubscribe, or a fetch; or at any time during the 266 subscription. 268 When a user de-registers from a device (logoff, power down of a 269 mobile device, etc.), subscribers SHOULD unsubscribe by sending a 270 SUBSCRIBE message with an Expires header of zero. 272 3.7 Notifier processing of SUBSCRIBE requests 274 When a SIP Messaging System receives SUBSCRIBE messages with the 275 message-summary event-type, it SHOULD authenticate the subscription 276 request. If authentication is successful, the Notifier MAY limit the 277 duration of the subscription to an administrator defined amount of 278 time as described in SIP Events. 280 3.8 Notifier generation of NOTIFY requests 282 Immediately after a subscription is accepted, the Notifier MUST send 283 a NOTIFY with the current message summary information. This allows 284 the Subscriber to resynchronize its state. This initial 285 synchronization NOTIFY MUST NOT include the optional RFC 2822 286 [9]-style message headers. 288 When the status of the messages changes sufficiently for a messaging 289 account to change the number of new or old messages, the Notifier 290 SHOULD send a NOTIFY message to all active subscribers to that 291 account. NOTIFY messages sent to subscribers of a group or alias, 292 MUST contain the message account name in the notification body. 294 A Messaging System MAY send a NOTIFY with an "Expires" header of "0" 295 and a "Subscription-State" header of "terminated" before a graceful 296 shutdown. 298 3.9 Subscriber processing of NOTIFY requests 300 Upon receipt of a valid NOTIFY request, the subscriber SHOULD 301 immediately render the message status and summary information to the 302 end user in an implementation specific way. 304 The Subscriber MUST be prepared to receive NOTIFYs from different 305 Contacts corresponding to the same SUBSCRIBE. (the SUBSCRIBE may 306 have been forked). 308 3.10 Handling of Forked Requests 310 Forked requests are allowed for this event type and may install 311 multiple subscriptions. The Subscriber MAY render multiple summaries 312 which correspond to the same account directly to the user, or MAY 313 merge them as described below. 315 If any of the "Messages-Waiting" status lines report "yes", then the 316 merged state is "yes"; otherwise the merged state is "no". 318 The Subscriber MAY merge summary lines in an implementation-specific 319 way if all notifications contain at least one msg-summary line. 321 3.11 Rate of notifications 322 A Notifier MAY choose to hold NOTIFY requests in "quarantine" for a 323 short administrator-defined period (seconds or minutes) when the 324 message status is changing rapidly. Requests in the quarantine which 325 become invalid are replaced by newer notifications, thus reducing the 326 total volume of notifications. This behavior is encouraged for 327 implementations with heavy interactive use. Note that timely 328 notification which results in a change of overall state (messages 329 waiting or not), and notification of newly added messages is probably 330 more significant to the end user than a notification of newly deleted 331 messages which do not affect the overall message waiting state (e.g. 332 there are still new messages). 334 Notifiers SHOULD NOT generate NOTIFY requests more frequently than 335 once per second. 337 3.12 State Agents and Lists 339 A Subscriber MAY use an "alias" or "group" in the Request-URI of a 340 subscription if that name is significant to the messaging system. 341 Implementers MAY create a service which consolidates and summarizes 342 NOTIFYs from many Contacts. This document does not preclude 343 implementations from building state agents which support this event 344 package. One way to implement such a service is with the event list 345 extension [10]. 347 3.13 Behavior of a Proxy Server 349 There are no additional requirements on a SIP Proxy, other than to 350 transparently forward the SUBSCRIBE and NOTIFY methods as required in 351 SIP. However, Proxies SHOULD allow non-SIP URLs. Proxies and 352 Redirect servers SHOULD be able to direct the SUBSCRIBE request to an 353 appropriate messaging notifier User Agent. 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. 466 Some headers from each of the new messages are appended. 468 NOTIFY sip:alice@alice-phone.example.com SIP/2.0 469 To: ;tag=78923 470 From: ;tag=4442 471 Date: Mon, 10 Jul 2000 04:28:53 GMT 472 Contact: 473 Call-ID: 1349882@alice-phone.example.com 474 CSeq: 31 NOTIFY 475 Event: message-summary 476 Subscription-State: active 477 Content-Type: application/simple-message-summary 478 Content-Length: 503 480 Messages-Waiting: yes 481 Message-Account: sip:alice@vmail.example.com 482 Voice-Message: 4/8 (1/2) 484 To: 485 From: 486 Subject: carpool tomorrow? 487 Date: Sun, 09 Jul 2000 21:23:01 -0700 488 Priority: normal 489 Message-ID: 13784434989@vmail.example.com 491 To: 492 From: 493 Subject: HELP! at home ill, present for me please 494 Date: Sun, 09 Jul 2000 21:25:12 -0700 495 Priority: urgent 496 Message-ID: 13684434990@vmail.example.com 498 A6: Subscriber -> Notifier 500 SIP/2.0 200 OK 501 To: ;tag=78923 502 From: ;tag=4442 503 Date: Mon, 10 Jul 2000 04:28:53 GMT 504 Call-ID: 1349882@alice-phone.example.com 505 CSeq: 31 NOTIFY 506 Content-Length: 0 508 A7: Subscriber -> Notifier 509 Refresh subscription. 511 SUBSCRIBE sip:alice@vmail.example.com SIP/2.0 512 To: ;tag=4442 513 From: ;tag=78923 514 Date: Mon, 10 Jul 2000 15:55:06 GMT 515 Call-Id: 1349882@alice-phone.example.com 516 CSeq: 8 SUBSCRIBE 517 Contact: 518 Event: message-summary 519 Expires: 86400 520 Accept: application/simple-message-summary 521 Content-Length: 0 523 A8: Notifier -> Subscriber 525 SIP/2.0 200 OK 526 To: ;tag=4442 527 From: ;tag=78923 528 Date: Mon, 10 Jul 2000 15:55:07 GMT 529 Call-Id: 1349882@alice-phone.example.com 530 CSeq: 8 SUBSCRIBE 531 Contact: 532 Expires: 86400 533 Content-Length: 0 535 A9: Notifier -> Subscriber 536 (immediate synchronization of current state) 538 NOTIFY sip:alice@alice-phone.example.com SIP/2.0 539 To: ;tag=78923 540 From: ;tag=4442 541 Date: Mon, 10 Jul 2000 15:55:07 GMT 542 Call-Id: 1349882@alice-phone.example.com 543 CSeq: 47 NOTIFY 544 Contact: 545 Event: message-summary 546 Subscription-State: active 547 Content-Type: application/simple-message-summary 548 Content-Length: 99 550 Messages-Waiting: yes 551 Message-Account: sip:alice@vmail.example.com 552 Voice-Message: 4/8 (1/2) 554 A10: Subscriber -> Notifier 556 SIP/2.0 200 OK 557 To: ;tag=78923 558 From: ;tag=4442 559 Date: Mon, 10 Jul 2000 15:55:08 GMT 560 Call-Id: 1349882@alice-phone.example.com 561 CSeq: 47 NOTIFY 562 Contact: 564 A11: Subscriber -> Notifier 565 Un-subscribe after "alice" logs out. 567 SUBSCRIBE sip:alice@vmail.example.com SIP/2.0 568 To: ;tag=4442 569 From: ;tag=78923 570 Date: Mon, 10 Jul 2000 19:35:06 GMT 571 Call-Id: 1349882@alice-phone.example.com 572 CSeq: 17 SUBSCRIBE 573 Contact: 574 Event: message-summary 575 Expires: 0 576 Accept: application/simple-message-summary 577 Content-Length: 0 579 A12: Notifier -> Subscriber 581 SIP/2.0 200 OK 582 To: ;tag=4442 583 From: ;tag=78923 584 Date: Mon, 10 Jul 2000 19:35:07 GMT 585 Call-Id: 1349882@alice-phone.example.com 586 CSeq: 17 SUBSCRIBE 587 Contact: 588 Expires: 0 589 Content-Length: 0 591 A13: Notifier -> Subscriber 592 (immediate synchronization of current state, 593 which the subscriber can now ignore) 595 NOTIFY sip:alice@alice-phone.example.com SIP/2.0 596 To: ;tag=78923 597 From: ;tag=4442 598 Date: Mon, 10 Jul 2000 19:35:07 GMT 599 Call-Id: 1349882@alice-phone.example.com 600 CSeq: 56 NOTIFY 601 Contact: 602 Event: message-summary 603 Subscription-State: terminated;reason=timeout 604 Content-Type: application/simple-message-summary 605 Content-Length: 99 607 Messages-Waiting: yes 608 Message-Account: sip:alice@vmail.example.com 609 Voice-Message: 4/8 (1/2) 611 A10: Subscriber -> Notifier 613 SIP/2.0 200 OK 614 To: ;tag=78923 615 From: ;tag=4442 616 Date: Mon, 10 Jul 2000 19:35:08 GMT 617 Call-Id: 1349882@alice-phone.example.com 618 CSeq: 56 NOTIFY 619 Event: message-summary 620 Content-Length: 0 622 4.2 Example Usage with Callee Capabilities 624 The use of callee capabilities is optional but encouraged. If callee 625 capabilities is used, a messaging notifier MAY REGISTER a Contact 626 with an appropriate methods and events tag as shown in the example 627 below. To further distinguish itself, the messaging notifier MAY 628 also REGISTER as a Contact with the feature="msgserver" tag. An 629 example of this kind of registration follows below. 631 REGISTER sip:sip3-sj.example.com SIP/2.0 632 To: 633 From: ;tag=4442 634 ... 635 Contact: 636 ;msgserver="true";methods="SUBSCRIBE" 637 ;events="message-summary" 639 5. Formal Syntax 641 The following syntax specification uses the augmented Backus-Naur 642 Form (BNF) as described in RFC-2234 [5]. 644 5.1 New event-package definition 646 This document defines a new event-package with the package name: 648 message-summary 650 5.2 Body Format Syntax 652 The formal syntax for application/simple-message-summary is below: 654 messsage-summary = msg-status-line CRLF 655 [msg-account CRLF] 656 [*(msg-summary-line CRLF)] 657 [ *opt-msg-headers ] 659 msg-status-line = "Messages-Waiting" HCOLON msg-status 660 msg-status = "yes" / "no" 661 msg-account = "Message-Account" HCOLON Account-URI 662 Account-URI = SIP-URI / SIPS-URI / absoluteURI 664 msg-summary-line = message-context-class HCOLON newmsgs SLASH oldmsgs 665 [ LPAREN new-urgentmsgs SLASH old-urgentmsgs RPAREN ] 667 opt-msg-headers = CRLF 1*(extension-header CRLF) 669 newmsgs = msgcount 670 oldmsgs = msgcount 671 new-urgentmsgs = msgcount 672 old-urgentmsgs = msgcount 673 msgcount = 1*DIGIT ; MUST NOT exceed 2^32-1 675 6. Security Considerations 677 Message summaries and optional message bodies contain information 678 which is typically very privacy sensitive. At minimum, subscriptions 679 to this event package SHOULD be authenticated and properly 680 authorized. Furthermore, notifications SHOULD be encrypted and 681 integrity protected using either end-to-end mechanisms, or the 682 hop-by-hop protection afforded messages sent to SIPS URIs. 684 Additional and privacy security considerations are discussed in 685 detail in SIP [1] and SIP Events [2]. 687 7. IANA Considerations 689 7.1 SIP Event Package Registration for message-summary 691 Package name: message-summary 693 Type: package 695 Contact: [Mahy] 697 Published Specification: This document. 699 7.2 MIME Registration for application/simple-message-summary 701 MIME media type name: application 703 MIME subtype name: simple-message-summary 705 Required parameters: none. 707 Optional parameters: none. 709 Encoding considerations: This type is only defined for transfer 710 via SIP [1]. 712 Security considerations: See the "Security Considerations" 713 section in this document. 715 Interoperability considerations: none 717 Published specification: This document. 719 Applications which use this media: The simple-message-summary 720 application subtype supports the exchange of message waiting and 721 message summary information in SIP networks. 723 Additional information: 725 1. Magic number(s): N/A 727 2. File extension(s): N/A 729 3. Macintosh file type code: N/A 731 8. Revision history 733 ** Note to the RFC editor: please remove this entire section upon 734 publication. ** 736 8.1 Changes from draft-ietf-sipping-mwi-01 and -02 738 1. Updated the caller-preference section (now the callee 739 capabilities section) to reflect the split of these drafts and 740 the new tag ;msgserver="true". 742 2. Added some text in the overview to further clarify how message 743 notifiers can be composed/decomposed with media processing. 745 3. Add a pointer to the event-list extension. 747 8.2 Changes from draft-ietf-sipping-mwi-00 749 1. Replaced the "media types" concept with message contexts. This is 750 a better semantic match than what was in the draft before, and 751 also controls extensibility and change control in a single 752 document. The list of valid message-context-classes are 753 voice-message, fax-message, pager-message, multimedia-message, 754 text-message, and none. 756 2. Completely updated the syntax to follow that of SIP instead of 757 the previously more restrictive (and somewhat arbitrary) syntax. 758 The SIP syntax adds line folding, for example. The optional 759 message-headers borrow the "extension-header" syntax and explicit 760 whitespace separators defined in SIP (ex: HCOLON, SLASH). 762 3. Added a Message-Account field in the body format to provide the 763 specific account name which corresponds to the notification when 764 forking or state agents are used with group aliases (or 765 collections). 767 4. Changed caller preferences example to exclude methods="SUBSCRIBE" 768 in the SUBSCRIBE request (removed redundant information). 770 5. Changed examples to be consistent with IESG recommendations 772 8.3 Changes from draft-mahy-sipping-mwi-00 774 1. Updated references and split into normative and informational 776 2. Removed normative behavior now specified in Events 778 3. Updated to address the event package sections now specified in 779 Events. 781 4. Added the Subscription-State header field to the examples and 782 removed the Event header field from responses. 784 5. Removed redundant BNF 786 6. Simplified text on how to choose the media type. For Internet 787 Mail, this now references the Message-Context header. 789 8.4 Changes from draft-mahy-sip-mwi-01 791 1. This document is now formatted as a SIP Event Package as defined 792 in Section 4 of RFC 3265 (SIP Events) [2]. 794 2. The event-package name is now "message-summary", to allow for 795 other bodies to extend the package. 797 3. The "urgent" token was missing from the BNF. 799 8.5 Changes from draft-mahy-sip-mwi-00 801 This draft greatly simplifies and shortens the -00 version. 803 1. The generic behavior of SUBSCRIBE/NOTIFY is now greatly clarified 804 in SIP Events [2] and made consistent with PINT and SIP for 805 presence. This message waiting draft is now consistent with SIP 806 Events. 808 2. The XML format has been removed due to lack of immediate 809 interest. At a future date, similar functionality may be added 810 as another body definition with an appropriate MIME type. 812 3. An IANA Considerations section was added to register the new 813 "application/simple-message-summary" MIME type and the 814 "simple-message-summary" SIP event package. 816 4. The "flag-list" was removed due to lack of interest and to 817 encourage simplicity. 819 5. Due to synchronization issues, and the recommendation of the VPIM 820 Working Group, support for message count "deltas" was removed. 822 6. The Messages-Waiting line in the body is now mandatory. 824 7. This version of the draft clarifies the role of caller 825 preferences as optional but encouraged. 827 8. A set of SMTP-like headers from the triggering messages may now 828 optionally follow the message summaries, provided that the 829 resulting NOTIFY on UDP fits in a single datagram. 831 9. Contributors 833 Ilya Slain came up with the initial format of the text body contained 834 in this document. He was previously listed as a co-author, however, 835 he is no longer reachable. 837 10. Acknowledgments 839 Thanks to Dan Wing, Dave Oran, Bill Foster, Steve Levy, Denise 840 Caballero-McCann, Jeff Michel, Priti Patil, Satyender Khatter, Bich 841 Nguyen, Manoj Bhatia, David Williams, and Bryan Byerly of Cisco; 842 Jonathan Rosenberg and Adam Roach of Dynamicsoft; Eric Burger of 843 Snowshore; Nir Chen of iComverse, and Eric Tremblay of Mediatrix. 845 Normative References 847 [1] Rosenberg, J., Schulzrinne, H., Camarillo, G., Johnston, A., 848 Peterson, J., Sparks, R., Handley, M. and E. Schooler, "SIP: 849 Session Initiation Protocol", RFC 3261, June 2002. 851 [2] Roach, A., "Session Initiation Protocol (SIP)-Specific Event 852 Notification", RFC 3265, June 2002. 854 [3] Bradner, S., "Key words for use in RFCs to Indicate Requirement 855 Levels", BCP 14, RFC 2119, March 1997. 857 [4] Rosenberg, J., "Indicating User Agent Capabilities in the 858 Session Initiation Protocol (SIP)", 859 draft-ietf-sip-callee-caps-00 (work in progress), June 2003. 861 [5] Crocker, D. and P. Overell, "Augmented BNF for Syntax 862 Specifications: ABNF", RFC 2234, November 1997. 864 [6] Burger, E., Candell, E., Eliot, C. and G. Klyne, "Message 865 Context for Internet Mail", RFC 3458, January 2003. 867 Informational References 869 [7] Vaudreuil, G. and G. Parsons, "Voice Profile for Internet Mail 870 - version 2", RFC 2421, September 1998. 872 [8] Freed, N. and N. Borenstein, "Multipurpose Internet Mail 873 Extensions (MIME) Part Two: Media Types", RFC 2046, November 874 1996. 876 [9] Resnick, P., "Internet Message Format", RFC 2822, April 2001. 878 [10] Rosenberg, J., Roach, A. and B. Campbell, "A Session Initiation 879 Protocol (SIP) Event Notification Extension for Resource 880 Lists", draft-ietf-simple-event-list-04 (work in progress), 881 June 2003. 883 [11] Telcordia, "GR-506: Signaling for Analog Interfaces, Issue 1, 884 Revision 1", Nov 1996. 886 Author's Address 888 Rohan Mahy 889 Cisco Systems, Inc. 890 101 Cooper Street 891 Santa Cruz, CA 95060 892 USA 894 EMail: rohan@cisco.com 896 Intellectual Property Statement 898 The IETF takes no position regarding the validity or scope of any 899 intellectual property or other rights that might be claimed to 900 pertain to the implementation or use of the technology described in 901 this document or the extent to which any license under such rights 902 might or might not be available; neither does it represent that it 903 has made any effort to identify any such rights. Information on the 904 IETF's procedures with respect to rights in standards-track and 905 standards-related documentation can be found in BCP-11. Copies of 906 claims of rights made available for publication and any assurances of 907 licenses to be made available, or the result of an attempt made to 908 obtain a general license or permission for the use of such 909 proprietary rights by implementors or users of this specification can 910 be obtained from the IETF Secretariat. 912 The IETF invites any interested party to bring to its attention any 913 copyrights, patents or patent applications, or other proprietary 914 rights which may cover technology that may be required to practice 915 this standard. Please address the information to the IETF Executive 916 Director. 918 Full Copyright Statement 920 Copyright (C) The Internet Society (2003). All Rights Reserved. 922 This document and translations of it may be copied and furnished to 923 others, and derivative works that comment on or otherwise explain it 924 or assist in its implementation may be prepared, copied, published 925 and distributed, in whole or in part, without restriction of any 926 kind, provided that the above copyright notice and this paragraph are 927 included on all such copies and derivative works. However, this 928 document itself may not be modified in any way, such as by removing 929 the copyright notice or references to the Internet Society or other 930 Internet organizations, except as needed for the purpose of 931 developing Internet standards in which case the procedures for 932 copyrights defined in the Internet Standards process must be 933 followed, or as required to translate it into languages other than 934 English. 936 The limited permissions granted above are perpetual and will not be 937 revoked by the Internet Society or its successors or assignees. 939 This document and the information contained herein is provided on an 940 "AS IS" basis and THE INTERNET SOCIETY AND THE INTERNET ENGINEERING 941 TASK FORCE DISCLAIMS ALL WARRANTIES, EXPRESS OR IMPLIED, INCLUDING 942 BUT NOT LIMITED TO ANY WARRANTY THAT THE USE OF THE INFORMATION 943 HEREIN WILL NOT INFRINGE ANY RIGHTS OR ANY IMPLIED WARRANTIES OF 944 MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE. 946 Acknowledgement 948 Funding for the RFC Editor function is currently provided by the 949 Internet Society.