ezmlm_hash() documentation. This function is needed to subscribe

users to a MySQL kept EZMLM list.


git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@27333 c90b9560-bf6c-de11-be94-00142212c4b1

functions/mail.xml

@@ -52,6 +52,39 @@ mail("nobody@aol.com", "the subject", $message,
 
  </reference>
 
+  <refentry id="function.ezmlm-hash">
+   <refnamediv>
+    <refname>ezmlm_hash</refname>
+    <refpurpose>Calculate the hash value needed by EZMLM</refpurpose>
+   </refnamediv>
+   <refsect1>
+    <title>Description</title>
+    <funcsynopsis>
+     <funcprototype>
+      <funcdef>int <function>ezmlm_hash</function></funcdef>
+      <paramdef>string <parameter>addr</parameter></paramdef>
+    </funcsynopsis>
+    <simpara>
+      <function>ezmlm_hash</function> calculates the hash value needed
+       when keeping EZMLM mailing lists in a MySQL database.
+    <para>
+     <example>
+      <title>Calculating the hash and subscribing a user.</title>
+      <programlisting>
+        $user = "kris@koehntopp.de";
+        $hash = ezmlm_hash($user);
+        $query = sprintf("INSERT INTO sample VALUES (%s,'%s')",
+                   $hash,
+                   $user
+                 );
+        $db->query($query); // using PHPLIB db interface
+      </programlisting>
+     </example></para>
+   </refsect1>
+  </refentry>
+
+ </reference>
+
 <!-- Keep this comment at the end of the file
 Local variables:
 mode: sgml