res_pjsip: Documentation improvement for Endpoint and AOR mailbox options.
authorRusty Newton <rnewton@digium.com>
Tue, 21 Jan 2014 21:48:15 +0000 (21:48 +0000)
committerRusty Newton <rnewton@digium.com>
Tue, 21 Jan 2014 21:48:15 +0000 (21:48 +0000)
Making the help text for both more explicit regarding the format of mailbox identifiers. i.e. clarifying the format for app_voicemail mailboxes vs mailboxes from external MWI sources through modules such as res_external_mwi.
........

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

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

res/res_pjsip.c

index e5da2eb..fc4afed 100644 (file)
                                        <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 example: mailboxes=6001@default.
-                                               For endpoints that SUBSCRIBE for MWI, you can set the <literal>mailboxes</literal> option in your AOR
+                                               specified with a comma-delimited string. app_voicemail mailboxes must be specified
+                                               as mailbox@context; for example: mailboxes=6001@default. For mailboxes provided by
+                                               external sources, such as through the res_external_mwi module, you must specify
+                                               strings supported by the external system.
+                                       </para><para>
+                                               For endpoints that SUBSCRIBE for MWI, use the <literal>mailboxes</literal> option in your AOR
                                                configuration.
                                        </para></description>
                                </configOption>
                                        <synopsis>Default expiration time in seconds for contacts that are dynamically bound to an AoR.</synopsis>
                                </configOption>
                                <configOption name="mailboxes">
-                                       <synopsis>Mailbox(es) to be associated with</synopsis>
+                                       <synopsis>Allow subscriptions for the specified mailbox(es)</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.
-                                       For endpoints that cannot SUBSCRIBE for MWI, you can set the <literal>mailboxes</literal> option in your
-                                       Endpoint configuration section.
+                                               for Message Waiting Indications. The mailboxes specified will be subscribed to.
+                                               More than one mailbox can be specified with a comma-delimited string.
+                                               app_voicemail mailboxes must be specified as mailbox@context;
+                                               for example: mailboxes=6001@default. For mailboxes provided by external sources,
+                                               such as through the res_external_mwi module, you must specify strings supported by
+                                               the external system.
+                                       </para><para>
+                                               For endpoints that cannot SUBSCRIBE for MWI, you can set the <literal>mailboxes</literal> option in your
+                                               endpoint configuration section to enable unsolicited MWI NOTIFYs to the endpoint.
                                        </para></description>
                                </configOption>
                                <configOption name="maximum_expiration" default="7200">