imap_append

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

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

    説明

    imap_append(
        IMAP\Connection $imap,
        string $folder,
        string $message,
        ?string $options = null,
        ?string $internal_date = null
    ): bool

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

    パラメータ

    imap

    IMAP\Connection クラスのインスタンス。

    folder

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

    警告

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

    message

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

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

    options

    指定した場合は、 options もその folder に書きこまれます。

    internal_date

    このパラメータが設定されていると、追加したメッセージに INTERNALDATE を設定します。 このパラメータは、rfc2060 の日付時刻値の仕様を満たす文字列でなければなりません。

    戻り値

    成功した場合に true を、失敗した場合に false を返します。

    変更履歴

    バージョン 説明
    8.1.0 引数 imap は、IMAP\Connection クラスのインスタンスを期待するようになりました。 これより前のバージョンでは、有効な imap リソース が期待されていました。
    8.0.0 options と internal_date は、nullable になりました。

    例

    例1 imap_append() の例

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

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

    imap_append($imap, "{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($imap);
    echo     "Msg Count after append : ". $check->Nmsgs . "\n";

    imap_close($imap);
    ?>

    Found A Problem?

    Learn How To Improve This Page • Submit a Pull Request • Report a Bug
    ＋add a note

    User Contributed Notes 4 notes

    up
    19
    rixsta at hotmail dot com
    11 years ago
    Hi,

    As we have been struggling with this for some time I wanted to share how we got imap_append working properly with all MIME parts including attachments. If you are sending email and also wish to append the sent message to the Sent Items folder, I cannot think of an easier way to do this, as follows:

    1) Use SwiftMailer to send the message via PHP.
    $message = Swift_Message::newInstance("Subject goes here");
    (then add from, to, body, attachments etc)
    $result = $mailer->send($message);

    2) When you construct the message in step 1) above save it to a variable as follows:

    $msg = $message->toString(); (this creates the full MIME message required for imap_append()!! After this you can call imap_append like this:

    imap_append($imap_conn,$mail_box,$msg."\r\n","\\Seen");

    I hope this helps the readers, and prevents saves people from doing what we started doing - hand crafting the MIME messages :-0
    up
    10
    Krzysiek
    9 years ago
    You can use PHPMailer ( https://github.com/PHPMailer/PHPMailer/ ) with imap.

    <?php
    // after creating content of mail you have to run preSend() - part of send() method
    $mail->send();
    // and you can get whole raw message with getSentMIMEMessage() method
    imap_append($imap, $mailserver.'INBOX.Sent',$mail->getSentMIMEMessage(), "\\Seen");
    up
    5
    kaminski at istori dot com
    14 years ago
    The date format string to use when creating $internal_date is 'd-M-Y H:i:s O'.
    up
    1
    jab_creations at yahoo dot com
    5 days ago
    This function is how you take a sent message in your mail shell and place a copy of it in the remote mail server's sent folder.

    It is however not intuitive and I struggled for a couple hours so I'm placing these notes here to spare others the aggravation. Some of the errors I encountered:

    - Can't append to mailbox with such a name
    - Internal date not correctly formatted

    The second/folder parameter is not the string you might think it is (e.g. "Sent", "Inbox.Sent", etc). It is the connection information used by imap_open() which doesn't make sense as the connection is already open! Whatever, here is a basic example addressing those three errors:

    <?php
    $server     = '{mail.example.com:993/ssl/imap}INBOX.Sent';
    $mail_connection_folder = imap_open($server, $user, $pass);

    if (    $mail_connection)
    {
    $result = imap_append($mail_connection, $server, $message_string_raw, '\\Seen', date('d-M-Y H:i:s O'));
    }
    ?>

    I had been using the PHP Pear Mail extension which did a fantastic job with DMARC, SPF, DKIM, etc. However it's not well maintained and I couldn't figure out if it returns the email message string. The PHPMailer library (https://github.com/PHPMailer/PHPMailer) does return the message string:

    <?php
    //Skip to key parts:
    $result = $mail->send();

    if (    $result)
    {
    $message_string_raw = $mail->getSentMIMEMessage();
    }
    else {    /*error handling*/}
    ?>

    Hopefully this will spare some folks a lot of aggravation.
    ＋add a note
    To Top