php-doc-en/reference/imap/functions/imap-mail.xml
Mehdi Achour 3a2da7cbd8 Fill in the blanks in constants.xml
CS
Replaced <programlisting> ... with <listitem>
Added constant/parameter tags
Added See Also parts
Used &return.success;
Added some para to make the whole thing more easy to read
Removed redundancy


git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@153120 c90b9560-bf6c-de11-be94-00142212c4b1
2004-03-08 09:18:45 +00:00

62 lines
2.2 KiB
XML

<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.5 $ -->
<!-- splitted from ./en/functions/imap.xml, last change in rev 1.33 -->
<refentry id="function.imap-mail">
<refnamediv>
<refname>imap_mail</refname>
<refpurpose>
Send an email message
</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>bool</type><methodname>imap_mail</methodname>
<methodparam><type>string</type><parameter>to</parameter></methodparam>
<methodparam><type>string</type><parameter>subject</parameter></methodparam>
<methodparam><type>string</type><parameter>message</parameter></methodparam>
<methodparam choice="opt"><type>string</type><parameter>additional_headers</parameter></methodparam>
<methodparam choice="opt"><type>string</type><parameter>cc</parameter></methodparam>
<methodparam choice="opt"><type>string</type><parameter>bcc</parameter></methodparam>
<methodparam choice="opt"><type>string</type><parameter>rpath</parameter></methodparam>
</methodsynopsis>
<para>
This function allows sending of emails with correct handling of
Cc and Bcc receivers. &return.success;.
</para>
<para>
The parameters <parameter>to</parameter>, <parameter>cc</parameter>
and <parameter>bcc</parameter> are all strings and are all parsed
as rfc822 address lists.
</para>
<para>
The receivers specified in <parameter>bcc</parameter> will get the
mail, but are excluded from the headers.
</para>
<para>
Use the <parameter>rpath</parameter> parameter to specify return path.
This is useful when using PHP as a mail client for multiple users.
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:1
sgml-indent-data:t
indent-tabs-mode:nil
sgml-parent-document:nil
sgml-default-dtd-file:"../../../../manual.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->