imap_mail_move
(PHP 4, PHP 5, PHP 7)
imap_mail_move — Move specified messages to a mailbox
Описание
bool imap_mail_move
( resource
$imap_stream
, string $msglist
, string $mailbox
[, int $options = 0
] )
Moves mail messages specified by msglist to the
specified mailbox.
Список параметров
-
imap_stream -
Поток IMAP, полученный из imap_open().
-
msglist -
msglistis a range not just message numbers (as described in » RFC2060). -
mailbox -
The mailbox name, see imap_open() for more information
-
options -
optionsis a bitmask and may contain the single option:-
CP_UID- the sequence numbers contain UIDS
-
Возвращаемые значения
Возвращает TRUE в случае успешного завершения или FALSE в случае возникновения ошибки.
Примечания
Замечание:
imap_mail_move() will flag the original mail with a delete flag, to successfully delete it a call to the imap_expunge() function must be made.
- PHP Руководство
- Функции по категориям
- Индекс функций
- Справочник функций
- Расширения для работы с почтой
- IMAP, POP3 и NNTP
- imap_8bit
- imap_alerts
- imap_append
- imap_base64
- imap_binary
- imap_body
- imap_bodystruct
- imap_check
- imap_clearflag_full
- imap_close
- imap_create
- imap_createmailbox
- imap_delete
- imap_deletemailbox
- imap_errors
- imap_expunge
- imap_fetch_overview
- imap_fetchbody
- imap_fetchheader
- imap_fetchmime
- imap_fetchstructure
- imap_fetchtext
- imap_gc
- imap_get_quota
- imap_get_quotaroot
- imap_getacl
- imap_getmailboxes
- imap_getsubscribed
- imap_header
- imap_headerinfo
- imap_headers
- imap_last_error
- imap_list
- imap_listmailbox
- imap_listscan
- imap_listsubscribed
- imap_lsub
- imap_mail_compose
- imap_mail_copy
- imap_mail_move
- imap_mail
- imap_mailboxmsginfo
- imap_mime_header_decode
- imap_msgno
- imap_num_msg
- imap_num_recent
- imap_open
- imap_ping
- imap_qprint
- imap_rename
- imap_renamemailbox
- imap_reopen
- imap_rfc822_parse_adrlist
- imap_rfc822_parse_headers
- imap_rfc822_write_address
- imap_savebody
- imap_scan
- imap_scanmailbox
- imap_search
- imap_set_quota
- imap_setacl
- imap_setflag_full
- imap_sort
- imap_status
- imap_subscribe
- imap_thread
- imap_timeout
- imap_uid
- imap_undelete
- imap_unsubscribe
- imap_utf7_decode
- imap_utf7_encode
- imap_utf8
Коментарии
After using imap_mail_move, imap_mail_copy or imap_delete it is necesary to call imap_expunge() function.to get right the folders names for imap_mail_move/imap_mail_copy, do not guess, instead use imap_listThe 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.