php-doc-en/reference/mail/ini.xml

<?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>PHP_INI_PERDIR</entry>
     <entry>Available since PHP 5.3.0.</entry>
    </row>
    <row>
     <entry><link linkend="ini.mail.log">mail.log</link></entry>
     <entry>NULL</entry>
     <entry>PHP_INI_PERDIR</entry>
     <entry>Available since PHP 5.3.0. (PHP_INI_SYSTEM|PHP_INI_PERDIR)</entry>
    </row>
    <row>
     <entry><link linkend="ini.mail.force_extra_parameters">mail.force_extra_parameters</link></entry>
     <entry>NULL</entry>
     <entry>PHP_INI_PERDIR</entry>
     <entry>Available since PHP 5.0.0. (PHP_INI_SYSTEM|PHP_INI_PERDIR)</entry>
    </row>
    <row>
     <entry><link linkend="ini.smtp">SMTP</link></entry>
     <entry>"localhost"</entry>
     <entry>PHP_INI_ALL</entry>
     <entry></entry>
    </row>
    <row>
     <entry><link linkend="ini.smtp-port">smtp_port</link></entry>
     <entry>"25"</entry>
     <entry>PHP_INI_ALL</entry>
     <entry></entry>
    </row>
    <row>
     <entry><link linkend="ini.sendmail-from">sendmail_from</link></entry>
     <entry>NULL</entry>
     <entry>PHP_INI_ALL</entry>
     <entry></entry>
    </row>
    <row>
     <entry><link linkend="ini.sendmail-path">sendmail_path</link></entry>
     <entry>"/usr/sbin/sendmail -t -i"</entry>
     <entry>PHP_INI_SYSTEM</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.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>, even in
     safe mode.
    </para>
   </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
-->