imap_mail_move

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

    imap_mail_move — Move specified messages to a mailbox

    Descrição

    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

    Uma instância de IMAP\Connection.

    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

    Aviso

    Passar dados não confiáveis para este parâmetro é inseguro, a menos que imap.enable_insecure_rsh esteja desabilitado.

    flags

    flags is a bitmask and may contain the single option:

    • CP_UID - the sequence numbers contain UIDS

    Valor Retornado

    Retorna true em caso de sucesso ou false em caso de falha.

    Registro de Alterações

    VersãoDescrição
    8.1.0 O parâmetro imap agora espera uma instância de IMAP\Connection; anteriormente, um resourceimap válido era esperado.

    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.

    Veja Também

    To Top