PHP: Hypertext Preprocessor (original) (raw)

imap_mail_copy

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

imap_mail_copy — Copy specified messages to a mailbox

Description

Parameters

imap

An IMAP\Connection instance.

message_nums

message_nums is a range not just message numbers (as described in » RFC2060).

mailbox

The mailbox name, see imap_open() for more information

flags

flags is a bitmask of one or more of

[CP_UID](imap.constants.php#constant.cp-uid) - the sequence numbers contain UIDS
[CP_MOVE](imap.constants.php#constant.cp-move) - Delete the messages from the current mailbox after copying. If this flag is set, the function behaves identically to imap_mail_move().

Return Values

Returns [true](reserved.constants.php#constant.true) on success or [false](reserved.constants.php#constant.false) on failure.

Changelog

Version	Description
8.1.0	The imap parameter expects an IMAP\Connection instance now; previously, a valid imap resource was expected.

Found A Problem?

marcus at names dot co dot uk ¶

22 years ago

`If you are having problems getting imap_mail_copy and imap_mail_move to work, check you have installed imap_devel (the imap development libraries) as well as imap (the imap daemon). Without it, PHP appears to configure correctly --with-imap, but some functions do not work.

It took me about 12 hours to figure this out!!

hxlvt at hotmail dot com ¶

24 years ago

After much fooling around, imap_mail_copy did work for me. One thing you might want to check, if you are having problems, is the new mailbox name. Make sure it is just a folder name, e.g. INBOX.haha without the server part.

jigar dot dhaduk79 at gmail dot com ¶

9 years ago

`When we want to copy more than one mail, we can write '(string)' before msg_num. Like.. msgnum="1,2,3,4,5,6,7";<spanclass="katex"><spanclass="katex−mathml"><mathxmlns="http://www.w3.org/1998/Math/MathML"><semantics><mrow><mi>c</mi><mi>o</mi><mi>p</mi><mi>y</mi><mo>=</mo><mi>i</mi><mi>m</mi><mi>a</mi><msub><mi>p</mi><mi>m</mi></msub><mi>a</mi><mi>i</mi><msub><mi>l</mi><mi>c</mi></msub><mi>o</mi><mi>p</mi><mi>y</mi><mostretchy="false">(</mo></mrow><annotationencoding="application/x−tex">copy=imapmailcopy(</annotation></semantics></math><spanclass="katex−html"aria−hidden="true"><spanclass="base"><spanclass="strut"style="height:0.625em;vertical−align:−0.1944em;"><spanclass="mordmathnormal">co<spanclass="mordmathnormal">p<spanclass="mordmathnormal"style="margin−right:0.03588em;">y<spanclass="mspace"style="margin−right:0.2778em;"><spanclass="mrel">=<spanclass="mspace"style="margin−right:0.2778em;"><spanclass="base"><spanclass="strut"style="height:1em;vertical−align:−0.25em;"><spanclass="mordmathnormal">ima<spanclass="mord"><spanclass="mordmathnormal">p<spanclass="msupsub"><spanclass="vlist−tvlist−t2"><spanclass="vlist−r"><spanclass="vlist"style="height:0.1514em;"><spanstyle="top:−2.55em;margin−left:0em;margin−right:0.05em;"><spanclass="pstrut"style="height:2.7em;"><spanclass="sizingreset−size6size3mtight"><spanclass="mordmathnormalmtight">m<spanclass="vlist−s"><spanclass="vlist−r"><spanclass="vlist"style="height:0.15em;"><spanclass="mordmathnormal">ai<spanclass="mord"><spanclass="mordmathnormal"style="margin−right:0.01968em;">l<spanclass="msupsub"><spanclass="vlist−tvlist−t2"><spanclass="vlist−r"><spanclass="vlist"style="height:0.1514em;"><spanstyle="top:−2.55em;margin−left:−0.0197em;margin−right:0.05em;"><spanclass="pstrut"style="height:2.7em;"><spanclass="sizingreset−size6size3mtight"><spanclass="mordmathnormalmtight">c<spanclass="vlist−s"><spanclass="vlist−r"><spanclass="vlist"style="height:0.15em;"><spanclass="mordmathnormal">o<spanclass="mordmathnormal">p<spanclass="mordmathnormal"style="margin−right:0.03588em;">y<spanclass="mopen">(imapstream,(string)msg_num = "1,2,3,4,5,6,7"; <math xmlns="http://www.w3.org/1998/Math/MathML"><semantics><mrow><mi>c</mi><mi>o</mi><mi>p</mi><mi>y</mi><mo>=</mo><mi>i</mi><mi>m</mi><mi>a</mi><msub><mi>p</mi><mi>m</mi></msub><mi>a</mi><mi>i</mi><msub><mi>l</mi><mi>c</mi></msub><mi>o</mi><mi>p</mi><mi>y</mi><mo stretchy="false">(</mo></mrow><annotation encoding="application/x-tex">copy = imap_mail_copy(</annotation></semantics></math>copy=imapmailcopy(imap_stream, (string) msgnum="1,2,3,4,5,6,7";<spanclass="katex"><spanclass="katex−mathml"><mathxmlns="http://www.w3.org/1998/Math/MathML"><semantics><mrow><mi>c</mi><mi>o</mi><mi>p</mi><mi>y</mi><mo>=</mo><mi>i</mi><mi>m</mi><mi>a</mi><msub><mi>p</mi><mi>m</mi></msub><mi>a</mi><mi>i</mi><msub><mi>l</mi><mi>c</mi></msub><mi>o</mi><mi>p</mi><mi>y</mi><mostretchy="false">(</mo></mrow><annotationencoding="application/x−tex">copy=imapmailcopy(</annotation></semantics></math><spanclass="katex−html"aria−hidden="true"><spanclass="base"><spanclass="strut"style="height:0.625em;vertical−align:−0.1944em;"><spanclass="mordmathnormal">co<spanclass="mordmathnormal">p<spanclass="mordmathnormal"style="margin−right:0.03588em;">y<spanclass="mspace"style="margin−right:0.2778em;"><spanclass="mrel">=<spanclass="mspace"style="margin−right:0.2778em;"><spanclass="base"><spanclass="strut"style="height:1em;vertical−align:−0.25em;"><spanclass="mordmathnormal">ima<spanclass="mord"><spanclass="mordmathnormal">p<spanclass="msupsub"><spanclass="vlist−tvlist−t2"><spanclass="vlist−r"><spanclass="vlist"style="height:0.1514em;"><spanstyle="top:−2.55em;margin−left:0em;margin−right:0.05em;"><spanclass="pstrut"style="height:2.7em;"><spanclass="sizingreset−size6size3mtight"><spanclass="mordmathnormalmtight">m<spanclass="vlist−s"><spanclass="vlist−r"><spanclass="vlist"style="height:0.15em;"><spanclass="mordmathnormal">ai<spanclass="mord"><spanclass="mordmathnormal"style="margin−right:0.01968em;">l<spanclass="msupsub"><spanclass="vlist−tvlist−t2"><spanclass="vlist−r"><spanclass="vlist"style="height:0.1514em;"><spanstyle="top:−2.55em;margin−left:−0.0197em;margin−right:0.05em;"><spanclass="pstrut"style="height:2.7em;"><spanclass="sizingreset−size6size3mtight"><spanclass="mordmathnormalmtight">c<spanclass="vlist−s"><spanclass="vlist−r"><spanclass="vlist"style="height:0.15em;"><spanclass="mordmathnormal">o<spanclass="mordmathnormal">p<spanclass="mordmathnormal"style="margin−right:0.03588em;">y<spanclass="mopen">(imapstream,(string)msg_num, '[Gmail]/Important', CP_UID);