トップページ　→関数リファレンス　→メール関連　→IMAP　→IMAP 関数

関数・クラス解説

imap_createmailbox

version:PHP 4, PHP 5, PHP 7 (公式)

新しいメールボックスを作る

公式リファレンス

書式

imap_createmailbox ( resource $imap_stream , string $mailbox ) : bool

説明

imap_createmailbox() は mailbox で指定された新しいメールボックスを作成します。

パラメータ

imap_stream: imap_open()が返す IMAP ストリーム。
mailbox: メールボックス名。詳細は imap_open() を参照ください。この名前に国際化文字を含む場合には、 imap_utf7_encode() でエンコードする必要があります。
警告信頼できないデータをこのパラメータに渡すのであれば、imap.enable_insecure_rshを無効にしておかなければ危険です。

返値

成功した場合に TRUE を、失敗した場合に FALSE を返します。

注意

警告信頼できないデータをこのパラメータに渡すのであれば、imap.enable_insecure_rshを無効にしておかなければ危険です。

サンプル

例1 imap_createmailbox() example 

$mbox = imap_open("{imap.example.org}", "username", "password", OP_HALFOPEN)
     or die("接続できません: " . imap_last_error());

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

$newname = $name1;

echo "Newname will be '$name1'\n";

// ここでは inbox フォルダ内に新しいメールボックス "phptestbox" を
// 作成し、その後でメールボックスの状態を確認し、最後にそれを削除して
// もとの状態に戻します。

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 "your new mailbox '$name1' has the following status:\n";
        echo "Messages:   " . $status->messages    . "\n";
        echo "Recent:     " . $status->recent      . "\n";
        echo "Unseen:     " . $status->unseen      . "\n";
        echo "UIDnext:    " . $status->uidnext     . "\n";
        echo "UIDvalidity:" . $status->uidvalidity . "\n";

        if (imap_renamemailbox($mbox, "{imap.example.org}INBOX.$newname", "{imap.example.org}INBOX.$name2")) {
            echo "renamed new mailbox from '$name1' to '$name2'\n";
            $newname = $name2;
        } else {
            echo "imap_renamemailbox on new mailbox failed: " . imap_last_error() . "\n";
        }
    } else {
        echo "imap_status on new mailbox failed: " . imap_last_error() . "\n";
    }

    if (@imap_deletemailbox($mbox, "{imap.example.org}INBOX.$newname")) {
        echo "new mailbox removed to restore initial state\n";
    } else {
        echo "imap_deletemailbox on new mailbox failed: " . implode("\n", imap_errors()) . "\n";
    }

} else {
    echo "could not create new mailbox: " . implode("\n", imap_errors()) . "\n";
}

imap_close($mbox);