php-doc-en/reference/mbstring/functions/mb-send-mail.xml
Damien Seguy 0aba88d956 boolean => bool
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@113668 c90b9560-bf6c-de11-be94-00142212c4b1
2003-01-28 02:30:18 +00:00

81 lines
2.7 KiB
XML

<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.3 $ -->
<!-- splitted from ./en/functions/mbstring.xml, last change in rev 1.19 -->
<refentry id="function.mb-send-mail">
<refnamediv>
<refname>mb_send_mail</refname>
<refpurpose>
Send encoded mail.
</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>bool</type><methodname>mb_send_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>additional_parameter</parameter></methodparam>
</methodsynopsis>
<para>
<function>mb_send_mail</function> sends email. Headers and
message are converted and encoded according to
<function>mb_language</function> setting.
<function>mb_send_mail</function> is wrapper
function of <function>mail</function>. See
<function>mail</function> for details.
</para>
<para>
<parameter>to</parameter> is mail addresses send to. Multiple
recipients can be specified by putting a comma between each
address in to. This parameter is not automatically encoded.
</para>
<para>
<parameter>subject</parameter> is subject of mail.
</para>
<para>
<parameter>message</parameter> is mail message.
</para>
<para>
<parameter>additional_headers</parameter> is inserted at
the end of the header. This is typically used to add extra
headers. Multiple extra headers are separated with a
newline ("\n").
</para>
<para>
<parameter>additional_parameter</parameter> is a MTA command line
parameter. It is useful when setting the correct Return-Path
header when using sendmail.
</para>
<para>
&return.success;
</para>
<para>
See also <function>mail</function>,
<function>mb_encode_mimeheader</function>, and
<function>mb_language</function>.
</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
-->