imap_mail_move

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

imap_mail_moveMove mensagens especificadas para uma caixa de correio

Descrição

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

Move mensagens de correio especificadas por message_nums para a caixa especificada em mailbox. Observe que as mensagens de correio são, na verdade, copiadas para a caixa mailbox, e as mensagens originais são sinalizadas para exclusão. Isso implica que as mensagens em mailbox recebem novos UIDs.

Parâmetros

imap

Uma instância de IMAP\Connection.

message_nums

message_nums é um intervalo e não só números de mensagens (como descrito em » RFC2060).

mailbox

O nome da caixa de correio, consulte imap_open() para mais informação.

Aviso

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

flags

flags é uma máscara de bits e pode conter esta única opção:

  • CP_UID - os números de sequência contêm UIDS

Valor Retornado

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

Registro de Alterações

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

Notas

Nota:

imap_mail_move() irá sinalizar a mensagem original com a marca de exclusão. Para excluí-la, é necessário chamar a função imap_expunge().

Veja Também