diff --git a/src/modules/msilo/doc/msilo_admin.xml b/src/modules/msilo/doc/msilo_admin.xml
index 3563e2a87a9..ca48d7ea075 100644
--- a/src/modules/msilo/doc/msilo_admin.xml
+++ b/src/modules/msilo/doc/msilo_admin.xml
@@ -10,39 +10,39 @@
-
+
&adminguide;
-
+
Overview
- This module provides offline message storage for &kamailioname;. It
- stores received messages for an offline user and sends them when the
+ This module provides offline message storage for &kamailioname;. It
+ stores received messages for an offline user and sends them when the
user comes back online. It can also send reminders and auto-expire
messages.
- For each message, the modules stores Request-URI
- (R-URI
) only if it is a complete address of record
- (username@hostname
), &uri; from To
+ For each message, the modules stores Request-URI
+ (R-URI
) only if it is a complete address of record
+ (username@hostname
), &uri; from To
header, &uri; from From
header, incoming time,
- expiration time, content type and body of the message. If
- R-URI
is not an address of record (it might be the
+ expiration time, content type and body of the message. If
+ R-URI
is not an address of record (it might be the
contact address for current &sip; session) the &uri;
from To
header will be used as R-URI.
- When the expiration time is passed, the message is discarded from
- database. Expiration time is computed based on incoming time and
+ When the expiration time is passed, the message is discarded from
+ database. Expiration time is computed based on incoming time and
one of the module's parameters.
- Every time when a user registers with &kamailio;, the module is looking in
- database for offline messages intended for that user. All of them will
+ Every time when a user registers with &kamailio;, the module is looking in
+ database for offline messages intended for that user. All of them will
be sent to contact address provided in REGISTER request and then be deleted.
- It may happen that the &sip; user registering use a &sip; User Agent
+ It may happen that the &sip; user registering use a &sip; User Agent
that has no support for MESSAGE requests. In this case the failure_route
should be used to re-store the undelivered requests.
@@ -62,15 +62,15 @@
- database module - mysql, dbtext or other
- module that implements the db
interface and
- provides support for storing/receiving data to/from a
+ database module - mysql, dbtext or other
+ module that implements the db
interface and
+ provides support for storing/receiving data to/from a
database system.
- TM--transaction module-- used to
+ TM--transaction module-- used to
send &sip; requests.
@@ -80,7 +80,7 @@
External libraries or applications
- The following libraries or applications must be installed before
+ The following libraries or applications must be installed before
running &kamailio; with this module:
@@ -101,7 +101,7 @@
- Default value is
+ Default value is
&defaultdb;
.
@@ -137,7 +137,7 @@ modparam("msilo", "db_table", "silo")
<varname>sc_mid</varname> (string)
- The name of the column in silo table used to store the message id.
+ The name of the column in silo table used to store the message id.
Default value is mid
.
@@ -148,12 +148,12 @@ modparam("msilo", "sc_mid", "other_mid")
...
-
+
<varname>sc_from</varname> (string)
- The name of the column in silo table, storing the source address.
+ The name of the column in silo table, storing the source address.
Default value is src_addr
.
@@ -164,11 +164,11 @@ modparam("msilo", "sc_from", "source_address")
...
-
+
<varname>sc_to</varname> (string)
- The name of the column in silo table, storing the destination address.
+ The name of the column in silo table, storing the destination address.
Default value is dst_addr
.
@@ -179,7 +179,7 @@ modparam("msilo", "sc_to", "destination_address")
...
-
+
<varname>sc_uri_user</varname> (string)
@@ -194,103 +194,118 @@ modparam("msilo", "sc_uri_user", "user")
...
-
+
<varname>sc_uri_host</varname> (string)
- The name of the column in silo table, storing the domain.
+ The name of the column in silo table, storing the domain.
Default value is domain
.
Set the <quote>sc_uri_host</quote> parameter
-
+
...
modparam("msilo", "sc_uri_host", "domain")
...
-
+
<varname>sc_body</varname> (string)
- The name of the column storing the message body in silo table.
+ The name of the column storing the message body in silo table.
Default value is body
.
-
+
Set the <quote>sc_body</quote> parameter
-
+
...
modparam("msilo", "sc_body", "message_body")
...
-
+
<varname>sc_ctype</varname> (string)
The name of the column in silo table, storing content type.
Default value is ctype
.
-
+
Set the <quote>sc_ctype</quote> parameter
-
+
...
modparam("msilo", "sc_ctype", "content_type")
...
-
+
<varname>sc_exp_time</varname> (string)
- The name of the column in silo table, storing the expire time of the message.
+ The name of the column in silo table, storing the expire time of the message.
Default value is exp_time
.
-
+
Set the <quote>sc_exp_time</quote> parameter
-
+
...
modparam("msilo", "sc_exp_time", "expire_time")
...
-
+
<varname>sc_inc_time</varname> (string)
- The name of the column in silo table, storing the incoming time of the message.
+ The name of the column in silo table, storing the incoming time of the message.
Default value is inc_time
.
-
+
Set the <quote>sc_inc_time</quote> parameter
-
+
...
modparam("msilo", "sc_inc_time", "incoming_time")
...
-
+
<varname>sc_snd_time</varname> (string)
- The name of the column in silo table, storing the send time for the reminder.
+ The name of the column in silo table, storing the send time for the reminder.
Default value is snd_time
.
-
+
Set the <quote>sc_snd_time</quote> parameter
-
+
...
modparam("msilo", "sc_snd_time", "send_reminder_time")
...
-
+
+
+ <varname>sc_stored_hdrs</varname> (string)
+
+ The name of the column in silo table, storing the extra headers.
+
+ Default value is extra_hdrs
.
+
+ Set the <quote>sc_stored_hdrs</quote> parameter
+
+...
+modparam("msilo", "sc_stored_hdrs", "extra_headers")
+...
+
+
+
<varname>from_address</varname> (string)
- The &sip; address used to inform users that destination of their
- message is not online and the message will be delivered next time
- when that user goes online. If the parameter is not set, the module
+ The &sip; address used to inform users that destination of their
+ message is not online and the message will be delivered next time
+ when that user goes online. If the parameter is not set, the module
will not send any notification. This parameter may contain pseudo-variables.
@@ -481,7 +496,7 @@ modparam("msilo", "check_time", 10)
<varname>send_time</varname> (int)
Timer interval in seconds to check if there are reminder messages.
- The module takes all reminder messages that must be sent at that moment
+ The module takes all reminder messages that must be sent at that moment
or before that moment.
@@ -688,10 +703,10 @@ m_store(...);
<function moreinfo="none">m_store([owner])</function>
- The method stores certain parts of the current &sip; request (it
- should be called when the request type is MESSAGE and the destination
- user is offline or his UA does not support MESSAGE requests). If the
- user is registered with a UA which does not support MESSAGE requests
+ The method stores certain parts of the current &sip; request (it
+ should be called when the request type is MESSAGE and the destination
+ user is offline or his UA does not support MESSAGE requests). If the
+ user is registered with a UA which does not support MESSAGE requests
you should not use mode=0
if you have
changed the request uri with the contact address of user's &ua;.
@@ -723,7 +738,7 @@ m_store("$tu");
<function moreinfo="none">m_dump([owner])</function>
The method sends stored messages for the &sip; user that has
- registered to the contact address in the registration.
+ registered to the contact address in the registration.
The method should be called when a REGISTER request is received
and the Expire
header has a value greater than zero.
@@ -787,7 +802,6 @@ m_dump("$fu");
-
Installation and Running
@@ -806,19 +820,3 @@ m_dump("$fu");
-
-
-
-
-
- <varname>sc_stored_hdrs</varname> (string)
-
- The name of the column in silo table, storing the extra headers.
-
- Default value is extra_hdrs
.
-
- Set the <quote>sc_stored_hdrs</quote> parameter
-
-...
-modparam("msilo", "sc_stored_hdrs", "extra_headers")
-...