imap_mail_move

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

    imap_mail_move — Move specified messages to a mailbox

    Descripción

    imap_mail_move(
        IMAP\Connection$imap,
        string$message_nums,
        string$mailbox,
        int$flags = 0
    ): bool

    Moves mail messages specified by message_nums to the specified mailbox. Note that the mail messages are actually copied to the mailbox, and the original messages are flagged for deletion. That implies that the messages in mailbox are assigned new UIDs.

    Parámetros

    imap

    An IMAP\Connection instance.

    message_nums

    message_nums is a range not just message numbers (as described in » RFC2060).

    mailbox

    The mailbox name, see imap_open() for more information

    Advertencia

    El paso de datos no confiables a este parámetro es inseguro, a menos que imap.enable_insecure_rsh esté inhabilitado.

    flags

    flags is a bitmask and may contain the single option:

    • CP_UID - the sequence numbers contain UIDS

    Valores devueltos

    Devuelve true en caso de éxito o false en caso de error.

    Historial de cambios

    VersiónDescripción
    8.1.0 The imap parameter expects an IMAP\Connection instance now; previously, a valid imaprecurso was expected.

    Notas

    Nota:

    imap_mail_move() will flag the original mail with a delete flag, to successfully delete it a call to the imap_expunge() function must be made.

    Ver también

    To Top