imap_createmailbox

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

imap_createmailbox — Cria uma nova caixa de correio

Descrição

function imap_createmailbox(IMAP\Connection $imap, string $mailbox): bool

Cria uma nova caixa de correio especificada por mailbox.

Parâmetros

imap
Uma instância de IMAP\Connection.
mailbox

O nome da caixa de correio, veja imap_open() para mais informações. Nomes contendo caracteres internacionais devem ser codificados por imap_utf7_encode()

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.

Exemplos

Exemplo #1 Exemplo de imap_createmailbox()

<?php
$mbox = imap_open("{imap.example.org}", "username", "password", OP_HALFOPEN)
     or die("Não foi possível conectar: " . imap_last_error());

$name1 = "phpnewbox";
$name2 = imap_utf7_encode("phpnewböx"); // phpnewb&w7Y-x

$newname = $name1;

echo "O novo nome será '$name1'<br />\n";

// Agora criaremos uma nova caixa de correio "phptestbox" na pasta de caixa de entrada,
// verificaremos seu status após a criação e finalmente a
// removeremos para restaurar a caixa de entrada ao seu estado inicial

if (@imap_createmailbox($mbox, imap_utf7_encode("{imap.example.org}INBOX.$newname"))) {
    $status = @imap_status($mbox, "{imap.example.org}INBOX.$newname", SA_ALL);
    if ($status) {
        echo "Sua caixa de correio '$name1' tem o seguinte status:<br />\n";
        echo "Messages:   " . $status->messages    . "<br />\n";
        echo "Recent:     " . $status->recent      . "<br />\n";
        echo "Unseen:     " . $status->unseen      . "<br />\n";
        echo "UIDnext:    " . $status->uidnext     . "<br />\n";
        echo "UIDvalidity:" . $status->uidvalidity . "<br />\n";

        if (imap_renamemailbox($mbox, "{imap.example.org}INBOX.$newname", "{imap.example.org}INBOX.$name2")) {
            echo "Renomeada a nova caixa de correio de '$name1' para '$name2'<br />\n";
            $newname = $name2;
        } else {
            echo "imap_renamemailbox na nova caixa de correio falhou: " . imap_last_error() . "<br />\n";
        }
    } else {
        echo "imap_status na nova caixa de correio falhou: " . imap_last_error() . "<br />\n";
    }

    if (@imap_deletemailbox($mbox, "{imap.example.org}INBOX.$newname")) {
        echo "Nova caixa de correio removida para restaurar o status inicial<br />\n";
    } else {
        echo "imap_deletemailbox na nova caixa de correio falhou: " . implode("<br />\n", imap_errors()) . "<br />\n";
    }

} else {
    echo "Não foi possível criar a nova caixa de correio: " . implode("<br />\n", imap_errors()) . "<br />\n";
}

imap_close($mbox);
?>

Veja Também