doc-es/reference/imap/functions/imap-check.xml at master · php/doc-es · GitHub

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
<?xml version="1.0" encoding="utf-8"?>
<!-- EN-Revision: 34892f82742329af7e7b4b22be6ad21418fd9768 Maintainer: PhilDaiguille Status: ready -->
<!-- Reviewed: no -->
<refentry xml:id="function.imap-check" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
 <refnamediv>
  <refname>imap_check</refname>
  <refpurpose>Verifica el buzón de correo actual</refpurpose>
 </refnamediv>
 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type class="union"><type>stdClass</type><type>false</type></type><methodname>imap_check</methodname>
   <methodparam><type>IMAP\Connection</type><parameter>imap</parameter></methodparam>
  </methodsynopsis>
  <para>
   Verifica la información del buzón de correo actual.
  </para>
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    &imap.imap-parameter.imap;
   </variablelist>
  </para>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   Devuelve la información en un objeto que contiene las siguientes propiedades:
   <itemizedlist>
    <listitem>
     <simpara>
      <constant>Date</constant> - Fecha de la última modificación del contenido del
      buzón de correo de acuerdo con la <link xlink:href="&url.rfc;2822">RFC2822</link>
     </simpara>
    </listitem>
    <listitem>
     <simpara>
      <constant>Driver</constant> - protocolo utilizado para acceder al
      buzón de correo: <acronym>POP3</acronym>,
      <acronym>IMAP</acronym>, <acronym>NNTP</acronym>.
     </simpara>
    </listitem>
    <listitem>
     <simpara>
      <constant>Mailbox</constant> - nombre del buzón de correo
     </simpara>
    </listitem>
    <listitem>
     <simpara>
      <constant>Nmsgs</constant> - número de mensajes en el buzón de correo
     </simpara>
    </listitem>
    <listitem>
     <simpara>
      <constant>Recent</constant> - número de mensajes recientes en el buzón de correo
     </simpara>
    </listitem>
   </itemizedlist>
  </para>
  <para>
   Devuelve &false; en caso de error.
  </para>
 </refsect1>

 <refsect1 role="changelog">
  &reftitle.changelog;
  <informaltable>
   <tgroup cols="2">
    <thead>
     <row>
      <entry>&Version;</entry>
      <entry>&Description;</entry>
     </row>
    </thead>
    <tbody>
     &imap.changelog.imap-param;
    </tbody>
   </tgroup>
  </informaltable>
 </refsect1>

 <refsect1 role="examples">
  &reftitle.examples;
  <para>
   <example>
    <title>Ejemplo con <function>imap_check</function></title>
    <programlisting role="php">
<![CDATA[
<?php

$imap = imap_check($imap_stream);
var_dump($imap);

?>
]]>
    </programlisting>
    &example.outputs.similar;
    <screen>
<![CDATA[
object(stdClass)(5) {
  ["Date"]=>
  string(37) "Wed, 10 Dec 2003 17:56:54 +0100 (CET)"
  ["Driver"]=>
  string(4) "imap"
  ["Mailbox"]=>
  string(54)
  "{www.example.com:143/imap/user="foo@example.com"}INBOX"
  ["Nmsgs"]=>
  int(1)
  ["Recent"]=>
  int(0)
}
]]>
    </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
-->