imap_mail_move
(PHP 4, PHP 5, PHP 7, PHP 8)
imap_mail_move — 指定されたメッセージをメールボックスに移動する
説明
message_nums
で指定されたメッセージを、
指定されたメールボックス mbox
に移動します。
実際には mailbox
にメッセージが
コピー され、
オリジナルのメッセージには削除済みのフラグが付く点に注意して下さい。
これは、mailbox
にあるメッセージには、
新しい UID が割り当てられるということです。
パラメータ
imap
IMAP\Connection クラスのインスタンス。
message_nums
-
message_nums
は、 (» RFC2060 に記述されたように) ただのメッセージ番号ではなく、範囲を示します。 mailbox
-
メールボックス名。詳細は imap_open() を参照ください。
警告信頼できないデータをこのパラメータに渡すのであれば、 imap.enable_insecure_rsh を無効にしておかなければ危険です。
flags
-
flags
はビットマスクであり、ひとつのオプションをとります。-
CP_UID
- UIDS を含む処理の数
-
変更履歴
バージョン | 説明 |
---|---|
8.1.0 |
引数 imap は、IMAP\Connection
クラスのインスタンスを期待するようになりました。
これより前のバージョンでは、有効な imap リソース が期待されていました。
|
注意
注意:
imap_mail_move() は元のメールに削除フラグを立てます。 imap_expunge() がコールされたときに確実に削除されるようにするためです。
+add a note
User Contributed Notes 3 notes
FredN ¶
4 years ago
to get right the folders names for imap_mail_move/imap_mail_copy, do not guess, instead use imap_list
alex at bestgames dot ro ¶
19 years ago
After using imap_mail_move, imap_mail_copy or imap_delete it is necesary to call imap_expunge() function.
jab_creations at yahoo dot com ¶
19 days ago
The imap_mail_move() function's second parameter (message_nums parameter) accept two valid values:
Individual message number:
47
or
Array:
47,58,112
Remember four key things in combination!
1. This move function does not move anything, internally it creates a copy and then deletes the original!
2. You should be tracking the Message-Id header (that should be set!) internally to confirm the unique IMAP id.
3. Because when a message is pseudo-"moved" the original message and unique IMAP id are lost! That means after the internal copy (or to us, having been moved) is created you will then have to create a new connection to the second mailbox folder, list or search and verify by internal message identifiers to keep your mail shell synchronized with the external server. Which then in turn means...
4. You will have to track the copied message after it is destroyed in the first mailbox folder. That gives you two logical approaches to use:
4.1 Individually move the message then simply get an index of the destination folder (e.g. moving from inbox to trash), "move" the message using this command, getting the index of the trash mailbox folder and comparing the arrays to determine the oddball out.
4.2 But in reality we're moving multiple messages in a single go so you can scan the mailbox folder for each message however this presumes that the header (e.g. Message-Id) exists.
Example search:
$result = imap_search($mail_connection_folder_trash, "TEXT \"<24322757.12578452.2416351620568@domain.tld>\"", SE_UID);
In my limited experience of a few thousand emails only spammers or devastatingly underpaid developers have not set the Message-Id. You can not presume however that the missing header implies spam as my original system never set it. Hence why it may be necessary to search by a secondary or tertiary means in more non-common scenarios with oddball messages. This may occur in one-in-several thousand instances.
Hopefully this logic will spare a few people the time spent on conceptual work.