File: mb-send-mail.xml

package info (click to toggle)
php-doc 20061001-1
  • links: PTS
  • area: non-free
  • in suites: etch, etch-m68k
  • size: 45,764 kB
  • ctags: 1,611
  • sloc: xml: 502,485; php: 7,645; cpp: 500; makefile: 297; perl: 161; sh: 141; awk: 28
file content (89 lines) | stat: -rw-r--r-- 3,007 bytes parent folder | download | duplicates (2)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.5 $ -->
<!-- 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>
    <note>
     <para>
      <literal>Content-Type</literal> and
      <literal>Content-Transfer-Encoding</literal> headers can be redefined as
      of PHP 5.0.0. In PHP 4, values defined by
      <function>mb_language</function> are always used.
     </para>
    </note>
    <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
-->