[PHP-DOC] cvs: phpdoc /en/functions mail.xml

[Damien Seguy]

dams            Fri May 11 00:31:28 2001 EDT

  Modified files:              
    /phpdoc/en/functions        mail.xml 
  Log:
  Added mail() return details. Pretty obvious, but not to all.
  
Index: phpdoc/en/functions/mail.xml
diff -u phpdoc/en/functions/mail.xml:1.16 phpdoc/en/functions/mail.xml:1.17
--- phpdoc/en/functions/mail.xml:1.16   Mon Apr 23 14:35:33 2001
+++ phpdoc/en/functions/mail.xml        Fri May 11 00:31:28 2001
@@ -7,7 +7,6 @@
    </simpara>
   </partintro>
 
-
   <refentry id="function.mail">
    <refnamediv>
     <refname>mail</refname>
@@ -36,6 +35,10 @@
       <parameter>to</parameter>. Multiple recipients can be specified by
       putting a comma between each address in <parameter>to</parameter>.
     </simpara>
+    <para>
+     <function>mail</function> returns <literal>TRUE</literal> if the mail
+     is sucessfully sent, <literal>FALSE</literal> otherwise.
+    </para>
     <para>
      <example>
       <title>Sending mail.</title>