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 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422 1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 1451 1452 1453 1454 1455 1456 1457 1458 1459 1460 1461 1462 1463 1464 1465 1466 1467 1468 1469 1470 1471 1472 1473 1474 1475 1476 1477 1478 1479 1480 1481 1482 1483 1484 1485 1486 1487 1488 1489 1490 1491 1492 1493 1494 1495 1496 1497 1498 1499 1500 1501 1502 1503 1504 1505 1506 1507 1508 1509 1510 1511 1512 1513 1514 1515 1516 1517 1518 1519 1520 1521 1522 1523 1524 1525 1526 1527 1528 1529 1530 1531 1532 1533 1534 1535 1536 1537 1538 1539 1540 1541 1542 1543 1544 1545 1546 1547 1548 1549 1550 1551 1552 1553 1554 1555 1556 1557 1558 1559 1560 1561 1562 1563 1564 1565 1566 1567 1568 1569 1570 1571 1572 1573 1574 1575 1576 1577 1578 1579 1580 1581 1582 1583 1584 1585 1586 1587 1588 1589 1590 1591 1592 1593 1594 1595 1596 1597 1598 1599 1600 1601 1602 1603 1604 1605 1606 1607 1608 1609 1610 1611 1612 1613 1614 1615 1616 1617 1618 1619 1620 1621 1622 1623 1624 1625 1626 1627 1628 1629 1630 1631 1632 1633 1634 1635 1636 1637 1638 1639 1640 1641 1642 1643 1644 1645 1646 1647 1648 1649 1650 1651 1652 1653 1654 1655 1656 1657 1658 1659 1660 1661 1662 1663 1664 1665 1666 1667 1668 1669 1670 1671 1672 1673 1674 1675 1676 1677 1678 1679 1680 1681 1682 1683 1684 1685 1686 1687 1688 1689 1690 1691 1692 1693 1694 1695 1696 1697 1698 1699 1700 1701 1702 1703 1704 1705 1706 1707 1708 1709 1710 1711 1712 1713 1714 1715 1716 1717 1718 1719 1720 1721 1722 1723 1724 1725 1726 1727 1728 1729 1730 1731 1732 1733 1734 1735 1736 1737 1738 1739 1740 1741 1742 1743 1744 1745 1746 1747 1748 1749 1750 1751 1752 1753 1754 1755 1756 1757 1758 1759 1760 1761 1762
|
<?xml version="1.0" encoding="iso-8859-1"?>
<reference id="ref.imap">
<title>Funciones IMAP</title>
<titleabbrev>IMAP</titleabbrev>
<partintro>
<simpara>
Para hacer funcionar estas funciones, debe compilar PHP con
<option role="configure">--with-imap</option>. Esto requiere que
la libreria c-client esté instalada. Obtenga la última versión de
<ulink url="&url.imap;">&url.imap;</ulink> y compílela. Luego
copie <filename>c-client/c-client.a</filename> al directorio
<filename>/usr/local/lib</filename> o a cualquier otro directorio
de su LINK path y copie <filename>c-client/rfc822.h</filename>,
<filename>mail.h</filename> y <filename>linkage.h</filename> al directorio
<filename>/usr/local/include</filename> o a cualquier otro de su INCLUDE
path.
</simpara>
<simpara>
Decir que estas funciones no están limitadas al protocolo
<acronym>IMAP</acronym>, a pesar de sus nombres. La librería subyacente
c-client también soporta <acronym>NNTP</acronym>, <acronym>POP3</acronym>
y métodos de acceso local a buzones de correo. Vea <function>imap_open</function>
para una mayor información.
</simpara>
</partintro>
<refentry id="function.imap-append">
<refnamediv>
<refname>imap_append</refname>
<refpurpose>
Agrega una cadena de mensaje al buzón especificado
</refpurpose>
</refnamediv>
<refsect1>
<title>Descripción</title>
<methodsynopsis>
<type>int</type><methodname>imap_append</methodname>
<methodparam><type>int</type><parameter>imap_stream</parameter></methodparam>
<methodparam><type>string</type><parameter>mbox</parameter></methodparam>
<methodparam><type>string</type><parameter>message</parameter></methodparam>
<methodparam><type>string</type><parameter>flags</parameter></methodparam>
</methodsynopsis>
<para>
Devuelve &true; si no hay error y &false; en caso contrario.
</para>
<para>
<function>imap_append</function> agrega una cadena de mensaje al buzón
especificado <parameter>mbox</parameter>. Si se especifica el
parámetro <parameter>flags</parameter>, escribe las opciones o condiciones
establecidas en el parámetro <parameter>flags</parameter> al buzón.
</para>
<para>
Cuando conecte con el servidor Cyrus IMAP, debe usar "\r\n" como
finalizador de linea en vez de "\n" o la operación fallará.
</para>
</refsect1>
</refentry>
<refentry id="function.imap-base64">
<refnamediv>
<refname>imap_base64</refname>
<refpurpose>Decodifica texto codificado en BASE64</refpurpose>
</refnamediv>
<refsect1>
<title>Descripción</title>
<methodsynopsis>
<type>string</type><methodname>imap_base64</methodname>
<methodparam><type>string</type><parameter>text</parameter></methodparam>
</methodsynopsis>
<para>
<function>imap_base64</function> decodifica texto codificado en BASE-64.
El mensaje decodificado es devuelto como una cadena.
</para>
</refsect1>
</refentry>
<refentry id="function.imap-body">
<refnamediv>
<refname>imap_body</refname>
<refpurpose>Lee el cuerpo del mensaje</refpurpose>
</refnamediv>
<refsect1>
<title>Descripción</title>
<methodsynopsis>
<type>string</type><methodname>imap_body</methodname>
<methodparam><type>int</type><parameter>imap_stream</parameter></methodparam>
<methodparam><type>int</type><parameter>msg_number</parameter></methodparam>
<methodparam><type>int</type><parameter>flags</parameter></methodparam>
</methodsynopsis>
<para>
<function>imap_body</function> devuelve el cuerpo del mensaje,
numerado <parameter> msg_number</parameter> del buzón actual.
Los <parameter>flags</parameter> opcionales son una máscara de bit
con una o mas de las siguientes:
<itemizedlist>
<listitem>
<simpara>
FT_UID - El msgno es un UID
</simpara>
</listitem>
<listitem>
<simpara>
FT_PEEK - No activar \Seen flag si no está ya activa
</simpara>
</listitem>
<listitem>
<simpara>
FT_INTERNAL - La cadena devuelta está en formato interno, no canoniza a
CRLF.
</simpara>
</listitem>
</itemizedlist>
</para>
</refsect1>
</refentry>
<refentry id="function.imap-check">
<refnamediv>
<refname>imap_check</refname>
<refpurpose>Comprueba el estado del buzón actual</refpurpose>
</refnamediv>
<refsect1>
<title>Descripción</title>
<methodsynopsis>
<type>object</type><methodname>imap_check</methodname>
<methodparam><type>int</type><parameter>imap_stream</parameter></methodparam>
</methodsynopsis>
<para>
Devuelve información acerca del buzón actual. Devuelve &false; si falla.
</para>
<para>
La función <function>imap_check</function> comprueba el estado del buzón
actual en el servidor y devuelve la información en un objeto con las
siguientes propiedades.
</para>
<para>
<informalexample>
<literallayout>
Date : fecha del mensaje
Driver : controlador
Mailbox : nombre del buzón
Nmsgs : número de mensajes
Recent : número de mensajes recientes
</literallayout>
</informalexample>
</para>
</refsect1>
</refentry>
<refentry id="function.imap-close">
<refnamediv>
<refname>imap_close</refname>
<refpurpose>Cierra una sesión IMAP</refpurpose>
</refnamediv>
<refsect1>
<title>Descripción</title>
<methodsynopsis>
<type>int</type><methodname>imap_close</methodname>
<methodparam><type>int</type><parameter>imap_stream</parameter></methodparam>
<methodparam><type>int</type><parameter>flags</parameter></methodparam>
</methodsynopsis>
<para>
Cierra una sesión imap. Toma un parámetro <parameter>flag</parameter>
opcional, CL_EXPUNGE, el cual purgará el buzón de forma trasparente antes de
cerrarla.
</para>
</refsect1>
</refentry>
<refentry id="function.imap-createmailbox">
<refnamediv>
<refname>imap_createmailbox</refname>
<refpurpose>Crea un buzón nuevo</refpurpose>
</refnamediv>
<refsect1>
<title>Descripción</title>
<methodsynopsis>
<type>int</type><methodname>imap_createmailbox</methodname>
<methodparam><type>int</type><parameter>imap_stream</parameter></methodparam>
<methodparam><type>string</type><parameter>mbox</parameter></methodparam>
</methodsynopsis>
<para>
<function>imap_createmailbox</function> crea un buzón nuevo
especificado por <parameter>mbox</parameter>
(ver <function>imap_open</function> para el formato del
parámetro <parameter>mbox</parameter>).
</para>
<para>
Devuelve &true; si no hay error y &false; en caso contrario.
</para>
<para>
Ver También <function>imap_renamemailbox</function> y
<function>imap_deletemailbox</function>.
</para>
</refsect1>
</refentry>
<refentry id="function.imap-delete">
<refnamediv>
<refname>imap_delete</refname>
<refpurpose>
Marca un mensaje para ser borrado en el buzón actual
</refpurpose>
</refnamediv>
<refsect1>
<title>Descripción</title>
<methodsynopsis>
<type>int</type><methodname>imap_delete</methodname>
<methodparam><type>int</type><parameter>imap_stream</parameter></methodparam>
<methodparam><type>int</type><parameter>msg_number</parameter></methodparam>
</methodsynopsis>
<para>
Devuelve &true;.
</para>
<para>
La función <function>imap_delete</function> marca el mensaje referenciado
por <parameter>msg_number</parameter> para su eliminación. El borrado
físico de los mensajes es realizado por
<function>imap_expunge</function>.
</para>
</refsect1>
</refentry>
<refentry id="function.imap-deletemailbox">
<refnamediv>
<refname>imap_deletemailbox</refname>
<refpurpose>Elimina un buzón</refpurpose>
</refnamediv>
<refsect1>
<title>Descripción</title>
<methodsynopsis>
<type>int</type><methodname>imap_deletemailbox</methodname>
<methodparam><type>int</type><parameter>imap_stream</parameter></methodparam>
<methodparam><type>string</type><parameter>mbox</parameter></methodparam>
</methodsynopsis>
<para>
<function>imap_deletemailbox</function> elimina el buzón especificado
(ver <function>imap_open</function> para el formato del
<parameter>mbox</parameter>).
</para>
<para>
Devuelve &true; si no hay error y &false; en caso contrario.
</para>
<para>
Ver También <function>imap_createmailbox</function> y
<function>imap_reanmemailbox</function>.
</para>
</refsect1>
</refentry>
<refentry id="function.imap-expunge">
<refnamediv>
<refname>imap_expunge</refname>
<refpurpose>Elimina todos los mensajes marcados como borrados</refpurpose>
</refnamediv>
<refsect1>
<title>Descripción</title>
<methodsynopsis>
<type>int</type><methodname>imap_expunge</methodname>
<methodparam><type>int</type><parameter>imap_stream</parameter></methodparam>
</methodsynopsis>
<para>
<function>imap_expunge</function> elimina todos los mensajes marcados
por la función <function>imap_delete</function>.</para>
<para>
Devuleve &true;.
</para>
</refsect1>
</refentry>
<refentry id="function.imap-fetchbody">
<refnamediv>
<refname>imap_fetchbody</refname>
<refpurpose>Localiza una sección particular en el cuerpo del mensaje</refpurpose>
</refnamediv>
<refsect1>
<title>Descripción</title>
<methodsynopsis>
<type>string</type><methodname>imap_fetchbody</methodname>
<methodparam><type>int</type><parameter>imap_stream</parameter></methodparam>
<methodparam><type>int</type><parameter>msg_number</parameter></methodparam>
<methodparam><type>string</type><parameter>part_number</parameter></methodparam>
<methodparam><type>flags</type><parameter>flags</parameter></methodparam>
</methodsynopsis>
<para>
Esta función busca una sección particular en el cuerpo de los mensajes
especificados, como una cadena de texto y devuleve esa cadena.
La especificación de la sección es una cadena de enteros delimitados
por comas,los cuales indexan las partes del cuerpo como indica la especificación IMAP4.
Partes del cuerpo no son decodificadas por esta función.
</para>
<para>
Las opciones para <function>imap_fetchbody </function> son una máscara
de bit con una o más de las siguientes
<itemizedlist>
<listitem>
<simpara>
FT_UID - El msgono es un UID
</simpara>
</listitem>
<listitem>
<simpara>
FT_PEEK - No activar \Seen flag si no esta ya activa
</simpara>
</listitem>
<listitem>
<simpara>
FT_INTERNAL - La cadena devuelta está en formato "interno",
sin ningún intento por canonizar CRLF
</simpara>
</listitem>
</itemizedlist>
</para>
</refsect1>
</refentry>
<refentry id="function.imap-fetchstructure">
<refnamediv>
<refname>imap_fetchstructure</refname>
<refpurpose>
Lee la estructuta de un mensaje concreto
</refpurpose>
</refnamediv>
<refsect1>
<title>Descripción</title>
<methodsynopsis>
<type>object</type><methodname>imap_fetchstructure</methodname>
<methodparam><type>int</type><parameter>imap_stream</parameter></methodparam>
<methodparam><type>int</type><parameter>msg_number</parameter></methodparam>
<methodparam choice="opt"><type>int</type><parameter>flags</parameter></methodparam>
</methodsynopsis>
<para>
Esta función busca toda la información estructurada en el mensaje
especificado. El parámetro opcional <parameter>flags</parameter> sólo
tiene una opcion, <parameter>FT_UID</parameter>, la cual indica a la función
que trate el argumento <parameter>msg_number</parameter> como un <parameter>UID</parameter>.
El objeto devuelto incluye el sobre, la fecha interna, el tamao, flags y la
estructura del cuerpo con un objeto similar por cada mime adjunto al mensaje.
La estructura de los objetos devueltos es como sigue:
</para>
<para>
<table>
<title>
Objetos Devueltos para <function>imap_fetchstructure</function>
</title>
<tgroup cols="2">
<tbody>
<row>
<entry>type</entry>
<entry>Tipo primario del cuerpo</entry>
</row>
<row>
<entry>encoding</entry>
<entry>Body transfer encoding</entry>
</row>
<row>
<entry>ifsubtype</entry>
<entry>&true; si hay una cadena de subtipo</entry>
</row>
<row>
<entry>subtype</entry>
<entry><acronym>MIME</acronym> subtype</entry>
</row>
<row>
<entry>ifDescripción</entry>
<entry>&true; si hay una cadena de Descripción</entry>
</row>
<row>
<entry>Description</entry>
<entry>Conenido de la cadena de Descripción</entry>
</row>
<row>
<entry>ifid</entry>
<entry>&true; si hay una cadena de identificación</entry>
</row>
<row>
<entry>id</entry>
<entry>Cadena de Identificación</entry>
</row>
<row>
<entry>lines</entry>
<entry>Número de lineas</entry>
</row>
<row>
<entry>bytes</entry>
<entry>Número de bytes</entry>
</row>
<row>
<entry>ifdisposition</entry>
<entry>&true; si hay una cadena de configuración</entry>
</row>
<row>
<entry>disposition</entry>
<entry>Cadena de configuración</entry>
</row>
<row>
<entry>ifdparameters</entry>
<entry>&true; si el array dparameters existe</entry>
</row>
<row>
<entry>dparameters
<footnote>
<para>
dparameters es un array de objetos donde cada objeto tiene
un "atributo" y una propiedad "valor".
</para>
</footnote>
</entry>
<entry>Array de parametro de configuración</entry>
</row>
<row>
<entry>ifparameters</entry>
<entry>&true; si el array de parámetros existe</entry>
</row>
<row>
<entry>parameters
<footnote>
<para>
parameter es un array de objetos donde cada objetor tiene un
"atributo" y una propiedad "valor".
</para>
</footnote>
</entry>
<entry><acronym>MIME</acronym> parameters array</entry>
</row>
<row>
<entry>parts
<footnote>
<para>
parts es un array de objetos identico en estructura al objeto del
primer nivel, con la limitación de que este no puede contener más
objetos 'parts'.
</para>
</footnote>
</entry>
<entry>Array de objetos describiendo cada parte del mensaje</entry>
</row>
</tbody>
</tgroup>
</table>
</para>
<para>
<table>
<title>Tipo primario del cuerpo</title>
<tgroup cols="2">
<tbody>
<row><entry>0</entry><entry>texto</entry></row>
<row><entry>1</entry><entry>multiparte</entry></row>
<row><entry>2</entry><entry>mensaje</entry></row>
<row><entry>3</entry><entry>aplicación</entry></row>
<row><entry>4</entry><entry>audio</entry></row>
<row><entry>5</entry><entry>imagen</entry></row>
<row><entry>6</entry><entry>video</entry></row>
<row><entry>7</entry><entry>otro</entry></row>
</tbody>
</tgroup>
</table>
</para>
<para>
<table>
<title>Codificacion para tranferencia</title>
<tgroup cols="2">
<tbody>
<row><entry>0</entry><entry>7BIT</entry></row>
<row><entry>1</entry><entry>8BIT</entry></row>
<row><entry>2</entry><entry>BINARY</entry></row>
<row><entry>3</entry><entry>BASE64</entry></row>
<row><entry>4</entry><entry>QUOTED-PRINTABLE</entry></row>
<row><entry>5</entry><entry>OTRO</entry></row>
</tbody>
</tgroup>
</table>
</para>
</refsect1>
</refentry>
<refentry id="function.imap-header">
<refnamediv>
<refname>imap_header</refname>
<refpurpose>Lee la cabecera del mensaje</refpurpose>
</refnamediv>
<refsect1>
<title>Descripción</title>
<methodsynopsis>
<type>object</type><methodname>imap_header</methodname>
<methodparam><type>int</type><parameter>imap_stream</parameter></methodparam>
<methodparam><type>int</type><parameter>msg_number</parameter></methodparam>
<methodparam choice="opt"><type>int</type><parameter>fromlength</parameter></methodparam>
<methodparam choice="opt"><type>int</type><parameter>subjectlength</parameter></methodparam>
<methodparam choice="opt"><type>string</type><parameter>defaulthost</parameter></methodparam>
</methodsynopsis>
<para>
Esta función devuelve un objeto con varios elementos de la cabecera.
</para>
<para>
<informalexample>
<literallayout>
remail, date, Date, subject, Subject, in_reply_to, message_id,
newsgroups, followup_to, references
message flags:
Recent - 'R' si es reciente y ha sido leido,
'N' si es reciente y no ha sido leido,
' ' si no es reciente
Unseen - 'U' si no ha sido leido Y no es reciente,
' ' si ha sido leido O no y es reciente
Answered -'A' si ha sido contestado,
' ' si no ha sido contestado
Deleted - 'D' si ha sido borrado,
' ' si no ha sido borrado
Draft - 'X' if draft,
' ' if not draft
Flagged - 'F' si esta if flagged,
' ' if not flagged
OBSERVE que el comportamiento Recent/Unseen es un poco extrao. Si quiere conocer
si un mensaje es Unseen, debe comprobarlo asi
Unseen == 'U' || Recent == 'N'
toaddress (la linea to: al completo, hasta 1024 caracteres)
to[] (devuelve un array de objetos a partir de la linea To, conteniendo:)
personal
adl
mailbox
host
fromaddress (la linea from: al completo, hasta 1024 caracteres)
from[] (devuelve un array de objetos a partir de la linea From, conteniendo:)
personal
adl
mailbox
host
ccaddress (la linea cc: al completo, hasta 1024 caracteres)
cc[] (devuelve un array de objetos a partir de la linea Cc:, conteniendo:)
personal
adl
mailbox
host
bccaddress (la linea bcc al completo, hasta 1024 caracteres)
bcc[] (devuelve un array de objetos a partir de la linea Bcc, conteniendo:)
personal
adl
mailbox
host
reply_toaddress (la linea reply_to: al completo, hasta 1024 caracteres)
reply_to[] (devuelve un array de objetos a partir de la linea Reply_to,
conteniendo:)
personal
adl
mailbox
host
senderaddress (la linea sender: al completo, hasta 1024 caracteres)
sender[] (devuelve un array de objetos a partir de la linea sender, conteniendo:)
personal
adl
mailbox
host
return_path (la linea return-path: al completo, hasta 1024 caracteres)
return_path[] (devuelve un array de objetos a partir de la linea return_path,
conteniendo:)
personal
adl
mailbox
host
udate (fecha del mensaje en formato unix)
fetchfrom (la linea from formateada hasta ajustarse a los caracteres
indicados en <parameter>fromlength</parameter>)
fetchsubject (la linea subject formateada hasta ajustarse a los caracteres
indicados en <parameter>subjectlength</parameter>)
</literallayout>
</informalexample>
</para>
</refsect1>
</refentry>
<refentry id="function.imap-headers">
<refnamediv>
<refname>imap_headers</refname>
<refpurpose>
Returns headers for all messages in a mailbox
</refpurpose>
</refnamediv>
<refsect1>
<title>Descripción</title>
<methodsynopsis>
<type>array</type><methodname>imap_headers</methodname>
<methodparam><type>int</type><parameter>imap_stream</parameter></methodparam>
</methodsynopsis>
<para>
Devuelve un array de cadenas formateadas con informacion de la cabecera. Un
elemento por mensaje de correo.
</para>
</refsect1>
</refentry>
<refentry id="function.imap-listmailbox">
<refnamediv>
<refname>imap_listmailbox</refname>
<refpurpose>Lee la lista de buzones</refpurpose>
</refnamediv>
<refsect1>
<title>Descripción</title>
<methodsynopsis>
<type>array</type><methodname>imap_listmailbox</methodname>
<methodparam><type>int</type><parameter>imap_stream</parameter></methodparam>
<methodparam><type>string</type><parameter>ref</parameter></methodparam>
<methodparam><type>string</type><parameter>pat</parameter></methodparam>
</methodsynopsis>
<para>
Devuelve un array que contiene los nombres de los buzones.
</para>
</refsect1>
</refentry>
<refentry id="function.imap-getmailboxes">
<refnamediv>
<refname>imap_getmailboxes</refname>
<refpurpose>
Lee la lista de buzones, devolviendo informacón detallada de cada uno
</refpurpose>
</refnamediv>
<refsect1>
<title>Descripción</title>
<methodsynopsis>
<type>array</type><methodname>imap_getmailboxes</methodname>
<methodparam><type>int</type><parameter>imap_stream</parameter></methodparam>
<methodparam><type>string</type><parameter>ref</parameter></methodparam>
<methodparam><type>string</type><parameter>pat</parameter></methodparam>
</methodsynopsis>
<para>
Devuelve un array de objetos coneniendo información del buzón. Cada
objeto tiene los atributos <parameter>name</parameter>, especificando el
nombre completo del buzón; <parameter>delimiter</parameter>,
que es el delimitador jerárquico para la parte de la jerarquía
dónde está este buzón; y
<parameter>attributes</parameter>. <parameter>Attributes</parameter>
es una máscara de bits contra la que se puede probar:
<itemizedlist>
<listitem>
<simpara>
LATT_NOINFERIORS - Este buzón no tiene "hijos" (No ha buzones por debajo de él)
</simpara>
</listitem>
<listitem>
<simpara>
LATT_NOSELECT - Esto es sólo un contenedor, no un buzón - No puede
abrirlo.
</simpara>
</listitem>
<listitem>
<simpara>
LATT_MARKED - Este buzón está marcado. Unicamente usado por UW-IMAPD.
</simpara>
</listitem>
<listitem>
<simpara>
LATT_UNMARKED - Este buzón no está marcado. Unicamente usado por
UW-IMAPD.
</simpara>
</listitem>
</itemizedlist>
</para>
<para>
<parameter>ref</parameter> normalmente debería ser solo el servidor
IMAP, de la forma: {imap_server:imap_port}, y
<parameter>pattern</parameter> especifica, dónde en la estructura jerárquica
del buzón, para comenzar a buscar. Si quiere todo los buzones, pase el
parámetro <parameter>pattern</parameter> como una cadena vacía.
</para>
<para>
Hay dos caracteres especiales que puede pasar como parte del parámetro
<parameter>pattern</parameter>: '*' and '%'. '*' significa que devuelva
todos los buzones. Si pasa el parámetro <parameter>pattern</parameter>
como '*', obtendrá una lista con la jerarquía completa del buzón.
%' significa que devuelva sólo el nivel actual. Pasar '%' en el parámetro
<parameter>pattern</parameter> devolverá sólo el nivel más alto
de los buzones; '~/mail/%' en UW_IMAPD devolverá cada buzón
del directorio ~/mail, pero ninguno de los subdirectorios de ese
directorio.
</para>
</refsect1>
</refentry>
<refentry id="function.imap-listsubscribed">
<refnamediv>
<refname>imap_listsubscribed</refname>
<refpurpose>Lista todos los buzones subscritos</refpurpose>
</refnamediv>
<refsect1>
<title>Descripción</title>
<methodsynopsis>
<type>array</type><methodname>imap_listsubscribed</methodname>
<methodparam><type>int</type><parameter>imap_stream</parameter></methodparam>
<methodparam><type>string</type><parameter>ref</parameter></methodparam>
<methodparam><type>string</type><parameter>pattern</parameter></methodparam>
</methodsynopsis>
<para>
Devuelve un array de todos los buzones que usted tiene
subscritos. Los parámetros <parameter>ref</parameter> y
<parameter>pattern</parameter> especifican la localización desde donde
comenzará a buscar y el patrón que el nombre del buzón debe encontrar.
</para>
</refsect1>
</refentry>
<refentry id="function.imap-getsubscribed">
<refnamediv>
<refname>imap_getsubscribed</refname>
<refpurpose>Lista todos los buzones subscritos</refpurpose>
</refnamediv>
<refsect1>
<title>Descripción</title>
<methodsynopsis>
<type>array</type><methodname>imap_getsubscribed</methodname>
<methodparam><type>int</type><parameter>imap_stream</parameter></methodparam>
<methodparam><type>string</type><parameter>ref</parameter></methodparam>
<methodparam><type>string</type><parameter>pattern</parameter></methodparam>
</methodsynopsis>
<para>
Esta función es idéntica a <function>imap_getmailboxes</function>,
excepto que esta sólo devuelve los buzones a los que está subscrito
el usuario.
</para>
</refsect1>
</refentry>
<refentry id="function.imap-mail-copy">
<refnamediv>
<refname>imap_mail_copy</refname>
<refpurpose>Copia los mensajes especificados a un buzón</refpurpose>
</refnamediv>
<refsect1>
<title>Descripción</title>
<methodsynopsis>
<type>int</type><methodname>imap_mail_copy</methodname>
<methodparam><type>int</type><parameter>imap_stream</parameter></methodparam>
<methodparam><type>string</type><parameter>msglist</parameter></methodparam>
<methodparam><type>string</type><parameter>mbox</parameter></methodparam>
<methodparam><type>int</type><parameter>flags</parameter></methodparam>
</methodsynopsis>
<para>
Devuelve &true; si no hay error y &false; en caso contrario.
</para>
<para>
Copia los mensajes especificados por <parameter>msglist</parameter>
a un buzón especificado. <parameter>msglist</parameter> es un rango
no números de mensajes.
</para>
<para>
Flags es una máscara de bit de uno o más
<itemizedlist>
<listitem>
<simpara>
CP_UID - los números de secuencia contienen UIDS
</simpara>
</listitem>
<listitem>
<simpara>
CP_MOVE - Elimina los mensajes del buzon actual despues de copiarlos
</simpara>
</listitem>
</itemizedlist>
</para>
</refsect1>
</refentry>
<refentry id="function.imap-mail-move">
<refnamediv>
<refname>imap_mail_move</refname>
<refpurpose>Mueve los mensajes especificados a un buzón</refpurpose>
</refnamediv>
<refsect1>
<title>Descripción</title>
<methodsynopsis>
<type>int</type><methodname>imap_mail_move</methodname>
<methodparam><type>int</type><parameter>imap_stream</parameter></methodparam>
<methodparam><type>string</type><parameter>msglist</parameter></methodparam>
<methodparam><type>string</type><parameter>mbox</parameter></methodparam>
</methodsynopsis>
<para>
Mueve los mensajes especificados por <parameter>msglist</parameter>
al buzón especicifado. <parameter>msglist</parameter> es un rango
no números de mensajes.
</para>
<para>
Devuelve &true; si no hay error y &false; en caso contrario.
</para>
</refsect1>
</refentry>
<refentry id="function.imap-num-msg">
<refnamediv>
<refname>imap_num_msg</refname>
<refpurpose>
Informa del número de mensajes en el buzón actual
</refpurpose>
</refnamediv>
<refsect1>
<title>Descripción</title>
<methodsynopsis>
<type>int</type><methodname>imap_num_msg</methodname>
<methodparam><type>int</type><parameter>imap_stream</parameter></methodparam>
</methodsynopsis>
<para>
Devuelve el número de mensajes en el buzón actual.
</para>
</refsect1>
</refentry>
<refentry id="function.imap-num-recent">
<refnamediv>
<refname>imap_num_recent</refname>
<refpurpose>Informa el número de mensajes recientes en el buzón
actual</refpurpose>
</refnamediv>
<refsect1>
<title>Descripción</title>
<methodsynopsis>
<type>int</type><methodname>imap_num_recent</methodname>
<methodparam><type>int</type><parameter>imap_stream</parameter></methodparam>
</methodsynopsis>
<para>
Devuleve el número de mensajes recientes en el buzón actual.
</para>
</refsect1>
</refentry>
<refentry id="function.imap-open">
<refnamediv>
<refname>imap_open</refname>
<refpurpose>Abre una sesión IMAP</refpurpose>
</refnamediv>
<refsect1>
<title>Descripción</title>
<methodsynopsis>
<type>int</type><methodname>imap_open</methodname>
<methodparam><type>string</type><parameter>mailbox</parameter></methodparam>
<methodparam><type>string</type><parameter>username</parameter></methodparam>
<methodparam><type>string</type><parameter>password</parameter></methodparam>
<methodparam><type>int</type><parameter>flags</parameter></methodparam>
</methodsynopsis>
<para>
Devuleve la sesion IMAP si no hay error y &false; en caso contrario. Esta
función también puede ser usada para abrir sesiones con servidores
POP3 y NNTP. Para conectarse a un servidor IMAP escuchando por el puerto
143 en una máquina local, haga lo siguiente:
<informalexample>
<programlisting role="php">
$mbox = imap_open("{localhost:143}INBOX","user_id","password");
</programlisting>
</informalexample>
Para conectarse a un servidor POP3 escuchando por el puerto 110, use:
<informalexample>
<programlisting role="php">
$mbox = imap_open("{localhost/pop3:110}INBOX","user_id","password");
</programlisting>
</informalexample>
Para conectarse a un servidor NNTP escuchando por el puerto 119, use:
<informalexample>
<programlisting role="php">
$nntp = imap_open("{localhost/nntp:119}comp.test","","");
</programlisting>
</informalexample>
Para conectarse a un servidor remoto sustituya "localhost", por el nombre
o dirección IP del servidor al cual quiere conectarse.
</para>
<para>
Las opciones son una máscara de bit con una o más de los siguientes:
<itemizedlist>
<listitem>
<simpara>
OP_READONLY - Abre el buzón en modo de sólo lectura
</simpara>
</listitem>
<listitem>
<simpara>
OP_ANONYMOUS - No usa o actualiza un .newsrc para las noticias
</simpara>
</listitem>
<listitem>
<simpara>
OP_HALFOPEN - Para nombres IMAP y NNTP, abre una conexión pero no abre
un buzón
</simpara>
</listitem>
<listitem>
<simpara>
CL_EXPUNGE - Purga automaticamente el buzón antes de cerrar la sesión
</simpara>
</listitem>
</itemizedlist>
</para>
</refsect1>
</refentry>
<refentry id="function.imap-ping">
<refnamediv>
<refname>imap_ping</refname>
<refpurpose>Comprueba si la sesión IMAP está aún activa</refpurpose>
</refnamediv>
<refsect1>
<title>Descripción</title>
<methodsynopsis>
<type>int</type><methodname>imap_ping</methodname>
<methodparam><type>int</type><parameter>imap_stream</parameter></methodparam>
</methodsynopsis>
<para>
Devuelve &true; si la sesión está activa, &false; en caso contrario.
</para>
<para>
La función <function>imap_ping</function> pings the stream to see
it is still active. Esto puede descubrir que hay correo nuevo; este es
el método preferido para hacer una comprobación periodica del buzón,
asi como para mantener activa sesiones en servidores que tienen
inactivity timeout.
</para>
</refsect1>
</refentry>
<refentry id="function.imap-renamemailbox">
<refnamediv>
<refname>imap_renamemailbox</refname>
<refpurpose>Renombra un buzón</refpurpose>
</refnamediv>
<refsect1>
<title>Descripción</title>
<methodsynopsis>
<type>int</type><methodname>imap_renamemailbox</methodname>
<methodparam><type>int</type><parameter>imap_stream</parameter></methodparam>
<methodparam><type>string</type><parameter>old_mbox</parameter></methodparam>
<methodparam><type>string</type><parameter>new_mbox</parameter></methodparam>
</methodsynopsis>
<para>
Esta función renombra un buzon (ver
<function>imap_open</function> para el formato del parámetro
<parameter>mbox</parameter>).
</para>
<para>
Devuelve &true; si no hay error y &false; en caso contrario.
</para>
<para>
Ver También <function>imap_createmailbox</function> and
<function>imap_deletemailbox</function>.
</para>
</refsect1>
</refentry>
<refentry id="function.imap-reopen">
<refnamediv>
<refname>imap_reopen</refname>
<refpurpose>Reabre una sesión IMAP a un nuevo buzón</refpurpose>
</refnamediv>
<refsect1>
<title>Descripción</title>
<methodsynopsis>
<type>int</type><methodname>imap_reopen</methodname>
<methodparam><type>string</type><parameter>imap_stream</parameter></methodparam>
<methodparam><type>string</type><parameter>mailbox</parameter></methodparam>
<methodparam choice="opt"><type>string</type><parameter>flags</parameter></methodparam>
</methodsynopsis>
<para>
Devuelve &true; si no hay error y &false; en caso contrario.</para>
<para>
Esta funció reabre la sesión especificada con un nuevo buzón.</para>
<para>
Las opciones son máscaras de bit con una o más de las siguientes:
<itemizedlist>
<listitem>
<simpara>
OP_READONLY - Abre el buzón en modo de sólo lectura
</simpara>
</listitem>
<listitem>
<simpara>
OP_ANONYMOUS - No usa o actualiza .newsrc para noticias
</simpara>
</listitem>
<listitem>
<simpara>
OP_HALFOPEN - Para nombres IMAP y NNTP, abre una conexión pero no
abre el buzon.
</simpara>
</listitem>
<listitem>
<simpara>
CL_EXPUNGE - Expurga automaticamente el buzon antes de cerra la sesión
</simpara>
</listitem>
</itemizedlist>
</para>
</refsect1>
</refentry>
<refentry id="function.imap-subscribe">
<refnamediv>
<refname>imap_subscribe</refname>
<refpurpose>Subscribe to a mailbox</refpurpose>
</refnamediv>
<refsect1>
<title>Descripción</title>
<methodsynopsis>
<type>int</type><methodname>imap_subscribe</methodname>
<methodparam><type>int</type><parameter>imap_stream</parameter></methodparam>
<methodparam><type>string</type><parameter>mbox</parameter></methodparam>
</methodsynopsis>
<para>
Da de alta un nuevo buzón.
</para>
<para>
Devuleve &true; si no hay error y &false; en caso contrario.
</para>
</refsect1>
</refentry>
<refentry id="function.imap-undelete">
<refnamediv>
<refname>imap_undelete</refname>
<refpurpose>
Desmarca los mensajes que están marcados como borrados
</refpurpose>
</refnamediv>
<refsect1>
<title>Descripción</title>
<methodsynopsis>
<type>int</type><methodname>imap_undelete</methodname>
<methodparam><type>int</type><parameter>imap_stream</parameter></methodparam>
<methodparam><type>int</type><parameter>msg_number</parameter></methodparam>
</methodsynopsis>
<para>
Esta funcion elimina la marca de borrado de un mensaje especifico,
puesta por la función <function>imap_delete</function>.
</para>
<para>
Devuleve &true; si no hay error y &false; en caso contrario.
</para>
</refsect1>
</refentry>
<refentry id="function.imap-unsubscribe">
<refnamediv>
<refname>imap_unsubscribe</refname>
<refpurpose>Unsubscribe from a mailbox</refpurpose>
</refnamediv>
<refsect1>
<title>Descripción</title>
<methodsynopsis>
<type>int</type><methodname>imap_unsubscribe</methodname>
<methodparam><type>int</type><parameter>imap_stream</parameter></methodparam>
<methodparam><type>string</type><parameter>mbox</parameter></methodparam>
</methodsynopsis>
<para>
Da de baja el buzón especificado.
</para>
<para>
Devuelve &true; si no hay error y &false; en caso contrario.
</para>
</refsect1>
</refentry>
<refentry id="function.imap-qprint">
<refnamediv>
<refname>imap_qprint</refname>
<refpurpose>Convierte una cadena quoted-printable a una cadena de 8 bit
</refpurpose>
</refnamediv>
<refsect1>
<title>Descripción</title>
<methodsynopsis>
<type>string</type><methodname>imap_qprint</methodname>
<methodparam><type>string</type><parameter>string</parameter></methodparam>
</methodsynopsis>
<para>
Convierte una cadena quoted-printable a una cadena de 8 bit</para>
<para>
Devuelve una cadena de 8 bit (binary)</para>
</refsect1>
</refentry>
<refentry id="function.imap-8bit">
<refnamediv>
<refname>imap_8bit</refname>
<refpurpose>
Convierte una cadena de 8bit a una cadena quoted-printable
</refpurpose>
</refnamediv>
<refsect1>
<title>Descripción</title>
<methodsynopsis>
<type>string</type><methodname>imap_8bit</methodname>
<methodparam><type>string</type><parameter>string</parameter></methodparam>
</methodsynopsis>
<para>
Convierte una cadena de 8bit a una cadena quoted-printable.</para>
<para>
Devuelve una cadena quoted-printable</para>
</refsect1>
</refentry>
<refentry id="function.imap-binary">
<refnamediv>
<refname>imap_binary</refname>
<refpurpose>
Convierte una cadena de 8bit a una cadena base64
</refpurpose>
</refnamediv>
<refsect1>
<title>Descripción</title>
<methodsynopsis>
<type>string</type><methodname>imap_binary</methodname>
<methodparam><type>string</type><parameter>string</parameter></methodparam>
</methodsynopsis>
<para>
Convierte una cadena de 8bit a una cadena base64.
</para>
<para>
Devuleve una cadena base64.
</para>
</refsect1>
</refentry>
<refentry id="function.imap-scanmailbox">
<refnamediv>
<refname>imap_scanmailbox</refname>
<refpurpose>
Lee la lista de buzones y toma una cadena para buscar en el
texto del buzón
</refpurpose>
</refnamediv>
<refsect1>
<title>Descripción</title>
<methodsynopsis>
<type>array</type><methodname>imap_scanmailbox</methodname>
<methodparam><type>int</type><parameter>imap_stream</parameter></methodparam>
<methodparam><type>string</type><parameter>string</parameter></methodparam>
</methodsynopsis>
<para>
Devuelve un array que contiene los nombres de los buzones que tienen
el parámetro <parameter>string</parameter> en el texto del buzón.
</para>
</refsect1>
</refentry>
<refentry id="function.imap-mailboxmsginfo">
<refnamediv>
<refname>imap_mailboxmsginfo</refname>
<refpurpose>Obtiene información acerca del buzón actual</refpurpose>
</refnamediv>
<refsect1>
<title>Descripción</title>
<methodsynopsis>
<type>object</type><methodname>imap_mailboxmsginfo</methodname>
<methodparam><type>int</type><parameter>imap_stream</parameter></methodparam>
</methodsynopsis>
<para>
Devuelve información acerca del buzón actual. Devuelve &false; en caso de
fallo.
</para>
<para>
La función <function>imap_mailboxmsginfo</function> comprueba el estado
del buzón actual en el servidor y devuelve la información en un objeto
con las siguientes propiedades.
</para>
<para>
<informalexample>
<literallayout>
Date : fecha del mensaje
Driver : driver
Mailbox : nombre del buzón
Nmsgs : número de mensajes
Recent : número de los mensajes recientes
Unread : número de los mensajes no leidos
Size : tamao del buzon
</literallayout>
</informalexample>
</para>
</refsect1>
</refentry>
<refentry id="function.imap-rfc822-write-address">
<refnamediv>
<refname>imap_rfc822_write_address</refname>
<refpurpose>
Devuleve una dirección de correo correctamente formateada dado el buzón,
host, e información personal.
</refpurpose>
</refnamediv>
<refsect1>
<title>Descripción</title>
<methodsynopsis>
<type>string</type><methodname>imap_rfc822_write_address</methodname>
<methodparam><type>string</type><parameter>mailbox</parameter></methodparam>
<methodparam><type>string</type><parameter>host</parameter></methodparam>
<methodparam><type>string</type><parameter>personal</parameter></methodparam>
</methodsynopsis>
<para>
Devuelve una dirección de correo correctamente formateada, dado el buzón,
host, e información personal.
</para>
</refsect1>
</refentry>
<refentry id="function.imap-rfc822-parse-adrlist">
<refnamediv>
<refname>imap_rfc822_parse_adrlist</refname>
<refpurpose>Examina la cadena dirección</refpurpose>
</refnamediv>
<refsect1>
<title>Descripción</title>
<methodsynopsis>
<type>string</type><methodname>imap_rfc822_parse_adrlist</methodname>
<methodparam><type>string</type><parameter>address</parameter></methodparam>
<methodparam><type>string</type><parameter>default_host</parameter></methodparam>
</methodsynopsis>
<para>
Esta función examina la cadena dirección y para cada dirección,
devuelve un array de objetos. Los 4 objetos son:
</para>
<para>
<informalexample>
<literallayout>
mailbox - el nombre del buzón (username)
host - el nombre del ordenador
personal - el nombre personal
adl - ruta del dominio
</literallayout>
</informalexample>
</para>
</refsect1>
</refentry>
<refentry id="function.imap-setflag-full">
<refnamediv>
<refname>imap_setflag_full</refname>
<refpurpose>Activa flags en los mensajes</refpurpose>
</refnamediv>
<refsect1>
<title>Descripción</title>
<methodsynopsis>
<type>string</type><methodname>imap_setflag_full</methodname>
<methodparam><type>int</type><parameter>stream</parameter></methodparam>
<methodparam><type>string</type><parameter>sequence</parameter></methodparam>
<methodparam><type>string</type><parameter>flag</parameter></methodparam>
<methodparam><type>string</type><parameter>options</parameter></methodparam>
</methodsynopsis>
<para>
Esta función aade el flag especificado al conjunto de flags
activos para los mensajes en la secuencia especificada.
</para>
<para>
Los flags que puede seleccionar son "\\Seen", "\\Answered",
"\\Flagged", "\\Deleted", "\\Draft", y "\\Recent" ( definidos
en el RFC2060)
</para>
<para>
Las opciones son una máscara de bit con uno o más de los siguientes:
<informalexample>
<literallayout>
ST_UID El argumento sequence contiene UIDs en vez de
números secuenciales
</literallayout>
</informalexample>
</para>
</refsect1>
</refentry>
<refentry id="function.imap-clearflag-full">
<refnamediv>
<refname>imap_clearflag_full</refname>
<refpurpose>Limpia los flags de los mensajes</refpurpose>
</refnamediv>
<refsect1>
<title>Descripción</title>
<methodsynopsis>
<type>string</type><methodname>imap_clearflag_full</methodname>
<methodparam><type>int</type><parameter>stream</parameter></methodparam>
<methodparam><type>string</type><parameter>sequence</parameter></methodparam>
<methodparam><type>string</type><parameter>flag</parameter></methodparam>
<methodparam><type>string</type><parameter>options</parameter></methodparam>
</methodsynopsis>
<para>
Esta funcion elimina el flag especificado del conjunto de
flags activos para los mensajes en la secuencia especificada.
</para>
<para>
Las opciones son una máscara de bit con uno o más de los siguientes:
<informalexample>
<literallayout>
ST_UID El argumento sequence contiene UIDs en vez de
números secuenciales
</literallayout>
</informalexample>
</para>
</refsect1>
</refentry>
<refentry id="function.imap-sort">
<refnamediv>
<refname>imap_sort</refname>
<refpurpose>Ordena un array de cabeceras de mensajes</refpurpose>
</refnamediv>
<refsect1>
<title>Descripción</title>
<methodsynopsis>
<type>string</type><methodname>imap_sort</methodname>
<methodparam><type>int</type><parameter>stream</parameter></methodparam>
<methodparam><type>int</type><parameter>criteria</parameter></methodparam>
<methodparam><type>int</type><parameter>reverse</parameter></methodparam>
<methodparam><type>int</type><parameter>options</parameter></methodparam>
</methodsynopsis>
<para>
Devuelve un array de números de mensajes ordenados por los
parametros dados
</para>
<para>
Rev es 1 para una ordenación inversa.
</para>
<para>
Criteria puede ser uno (y sólo uno) de los siguientes:
<informalexample>
<literallayout>
SORTDATE Fecha del mensaje
SORTARRIVAL Fecha de llegada
SORTFROM mailbox in first From address
SORTSUBJECT Asunto del mensaje
SORTTO mailbox in first To address
SORTCC mailbox in first cc address
SORTSIZE tamao del mensaje en bytes
</literallayout>
</informalexample>
</para>
<para>
Las opciones son una máscara de bit con uno o más de los siguientes:
<informalexample>
<literallayout>
SE_UID Devuelve UIDs en vez de números secuenciales
SE_NOPREFETCH No preselecciona los mensajes buscados.
</literallayout>
</informalexample>
</para>
</refsect1>
</refentry>
<refentry id="function.imap-fetchheader">
<refnamediv>
<refname>imap_fetchheader</refname>
<refpurpose>Devuelve la cabecera del mensaje</refpurpose>
</refnamediv>
<refsect1>
<title>Descripción</title>
<methodsynopsis>
<type>string</type><methodname>imap_fetchheader</methodname>
<methodparam><type>int</type><parameter>imap_stream</parameter></methodparam>
<methodparam><type>int</type><parameter>msgno</parameter></methodparam>
<methodparam><type>int</type><parameter>flags</parameter></methodparam>
</methodsynopsis>
<para>
Esta función localiza el formato de la cabecera RFC 822
del mensaje especificado como una cadena de texto y
devuelve esa cadena de texto.
</para>
<para>
The options are:
<informalexample>
<literallayout>
FT_UID El argumento msgno es un UID
FT_INTERNAL La cadena devuelta esta en formato "interno",
sin ningún intento de canonizar CRLF
FT_PREFETCHTEXT The RFC822.TEXT should be pre-fetched at the
same time. Esto evita un extra RTT en una
conexión IMAP si se desea un mensaje completo de
texto (e.g. en una operación de
"guardar a un fichero local")
</literallayout>
</informalexample>
</para>
</refsect1>
</refentry>
<refentry id="function.imap-uid">
<refnamediv>
<refname>imap_uid</refname>
<refpurpose>
Esta función devuelve el UID del número de secuencia del mensaje dado
</refpurpose>
</refnamediv>
<refsect1>
<title>Descripción</title>
<methodsynopsis>
<type>int</type><methodname>imap_uid</methodname>
<methodparam><type>int</type><parameter>imap_stream</parameter></methodparam>
<methodparam><type>int</type><parameter>msgno</parameter></methodparam>
</methodsynopsis>
<para>
Esta función devuelve el UID del número de secuencia del mensaje dado.
Esta función es la inversa a <function>imap_msgno</function>.
</para>
</refsect1>
</refentry>
<refentry id="function.imap-msgno">
<refnamediv>
<refname>imap_msgno</refname>
<refpurpose>
Esta función devuelve el número de secuencia del mensaje para el UID dado.
</refpurpose>
</refnamediv>
<refsect1>
<title>Descripción</title>
<methodsynopsis>
<type>int</type><methodname>imap_msgno</methodname>
<methodparam><type>int</type><parameter>imap_stream</parameter></methodparam>
<methodparam><type>int</type><parameter>uid</parameter></methodparam>
</methodsynopsis>
<para>
Esta función devuelve el número de secuencia del mensaje para el UID dado.
Esta función es la inversa a <function>imap_uid</function>.
</para>
</refsect1>
</refentry>
<refentry id="function.imap-search">
<refnamediv>
<refname>imap_search</refname>
<refpurpose>
Esta función devuelve un array de mensajes que coinciden con el
criterio de busqueda dado.
</refpurpose>
</refnamediv>
<refsect1>
<title>Descripción</title>
<methodsynopsis>
<type>array</type><methodname>imap_search</methodname>
<methodparam><type>int</type><parameter>imap_stream</parameter></methodparam>
<methodparam><type>string</type><parameter>criteria</parameter></methodparam>
<methodparam><type>int</type><parameter>flags</parameter></methodparam>
</methodsynopsis>
<para>
Esta función realiza una busqueda en el buzón actualmente abierto
indicado por imap_stream. <parameter>criteria</parameter> es una
cadena, delimitada por espacios, en la cual las siguientes palabras
claves son permitidas. Cualquier argumento múltiple (ej. FROM "joey smith") debe estar
entre comillas.
<itemizedlist>
<listitem>
<simpara>
ALL - devuelve todos los mensajes que coinciden con el resto del criterio
</simpara>
</listitem>
<listitem>
<simpara>
ANSWERED - busca mensajes con el flag \\ANSWERED activado
</simpara>
</listitem>
<listitem>
<simpara>
BCC "string" - busca mensajes con "cadena" en el campo Bcc:
</simpara>
</listitem>
<listitem>
<simpara>
BEFORE "date" - busca mensajes con Date: antes de "date"
</simpara>
</listitem>
<listitem>
<simpara>
BODY "string" - busca mensajes con "cadena" en el cuerpo del mensaje
</simpara>
</listitem>
<listitem>
<simpara>
CC "string" - busca mensajes con "cadena" en el campo Cc:
</simpara>
</listitem>
<listitem>
<simpara>
DELETED - busca mensajes eliminados
</simpara>
</listitem>
<listitem>
<simpara>
FLAGGED - busca mensajes con el flag \\FLAGGED (sometimes
referred to as Important or Urgent) activado
</simpara>
</listitem>
<listitem>
<simpara>
FROM "string" - busca mensajes con "cadena" en el campo From:
</simpara>
</listitem>
<listitem>
<simpara>
KEYWORD "string" - busca mensajes con "cadena" como una palabra clave
</simpara>
</listitem>
<listitem>
<simpara>
NEW - busca mensajes nuevos
</simpara>
</listitem>
<listitem>
<simpara>
OLD - busca mensajes viejos
</simpara>
</listitem>
<listitem>
<simpara>
ON "date" - busca mensajes con "date" igual a Date:
</simpara>
</listitem>
<listitem>
<simpara>
RECENT - busca mensajes con el flag \\RECENT activado
</simpara>
</listitem>
<listitem>
<simpara>
SEEN - busca mensajes que han sido leidos (la opcion \\SEEN activada)
</simpara>
</listitem>
<listitem>
<simpara>
SINCE "date" - busca mensajes conwith Date: after "date"
</simpara>
</listitem>
<listitem>
<simpara>
SUBJECT "string" - busca mensajes con "string" en el campo Subject:
</simpara>
</listitem>
<listitem>
<simpara>
TEXT "string" - busca mensajes con el texto "string"
</simpara>
</listitem>
<listitem>
<simpara>
TO "string" - busca mensajes con "string" en el campo To:
</simpara>
</listitem>
<listitem>
<simpara>
UNANSWERED - busca mensajes que no han sido respondidos
</simpara>
</listitem>
<listitem>
<simpara>
UNDELETED - busca mensajes que no han sido eliminados
</simpara>
</listitem>
<listitem>
<simpara>
UNFLAGGED - busca mensajes que no estan flagged
</simpara>
</listitem>
<listitem>
<simpara>
UNKEYWORD "string" - busca mensajes que no coinciden con la palabra
clave "string"
</simpara>
</listitem>
<listitem>
<simpara>
UNSEEN - busca mensajes que no han sido leidos aún
</simpara>
</listitem>
</itemizedlist>
</para>
<para>
Por ejemplo, para buscar todos los mensajes no contestados enviados por
Mamá, usaría: "UNANSWERED FROM mamá". La busqueda parece ser no sensitiva.
Esta lista de criterios está tomada del codigo fuente del UW
c-client y puede que este incompleta o sea inexacta.
</para>
<para>
Valores validos para los flags son SE_UID, que provoca que el array
devuelto contenga UIDs en vez de los numeros de secuencia de los mensajes
</para>
</refsect1>
</refentry>
<refentry id="function.imap-last-error">
<refnamediv>
<refname>imap_last_error</refname>
<refpurpose>
Esta función devuelve el último error IMAP (si se produjo) que ocurrió
durante la petición de esta página.
</refpurpose>
</refnamediv>
<refsect1>
<title>Descripción</title>
<methodsynopsis>
<type>string</type><methodname>imap_last_error</methodname>
<void/>
</methodsynopsis>
<para>
Esta función devuelve el texto completo del último error IMAP
que ocurrió en la pagina actual. La plia de errores The error stack is
untouched; llamando despues a la función <function>imap_last_error</function>,
sin que se produzca un error, devolverá el mismo error.
</para>
<para>ATENCIN: esta función no esta disponible aún en PHP4.
</para>
</refsect1>
</refentry>
<refentry id="function.imap-errors">
<refnamediv>
<refname>imap_errors</refname>
<refpurpose>
Esta función devuelve todos los errores IMAP (si hubo) que han
occurrido durante la petición de la página o desde que la pila de errores
se inicializó.
</refpurpose>
</refnamediv>
<refsect1>
<title>Descripción</title>
<methodsynopsis>
<type>array</type><methodname>imap_errors</methodname>
<void/>
</methodsynopsis>
<para>
Esta función devuelve un array de todos los mensajes de error IMAP
generados desde la última llamada a <function>imap_errors</function>,
o el principio de la página. Cuando se llama a <function>imap_errors</function>,
la pila de errores se inicializa.
</para>
<para>
ATENCIN: esta función no esta disponible aún en PHP4.
</para>
</refsect1>
</refentry>
<refentry id="function.imap-alerts">
<refnamediv>
<refname>imap_alerts</refname>
<refpurpose>
Esta función devuelve todos los mensajes de alerta IMAP (si hubo) que han
ocurrido durante la petición de la pagina o desde que la pila de alertas fue
inicializada.
</refpurpose>
</refnamediv>
<refsect1>
<title>Descripción</title>
<methodsynopsis>
<type>array</type><methodname>imap_alerts</methodname>
<void/>
</methodsynopsis>
<para>
Esta función devuelve un array con todos los mensajes de alerta IMAP
generados desde la última llamada a <function>imap_alerts</function>,
o el comienzo de la pagina. Cuando se llama a <function>imap_alerts</function>, la pila de alerta
es inicializada. La especificación IMAP requiere que estos mensajes
sean pasados al usuario.
</para>
</refsect1>
</refentry>
<refentry id="function.imap-status">
<refnamediv>
<refname>imap_status</refname>
<refpurpose>
Esta función devuelve el información de estado de otro buzón distinto
al actual.
</refpurpose>
</refnamediv>
<refsect1>
<title>Descripción</title>
<methodsynopsis>
<type>object</type><methodname>imap_status</methodname>
<methodparam><type>int</type><parameter>imap_stream</parameter></methodparam>
<methodparam><type>string</type><parameter>mailbox</parameter></methodparam>
<methodparam><type>int</type><parameter>options</parameter></methodparam>
</methodsynopsis>
<para>
Esta función devuelve un objeto que contiene información de estado.
Las opciones válidas son:
<itemizedlist>
<listitem>
<simpara>
SA_MESSAGES - activa status->messages con el número de mensajes
en el buzon
</simpara>
</listitem>
<listitem>
<simpara>
SA_RECENT - activa status->recent con el número de mensajes recientes en
el buzón
</simpara>
</listitem>
<listitem>
<simpara>
SA_UNSEEN - activa status->unseen con el número de mesajes no leidos (nuevos)
en el buzón
</simpara>
</listitem>
<listitem>
<simpara>
SA_UIDNEXT - activa status->uidnext con el próximo uid a usar en el bizón
</simpara>
</listitem>
<listitem>
<simpara>
SA_UIDVALIDITY - activa status->uidvalidity con una constante que cambia
cuando los uids del buzon ya no son válidos
</simpara>
</listitem>
<listitem>
<simpara>
SA_ALL - activa todos los de arriba
</simpara>
</listitem>
</itemizedlist>
</para>
<para>
status->flags contienen una máscara de bits la cual puede ser
comprobada contra cualquiera de las propiedades de arriba.
</para>
</refsect1>
</refentry>
</reference>
<!-- 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:"../../manual.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
-->
|