From: Rusty Newton <rnewton@digium.com>
Date: Tue, 21 Jan 2014 21:47:13 +0000 (+0000)
Subject: res_pjsip: Documentation improvement for Endpoint and AOR mailbox options.
X-Git-Tag: 12.1.0-rc1~3^2~58
X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=88417eb71ddd37fd5dd6621d0846b197c720c3b4;p=thirdparty%2Fasterisk.git

res_pjsip: Documentation improvement for Endpoint and AOR mailbox options.

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.


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

diff --git a/res/res_pjsip.c b/res/res_pjsip.c
index 06e5b7284d..b7e37edae7 100644
--- a/res/res_pjsip.c
+++ b/res/res_pjsip.c
@@ -270,9 +270,12 @@
 					<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>
@@ -930,12 +933,17 @@
 					<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">