From: Rusty Newton <rnewton@digium.com>
Date: Fri, 17 Jan 2014 15:12:50 +0000 (+0000)
Subject: res_pjsip: enhance documentation for mailboxes options, for both endpoints and aors
X-Git-Tag: 12.1.0-rc1~3^2~73
X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=5a8ada8a3ac2cbf95693fad55bc143ac8365c853;p=thirdparty%2Fasterisk.git

res_pjsip: enhance documentation for mailboxes options, for both endpoints and aors

Made documentation more explicit as to the use of the both options.

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


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

diff --git a/res/res_pjsip.c b/res/res_pjsip.c
index b06ae57cb2..0b3f95e74b 100644
--- a/res/res_pjsip.c
+++ b/res/res_pjsip.c
@@ -266,7 +266,14 @@
 					</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>
@@ -925,7 +932,10 @@
 					<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>