PHP Conference Kansai 2025

imap_mail_move

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

imap_mail_moveMueve mensajes a una caja de correo

Descripción

imap_mail_move(
    IMAP\Connection $imap,
    string $message_nums,
    string $mailbox,
    int $flags = 0
): bool

imap_mail_move() mueve los mensajes especificados por message_nums a la caja de correo mailbox. Es importante destacar que los mensajes son en realidad copiados a la caja de correo mailbox, y los mensajes originales son marcados para ser eliminados. Esto implica que los mensajes en mailbox son asignados nuevos UIDs.

Parámetros

imap

An IMAP\Connection instance.

message_nums

message_nums es un intervalo, y no solo una lista de mensajes (como se describe en la » RFC2060).

mailbox

El nombre de la caja de correo, ver la documentación de la función imap_open() para más detalles

Advertencia

El paso de datos no confiables a este parámetro es inseguro, a menos que imap.enable_insecure_rsh esté inhabilitado.

flags

flags es un campo de bits y puede contener un solo valor:

  • CP_UID - La secuencia de números contiene UIDs

Valores devueltos

Devuelve true en caso de éxito o false en caso de error.

Historial de cambios

Versión Descripción
8.1.0 The imap parameter expects an IMAP\Connection instance now; previously, a valid imap recurso was expected.

Notas

Nota:

imap_mail_move() marcará el correo electrónico original con un marcador de eliminación, para eliminarlo efectivamente, se requiere una llamada a imap_expunge().

Ver también

add a note

User Contributed Notes 3 notes

up
8
FredN
4 years ago
to get right the folders names for imap_mail_move/imap_mail_copy, do not guess, instead use imap_list
up
8
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.
up
1
jab_creations at yahoo dot com
5 months 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.
To Top