File: ini.xml

package info (click to toggle)
php-doc 20250827~git.abe740d%2Bdfsg-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 71,968 kB
  • sloc: xml: 985,760; php: 25,504; javascript: 671; sh: 177; makefile: 37
file content (236 lines) | stat: -rw-r--r-- 7,123 bytes parent folder | download
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
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<section xml:id="mail.configuration" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
 &reftitle.runtime;
 &extension.runtime;
 <para>
 <table>
  <title>Mail configuration options</title>
  <tgroup cols="4">
   <thead>
    <row>
     <entry>&Name;</entry>
     <entry>&Default;</entry>
     <entry>&Changeable;</entry>
     <entry>&Changelog;</entry>
    </row>
   </thead>
   <tbody>
    <row>
     <entry><link linkend="ini.mail.add-x-header">mail.add_x_header</link></entry>
     <entry>"0"</entry>
     <entry><constant>INI_PERDIR</constant></entry>
     <entry></entry>
    </row>
    <row>
     <entry><link linkend="ini.mail.mixed_lf_and_crlf">mail.mixed_lf_and_crlf</link></entry>
     <entry>"0"</entry>
     <entry><constant>INI_SYSTEM</constant>|<constant>INI_PERDIR</constant></entry>
     <entry>Added in PHP 8.2.4</entry>
    </row>
    <row>
     <entry><link linkend="ini.mail.log">mail.log</link></entry>
     <entry>NULL</entry>
     <entry><constant>INI_SYSTEM</constant>|<constant>INI_PERDIR</constant></entry>
     <entry></entry>
    </row>
    <row>
     <entry><link linkend="ini.mail.force_extra_parameters">mail.force_extra_parameters</link></entry>
     <entry>NULL</entry>
     <entry><constant>INI_SYSTEM</constant></entry>
     <entry></entry>
    </row>
    <row>
     <entry><link linkend="ini.smtp">SMTP</link></entry>
     <entry>"localhost"</entry>
     <entry><constant>INI_ALL</constant></entry>
     <entry></entry>
    </row>
    <row>
     <entry><link linkend="ini.smtp-port">smtp_port</link></entry>
     <entry>"25"</entry>
     <entry><constant>INI_ALL</constant></entry>
     <entry></entry>
    </row>
    <row>
     <entry><link linkend="ini.sendmail-from">sendmail_from</link></entry>
     <entry>NULL</entry>
     <entry><constant>INI_ALL</constant></entry>
     <entry></entry>
    </row>
    <row>
     <entry><link linkend="ini.sendmail-path">sendmail_path</link></entry>
     <entry>"/usr/sbin/sendmail -t -i"</entry>
     <entry><constant>INI_SYSTEM</constant></entry>
     <entry></entry>
    </row>
   </tbody>
  </tgroup>
 </table>
 &ini.php.constants;
 </para>
 
 &ini.descriptions.title;
 
 <para>
 <variablelist>
  <varlistentry xml:id="ini.mail.add-x-header">
   <term>
    <parameter>mail.add_x_header</parameter>
    <type>bool</type>
   </term>
   <listitem>
    <para>
     Add <literal>X-PHP-Originating-Script</literal> that will include UID of
     the script followed by the filename.
    </para>
   </listitem>
  </varlistentry>

  <varlistentry xml:id="ini.mail.log">
   <term>
    <parameter>mail.log</parameter>
    <type>string</type>
   </term>
   <listitem>
    <para>
     The path to a log file that will log all <function>mail</function> calls.
     Log entries include the full path of the script, line number,
     <literal>To</literal> address and headers.
    </para>
   </listitem>
  </varlistentry>

  <varlistentry xml:id="ini.mail.mixed_lf_and_crlf">
   <term>
    <parameter>mail.mixed_lf_and_crlf</parameter>
    <type>bool</type>
   </term>
   <listitem>
    <para>
     Allows reverting the line separator for email headers and message bodies to LF (Line Feed),
     mimicking the non-compliant behavior of PHP 7. It is provided as a compatibility measure
     for certain non-compliant Mail Transfer Agents (MTAs) that fail to correctly process CRLF
     (Carriage Return + Line Feed) as a line separator in email headers and message content.
    </para>
   </listitem>
  </varlistentry>

  <varlistentry xml:id="ini.mail.force_extra_parameters">
   <term>
    <parameter>mail.force_extra_parameters</parameter>
    <type>string</type>
   </term>
   <listitem>
    <para>
     Force the addition of the specified parameters to be passed as extra
     parameters to the sendmail binary. These parameters will always replace
     the value of the 5th parameter to <function>mail</function>.
    </para>
    <simpara>
     In addition to the default behavior for <constant>INI_SYSTEM</constant>,
     this value can also be set with <literal>php_value</literal>
     in <filename>httpd.conf</filename> (but this is not recommended).
    </simpara>
   </listitem>
  </varlistentry>

  <varlistentry xml:id="ini.smtp">
   <term>
    <parameter>SMTP</parameter>
    <type>string</type>
   </term>
   <listitem>
    <para>
     Used under Windows only: host name or IP address of the SMTP server PHP
     should use for mail sent with the <function>mail</function> function.
    </para>
   </listitem>
  </varlistentry>

  <varlistentry xml:id="ini.smtp-port">
   <term>
    <parameter>smtp_port</parameter>
    <type>int</type>
   </term>
   <listitem>
    <para>
     Used under Windows only: Number of the port to connect to the server
     specified with the <literal>SMTP</literal> setting when sending mail
     with <function>mail</function>; defaults to 25.
    </para>
   </listitem>
  </varlistentry>

  <varlistentry xml:id="ini.sendmail-from">
   <term>
    <parameter>sendmail_from</parameter>
    <type>string</type>
   </term>
   <listitem>
    <para>
     Which <literal>"From:"</literal> mail address should be used in mail sent
     directly via SMTP (Windows only).
     This directive also sets the <literal>"Return-Path:"</literal> header.
    </para>
   </listitem>
  </varlistentry>

  <varlistentry xml:id="ini.sendmail-path">
   <term>
    <parameter>sendmail_path</parameter>
    <type>string</type>
   </term>
   <listitem>
    <para>
     Where the <command>sendmail</command> program can be found,
     usually <filename>/usr/sbin/sendmail</filename> or
     <filename>/usr/lib/sendmail</filename>.
     <command>configure</command> does an honest attempt of
     locating this one for you and set a default, but if it fails,
     you can set it here.
    </para>
    <para>
     Systems not using <command>sendmail</command> should set this directive to the
     sendmail wrapper/replacement their mail system offers, if any.
     For example, <link xlink:href="&url.qmail;">Qmail</link>
     users can normally set it to
     <filename>/var/qmail/bin/sendmail</filename> or <filename>
     /var/qmail/bin/qmail-inject</filename>.
    </para>
    <para>
     <command>qmail-inject</command> does not require any option to
     process mail correctly.
    </para>
    <para>
     This directive works also under Windows. If set, <varname>smtp</varname>,
     <varname>smtp_port</varname> and <varname>sendmail_from</varname> are
     ignored and the specified command is executed.
    </para>
   </listitem>
  </varlistentry>
 </variablelist>

 </para>
</section>

<!-- 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:"~/.phpdoc/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
-->