[PHP-DOC] cvs: phpdoc /en/functions mail.xml From: Kristian Köhntopp (kk <email protected>)
Date: 06/29/00

kk Thu Jun 29 05:11:24 2000 EDT

  Modified files:
    /phpdoc/en/functions mail.xml
  Log:
  ezmlm_hash() documentation. This function is needed to subscribe
  users to a MySQL kept EZMLM list.
  
  
Index: phpdoc/en/functions/mail.xml
diff -u phpdoc/en/functions/mail.xml:1.3 phpdoc/en/functions/mail.xml:1.4
--- phpdoc/en/functions/mail.xml:1.3 Sat Jun 24 00:38:43 2000
+++ phpdoc/en/functions/mail.xml Thu Jun 29 05:11:24 2000
@@ -52,6 +52,39 @@
 
  </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 <email protected>";
+ $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