File: getmxrr.xml

package info (click to toggle)
php-doc 20140201-1
  • links: PTS
  • area: main
  • in suites: jessie, jessie-kfreebsd
  • size: 74,084 kB
  • ctags: 4,040
  • sloc: xml: 998,137; php: 20,812; cpp: 500; sh: 177; makefile: 63; awk: 28
file content (145 lines) | stat: -rw-r--r-- 4,005 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
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
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision: 297028 $ -->
<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">mxhosts</parameter></methodparam>
   <methodparam choice="opt"><type>array</type><parameter role="reference">weight</parameter></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>mxhosts</parameter></term>
     <listitem>
      <para>
       A list of the MX records found is placed into the array
       <parameter>mxhosts</parameter>. 
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>weight</parameter></term>
     <listitem>
      <para>
       If the <parameter>weight</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="changelog">
  &reftitle.changelog;
  <para>
   <informaltable>
    <tgroup cols="2">
     <thead>
      <row>
       <entry>&Version;</entry>
       <entry>&Description;</entry>
      </row>
     </thead>
     <tbody>
      <row>
       <entry>5.3.0</entry>
       <entry>
         This function is now available on Windows platforms.
       </entry>
      </row>
     </tbody>
    </tgroup>
   </informaltable>
  </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
-->