imap_close

imap_close

Termina un flujo IMAP

Descripción#

php imap_close(IMAP\Connection $imap, [int $flags]): truephp

Termina un flujo IMAP.

Parámetros#

imap
Una instancia de IMAP\Connection.

flags
Si se establece en CL_EXPUNGE, la función realizará una purga automática del buzón antes de cerrarlo, eliminando todos los mensajes marcados para su eliminación. Se puede lograr lo mismo con la función imap_expunge

Valores devueltos#

Retorna siempre true.

Errores/Excepciones#

Lanza una excepción ValueError si el argumento flags es inválido.

Historial de cambios#

Versión	Descripción
8.1.0	El parámetro imap ahora espera una instancia de IMAP\Connection ; anteriormente, se esperaba un resource imap válido.
8.0.0	Ahora se lanza una excepción ValueError para valores de argumento flags inválidos. Anteriormente, se emitía una advertencia y la función devolvía false.

Véase también#

imap_open