imap_close

    (PHP 4, PHP 5, PHP 7, PHP 8)

    imap_close — Close an IMAP stream

    Descripción

    imap_close(IMAP\Connection$imap, int$flags = 0): true

    Closes the imap stream.

    Parámetros

    imap

    An IMAP\Connection instance.

    flags

    If set to CL_EXPUNGE, the function will silently expunge the mailbox before closing, removing all messages marked for deletion. You can achieve the same thing by using imap_expunge()

    Valores devueltos

    Siempre devuelve true.

    Errores/Excepciones

    Throws a ValueError if flags is invalid.

    Historial de cambios

    VersiónDescripción
    8.1.0 The imap parameter expects an IMAP\Connection instance now; previously, a valid imaprecurso was expected.
    8.0.0 A ValueError is now thrown on invalid flags parameter values. Previously, a warning was emitted and the function returned false.

    Ver también

    To Top