imap_renamemailbox

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

    imap_renamemailbox — Renomeia uma caixa de correio antiga para uma nova caixa de correio

    Descrição

    imap_renamemailbox(IMAP\Connection $imap, string $from, string $to): bool

    Esta função renomeia uma caixa de correio antiga para uma nova caixa de correio (veja imap_open() para o formato de nomes para mbox).

    Parâmetros

    imap

    Uma instância de IMAP\Connection.

    from

    O antigo nome da caixa de correio, veja imap_open() para mais informações

    Aviso

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

    to

    O novo nome da caixa de correio, veja imap_open() para mais informações

    Aviso

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

    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.

    Veja Também

    Melhore Esta Página

    Aprenda Como Melhorar Esta Página • Envie uma Solicitação de Modificação • Reporte um Problema
    ＋adicione uma nota

    Notas Enviadas por Usuários (em inglês) 2 notes

    up
    3
    josh at paducahwebpublishing dot com
    25 years ago
    Don't let "...string old_mbox, string new_mbox);" fool you. You have to add the server and port to the mailbox name also. So it would be something like:

    imap_renamemailbox($mailbox, "{localhost:143}$oldfolder", "{localhost:143}$newfolder")

    Just thought I would point it out, it took me a while to figure it out.
    up
    1
    Christoffer Lindahl
    14 years ago
    Don't forget that you can't be connected to the mailbox that you are going to rename (or delete).

    If you have the following mailboxes:
    INBOX
    INBOX.Foo

    ...and want to rename "INBOX.Foo" to "INBOX.Bar" you have to be connected to "INBOX":

    <?php
    $mbox     = imap_open('{imap.example.com}INBOX', 'username', 'password');
    imap_renamemailbox($mbox, '{imap.example.com}INBOX.Foo', '{imap.example.com}INBOX.Bar');
    imap_close($mbox);
    ?>
    ＋adicione uma nota
    To Top