-
Notifications
You must be signed in to change notification settings - Fork 49
/
mailparse-rfc822-parse-addresses.xml
141 lines (134 loc) · 3.51 KB
/
mailparse-rfc822-parse-addresses.xml
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
<?xml version="1.0" encoding="utf-8"?>
<!-- EN-Revision: 4754397753fd79f1c846868b66a2448babab1c54 Maintainer: lboshell Status: ready -->
<!-- Reviewed: no -->
<refentry xml:id="function.mailparse-rfc822-parse-addresses" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>mailparse_rfc822_parse_addresses</refname>
<refpurpose>Procesa direcciones compatibles con RFC 822</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>array</type><methodname>mailparse_rfc822_parse_addresses</methodname>
<methodparam><type>string</type><parameter>addresses</parameter></methodparam>
</methodsynopsis>
<para>
Procesa una lista de recipientes compatible con <link
xlink:href="&url.rfc;822">RFC 822</link>, tal como la que es encontrada en una
cabecera <literal>To:</literal>.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>addresses</parameter></term>
<listitem>
<para>
Una cadena que contiene direcciones, como:
<literal>Wez Furlong <wez@example.com>, pepe@example.com</literal>
</para>
<note>
<para>
Esta cadena no debe contener el nombre de la cabecera.
</para>
</note>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Devuelve una matriz de matrices asociativas con las siguientes claves
para cada recipiente:
<informaltable>
<tgroup cols="2">
<tbody>
<row>
<entry><literal>display</literal></entry>
<entry>
El nombre del recipiente, para propósitos de muestra. Si esta parte
no es definida para un recipiente, esta clave contendrá el mismo
valor que <literal>address</literal>.
</entry>
</row>
<row>
<entry><literal>address</literal></entry>
<entry>La dirección de correo electrónico</entry>
</row>
<row>
<entry><literal>is_group</literal></entry>
<entry>&true; si el recipiente es un grupo de noticias, &false; de lo
contrario.</entry>
</row>
</tbody>
</tgroup>
</informaltable>
</para>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<para>
<example>
<title>Ejemplo de
<function>mailparse_rfc822_parse_addresses</function></title>
<programlisting role="php">
<![CDATA[
<?php
$to = 'Wez Furlong <wez@example.com>, pepe@example.com';
var_dump(mailparse_rfc822_parse_addresses($to));
?>
]]>
</programlisting>
&example.outputs;
<screen>
<![CDATA[
array(2) {
[0]=>
array(3) {
["display"]=>
string(11) "Wez Furlong"
["address"]=>
string(15) "wez@example.com"
["is_group"]=>
bool(false)
}
[1]=>
array(3) {
["display"]=>
string(16) "pepe@example.com"
["address"]=>
string(16) "pepe@example.com"
["is_group"]=>
bool(false)
}
}
]]>
</screen>
</example>
</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
-->