getmxrr.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="function.getmxrr" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
 <refnamediv>
  <refname>getmxrr</refname>
  <refpurpose>Get MX records corresponding to a given Internet host name</refpurpose>
 </refnamediv>
 
 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type>bool</type><methodname>getmxrr</methodname>
   <methodparam><type>string</type><parameter>hostname</parameter></methodparam>
   <methodparam><type>array</type><parameter role="reference">hosts</parameter></methodparam>
   <methodparam choice="opt"><type>array</type><parameter role="reference">weights</parameter><initializer>&null;</initializer></methodparam>
  </methodsynopsis>
  <para>
   Searches DNS for MX records corresponding to 
   <parameter>hostname</parameter>. 
  </para>
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>hostname</parameter></term>
     <listitem>
      <para>
       The Internet host name.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>hosts</parameter></term>
     <listitem>
      <para>
       A list of the MX records found is placed into the array
       <parameter>hosts</parameter>. 
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>weights</parameter></term>
     <listitem>
      <para>
       If the <parameter>weights</parameter> array is given, it will be filled
       with the weight information gathered.
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   Returns &true; if any records are found; returns &false; if no records
   were found or if an error occurred.
  </para>
 </refsect1>

 <refsect1 role="notes">
  &reftitle.notes;
  <note>
   <para>
    This function should not be used for the purposes of address
    verification.  Only the mailexchangers found in DNS are returned,
    however, according to <link xlink:href="&url.rfc;2821">RFC 2821</link>
    when no mail exchangers are listed, <parameter>hostname</parameter>
    itself should be used as the only mail exchanger with a priority of
    <literal>0</literal>.
   </para>
  </note>
  <note>
   <para>
    For compatibility with Windows before this was implemented, then try the
    <link xlink:href="&url.php.pear;">PEAR</link> class
    <link xlink:href="&url.pear.package;Net_DNS">Net_DNS</link>.
   </para>
  </note>
 </refsect1>

 <refsect1 role="seealso">
  &reftitle.seealso;
  <para>
   <simplelist>
    <member><function>checkdnsrr</function></member>
    <member><function>dns_get_record</function></member>
    <member><function>gethostbyname</function></member>
    <member><function>gethostbynamel</function></member>
    <member><function>gethostbyaddr</function></member>
    <member>the <literal>named(8)</literal> manual page</member>
   </simplelist>
  </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:"~/.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
-->