[sr-dev] git:master:c6ce384e: textops: docs for remove_hf_idx() function

[Daniel-Constantin Mierla]

Content preview: Module: kamailio Branch: master Commit: c6ce384e479ed21aae803a78fc5835e774fe521d
URL: https://github.com/kamailio/kamailio/commit/c6ce384e479ed21aae803a78fc5835e774fe521d
Author: Daniel-Constantin Mierla <***@gmail.com> Committer: Daniel-Constantin
Mierla <***@gmail.com> Date: 2021-05-26T15:43:50+02:00

Content analysis details: (-2.4 points, 5.5 required)

pts rule name description
---- ---------------------- --------------------------------------------------
-1.0 ALL_TRUSTED Passed through trusted hosts only via SMTP
-1.9 BAYES_00 BODY: Bayes spam probability is 0 to 1%
[score: 0.0000]
0.2 HEADER_FROM_DIFFERENT_DOMAINS From and EnvelopeFrom 2nd level
mail domains are different
1.0 FORGED_GMAIL_RCVD 'From' gmail.com does not match 'Received'
headers
0.0 DKIM_ADSP_CUSTOM_MED No valid author signature, adsp_override is
CUSTOM_MED
0.0 FREEMAIL_FROM Sender email is commonly abused enduser mail
provider (miconda[at]gmail.com)
0.2 FREEMAIL_FORGED_FROMDOMAIN 2nd level domains in From and
EnvelopeFrom freemail headers are
different
-1.0 MAILING_LIST_MULTI Multiple indicators imply a widely-seen list
manager

Module: kamailio
Branch: master
Commit: c6ce384e479ed21aae803a78fc5835e774fe521d
URL: https://github.com/kamailio/kamailio/commit/c6ce384e479ed21aae803a78fc5835e774fe521d

Author: Daniel-Constantin Mierla <***@gmail.com>
Committer: Daniel-Constantin Mierla <***@gmail.com>
Date: 2021-05-26T15:43:50+02:00

textops: docs for remove_hf_idx() function

---

Modified: src/modules/textops/doc/textops_admin.xml

---

Diff: https://github.com/kamailio/kamailio/commit/c6ce384e479ed21aae803a78fc5835e774fe521d.diff
Patch: https://github.com/kamailio/kamailio/commit/c6ce384e479ed21aae803a78fc5835e774fe521d.patch

---

diff --git a/src/modules/textops/doc/textops_admin.xml b/src/modules/textops/doc/textops_admin.xml
index 6f3ab09f9a..4427ee1e00 100644
--- a/src/modules/textops/doc/textops_admin.xml
+++ b/src/modules/textops/doc/textops_admin.xml
@@ -1497,6 +1497,44 @@ if(remove_hf_exp_pv("^$var(match)", "^$var(keep)"))
</example>
</section>

+ <section id="textops.f.remove_hf_idx">
+ <title>
+ <function moreinfo="none">remove_hf_idx(hname, idx)</function>
+ </title>
+ <para>
+ Remove from message the headers matching by name 'hname' with
+ the index 'idx'.
+ </para>
+ <para>
+ Returns true if the header is removed.
+ </para>
+ <para>Meaning of the parameters is as follows:</para>
+ <itemizedlist>
+ <listitem>
+ <para><emphasis>hname</emphasis> - header name.</para>
+ </listitem>
+ <listitem>
+ <para><emphasis>idx</emphasis> - index of the header, starting
+ from 0 with first header; negative values count from the end of
+ the headers, -1 being the last header matching the name.</para>
+ </listitem>
+ </itemizedlist>
+ <para>
+ The parameters can be config variables.
+ </para>
+ <para>
+ This function can be used from ANY_ROUTE.
+ </para>
+ <example>
+ <title><function>remove_hf_idx</function> usage</title>
+ <programlisting format="linespecific">
+...
+remove_hf_idx("X-My-Header", "-1");
+...
+</programlisting>
+ </example>
+ </section>
+
<section id="textops.f.has_body">
<title>
<function moreinfo="none">has_body()</function>,