From 5935cf5b72d5cdac6d52de47d1974fbbbb6e1fc9 Mon Sep 17 00:00:00 2001
From: Damien Seguy <dams@php.net>
Date: Fri, 11 May 2001 07:31:28 +0000
Subject: [PATCH] Added mail() return details. Pretty obvious, but not to all.

git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@47093 c90b9560-bf6c-de11-be94-00142212c4b1
---
 functions/mail.xml | 5 ++++-
 1 file changed, 4 insertions(+), 1 deletion(-)

diff --git a/functions/mail.xml b/functions/mail.xml
index f3d34b94c5..4266f22c48 100644
--- a/functions/mail.xml
+++ b/functions/mail.xml
@@ -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>