Skip to content

Commit

Permalink
msilo: docs for m_store_addrs()
Browse files Browse the repository at this point in the history
  • Loading branch information
miconda committed Jul 10, 2023
1 parent 3542608 commit 8da60f5
Showing 1 changed file with 43 additions and 0 deletions.
43 changes: 43 additions & 0 deletions src/modules/msilo/doc/msilo_admin.xml
Original file line number Diff line number Diff line change
Expand Up @@ -731,6 +731,49 @@ m_store(...);
m_store();
m_store("$tu");
...
</programlisting>
</example>
</section>
<section id="msilo.f.m_store_addrs">
<title><function moreinfo="none">m_store_addrs(owner, srcaddr, dstaddr)</function></title>
<para>
Similar to m_store(), but instead of getting source user address from
From-URI and destination user address from To_URI, this function allows
to give them via parameters.
</para>
<para>Meaning of the parameters is as follows:</para>
<itemizedlist>
<listitem>
<para>
<emphasis>owner</emphasis> - is a string that must contain
a SIP URI in whose inbox the message will be stored. It can have
any pseudo variable.
</para>
</listitem>
<listitem>
<para>
<emphasis>srcaddr</emphasis> - is a string that must contain
a SIP URI corresponding to From user. It can have
any pseudo variable.
</para>
</listitem>
<listitem>
<para>
<emphasis>dstaddr</emphasis> - is a string that must contain
a SIP URI correspinding to To user. It can have
any pseudo variable.
</para>
</listitem>
</itemizedlist>
<para>
This function can be used from REQUEST_ROUTE, FAILURE_ROUTE.
</para>
<example>
<title><function>m_store_addrs</function> usage</title>
<programlisting format="linespecific">
...
m_store_addrs("sip:$rU@a.com", "sip:$fU@a.com", "sip:$tU@a.com");
...
</programlisting>
</example>
</section>
Expand Down

0 comments on commit 8da60f5

Please sign in to comment.