| 1 |
<?php |
| 2 |
|
| 3 |
// Start of imap v. |
| 4 |
|
| 5 |
/** |
| 6 |
* Open an <acronym>IMAP</acronym> stream to a mailbox |
| 7 |
* @link http://www.php.net/manual/en/function.imap-open.php |
| 8 |
* @param mailbox string <p> |
| 9 |
* A mailbox name consists of a server and a mailbox path on this server. |
| 10 |
* The special name INBOX stands for the current users |
| 11 |
* personal mailbox. Mailbox names that contain international characters |
| 12 |
* besides those in the printable ASCII space have to be encoded width |
| 13 |
* imap_utf7_encode. |
| 14 |
* </p> |
| 15 |
* <p> |
| 16 |
* The server part, which is enclosed in '{' and '}', consists of the servers |
| 17 |
* name or ip address, an optional port (prefixed by ':'), and an optional |
| 18 |
* protocol specification (prefixed by '/'). |
| 19 |
* </p> |
| 20 |
* <p> |
| 21 |
* The server part is mandatory in all mailbox |
| 22 |
* parameters. |
| 23 |
* </p> |
| 24 |
* <p> |
| 25 |
* All names which start with { are remote names, and are |
| 26 |
* in the form "{" remote_system_name [":" port] [flags] "}" |
| 27 |
* [mailbox_name] where: |
| 28 |
* |
| 29 |
* |
| 30 |
* |
| 31 |
* remote_system_name - Internet domain name or |
| 32 |
* bracketed IP address of server. |
| 33 |
* @param username string <p> |
| 34 |
* The user name |
| 35 |
* </p> |
| 36 |
* @param password string <p> |
| 37 |
* The password associated with the username |
| 38 |
* </p> |
| 39 |
* @param options int[optional] <p> |
| 40 |
* The options are a bit mask with one or more of |
| 41 |
* the following: |
| 42 |
* |
| 43 |
* |
| 44 |
* |
| 45 |
* OP_READONLY - Open mailbox read-only |
| 46 |
* @param n_retries int[optional] <p> |
| 47 |
* Number of maximum connect attempts |
| 48 |
* </p> |
| 49 |
* @param params array[optional] <p> |
| 50 |
* Connection parameters, the following (string) keys maybe used |
| 51 |
* to set one or more connection parameters: |
| 52 |
* |
| 53 |
* |
| 54 |
* |
| 55 |
* DISABLE_AUTHENTICATOR - Disable authentication properties |
| 56 |
* @return resource an IMAP stream on success or false on error. |
| 57 |
*/ |
| 58 |
function imap_open ($mailbox, $username, $password, $options = null, $n_retries = null, array $params = null) {} |
| 59 |
|
| 60 |
/** |
| 61 |
* Reopen <acronym>IMAP</acronym> stream to new mailbox |
| 62 |
* @link http://www.php.net/manual/en/function.imap-reopen.php |
| 63 |
* @param imap_stream resource |
| 64 |
* @param mailbox string <p> |
| 65 |
* The mailbox name, see imap_open for more |
| 66 |
* information |
| 67 |
* </p> |
| 68 |
* @param options int[optional] <p> |
| 69 |
* The options are a bit mask with one or more of |
| 70 |
* the following: |
| 71 |
* |
| 72 |
* |
| 73 |
* |
| 74 |
* OP_READONLY - Open mailbox read-only |
| 75 |
* @param n_retries int[optional] <p> |
| 76 |
* Number of maximum connect attempts |
| 77 |
* </p> |
| 78 |
* @return bool true if the stream is reopened, false otherwise. |
| 79 |
*/ |
| 80 |
function imap_reopen ($imap_stream, $mailbox, $options = null, $n_retries = null) {} |
| 81 |
|
| 82 |
/** |
| 83 |
* Close an IMAP stream |
| 84 |
* @link http://www.php.net/manual/en/function.imap-close.php |
| 85 |
* @param imap_stream resource |
| 86 |
* @param flag int[optional] <p> |
| 87 |
* If set to CL_EXPUNGE, the function will silently |
| 88 |
* expunge the mailbox before closing, removing all messages marked for |
| 89 |
* deletion. You can achieve the same thing by using |
| 90 |
* imap_expunge |
| 91 |
* </p> |
| 92 |
* @return bool Returns true on success, false on failure. |
| 93 |
*/ |
| 94 |
function imap_close ($imap_stream, $flag = null) {} |
| 95 |
|
| 96 |
/** |
| 97 |
* Gets the number of messages in the current mailbox |
| 98 |
* @link http://www.php.net/manual/en/function.imap-num-msg.php |
| 99 |
* @param imap_stream resource |
| 100 |
* @return int Return the number of messages in the current mailbox, as an integer. |
| 101 |
*/ |
| 102 |
function imap_num_msg ($imap_stream) {} |
| 103 |
|
| 104 |
/** |
| 105 |
* Gets the number of recent messages in current mailbox |
| 106 |
* @link http://www.php.net/manual/en/function.imap-num-recent.php |
| 107 |
* @param imap_stream resource |
| 108 |
* @return int the number of recent messages in the current mailbox, as an |
| 109 |
* integer. |
| 110 |
*/ |
| 111 |
function imap_num_recent ($imap_stream) {} |
| 112 |
|
| 113 |
/** |
| 114 |
* Returns headers for all messages in a mailbox |
| 115 |
* @link http://www.php.net/manual/en/function.imap-headers.php |
| 116 |
* @param imap_stream resource |
| 117 |
* @return array an array of string formatted with header info. One |
| 118 |
* element per mail message. |
| 119 |
*/ |
| 120 |
function imap_headers ($imap_stream) {} |
| 121 |
|
| 122 |
/** |
| 123 |
* Read the header of the message |
| 124 |
* @link http://www.php.net/manual/en/function.imap-headerinfo.php |
| 125 |
* @param imap_stream resource |
| 126 |
* @param msg_number int <p> |
| 127 |
* The message number |
| 128 |
* </p> |
| 129 |
* @param fromlength int[optional] <p> |
| 130 |
* Number of characters for the fetchfrom property. |
| 131 |
* Must be greater than or equal to zero. |
| 132 |
* </p> |
| 133 |
* @param subjectlength int[optional] <p> |
| 134 |
* Number of characters for the fetchsubject property |
| 135 |
* Must be greater than or equal to zero. |
| 136 |
* </p> |
| 137 |
* @param defaulthost string[optional] <p> |
| 138 |
* </p> |
| 139 |
* @return object the information in an object with following properties: |
| 140 |
* |
| 141 |
* |
| 142 |
* |
| 143 |
* toaddress - full to: line, up to 1024 characters |
| 144 |
* |
| 145 |
* |
| 146 |
* |
| 147 |
* |
| 148 |
* to - an array of objects from the To: line, with the following |
| 149 |
* properties: personal, adl, |
| 150 |
* mailbox, and host |
| 151 |
* |
| 152 |
* |
| 153 |
* |
| 154 |
* |
| 155 |
* fromaddress - full from: line, up to 1024 characters |
| 156 |
* |
| 157 |
* |
| 158 |
* |
| 159 |
* |
| 160 |
* from - an array of objects from the From: line, with the following |
| 161 |
* properties: personal, adl, |
| 162 |
* mailbox, and host |
| 163 |
* |
| 164 |
* |
| 165 |
* |
| 166 |
* |
| 167 |
* ccaddress - full cc: line, up to 1024 characters |
| 168 |
* |
| 169 |
* |
| 170 |
* |
| 171 |
* |
| 172 |
* cc - an array of objects from the Cc: line, with the following |
| 173 |
* properties: personal, adl, |
| 174 |
* mailbox, and host |
| 175 |
* |
| 176 |
* |
| 177 |
* |
| 178 |
* |
| 179 |
* bccaddress - full bcc: line, up to 1024 characters |
| 180 |
* |
| 181 |
* |
| 182 |
* |
| 183 |
* |
| 184 |
* bcc - an array of objects from the Bcc: line, with the following |
| 185 |
* properties: personal, adl, |
| 186 |
* mailbox, and host |
| 187 |
* |
| 188 |
* |
| 189 |
* |
| 190 |
* |
| 191 |
* reply_toaddress - full Reply-To: line, up to 1024 characters |
| 192 |
* |
| 193 |
* |
| 194 |
* |
| 195 |
* |
| 196 |
* reply_to - an array of objects from the Reply-To: line, with the following |
| 197 |
* properties: personal, adl, |
| 198 |
* mailbox, and host |
| 199 |
* |
| 200 |
* |
| 201 |
* |
| 202 |
* |
| 203 |
* senderaddress - full sender: line, up to 1024 characters |
| 204 |
* |
| 205 |
* |
| 206 |
* |
| 207 |
* |
| 208 |
* sender - an array of objects from the Sender: line, with the following |
| 209 |
* properties: personal, adl, |
| 210 |
* mailbox, and host |
| 211 |
* |
| 212 |
* |
| 213 |
* |
| 214 |
* |
| 215 |
* return_pathaddress - full Return-Path: line, up to 1024 characters |
| 216 |
* |
| 217 |
* |
| 218 |
* |
| 219 |
* |
| 220 |
* return_path - an array of objects from the Return-Path: line, with the |
| 221 |
* following properties: personal, |
| 222 |
* adl, mailbox, and |
| 223 |
* host |
| 224 |
* |
| 225 |
* |
| 226 |
* |
| 227 |
* |
| 228 |
* remail - |
| 229 |
* |
| 230 |
* |
| 231 |
* |
| 232 |
* |
| 233 |
* date - The message date as found in its headers |
| 234 |
* |
| 235 |
* |
| 236 |
* |
| 237 |
* |
| 238 |
* Date - Same as date |
| 239 |
* |
| 240 |
* |
| 241 |
* |
| 242 |
* |
| 243 |
* subject - The message subject |
| 244 |
* |
| 245 |
* |
| 246 |
* |
| 247 |
* |
| 248 |
* Subject - Same as subject |
| 249 |
* |
| 250 |
* |
| 251 |
* |
| 252 |
* |
| 253 |
* in_reply_to - |
| 254 |
* |
| 255 |
* |
| 256 |
* |
| 257 |
* |
| 258 |
* message_id - |
| 259 |
* |
| 260 |
* |
| 261 |
* |
| 262 |
* |
| 263 |
* newsgroups - |
| 264 |
* |
| 265 |
* |
| 266 |
* |
| 267 |
* |
| 268 |
* followup_to - |
| 269 |
* |
| 270 |
* |
| 271 |
* |
| 272 |
* |
| 273 |
* references - |
| 274 |
* |
| 275 |
* |
| 276 |
* |
| 277 |
* |
| 278 |
* Recent - R if recent and seen, N |
| 279 |
* if recent and not seen, ' ' if not recent. |
| 280 |
* |
| 281 |
* |
| 282 |
* |
| 283 |
* |
| 284 |
* Unseen - U if not seen AND not recent, ' ' if seen |
| 285 |
* OR not seen and recent |
| 286 |
* |
| 287 |
* |
| 288 |
* |
| 289 |
* |
| 290 |
* Flagged - F if flagged, ' ' if not flagged |
| 291 |
* |
| 292 |
* |
| 293 |
* |
| 294 |
* |
| 295 |
* Answered - A if answered, ' ' if unanswered |
| 296 |
* |
| 297 |
* |
| 298 |
* |
| 299 |
* |
| 300 |
* Deleted - D if deleted, ' ' if not deleted |
| 301 |
* |
| 302 |
* |
| 303 |
* |
| 304 |
* |
| 305 |
* Draft - X if draft, ' ' if not draft |
| 306 |
* |
| 307 |
* |
| 308 |
* |
| 309 |
* |
| 310 |
* Msgno - The message number |
| 311 |
* |
| 312 |
* |
| 313 |
* |
| 314 |
* |
| 315 |
* MailDate - |
| 316 |
* |
| 317 |
* |
| 318 |
* |
| 319 |
* |
| 320 |
* Size - The message size |
| 321 |
* |
| 322 |
* |
| 323 |
* |
| 324 |
* |
| 325 |
* udate - mail message date in Unix time |
| 326 |
* |
| 327 |
* |
| 328 |
* |
| 329 |
* |
| 330 |
* fetchfrom - from line formatted to fit fromlength |
| 331 |
* characters |
| 332 |
* |
| 333 |
* |
| 334 |
* |
| 335 |
* |
| 336 |
* fetchsubject - subject line formatted to fit |
| 337 |
* subjectlength characters |
| 338 |
*/ |
| 339 |
function imap_headerinfo ($imap_stream, $msg_number, $fromlength = null, $subjectlength = null, $defaulthost = null) {} |
| 340 |
|
| 341 |
/** |
| 342 |
* Parse mail headers from a string |
| 343 |
* @link http://www.php.net/manual/en/function.imap-rfc822-parse-headers.php |
| 344 |
* @param headers string <p> |
| 345 |
* The parsed headers data |
| 346 |
* </p> |
| 347 |
* @param defaulthost string[optional] <p> |
| 348 |
* The default host name |
| 349 |
* </p> |
| 350 |
* @return object an object similar to the one returned by |
| 351 |
* imap_header, except for the flags and other |
| 352 |
* properties that come from the IMAP server. |
| 353 |
*/ |
| 354 |
function imap_rfc822_parse_headers ($headers, $defaulthost = null) {} |
| 355 |
|
| 356 |
/** |
| 357 |
* Returns a properly formatted email address given the mailbox, host, and personal info |
| 358 |
* @link http://www.php.net/manual/en/function.imap-rfc822-write-address.php |
| 359 |
* @param mailbox string <p> |
| 360 |
* The mailbox name, see imap_open for more |
| 361 |
* information |
| 362 |
* </p> |
| 363 |
* @param host string <p> |
| 364 |
* The email host part |
| 365 |
* </p> |
| 366 |
* @param personal string <p> |
| 367 |
* The name of the account owner |
| 368 |
* </p> |
| 369 |
* @return string a string properly formatted email address as defined in RFC2822. |
| 370 |
*/ |
| 371 |
function imap_rfc822_write_address ($mailbox, $host, $personal) {} |
| 372 |
|
| 373 |
/** |
| 374 |
* Parses an address string |
| 375 |
* @link http://www.php.net/manual/en/function.imap-rfc822-parse-adrlist.php |
| 376 |
* @param address string <p> |
| 377 |
* A string containing addresses |
| 378 |
* </p> |
| 379 |
* @param default_host string <p> |
| 380 |
* The default host name |
| 381 |
* </p> |
| 382 |
* @return array an array of objects. The objects properties are: |
| 383 |
* </p> |
| 384 |
* <p> |
| 385 |
* |
| 386 |
* |
| 387 |
* |
| 388 |
* mailbox - the mailbox name (username) |
| 389 |
* |
| 390 |
* |
| 391 |
* |
| 392 |
* |
| 393 |
* host - the host name |
| 394 |
* |
| 395 |
* |
| 396 |
* |
| 397 |
* |
| 398 |
* personal - the personal name |
| 399 |
* |
| 400 |
* |
| 401 |
* |
| 402 |
* |
| 403 |
* adl - at domain source route |
| 404 |
*/ |
| 405 |
function imap_rfc822_parse_adrlist ($address, $default_host) {} |
| 406 |
|
| 407 |
/** |
| 408 |
* Read the message body |
| 409 |
* @link http://www.php.net/manual/en/function.imap-body.php |
| 410 |
* @param imap_stream resource |
| 411 |
* @param msg_number int <p> |
| 412 |
* The message number |
| 413 |
* </p> |
| 414 |
* @param options int[optional] <p> |
| 415 |
* The optional options are a bit mask |
| 416 |
* with one or more of the following: |
| 417 |
* |
| 418 |
* |
| 419 |
* |
| 420 |
* FT_UID - The msg_number is a UID |
| 421 |
* @return string the body of the specified message, as a string. |
| 422 |
*/ |
| 423 |
function imap_body ($imap_stream, $msg_number, $options = null) {} |
| 424 |
|
| 425 |
/** |
| 426 |
* Read the structure of a specified body section of a specific message |
| 427 |
* @link http://www.php.net/manual/en/function.imap-bodystruct.php |
| 428 |
* @param imap_stream resource |
| 429 |
* @param msg_number int <p> |
| 430 |
* The message number |
| 431 |
* </p> |
| 432 |
* @param section string <p> |
| 433 |
* The body section to read |
| 434 |
* </p> |
| 435 |
* @return object the information in an object, for a detailed description |
| 436 |
* of the object structure and properties see |
| 437 |
* imap_fetchstructure. |
| 438 |
*/ |
| 439 |
function imap_bodystruct ($imap_stream, $msg_number, $section) {} |
| 440 |
|
| 441 |
/** |
| 442 |
* Fetch a particular section of the body of the message |
| 443 |
* @link http://www.php.net/manual/en/function.imap-fetchbody.php |
| 444 |
* @param imap_stream resource |
| 445 |
* @param msg_number int <p> |
| 446 |
* The message number |
| 447 |
* </p> |
| 448 |
* @param section string <p> |
| 449 |
* The part number. It is a string of integers delimited by period which |
| 450 |
* index into a body part list as per the IMAP4 specification |
| 451 |
* </p> |
| 452 |
* @param options int[optional] <p> |
| 453 |
* A bitmask with one or more of the following: |
| 454 |
* |
| 455 |
* |
| 456 |
* |
| 457 |
* FT_UID - The msg_number is a UID |
| 458 |
* @return string a particular section of the body of the specified messages as a |
| 459 |
* text string. |
| 460 |
*/ |
| 461 |
function imap_fetchbody ($imap_stream, $msg_number, $section, $options = null) {} |
| 462 |
|
| 463 |
/** |
| 464 |
* Fetch MIME headers for a particular section of the message |
| 465 |
* @link http://www.php.net/manual/en/function.imap-fetchmime.php |
| 466 |
* @param imap_stream resource |
| 467 |
* @param msg_number int <p> |
| 468 |
* The message number |
| 469 |
* </p> |
| 470 |
* @param section string <p> |
| 471 |
* The part number. It is a string of integers delimited by period which |
| 472 |
* index into a body part list as per the IMAP4 specification |
| 473 |
* </p> |
| 474 |
* @param options int[optional] <p> |
| 475 |
* A bitmask with one or more of the following: |
| 476 |
* |
| 477 |
* |
| 478 |
* |
| 479 |
* FT_UID - The msg_number is a UID |
| 480 |
* @return string the MIME headers of a particular section of the body of the specified messages as a |
| 481 |
* text string. |
| 482 |
*/ |
| 483 |
function imap_fetchmime ($imap_stream, $msg_number, $section, $options = null) {} |
| 484 |
|
| 485 |
/** |
| 486 |
* Save a specific body section to a file |
| 487 |
* @link http://www.php.net/manual/en/function.imap-savebody.php |
| 488 |
* @param imap_stream resource |
| 489 |
* @param file mixed <p> |
| 490 |
* The path to the saved file as a string, or a valid file descriptor |
| 491 |
* returned by fopen. |
| 492 |
* </p> |
| 493 |
* @param msg_number int <p> |
| 494 |
* The message number |
| 495 |
* </p> |
| 496 |
* @param part_number string[optional] <p> |
| 497 |
* The part number. It is a string of integers delimited by period which |
| 498 |
* index into a body part list as per the IMAP4 specification |
| 499 |
* </p> |
| 500 |
* @param options int[optional] <p> |
| 501 |
* A bitmask with one or more of the following: |
| 502 |
* |
| 503 |
* |
| 504 |
* |
| 505 |
* FT_UID - The msg_number is a UID |
| 506 |
* @return bool Returns true on success, false on failure. |
| 507 |
*/ |
| 508 |
function imap_savebody ($imap_stream, $file, $msg_number, $part_number = null, $options = null) {} |
| 509 |
|
| 510 |
/** |
| 511 |
* Returns header for a message |
| 512 |
* @link http://www.php.net/manual/en/function.imap-fetchheader.php |
| 513 |
* @param imap_stream resource |
| 514 |
* @param msg_number int <p> |
| 515 |
* The message number |
| 516 |
* </p> |
| 517 |
* @param options int[optional] <p> |
| 518 |
* The possible options are: |
| 519 |
* |
| 520 |
* |
| 521 |
* |
| 522 |
* FT_UID - The msgno |
| 523 |
* argument is a UID |
| 524 |
* @return string the header of the specified message as a text string. |
| 525 |
*/ |
| 526 |
function imap_fetchheader ($imap_stream, $msg_number, $options = null) {} |
| 527 |
|
| 528 |
/** |
| 529 |
* Read the structure of a particular message |
| 530 |
* @link http://www.php.net/manual/en/function.imap-fetchstructure.php |
| 531 |
* @param imap_stream resource |
| 532 |
* @param msg_number int <p> |
| 533 |
* The message number |
| 534 |
* </p> |
| 535 |
* @param options int[optional] <p> |
| 536 |
* This optional parameter only has a single option, |
| 537 |
* FT_UID, which tells the function to treat the |
| 538 |
* msg_number argument as a |
| 539 |
* UID. |
| 540 |
* </p> |
| 541 |
* @return object an object includes the envelope, internal date, size, flags and |
| 542 |
* body structure along with a similar object for each mime attachment. The |
| 543 |
* structure of the returned objects is as follows: |
| 544 |
* </p> |
| 545 |
* <p> |
| 546 |
* <table> |
| 547 |
* |
| 548 |
* Returned Objects for imap_fetchstructure |
| 549 |
* |
| 550 |
* |
| 551 |
* |
| 552 |
* <tr valign="top"> |
| 553 |
* <td>type</td> |
| 554 |
* <td>Primary body type</td> |
| 555 |
* </tr> |
| 556 |
* <tr valign="top"> |
| 557 |
* <td>encoding</td> |
| 558 |
* <td>Body transfer encoding</td> |
| 559 |
* </tr> |
| 560 |
* <tr valign="top"> |
| 561 |
* <td>ifsubtype</td> |
| 562 |
* <td>true if there is a subtype string</td> |
| 563 |
* </tr> |
| 564 |
* <tr valign="top"> |
| 565 |
* <td>subtype</td> |
| 566 |
* <td>MIME subtype</td> |
| 567 |
* </tr> |
| 568 |
* <tr valign="top"> |
| 569 |
* <td>ifdescription</td> |
| 570 |
* <td>true if there is a description string</td> |
| 571 |
* </tr> |
| 572 |
* <tr valign="top"> |
| 573 |
* <td>description</td> |
| 574 |
* <td>Content description string</td> |
| 575 |
* </tr> |
| 576 |
* <tr valign="top"> |
| 577 |
* <td>ifid</td> |
| 578 |
* <td>true if there is an identification string</td> |
| 579 |
* </tr> |
| 580 |
* <tr valign="top"> |
| 581 |
* <td>id</td> |
| 582 |
* <td>Identification string</td> |
| 583 |
* </tr> |
| 584 |
* <tr valign="top"> |
| 585 |
* <td>lines</td> |
| 586 |
* <td>Number of lines</td> |
| 587 |
* </tr> |
| 588 |
* <tr valign="top"> |
| 589 |
* <td>bytes</td> |
| 590 |
* <td>Number of bytes</td> |
| 591 |
* </tr> |
| 592 |
* <tr valign="top"> |
| 593 |
* <td>ifdisposition</td> |
| 594 |
* <td>true if there is a disposition string</td> |
| 595 |
* </tr> |
| 596 |
* <tr valign="top"> |
| 597 |
* <td>disposition</td> |
| 598 |
* <td>Disposition string</td> |
| 599 |
* </tr> |
| 600 |
* <tr valign="top"> |
| 601 |
* <td>ifdparameters</td> |
| 602 |
* <td>true if the dparameters array exists</td> |
| 603 |
* </tr> |
| 604 |
* <tr valign="top"> |
| 605 |
* <td>dparameters</td> |
| 606 |
* <td>An array of objects where each object has an |
| 607 |
* "attribute" and a "value" |
| 608 |
* property corresponding to the parameters on the |
| 609 |
* Content-disposition MIME |
| 610 |
* header.</td> |
| 611 |
* </tr> |
| 612 |
* <tr valign="top"> |
| 613 |
* <td>ifparameters</td> |
| 614 |
* <td>true if the parameters array exists</td> |
| 615 |
* </tr> |
| 616 |
* <tr valign="top"> |
| 617 |
* <td>parameters</td> |
| 618 |
* <td>An array of objects where each object has an |
| 619 |
* "attribute" and a "value" |
| 620 |
* property.</td> |
| 621 |
* </tr> |
| 622 |
* <tr valign="top"> |
| 623 |
* <td>parts</td> |
| 624 |
* <td>An array of objects identical in structure to the top-level |
| 625 |
* object, each of which corresponds to a MIME body |
| 626 |
* part.</td> |
| 627 |
* </tr> |
| 628 |
* |
| 629 |
* |
| 630 |
* </table> |
| 631 |
* </p> |
| 632 |
* <p> |
| 633 |
* <table> |
| 634 |
* Primary body type (may vary with used library) |
| 635 |
* |
| 636 |
* |
| 637 |
* <tr valign="top"><td>0</td><td>text</td></tr> |
| 638 |
* <tr valign="top"><td>1</td><td>multipart</td></tr> |
| 639 |
* <tr valign="top"><td>2</td><td>message</td></tr> |
| 640 |
* <tr valign="top"><td>3</td><td>application</td></tr> |
| 641 |
* <tr valign="top"><td>4</td><td>audio</td></tr> |
| 642 |
* <tr valign="top"><td>5</td><td>image</td></tr> |
| 643 |
* <tr valign="top"><td>6</td><td>video</td></tr> |
| 644 |
* <tr valign="top"><td>7</td><td>other</td></tr> |
| 645 |
* |
| 646 |
* |
| 647 |
* </table> |
| 648 |
* </p> |
| 649 |
* <p> |
| 650 |
* <table> |
| 651 |
* Transfer encodings (may vary with used library) |
| 652 |
* |
| 653 |
* |
| 654 |
* <tr valign="top"><td>0</td><td>7BIT</td></tr> |
| 655 |
* <tr valign="top"><td>1</td><td>8BIT</td></tr> |
| 656 |
* <tr valign="top"><td>2</td><td>BINARY</td></tr> |
| 657 |
* <tr valign="top"><td>3</td><td>BASE64</td></tr> |
| 658 |
* <tr valign="top"><td>4</td><td>QUOTED-PRINTABLE</td></tr> |
| 659 |
* <tr valign="top"><td>5</td><td>OTHER</td></tr> |
| 660 |
* |
| 661 |
* |
| 662 |
* </table> |
| 663 |
*/ |
| 664 |
function imap_fetchstructure ($imap_stream, $msg_number, $options = null) {} |
| 665 |
|
| 666 |
/** |
| 667 |
* Clears IMAP cache |
| 668 |
* @link http://www.php.net/manual/en/function.imap-gc.php |
| 669 |
* @param imap_stream resource |
| 670 |
* @param caches int <p> |
| 671 |
* Specifies the cache to purge. It may one or a combination |
| 672 |
* of the following constants: |
| 673 |
* IMAP_GC_ELT (message cache elements), |
| 674 |
* IMAP_GC_ENV (enveloppe and bodies), |
| 675 |
* IMAP_GC_TEXTS (texts). |
| 676 |
* </p> |
| 677 |
* @return bool Returns true on success, false on failure. |
| 678 |
*/ |
| 679 |
function imap_gc ($imap_stream, $caches) {} |
| 680 |
|
| 681 |
/** |
| 682 |
* Delete all messages marked for deletion |
| 683 |
* @link http://www.php.net/manual/en/function.imap-expunge.php |
| 684 |
* @param imap_stream resource |
| 685 |
* @return bool true. |
| 686 |
*/ |
| 687 |
function imap_expunge ($imap_stream) {} |
| 688 |
|
| 689 |
/** |
| 690 |
* Mark a message for deletion from current mailbox |
| 691 |
* @link http://www.php.net/manual/en/function.imap-delete.php |
| 692 |
* @param imap_stream resource |
| 693 |
* @param msg_number int <p> |
| 694 |
* The message number |
| 695 |
* </p> |
| 696 |
* @param options int[optional] <p> |
| 697 |
* You can set the FT_UID which tells the function |
| 698 |
* to treat the msg_number argument as an |
| 699 |
* UID. |
| 700 |
* </p> |
| 701 |
* @return bool true. |
| 702 |
*/ |
| 703 |
function imap_delete ($imap_stream, $msg_number, $options = null) {} |
| 704 |
|
| 705 |
/** |
| 706 |
* Unmark the message which is marked deleted |
| 707 |
* @link http://www.php.net/manual/en/function.imap-undelete.php |
| 708 |
* @param imap_stream resource |
| 709 |
* @param msg_number int <p> |
| 710 |
* The message number |
| 711 |
* </p> |
| 712 |
* @param flags int[optional] <p> |
| 713 |
* </p> |
| 714 |
* @return bool Returns true on success, false on failure. |
| 715 |
*/ |
| 716 |
function imap_undelete ($imap_stream, $msg_number, $flags = null) {} |
| 717 |
|
| 718 |
/** |
| 719 |
* Check current mailbox |
| 720 |
* @link http://www.php.net/manual/en/function.imap-check.php |
| 721 |
* @param imap_stream resource |
| 722 |
* @return object the information in an object with following properties: |
| 723 |
* |
| 724 |
* |
| 725 |
* |
| 726 |
* Date - current system time formatted according to RFC2822 |
| 727 |
* |
| 728 |
* |
| 729 |
* |
| 730 |
* |
| 731 |
* Driver - protocol used to access this mailbox: |
| 732 |
* POP3, IMAP, NNTP |
| 733 |
* |
| 734 |
* |
| 735 |
* |
| 736 |
* |
| 737 |
* Mailbox - the mailbox name |
| 738 |
* |
| 739 |
* |
| 740 |
* |
| 741 |
* |
| 742 |
* Nmsgs - number of messages in the mailbox |
| 743 |
* |
| 744 |
* |
| 745 |
* |
| 746 |
* |
| 747 |
* Recent - number of recent messages in the mailbox |
| 748 |
* |
| 749 |
* |
| 750 |
* |
| 751 |
* </p> |
| 752 |
* <p> |
| 753 |
* Returns false on failure. |
| 754 |
*/ |
| 755 |
function imap_check ($imap_stream) {} |
| 756 |
|
| 757 |
/** |
| 758 |
* Returns the list of mailboxes that matches the given text |
| 759 |
* @link http://www.php.net/manual/en/function.imap-listscan.php |
| 760 |
* @param imap_stream resource |
| 761 |
* @param ref string <p> |
| 762 |
* ref should normally be just the server |
| 763 |
* specification as described in imap_open |
| 764 |
* </p> |
| 765 |
* @param pattern string &imap.pattern; |
| 766 |
* @param content string <p> |
| 767 |
* The searched string |
| 768 |
* </p> |
| 769 |
* @return array an array containing the names of the mailboxes that have |
| 770 |
* content in the text of the mailbox. |
| 771 |
*/ |
| 772 |
function imap_listscan ($imap_stream, $ref, $pattern, $content) {} |
| 773 |
|
| 774 |
/** |
| 775 |
* Copy specified messages to a mailbox |
| 776 |
* @link http://www.php.net/manual/en/function.imap-mail-copy.php |
| 777 |
* @param imap_stream resource |
| 778 |
* @param msglist string <p> |
| 779 |
* msglist is a range not just message |
| 780 |
* numbers (as described in RFC2060). |
| 781 |
* </p> |
| 782 |
* @param mailbox string <p> |
| 783 |
* The mailbox name, see imap_open for more |
| 784 |
* information |
| 785 |
* </p> |
| 786 |
* @param options int[optional] <p> |
| 787 |
* options is a bitmask of one or more of |
| 788 |
* |
| 789 |
* |
| 790 |
* |
| 791 |
* CP_UID - the sequence numbers contain UIDS |
| 792 |
* @return bool Returns true on success, false on failure. |
| 793 |
*/ |
| 794 |
function imap_mail_copy ($imap_stream, $msglist, $mailbox, $options = null) {} |
| 795 |
|
| 796 |
/** |
| 797 |
* Move specified messages to a mailbox |
| 798 |
* @link http://www.php.net/manual/en/function.imap-mail-move.php |
| 799 |
* @param imap_stream resource |
| 800 |
* @param msglist string <p> |
| 801 |
* msglist is a range not just message numbers |
| 802 |
* (as described in RFC2060). |
| 803 |
* </p> |
| 804 |
* @param mailbox string <p> |
| 805 |
* The mailbox name, see imap_open for more |
| 806 |
* information |
| 807 |
* </p> |
| 808 |
* @param options int[optional] <p> |
| 809 |
* options is a bitmask and may contain the single option: |
| 810 |
* |
| 811 |
* |
| 812 |
* |
| 813 |
* CP_UID - the sequence numbers contain UIDS |
| 814 |
* @return bool Returns true on success, false on failure. |
| 815 |
*/ |
| 816 |
function imap_mail_move ($imap_stream, $msglist, $mailbox, $options = null) {} |
| 817 |
|
| 818 |
/** |
| 819 |
* Create a MIME message based on given envelope and body sections |
| 820 |
* @link http://www.php.net/manual/en/function.imap-mail-compose.php |
| 821 |
* @param envelope array <p> |
| 822 |
* An associative array of headers fields. Valid keys are: "remail", |
| 823 |
* "return_path", "date", "from", "reply_to", "in_reply_to", "subject", |
| 824 |
* "to", "cc", "bcc", "message_id" and "custom_headers" (which contains |
| 825 |
* associative array of other headers). |
| 826 |
* </p> |
| 827 |
* @param body array <p> |
| 828 |
* An indexed array of bodies |
| 829 |
* </p> |
| 830 |
* <p> |
| 831 |
* A body is an associative array which can consist of the following keys: |
| 832 |
* "type", "encoding", "charset", "type.parameters", "subtype", "id", |
| 833 |
* "description", "disposition.type", "disposition", "contents.data", |
| 834 |
* "lines", "bytes" and "md5". |
| 835 |
* </p> |
| 836 |
* @return string the MIME message. |
| 837 |
*/ |
| 838 |
function imap_mail_compose (array $envelope, array $body) {} |
| 839 |
|
| 840 |
/** |
| 841 |
* Create a new mailbox |
| 842 |
* @link http://www.php.net/manual/en/function.imap-createmailbox.php |
| 843 |
* @param imap_stream resource |
| 844 |
* @param mailbox string <p> |
| 845 |
* The mailbox name, see imap_open for more |
| 846 |
* information. Names containing international characters should be |
| 847 |
* encoded by imap_utf7_encode |
| 848 |
* </p> |
| 849 |
* @return bool Returns true on success, false on failure. |
| 850 |
*/ |
| 851 |
function imap_createmailbox ($imap_stream, $mailbox) {} |
| 852 |
|
| 853 |
/** |
| 854 |
* Rename an old mailbox to new mailbox |
| 855 |
* @link http://www.php.net/manual/en/function.imap-renamemailbox.php |
| 856 |
* @param imap_stream resource |
| 857 |
* @param old_mbox string <p> |
| 858 |
* The old mailbox name, see imap_open for more |
| 859 |
* information |
| 860 |
* </p> |
| 861 |
* @param new_mbox string <p> |
| 862 |
* The new mailbox name, see imap_open for more |
| 863 |
* information |
| 864 |
* </p> |
| 865 |
* @return bool Returns true on success, false on failure. |
| 866 |
*/ |
| 867 |
function imap_renamemailbox ($imap_stream, $old_mbox, $new_mbox) {} |
| 868 |
|
| 869 |
/** |
| 870 |
* Delete a mailbox |
| 871 |
* @link http://www.php.net/manual/en/function.imap-deletemailbox.php |
| 872 |
* @param imap_stream resource |
| 873 |
* @param mailbox string <p> |
| 874 |
* The mailbox name, see imap_open for more |
| 875 |
* information |
| 876 |
* </p> |
| 877 |
* @return bool Returns true on success, false on failure. |
| 878 |
*/ |
| 879 |
function imap_deletemailbox ($imap_stream, $mailbox) {} |
| 880 |
|
| 881 |
/** |
| 882 |
* Subscribe to a mailbox |
| 883 |
* @link http://www.php.net/manual/en/function.imap-subscribe.php |
| 884 |
* @param imap_stream resource |
| 885 |
* @param mailbox string <p> |
| 886 |
* The mailbox name, see imap_open for more |
| 887 |
* information |
| 888 |
* </p> |
| 889 |
* @return bool Returns true on success, false on failure. |
| 890 |
*/ |
| 891 |
function imap_subscribe ($imap_stream, $mailbox) {} |
| 892 |
|
| 893 |
/** |
| 894 |
* Unsubscribe from a mailbox |
| 895 |
* @link http://www.php.net/manual/en/function.imap-unsubscribe.php |
| 896 |
* @param imap_stream resource |
| 897 |
* @param mailbox string <p> |
| 898 |
* The mailbox name, see imap_open for more |
| 899 |
* information |
| 900 |
* </p> |
| 901 |
* @return bool Returns true on success, false on failure. |
| 902 |
*/ |
| 903 |
function imap_unsubscribe ($imap_stream, $mailbox) {} |
| 904 |
|
| 905 |
/** |
| 906 |
* Append a string message to a specified mailbox |
| 907 |
* @link http://www.php.net/manual/en/function.imap-append.php |
| 908 |
* @param imap_stream resource |
| 909 |
* @param mailbox string <p> |
| 910 |
* The mailbox name, see imap_open for more |
| 911 |
* information |
| 912 |
* </p> |
| 913 |
* @param message string <p> |
| 914 |
* The message to be append, as a string |
| 915 |
* </p> |
| 916 |
* <p> |
| 917 |
* When talking to the Cyrus IMAP server, you must use "\r\n" as |
| 918 |
* your end-of-line terminator instead of "\n" or the operation will |
| 919 |
* fail |
| 920 |
* </p> |
| 921 |
* @param options string[optional] <p> |
| 922 |
* If provided, the options will also be written |
| 923 |
* to the mailbox |
| 924 |
* </p> |
| 925 |
* @param internal_date string[optional] <p> |
| 926 |
* If this parameter is set, it will set the INTERNALDATE on the appended message. The parameter should be a date string that conforms to the rfc2060 specifications for a date_time value. |
| 927 |
* </p> |
| 928 |
* @return bool Returns true on success, false on failure. |
| 929 |
*/ |
| 930 |
function imap_append ($imap_stream, $mailbox, $message, $options = null, $internal_date = null) {} |
| 931 |
|
| 932 |
/** |
| 933 |
* Check if the IMAP stream is still active |
| 934 |
* @link http://www.php.net/manual/en/function.imap-ping.php |
| 935 |
* @param imap_stream resource |
| 936 |
* @return bool true if the stream is still alive, false otherwise. |
| 937 |
*/ |
| 938 |
function imap_ping ($imap_stream) {} |
| 939 |
|
| 940 |
/** |
| 941 |
* Decode BASE64 encoded text |
| 942 |
* @link http://www.php.net/manual/en/function.imap-base64.php |
| 943 |
* @param text string <p> |
| 944 |
* The encoded text |
| 945 |
* </p> |
| 946 |
* @return string the decoded message as a string. |
| 947 |
*/ |
| 948 |
function imap_base64 ($text) {} |
| 949 |
|
| 950 |
/** |
| 951 |
* Convert a quoted-printable string to an 8 bit string |
| 952 |
* @link http://www.php.net/manual/en/function.imap-qprint.php |
| 953 |
* @param string string <p> |
| 954 |
* A quoted-printable string |
| 955 |
* </p> |
| 956 |
* @return string an 8 bits string. |
| 957 |
*/ |
| 958 |
function imap_qprint ($string) {} |
| 959 |
|
| 960 |
/** |
| 961 |
* Convert an 8bit string to a quoted-printable string |
| 962 |
* @link http://www.php.net/manual/en/function.imap-8bit.php |
| 963 |
* @param string string <p> |
| 964 |
* The 8bit string to convert |
| 965 |
* </p> |
| 966 |
* @return string a quoted-printable string. |
| 967 |
*/ |
| 968 |
function imap_8bit ($string) {} |
| 969 |
|
| 970 |
/** |
| 971 |
* Convert an 8bit string to a base64 string |
| 972 |
* @link http://www.php.net/manual/en/function.imap-binary.php |
| 973 |
* @param string string <p> |
| 974 |
* The 8bit string |
| 975 |
* </p> |
| 976 |
* @return string a base64 encoded string. |
| 977 |
*/ |
| 978 |
function imap_binary ($string) {} |
| 979 |
|
| 980 |
/** |
| 981 |
* Converts MIME-encoded text to UTF-8 |
| 982 |
* @link http://www.php.net/manual/en/function.imap-utf8.php |
| 983 |
* @param mime_encoded_text string <p> |
| 984 |
* A MIME encoded string. MIME encoding method and the UTF-8 |
| 985 |
* specification are described in RFC2047 and RFC2044 respectively. |
| 986 |
* </p> |
| 987 |
* @return string an UTF-8 encoded string. |
| 988 |
*/ |
| 989 |
function imap_utf8 ($mime_encoded_text) {} |
| 990 |
|
| 991 |
/** |
| 992 |
* Returns status information on a mailbox |
| 993 |
* @link http://www.php.net/manual/en/function.imap-status.php |
| 994 |
* @param imap_stream resource |
| 995 |
* @param mailbox string <p> |
| 996 |
* The mailbox name, see imap_open for more |
| 997 |
* information |
| 998 |
* </p> |
| 999 |
* @param options int <p> |
| 1000 |
* Valid flags are: |
| 1001 |
* |
| 1002 |
* |
| 1003 |
* |
| 1004 |
* SA_MESSAGES - set $status->messages to the |
| 1005 |
* number of messages in the mailbox |
| 1006 |
* @return object This function returns an object containing status information. |
| 1007 |
* The object has the following properties: messages, |
| 1008 |
* recent, unseen, |
| 1009 |
* uidnext, and uidvalidity. |
| 1010 |
* </p> |
| 1011 |
* <p> |
| 1012 |
* flags is also set, which contains a bitmask which can |
| 1013 |
* be checked against any of the above constants. |
| 1014 |
*/ |
| 1015 |
function imap_status ($imap_stream, $mailbox, $options) {} |
| 1016 |
|
| 1017 |
/** |
| 1018 |
* Get information about the current mailbox |
| 1019 |
* @link http://www.php.net/manual/en/function.imap-mailboxmsginfo.php |
| 1020 |
* @param imap_stream resource |
| 1021 |
* @return object the information in an object with following properties: |
| 1022 |
* <table> |
| 1023 |
* Mailbox properties |
| 1024 |
* |
| 1025 |
* |
| 1026 |
* <tr valign="top"> |
| 1027 |
* <td>Date</td> |
| 1028 |
* <td>date of last change (current datetime)</td> |
| 1029 |
* </tr> |
| 1030 |
* <tr valign="top"> |
| 1031 |
* <td>Driver</td> |
| 1032 |
* <td>driver</td> |
| 1033 |
* </tr> |
| 1034 |
* <tr valign="top"> |
| 1035 |
* <td>Mailbox</td> |
| 1036 |
* <td>name of the mailbox</td> |
| 1037 |
* </tr> |
| 1038 |
* <tr valign="top"> |
| 1039 |
* <td>Nmsgs</td> |
| 1040 |
* <td>number of messages</td> |
| 1041 |
* </tr> |
| 1042 |
* <tr valign="top"> |
| 1043 |
* <td>Recent</td> |
| 1044 |
* <td>number of recent messages</td> |
| 1045 |
* </tr> |
| 1046 |
* <tr valign="top"> |
| 1047 |
* <td>Unread</td> |
| 1048 |
* <td>number of unread messages</td> |
| 1049 |
* </tr> |
| 1050 |
* <tr valign="top"> |
| 1051 |
* <td>Deleted</td> |
| 1052 |
* <td>number of deleted messages</td> |
| 1053 |
* </tr> |
| 1054 |
* <tr valign="top"> |
| 1055 |
* <td>Size</td> |
| 1056 |
* <td>mailbox size</td> |
| 1057 |
* </tr> |
| 1058 |
* |
| 1059 |
* |
| 1060 |
* </table> |
| 1061 |
* </p> |
| 1062 |
* <p> |
| 1063 |
* Returns false on failure. |
| 1064 |
*/ |
| 1065 |
function imap_mailboxmsginfo ($imap_stream) {} |
| 1066 |
|
| 1067 |
/** |
| 1068 |
* Sets flags on messages |
| 1069 |
* @link http://www.php.net/manual/en/function.imap-setflag-full.php |
| 1070 |
* @param imap_stream resource |
| 1071 |
* @param sequence string <p> |
| 1072 |
* A sequence of message numbers. You can enumerate desired messages |
| 1073 |
* with the X,Y syntax, or retrieve all messages |
| 1074 |
* within an interval with the X:Y syntax |
| 1075 |
* </p> |
| 1076 |
* @param flag string <p> |
| 1077 |
* The flags which you can set are \Seen, |
| 1078 |
* \Answered, \Flagged, |
| 1079 |
* \Deleted, and \Draft as |
| 1080 |
* defined by RFC2060. |
| 1081 |
* </p> |
| 1082 |
* @param options int[optional] <p> |
| 1083 |
* A bit mask that may contain the single option: |
| 1084 |
* |
| 1085 |
* |
| 1086 |
* |
| 1087 |
* ST_UID - The sequence argument contains UIDs |
| 1088 |
* instead of sequence numbers |
| 1089 |
* @return bool Returns true on success, false on failure. |
| 1090 |
*/ |
| 1091 |
function imap_setflag_full ($imap_stream, $sequence, $flag, $options = null) {} |
| 1092 |
|
| 1093 |
/** |
| 1094 |
* Clears flags on messages |
| 1095 |
* @link http://www.php.net/manual/en/function.imap-clearflag-full.php |
| 1096 |
* @param imap_stream resource |
| 1097 |
* @param sequence string <p> |
| 1098 |
* A sequence of message numbers. You can enumerate desired messages |
| 1099 |
* with the X,Y syntax, or retrieve all messages |
| 1100 |
* within an interval with the X:Y syntax |
| 1101 |
* </p> |
| 1102 |
* @param flag string <p> |
| 1103 |
* The flags which you can unset are "\\Seen", "\\Answered", "\\Flagged", |
| 1104 |
* "\\Deleted", and "\\Draft" (as defined by RFC2060) |
| 1105 |
* </p> |
| 1106 |
* @param options int[optional] <p> |
| 1107 |
* options are a bit mask and may contain |
| 1108 |
* the single option: |
| 1109 |
* |
| 1110 |
* |
| 1111 |
* |
| 1112 |
* ST_UID - The sequence argument contains UIDs |
| 1113 |
* instead of sequence numbers |
| 1114 |
* @return bool Returns true on success, false on failure. |
| 1115 |
*/ |
| 1116 |
function imap_clearflag_full ($imap_stream, $sequence, $flag, $options = null) {} |
| 1117 |
|
| 1118 |
/** |
| 1119 |
* Gets and sort messages |
| 1120 |
* @link http://www.php.net/manual/en/function.imap-sort.php |
| 1121 |
* @param imap_stream resource |
| 1122 |
* @param criteria int <p> |
| 1123 |
* Criteria can be one (and only one) of the following: |
| 1124 |
* |
| 1125 |
* |
| 1126 |
* |
| 1127 |
* SORTDATE - message Date |
| 1128 |
* @param reverse int <p> |
| 1129 |
* Set this to 1 for reverse sorting |
| 1130 |
* </p> |
| 1131 |
* @param options int[optional] <p> |
| 1132 |
* The options are a bitmask of one or more of the |
| 1133 |
* following: |
| 1134 |
* |
| 1135 |
* |
| 1136 |
* |
| 1137 |
* SE_UID - Return UIDs instead of sequence numbers |
| 1138 |
* @param search_criteria string[optional] <p> |
| 1139 |
* </p> |
| 1140 |
* @param charset string[optional] <p> |
| 1141 |
* </p> |
| 1142 |
* @return array an array of message numbers sorted by the given |
| 1143 |
* parameters. |
| 1144 |
*/ |
| 1145 |
function imap_sort ($imap_stream, $criteria, $reverse, $options = null, $search_criteria = null, $charset = null) {} |
| 1146 |
|
| 1147 |
/** |
| 1148 |
* This function returns the UID for the given message sequence number |
| 1149 |
* @link http://www.php.net/manual/en/function.imap-uid.php |
| 1150 |
* @param imap_stream resource |
| 1151 |
* @param msg_number int <p> |
| 1152 |
* The message number. |
| 1153 |
* </p> |
| 1154 |
* @return int The UID of the given message. |
| 1155 |
*/ |
| 1156 |
function imap_uid ($imap_stream, $msg_number) {} |
| 1157 |
|
| 1158 |
/** |
| 1159 |
* Gets the message sequence number for the given UID |
| 1160 |
* @link http://www.php.net/manual/en/function.imap-msgno.php |
| 1161 |
* @param imap_stream resource |
| 1162 |
* @param uid int <p> |
| 1163 |
* The message UID |
| 1164 |
* </p> |
| 1165 |
* @return int the message sequence number for the given |
| 1166 |
* uid. |
| 1167 |
*/ |
| 1168 |
function imap_msgno ($imap_stream, $uid) {} |
| 1169 |
|
| 1170 |
/** |
| 1171 |
* Read the list of mailboxes |
| 1172 |
* @link http://www.php.net/manual/en/function.imap-list.php |
| 1173 |
* @param imap_stream resource |
| 1174 |
* @param ref string <p> |
| 1175 |
* ref should normally be just the server |
| 1176 |
* specification as described in imap_open. |
| 1177 |
* </p> |
| 1178 |
* @param pattern string &imap.pattern; |
| 1179 |
* @return array an array containing the names of the mailboxes. |
| 1180 |
*/ |
| 1181 |
function imap_list ($imap_stream, $ref, $pattern) {} |
| 1182 |
|
| 1183 |
/** |
| 1184 |
* List all the subscribed mailboxes |
| 1185 |
* @link http://www.php.net/manual/en/function.imap-lsub.php |
| 1186 |
* @param imap_stream resource |
| 1187 |
* @param ref string <p> |
| 1188 |
* ref should normally be just the server |
| 1189 |
* specification as described in imap_open |
| 1190 |
* </p> |
| 1191 |
* @param pattern string &imap.pattern; |
| 1192 |
* @return array an array of all the subscribed mailboxes. |
| 1193 |
*/ |
| 1194 |
function imap_lsub ($imap_stream, $ref, $pattern) {} |
| 1195 |
|
| 1196 |
/** |
| 1197 |
* Read an overview of the information in the headers of the given message |
| 1198 |
* @link http://www.php.net/manual/en/function.imap-fetch-overview.php |
| 1199 |
* @param imap_stream resource |
| 1200 |
* @param sequence string <p> |
| 1201 |
* A message sequence description. You can enumerate desired messages |
| 1202 |
* with the X,Y syntax, or retrieve all messages |
| 1203 |
* within an interval with the X:Y syntax |
| 1204 |
* </p> |
| 1205 |
* @param options int[optional] <p> |
| 1206 |
* sequence will contain a sequence of message |
| 1207 |
* indices or UIDs, if this parameter is set to |
| 1208 |
* FT_UID. |
| 1209 |
* </p> |
| 1210 |
* @return array an array of objects describing one message header each. |
| 1211 |
* The object will only define a property if it exists. The possible |
| 1212 |
* properties are: |
| 1213 |
* |
| 1214 |
* |
| 1215 |
* |
| 1216 |
* subject - the messages subject |
| 1217 |
* |
| 1218 |
* |
| 1219 |
* |
| 1220 |
* |
| 1221 |
* from - who sent it |
| 1222 |
* |
| 1223 |
* |
| 1224 |
* |
| 1225 |
* |
| 1226 |
* to - recipient |
| 1227 |
* |
| 1228 |
* |
| 1229 |
* |
| 1230 |
* |
| 1231 |
* date - when was it sent |
| 1232 |
* |
| 1233 |
* |
| 1234 |
* |
| 1235 |
* |
| 1236 |
* message_id - Message-ID |
| 1237 |
* |
| 1238 |
* |
| 1239 |
* |
| 1240 |
* |
| 1241 |
* references - is a reference to this message id |
| 1242 |
* |
| 1243 |
* |
| 1244 |
* |
| 1245 |
* |
| 1246 |
* in_reply_to - is a reply to this message id |
| 1247 |
* |
| 1248 |
* |
| 1249 |
* |
| 1250 |
* |
| 1251 |
* size - size in bytes |
| 1252 |
* |
| 1253 |
* |
| 1254 |
* |
| 1255 |
* |
| 1256 |
* uid - UID the message has in the mailbox |
| 1257 |
* |
| 1258 |
* |
| 1259 |
* |
| 1260 |
* |
| 1261 |
* msgno - message sequence number in the mailbox |
| 1262 |
* |
| 1263 |
* |
| 1264 |
* |
| 1265 |
* |
| 1266 |
* recent - this message is flagged as recent |
| 1267 |
* |
| 1268 |
* |
| 1269 |
* |
| 1270 |
* |
| 1271 |
* flagged - this message is flagged |
| 1272 |
* |
| 1273 |
* |
| 1274 |
* |
| 1275 |
* |
| 1276 |
* answered - this message is flagged as answered |
| 1277 |
* |
| 1278 |
* |
| 1279 |
* |
| 1280 |
* |
| 1281 |
* deleted - this message is flagged for deletion |
| 1282 |
* |
| 1283 |
* |
| 1284 |
* |
| 1285 |
* |
| 1286 |
* seen - this message is flagged as already read |
| 1287 |
* |
| 1288 |
* |
| 1289 |
* |
| 1290 |
* |
| 1291 |
* draft - this message is flagged as being a draft |
| 1292 |
*/ |
| 1293 |
function imap_fetch_overview ($imap_stream, $sequence, $options = null) {} |
| 1294 |
|
| 1295 |
/** |
| 1296 |
* Returns all IMAP alert messages that have occurred |
| 1297 |
* @link http://www.php.net/manual/en/function.imap-alerts.php |
| 1298 |
* @return array an array of all of the IMAP alert messages generated or false if |
| 1299 |
* no alert messages are available. |
| 1300 |
*/ |
| 1301 |
function imap_alerts () {} |
| 1302 |
|
| 1303 |
/** |
| 1304 |
* Returns all of the IMAP errors that have occurred |
| 1305 |
* @link http://www.php.net/manual/en/function.imap-errors.php |
| 1306 |
* @return array This function returns an array of all of the IMAP error messages |
| 1307 |
* generated since the last imap_errors call, |
| 1308 |
* or the beginning of the page. Returns false if no error messages are |
| 1309 |
* available. |
| 1310 |
*/ |
| 1311 |
function imap_errors () {} |
| 1312 |
|
| 1313 |
/** |
| 1314 |
* Gets the last IMAP error that occurred during this page request |
| 1315 |
* @link http://www.php.net/manual/en/function.imap-last-error.php |
| 1316 |
* @return string the full text of the last IMAP error message that occurred on the |
| 1317 |
* current page. Returns false if no error messages are available. |
| 1318 |
*/ |
| 1319 |
function imap_last_error () {} |
| 1320 |
|
| 1321 |
/** |
| 1322 |
* This function returns an array of messages matching the given search criteria |
| 1323 |
* @link http://www.php.net/manual/en/function.imap-search.php |
| 1324 |
* @param imap_stream resource |
| 1325 |
* @param criteria string <p> |
| 1326 |
* A string, delimited by spaces, in which the following keywords are |
| 1327 |
* allowed. Any multi-word arguments (e.g. |
| 1328 |
* FROM "joey smith") must be quoted. Results will match |
| 1329 |
* all criteria entries. |
| 1330 |
* |
| 1331 |
* |
| 1332 |
* |
| 1333 |
* ALL - return all messages matching the rest of the criteria |
| 1334 |
* @param options int[optional] <p> |
| 1335 |
* Valid values for options are |
| 1336 |
* SE_UID, which causes the returned array to |
| 1337 |
* contain UIDs instead of messages sequence numbers. |
| 1338 |
* </p> |
| 1339 |
* @param charset string[optional] <p> |
| 1340 |
* </p> |
| 1341 |
* @return array an array of message numbers or UIDs. |
| 1342 |
* </p> |
| 1343 |
* <p> |
| 1344 |
* Return false if it does not understand the search |
| 1345 |
* criteria or no messages have been found. |
| 1346 |
*/ |
| 1347 |
function imap_search ($imap_stream, $criteria, $options = null, $charset = null) {} |
| 1348 |
|
| 1349 |
/** |
| 1350 |
* Decodes a modified UTF-7 encoded string |
| 1351 |
* @link http://www.php.net/manual/en/function.imap-utf7-decode.php |
| 1352 |
* @param text string <p> |
| 1353 |
* A modified UTF-7 encoding string, as defined in RFC 2060, section 5.1.3 (original UTF-7 |
| 1354 |
* was defined in RFC1642). |
| 1355 |
* </p> |
| 1356 |
* @return string a string that is encoded in ISO-8859-1 and consists of the same |
| 1357 |
* sequence of characters in text, or false |
| 1358 |
* if text contains invalid modified UTF-7 sequence |
| 1359 |
* or text contains a character that is not part of |
| 1360 |
* ISO-8859-1 character set. |
| 1361 |
*/ |
| 1362 |
function imap_utf7_decode ($text) {} |
| 1363 |
|
| 1364 |
/** |
| 1365 |
* Converts ISO-8859-1 string to modified UTF-7 text |
| 1366 |
* @link http://www.php.net/manual/en/function.imap-utf7-encode.php |
| 1367 |
* @param data string <p> |
| 1368 |
* An ISO-8859-1 string. |
| 1369 |
* </p> |
| 1370 |
* @return string data encoded with the modified UTF-7 |
| 1371 |
* encoding as defined in RFC 2060, |
| 1372 |
* section 5.1.3 (original UTF-7 was defined in RFC1642). |
| 1373 |
*/ |
| 1374 |
function imap_utf7_encode ($data) {} |
| 1375 |
|
| 1376 |
/** |
| 1377 |
* Decode MIME header elements |
| 1378 |
* @link http://www.php.net/manual/en/function.imap-mime-header-decode.php |
| 1379 |
* @param text string <p> |
| 1380 |
* The MIME text |
| 1381 |
* </p> |
| 1382 |
* @return array The decoded elements are returned in an array of objects, where each |
| 1383 |
* object has two properties, charset and |
| 1384 |
* text. |
| 1385 |
* </p> |
| 1386 |
* <p> |
| 1387 |
* If the element hasn't been encoded, and in other words is in |
| 1388 |
* plain US-ASCII, the charset property of that element is |
| 1389 |
* set to default. |
| 1390 |
*/ |
| 1391 |
function imap_mime_header_decode ($text) {} |
| 1392 |
|
| 1393 |
/** |
| 1394 |
* Returns a tree of threaded message |
| 1395 |
* @link http://www.php.net/manual/en/function.imap-thread.php |
| 1396 |
* @param imap_stream resource |
| 1397 |
* @param options int[optional] <p> |
| 1398 |
* </p> |
| 1399 |
* @return array imap_thread returns an associative array containing |
| 1400 |
* a tree of messages threaded by REFERENCES, or false |
| 1401 |
* on error. |
| 1402 |
* </p> |
| 1403 |
* <p> |
| 1404 |
* Every message in the current mailbox will be represented by three entries |
| 1405 |
* in the resulting array: |
| 1406 |
* |
| 1407 |
* <p> |
| 1408 |
* $thread["XX.num"] - current message number |
| 1409 |
* </p> |
| 1410 |
* <p> |
| 1411 |
* $thread["XX.next"] |
| 1412 |
* </p> |
| 1413 |
* <p> |
| 1414 |
* $thread["XX.branch"] |
| 1415 |
* </p> |
| 1416 |
*/ |
| 1417 |
function imap_thread ($imap_stream, $options = null) {} |
| 1418 |
|
| 1419 |
/** |
| 1420 |
* Set or fetch imap timeout |
| 1421 |
* @link http://www.php.net/manual/en/function.imap-timeout.php |
| 1422 |
* @param timeout_type int <p> |
| 1423 |
* One of the following: |
| 1424 |
* IMAP_OPENTIMEOUT, |
| 1425 |
* IMAP_READTIMEOUT, |
| 1426 |
* IMAP_WRITETIMEOUT, or |
| 1427 |
* IMAP_CLOSETIMEOUT. |
| 1428 |
* </p> |
| 1429 |
* @param timeout int[optional] <p> |
| 1430 |
* The timeout, in seconds. |
| 1431 |
* </p> |
| 1432 |
* @return mixed If the timeout parameter is set, this function |
| 1433 |
* returns true on success and false on failure. |
| 1434 |
* </p> |
| 1435 |
* <p> |
| 1436 |
* If timeout is not provided or evaluates to -1, |
| 1437 |
* the current timeout value of timeout_type is |
| 1438 |
* returned as an integer. |
| 1439 |
*/ |
| 1440 |
function imap_timeout ($timeout_type, $timeout = null) {} |
| 1441 |
|
| 1442 |
/** |
| 1443 |
* Retrieve the quota level settings, and usage statics per mailbox |
| 1444 |
* @link http://www.php.net/manual/en/function.imap-get-quota.php |
| 1445 |
* @param imap_stream resource |
| 1446 |
* @param quota_root string <p> |
| 1447 |
* quota_root should normally be in the form of |
| 1448 |
* user.name where name is the mailbox you wish to |
| 1449 |
* retrieve information about. |
| 1450 |
* </p> |
| 1451 |
* @return array an array with integer values limit and usage for the given |
| 1452 |
* mailbox. The value of limit represents the total amount of space |
| 1453 |
* allowed for this mailbox. The usage value represents the mailboxes |
| 1454 |
* current level of capacity. Will return false in the case of failure. |
| 1455 |
* </p> |
| 1456 |
* <p> |
| 1457 |
* As of PHP 4.3, the function more properly reflects the |
| 1458 |
* functionality as dictated by the RFC2087. |
| 1459 |
* The array return value has changed to support an unlimited number of returned |
| 1460 |
* resources (i.e. messages, or sub-folders) with each named resource receiving |
| 1461 |
* an individual array key. Each key value then contains an another array with |
| 1462 |
* the usage and limit values within it. |
| 1463 |
* </p> |
| 1464 |
* <p> |
| 1465 |
* For backwards compatibility reasons, the original access methods are |
| 1466 |
* still available for use, although it is suggested to update. |
| 1467 |
*/ |
| 1468 |
function imap_get_quota ($imap_stream, $quota_root) {} |
| 1469 |
|
| 1470 |
/** |
| 1471 |
* Retrieve the quota settings per user |
| 1472 |
* @link http://www.php.net/manual/en/function.imap-get-quotaroot.php |
| 1473 |
* @param imap_stream resource |
| 1474 |
* @param quota_root string <p> |
| 1475 |
* quota_root should normally be in the form of |
| 1476 |
* which mailbox (i.e. INBOX). |
| 1477 |
* </p> |
| 1478 |
* @return array an array of integer values pertaining to the specified user |
| 1479 |
* mailbox. All values contain a key based upon the resource name, and a |
| 1480 |
* corresponding array with the usage and limit values within. |
| 1481 |
* </p> |
| 1482 |
* <p> |
| 1483 |
* This function will return false in the case of call failure, and an |
| 1484 |
* array of information about the connection upon an un-parsable response |
| 1485 |
* from the server. |
| 1486 |
*/ |
| 1487 |
function imap_get_quotaroot ($imap_stream, $quota_root) {} |
| 1488 |
|
| 1489 |
/** |
| 1490 |
* Sets a quota for a given mailbox |
| 1491 |
* @link http://www.php.net/manual/en/function.imap-set-quota.php |
| 1492 |
* @param imap_stream resource |
| 1493 |
* @param quota_root string <p> |
| 1494 |
* The mailbox to have a quota set. This should follow the IMAP standard |
| 1495 |
* format for a mailbox: user.name. |
| 1496 |
* </p> |
| 1497 |
* @param quota_limit int <p> |
| 1498 |
* The maximum size (in KB) for the quota_root |
| 1499 |
* </p> |
| 1500 |
* @return bool Returns true on success, false on failure. |
| 1501 |
*/ |
| 1502 |
function imap_set_quota ($imap_stream, $quota_root, $quota_limit) {} |
| 1503 |
|
| 1504 |
/** |
| 1505 |
* Sets the ACL for a given mailbox |
| 1506 |
* @link http://www.php.net/manual/en/function.imap-setacl.php |
| 1507 |
* @param imap_stream resource |
| 1508 |
* @param mailbox string <p> |
| 1509 |
* The mailbox name, see imap_open for more |
| 1510 |
* information |
| 1511 |
* </p> |
| 1512 |
* @param id string <p> |
| 1513 |
* The user to give the rights to. |
| 1514 |
* </p> |
| 1515 |
* @param rights string <p> |
| 1516 |
* The rights to give to the user. Passing an empty string will delete |
| 1517 |
* acl. |
| 1518 |
* </p> |
| 1519 |
* @return bool Returns true on success, false on failure. |
| 1520 |
*/ |
| 1521 |
function imap_setacl ($imap_stream, $mailbox, $id, $rights) {} |
| 1522 |
|
| 1523 |
/** |
| 1524 |
* Gets the ACL for a given mailbox |
| 1525 |
* @link http://www.php.net/manual/en/function.imap-getacl.php |
| 1526 |
* @param imap_stream resource |
| 1527 |
* @param mailbox string <p> |
| 1528 |
* The mailbox name, see imap_open for more |
| 1529 |
* information |
| 1530 |
* </p> |
| 1531 |
* @return array an associative array of "folder" => "acl" pairs. |
| 1532 |
*/ |
| 1533 |
function imap_getacl ($imap_stream, $mailbox) {} |
| 1534 |
|
| 1535 |
/** |
| 1536 |
* Send an email message |
| 1537 |
* @link http://www.php.net/manual/en/function.imap-mail.php |
| 1538 |
* @param to string <p> |
| 1539 |
* The receiver |
| 1540 |
* </p> |
| 1541 |
* @param subject string <p> |
| 1542 |
* The mail subject |
| 1543 |
* </p> |
| 1544 |
* @param message string <p> |
| 1545 |
* The mail body, see imap_mail_compose |
| 1546 |
* </p> |
| 1547 |
* @param additional_headers string[optional] <p> |
| 1548 |
* As string with additional headers to be set on the mail |
| 1549 |
* </p> |
| 1550 |
* @param cc string[optional] <p> |
| 1551 |
* </p> |
| 1552 |
* @param bcc string[optional] <p> |
| 1553 |
* The receivers specified in bcc will get the |
| 1554 |
* mail, but are excluded from the headers. |
| 1555 |
* </p> |
| 1556 |
* @param rpath string[optional] <p> |
| 1557 |
* Use this parameter to specify return path upon mail delivery failure. |
| 1558 |
* This is useful when using PHP as a mail client for multiple users. |
| 1559 |
* </p> |
| 1560 |
* @return bool Returns true on success, false on failure. |
| 1561 |
*/ |
| 1562 |
function imap_mail ($to, $subject, $message, $additional_headers = null, $cc = null, $bcc = null, $rpath = null) {} |
| 1563 |
|
| 1564 |
/** |
| 1565 |
* &Alias; <function>imap_headerinfo</function> |
| 1566 |
* @link http://www.php.net/manual/en/function.imap-header.php |
| 1567 |
* @param stream_id |
| 1568 |
* @param msg_no |
| 1569 |
* @param from_length[optional] |
| 1570 |
* @param subject_length[optional] |
| 1571 |
* @param default_host[optional] |
| 1572 |
*/ |
| 1573 |
function imap_header ($stream_id, $msg_no, $from_length, $subject_length, $default_host) {} |
| 1574 |
|
| 1575 |
/** |
| 1576 |
* &Alias; <function>imap_list</function> |
| 1577 |
* @link http://www.php.net/manual/en/function.imap-listmailbox.php |
| 1578 |
* @param stream_id |
| 1579 |
* @param ref |
| 1580 |
* @param pattern |
| 1581 |
*/ |
| 1582 |
function imap_listmailbox ($stream_id, $ref, $pattern) {} |
| 1583 |
|
| 1584 |
/** |
| 1585 |
* Read the list of mailboxes, returning detailed information on each one |
| 1586 |
* @link http://www.php.net/manual/en/function.imap-getmailboxes.php |
| 1587 |
* @param imap_stream resource |
| 1588 |
* @param ref string <p> |
| 1589 |
* ref should normally be just the server |
| 1590 |
* specification as described in imap_open |
| 1591 |
* </p> |
| 1592 |
* @param pattern string &imap.pattern; |
| 1593 |
* @return array an array of objects containing mailbox information. Each |
| 1594 |
* object has the attributes name, specifying |
| 1595 |
* the full name of the mailbox; delimiter, |
| 1596 |
* which is the hierarchy delimiter for the part of the hierarchy |
| 1597 |
* this mailbox is in; and |
| 1598 |
* attributes. Attributes |
| 1599 |
* is a bitmask that can be tested against: |
| 1600 |
* |
| 1601 |
* |
| 1602 |
* <p> |
| 1603 |
* LATT_NOINFERIORS - This mailbox contains, and may not contain any |
| 1604 |
* "children" (there are no mailboxes below this one). Calling |
| 1605 |
* imap_createmailbox will not work on this mailbox. |
| 1606 |
* </p> |
| 1607 |
* |
| 1608 |
* |
| 1609 |
* <p> |
| 1610 |
* LATT_NOSELECT - This is only a container, |
| 1611 |
* not a mailbox - you cannot open it. |
| 1612 |
* </p> |
| 1613 |
* |
| 1614 |
* |
| 1615 |
* <p> |
| 1616 |
* LATT_MARKED - This mailbox is marked. This means that it may |
| 1617 |
* contain new messages since the last time it was checked. Not provided by all IMAP |
| 1618 |
* servers. |
| 1619 |
* </p> |
| 1620 |
* |
| 1621 |
* |
| 1622 |
* <p> |
| 1623 |
* LATT_UNMARKED - This mailbox is not marked, does not contain new |
| 1624 |
* messages. If either MARKED or UNMARKED is |
| 1625 |
* provided, you can assume the IMAP server supports this feature for this mailbox. |
| 1626 |
* </p> |
| 1627 |
*/ |
| 1628 |
function imap_getmailboxes ($imap_stream, $ref, $pattern) {} |
| 1629 |
|
| 1630 |
/** |
| 1631 |
* &Alias; <function>imap_listscan</function> |
| 1632 |
* @link http://www.php.net/manual/en/function.imap-scanmailbox.php |
| 1633 |
* @param stream_id |
| 1634 |
* @param ref |
| 1635 |
* @param pattern |
| 1636 |
* @param content |
| 1637 |
*/ |
| 1638 |
function imap_scanmailbox ($stream_id, $ref, $pattern, $content) {} |
| 1639 |
|
| 1640 |
/** |
| 1641 |
* &Alias; <function>imap_lsub</function> |
| 1642 |
* @link http://www.php.net/manual/en/function.imap-listsubscribed.php |
| 1643 |
* @param stream_id |
| 1644 |
* @param ref |
| 1645 |
* @param pattern |
| 1646 |
*/ |
| 1647 |
function imap_listsubscribed ($stream_id, $ref, $pattern) {} |
| 1648 |
|
| 1649 |
/** |
| 1650 |
* List all the subscribed mailboxes |
| 1651 |
* @link http://www.php.net/manual/en/function.imap-getsubscribed.php |
| 1652 |
* @param imap_stream resource |
| 1653 |
* @param ref string <p> |
| 1654 |
* ref should normally be just the server |
| 1655 |
* specification as described in imap_open |
| 1656 |
* </p> |
| 1657 |
* @param pattern string &imap.pattern; |
| 1658 |
* @return array an array of objects containing mailbox information. Each |
| 1659 |
* object has the attributes name, specifying |
| 1660 |
* the full name of the mailbox; delimiter, |
| 1661 |
* which is the hierarchy delimiter for the part of the hierarchy |
| 1662 |
* this mailbox is in; and |
| 1663 |
* attributes. Attributes |
| 1664 |
* is a bitmask that can be tested against: |
| 1665 |
* |
| 1666 |
* |
| 1667 |
* |
| 1668 |
* LATT_NOINFERIORS - This mailbox has no |
| 1669 |
* "children" (there are no mailboxes below this one). |
| 1670 |
* |
| 1671 |
* |
| 1672 |
* |
| 1673 |
* |
| 1674 |
* LATT_NOSELECT - This is only a container, |
| 1675 |
* not a mailbox - you cannot open it. |
| 1676 |
* |
| 1677 |
* |
| 1678 |
* |
| 1679 |
* |
| 1680 |
* LATT_MARKED - This mailbox is marked. |
| 1681 |
* Only used by UW-IMAPD. |
| 1682 |
* |
| 1683 |
* |
| 1684 |
* |
| 1685 |
* |
| 1686 |
* LATT_UNMARKED - This mailbox is not marked. |
| 1687 |
* Only used by UW-IMAPD. |
| 1688 |
*/ |
| 1689 |
function imap_getsubscribed ($imap_stream, $ref, $pattern) {} |
| 1690 |
|
| 1691 |
/** |
| 1692 |
* &Alias; <function>imap_body</function> |
| 1693 |
* @link http://www.php.net/manual/en/function.imap-fetchtext.php |
| 1694 |
* @param stream_id |
| 1695 |
* @param msg_no |
| 1696 |
* @param options[optional] |
| 1697 |
*/ |
| 1698 |
function imap_fetchtext ($stream_id, $msg_no, $options) {} |
| 1699 |
|
| 1700 |
/** |
| 1701 |
* &Alias; <function>imap_listscan</function> |
| 1702 |
* @link http://www.php.net/manual/en/function.imap-scan.php |
| 1703 |
* @param stream_id |
| 1704 |
* @param ref |
| 1705 |
* @param pattern |
| 1706 |
* @param content |
| 1707 |
*/ |
| 1708 |
function imap_scan ($stream_id, $ref, $pattern, $content) {} |
| 1709 |
|
| 1710 |
/** |
| 1711 |
* &Alias; <function>imap_createmailbox</function> |
| 1712 |
* @link http://www.php.net/manual/en/function.imap-create.php |
| 1713 |
* @param stream_id |
| 1714 |
* @param mailbox |
| 1715 |
*/ |
| 1716 |
function imap_create ($stream_id, $mailbox) {} |
| 1717 |
|
| 1718 |
/** |
| 1719 |
* &Alias; <function>imap_renamemailbox</function> |
| 1720 |
* @link http://www.php.net/manual/en/function.imap-rename.php |
| 1721 |
* @param stream_id |
| 1722 |
* @param old_name |
| 1723 |
* @param new_name |
| 1724 |
*/ |
| 1725 |
function imap_rename ($stream_id, $old_name, $new_name) {} |
| 1726 |
|
| 1727 |
define ('NIL', 0); |
| 1728 |
define ('IMAP_OPENTIMEOUT', 1); |
| 1729 |
define ('IMAP_READTIMEOUT', 2); |
| 1730 |
define ('IMAP_WRITETIMEOUT', 3); |
| 1731 |
define ('IMAP_CLOSETIMEOUT', 4); |
| 1732 |
define ('OP_DEBUG', 1); |
| 1733 |
|
| 1734 |
/** |
| 1735 |
* Open mailbox read-only |
| 1736 |
* @link http://www.php.net/manual/en/imap.constants.php |
| 1737 |
*/ |
| 1738 |
define ('OP_READONLY', 2); |
| 1739 |
|
| 1740 |
/** |
| 1741 |
* Don't use or update a .newsrc for news |
| 1742 |
* (NNTP only) |
| 1743 |
* @link http://www.php.net/manual/en/imap.constants.php |
| 1744 |
*/ |
| 1745 |
define ('OP_ANONYMOUS', 4); |
| 1746 |
define ('OP_SHORTCACHE', 8); |
| 1747 |
define ('OP_SILENT', 16); |
| 1748 |
define ('OP_PROTOTYPE', 32); |
| 1749 |
|
| 1750 |
/** |
| 1751 |
* For IMAP and NNTP |
| 1752 |
* names, open a connection but don't open a mailbox. |
| 1753 |
* @link http://www.php.net/manual/en/imap.constants.php |
| 1754 |
*/ |
| 1755 |
define ('OP_HALFOPEN', 64); |
| 1756 |
define ('OP_EXPUNGE', 128); |
| 1757 |
define ('OP_SECURE', 256); |
| 1758 |
|
| 1759 |
/** |
| 1760 |
* silently expunge the mailbox before closing when |
| 1761 |
* calling imap_close |
| 1762 |
* @link http://www.php.net/manual/en/imap.constants.php |
| 1763 |
*/ |
| 1764 |
define ('CL_EXPUNGE', 32768); |
| 1765 |
|
| 1766 |
/** |
| 1767 |
* The parameter is a UID |
| 1768 |
* @link http://www.php.net/manual/en/imap.constants.php |
| 1769 |
*/ |
| 1770 |
define ('FT_UID', 1); |
| 1771 |
|
| 1772 |
/** |
| 1773 |
* Do not set the \Seen flag if not already set |
| 1774 |
* @link http://www.php.net/manual/en/imap.constants.php |
| 1775 |
*/ |
| 1776 |
define ('FT_PEEK', 2); |
| 1777 |
define ('FT_NOT', 4); |
| 1778 |
|
| 1779 |
/** |
| 1780 |
* The return string is in internal format, will not canonicalize to CRLF. |
| 1781 |
* @link http://www.php.net/manual/en/imap.constants.php |
| 1782 |
*/ |
| 1783 |
define ('FT_INTERNAL', 8); |
| 1784 |
define ('FT_PREFETCHTEXT', 32); |
| 1785 |
|
| 1786 |
/** |
| 1787 |
* The sequence argument contains UIDs instead of sequence numbers |
| 1788 |
* @link http://www.php.net/manual/en/imap.constants.php |
| 1789 |
*/ |
| 1790 |
define ('ST_UID', 1); |
| 1791 |
define ('ST_SILENT', 2); |
| 1792 |
define ('ST_SET', 4); |
| 1793 |
|
| 1794 |
/** |
| 1795 |
* the sequence numbers contain UIDS |
| 1796 |
* @link http://www.php.net/manual/en/imap.constants.php |
| 1797 |
*/ |
| 1798 |
define ('CP_UID', 1); |
| 1799 |
|
| 1800 |
/** |
| 1801 |
* Delete the messages from the current mailbox after copying |
| 1802 |
* with imap_mail_copy |
| 1803 |
* @link http://www.php.net/manual/en/imap.constants.php |
| 1804 |
*/ |
| 1805 |
define ('CP_MOVE', 2); |
| 1806 |
|
| 1807 |
/** |
| 1808 |
* Return UIDs instead of sequence numbers |
| 1809 |
* @link http://www.php.net/manual/en/imap.constants.php |
| 1810 |
*/ |
| 1811 |
define ('SE_UID', 1); |
| 1812 |
define ('SE_FREE', 2); |
| 1813 |
|
| 1814 |
/** |
| 1815 |
* Don't prefetch searched messages |
| 1816 |
* @link http://www.php.net/manual/en/imap.constants.php |
| 1817 |
*/ |
| 1818 |
define ('SE_NOPREFETCH', 4); |
| 1819 |
define ('SO_FREE', 8); |
| 1820 |
define ('SO_NOSERVER', 16); |
| 1821 |
define ('SA_MESSAGES', 1); |
| 1822 |
define ('SA_RECENT', 2); |
| 1823 |
define ('SA_UNSEEN', 4); |
| 1824 |
define ('SA_UIDNEXT', 8); |
| 1825 |
define ('SA_UIDVALIDITY', 16); |
| 1826 |
define ('SA_ALL', 31); |
| 1827 |
|
| 1828 |
/** |
| 1829 |
* This mailbox has no "children" (there are no |
| 1830 |
* mailboxes below this one). |
| 1831 |
* @link http://www.php.net/manual/en/imap.constants.php |
| 1832 |
*/ |
| 1833 |
define ('LATT_NOINFERIORS', 1); |
| 1834 |
|
| 1835 |
/** |
| 1836 |
* This is only a container, not a mailbox - you |
| 1837 |
* cannot open it. |
| 1838 |
* @link http://www.php.net/manual/en/imap.constants.php |
| 1839 |
*/ |
| 1840 |
define ('LATT_NOSELECT', 2); |
| 1841 |
|
| 1842 |
/** |
| 1843 |
* This mailbox is marked. Only used by UW-IMAPD. |
| 1844 |
* @link http://www.php.net/manual/en/imap.constants.php |
| 1845 |
*/ |
| 1846 |
define ('LATT_MARKED', 4); |
| 1847 |
|
| 1848 |
/** |
| 1849 |
* This mailbox is not marked. Only used by |
| 1850 |
* UW-IMAPD. |
| 1851 |
* @link http://www.php.net/manual/en/imap.constants.php |
| 1852 |
*/ |
| 1853 |
define ('LATT_UNMARKED', 8); |
| 1854 |
define ('LATT_REFERRAL', 16); |
| 1855 |
define ('LATT_HASCHILDREN', 32); |
| 1856 |
define ('LATT_HASNOCHILDREN', 64); |
| 1857 |
|
| 1858 |
/** |
| 1859 |
* Sort criteria for imap_sort: |
| 1860 |
* message Date |
| 1861 |
* @link http://www.php.net/manual/en/imap.constants.php |
| 1862 |
*/ |
| 1863 |
define ('SORTDATE', 0); |
| 1864 |
|
| 1865 |
/** |
| 1866 |
* Sort criteria for imap_sort: |
| 1867 |
* arrival date |
| 1868 |
* @link http://www.php.net/manual/en/imap.constants.php |
| 1869 |
*/ |
| 1870 |
define ('SORTARRIVAL', 1); |
| 1871 |
|
| 1872 |
/** |
| 1873 |
* Sort criteria for imap_sort: |
| 1874 |
* mailbox in first From address |
| 1875 |
* @link http://www.php.net/manual/en/imap.constants.php |
| 1876 |
*/ |
| 1877 |
define ('SORTFROM', 2); |
| 1878 |
|
| 1879 |
/** |
| 1880 |
* Sort criteria for imap_sort: |
| 1881 |
* message subject |
| 1882 |
* @link http://www.php.net/manual/en/imap.constants.php |
| 1883 |
*/ |
| 1884 |
define ('SORTSUBJECT', 3); |
| 1885 |
|
| 1886 |
/** |
| 1887 |
* Sort criteria for imap_sort: |
| 1888 |
* mailbox in first To address |
| 1889 |
* @link http://www.php.net/manual/en/imap.constants.php |
| 1890 |
*/ |
| 1891 |
define ('SORTTO', 4); |
| 1892 |
|
| 1893 |
/** |
| 1894 |
* Sort criteria for imap_sort: |
| 1895 |
* mailbox in first cc address |
| 1896 |
* @link http://www.php.net/manual/en/imap.constants.php |
| 1897 |
*/ |
| 1898 |
define ('SORTCC', 5); |
| 1899 |
|
| 1900 |
/** |
| 1901 |
* Sort criteria for imap_sort: |
| 1902 |
* size of message in octets |
| 1903 |
* @link http://www.php.net/manual/en/imap.constants.php |
| 1904 |
*/ |
| 1905 |
define ('SORTSIZE', 6); |
| 1906 |
define ('TYPETEXT', 0); |
| 1907 |
define ('TYPEMULTIPART', 1); |
| 1908 |
define ('TYPEMESSAGE', 2); |
| 1909 |
define ('TYPEAPPLICATION', 3); |
| 1910 |
define ('TYPEAUDIO', 4); |
| 1911 |
define ('TYPEIMAGE', 5); |
| 1912 |
define ('TYPEVIDEO', 6); |
| 1913 |
define ('TYPEMODEL', 7); |
| 1914 |
define ('TYPEOTHER', 8); |
| 1915 |
define ('ENC7BIT', 0); |
| 1916 |
define ('ENC8BIT', 1); |
| 1917 |
define ('ENCBINARY', 2); |
| 1918 |
define ('ENCBASE64', 3); |
| 1919 |
define ('ENCQUOTEDPRINTABLE', 4); |
| 1920 |
define ('ENCOTHER', 5); |
| 1921 |
|
| 1922 |
/** |
| 1923 |
* Garbage collector, clear message cache elements. |
| 1924 |
* @link http://www.php.net/manual/en/imap.constants.php |
| 1925 |
*/ |
| 1926 |
define ('IMAP_GC_ELT', 1); |
| 1927 |
|
| 1928 |
/** |
| 1929 |
* Garbage collector, clear envelopes and bodies. |
| 1930 |
* @link http://www.php.net/manual/en/imap.constants.php |
| 1931 |
*/ |
| 1932 |
define ('IMAP_GC_ENV', 2); |
| 1933 |
|
| 1934 |
/** |
| 1935 |
* Garbage collector, clear texts. |
| 1936 |
* @link http://www.php.net/manual/en/imap.constants.php |
| 1937 |
*/ |
| 1938 |
define ('IMAP_GC_TEXTS', 4); |
| 1939 |
|
| 1940 |
// End of imap v. |
| 1941 |
?> |