res_pjsip: enhance documentation for mailboxes options, for both endpoints and aors
authorRusty Newton <rnewton@digium.com>
Fri, 17 Jan 2014 15:14:03 +0000 (15:14 +0000)
committerRusty Newton <rnewton@digium.com>
Fri, 17 Jan 2014 15:14:03 +0000 (15:14 +0000)
Made documentation more explicit as to the use of the both options.

(issue ASTERISK-23071)
(closes issue ASTERISK-23071)
Reported by: Matt Jordan
........

Merged revisions 405777 from http://svn.asterisk.org/svn/asterisk/branches/12

git-svn-id: https://origsvn.digium.com/svn/asterisk/trunk@405778 65c4cc65-6c06-0410-ace0-fbb531ad65f3

res/res_pjsip.c

index a74f232..e5b3f51 100644 (file)
                                        </description>
                                </configOption>
                                <configOption name="mailboxes">
-                                       <synopsis>Mailbox(es) to be associated with</synopsis>
+                                       <synopsis>NOTIFY the endpoint when state changes for any of the specified mailboxes</synopsis>
+                                       <description><para>
+                                               Asterisk will send unsolicited MWI NOTIFY messages to the endpoint when state
+                                               changes happen for any of the specified mailboxes. More than one mailbox can be
+                                               specified with a comma-delimited string. Mailboxes must be specified as <mailbox>@<context>.
+                                               For endpoints that SUBSCRIBE for MWI, you can set the <literal>mailboxes</literal> option in your AOR
+                                               configuration.
+                                       </para></description>
                                </configOption>
                                <configOption name="moh_suggest" default="default">
                                        <synopsis>Default Music On Hold class</synopsis>
                                        <synopsis>Mailbox(es) to be associated with</synopsis>
                                        <description><para>This option applies when an external entity subscribes to an AoR
                                        for message waiting indications. The mailboxes specified will be subscribed to.
-                                       More than one mailbox can be specified with a comma-delimited string.</para></description>
+                                       More than one mailbox can be specified with a comma-delimited string.
+                                       For endpoints that cannot SUBSCRIBE for MWI, you can set the <literal>mailboxes</literal> option in your
+                                       Endpoint configuration section.
+                                       </para></description>
                                </configOption>
                                <configOption name="maximum_expiration" default="7200">
                                        <synopsis>Maximum time to keep an AoR</synopsis>