imap_append

(PHP 3, PHP 4, PHP 5)

imap_append -- 指定されたメールボックスに文字列メッセージを追加する

説明

bool imap_append ( resource imap_stream, string mailbox, string message [, string options] )

指定したメールボックス mbox に文字列メッセージ message を追加します。

パラメータ

imap_stream

imap_open() が返す IMAP ストリーム。

mailbox

メールボックスの名前。詳細は imap_open() を参照ください。

message

追加したいメッセージを表す文字列。

Cyrus IMAP サーバと通信する際には、改行コードとして "\n" のかわりに "\r\n" を使用する必要があります。さもなくば、操作は失敗します。

options

指定した場合は、 options もそのメールボックスに書きこまれます。

返り値

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

例 1. imap_append() の例

<?php
$stream
= imap_open("{imap.example.org}INBOX.Drafts", "username", "password");

$check = imap_check($stream);
echo
"Msg Count before append: ". $check->Nmsgs . "\n";

imap_append($stream, "{imap.example.org}INBOX.Drafts"
                   
, "From: me@example.com\r\n"
                   
. "To: you@example.com\r\n"
                   
. "Subject: test\r\n"
                   
. "\r\n"
                   
. "this is a test message, please ignore\r\n"
                   
);

$check = imap_check($stream);
echo
"Msg Count after append : ". $check->Nmsgs . "\n";

imap_close($stream);
?>