Copies the specified messages from the currently selected folder to the specified folder, and retrieves UIDs assigned to the copied messages in the destination folder.

Parameters

messageIndexSet

A message sequence string containing ordinal message numbers or UIDs. Can be composed manually or using ToString.

indexIsUid

If true, messageIndexSet is treated as a sequence of UIDs; otherwise, as a sequence of ordinal message numbers.

targetFolderName

The full name of the destination folder.

result

A reference to the UidPlusResult object to be filled with the outcome of the copy operation reported by UIDPLUS enabled server (the outcome includes the UIDs of the source messages being copied, the UIDs assigned to the copied messages in the destination folder, and the UIDVALIDITY of the destination folder), or a null reference (Nothing in Visual Basic) if the application does not need this information.

Return Value

true if the messages were copied successfully; otherwise, false.

Remarks

To learn how to specify a valid message sequence (messageIndexSet value), see DownloadEnvelopes topic.

When result is specified and the server supports UIDPLUS extension, CopyMessages method will set the supplied UidPlusResult object properties as below:

If UIDPLUS capability is not supported by the server, IsSupported will be set to false.

Exceptions

Example

This sample copies last 3 messages from the inbox folder to the Sent folder (it's assumed the Sent folder already exists and the inbox contains at least 3 messages). The UIDs assigned to the copied messages in the destination folder are displayed if UIDPLUS capability is supported by the server.

[C#]
using System;
using MailBee;
using MailBee.ImapMail;

class Sample
{
    static void Main(string[] args)
    {
        Imap imp = new Imap();

        // Connect to the server, login and select inbox.
        imp.Connect("mail.company.com");
        imp.Login("jdoe@company.com", "secret");
        imp.SelectFolder("INBOX");

        // Prepare the object that will receive copying results.
        UidPlusResult res = new UidPlusResult();

        string range = (imp.MessageCount - 2).ToString() + ":*";

        // Copy the messages into "Sent" and fill res with copying results.
        imp.CopyMessages(range, false, "Sent", res);

        if (res.IsSupported)
        {
            Console.WriteLine("UIDs assigned to the copied messages are " +
                res.DestUidString);
        }
        else
        {
            Console.WriteLine("Sorry, UIDPLUS is not supported by the server");
        }

        // Disconnect from the server.
        imp.Disconnect();
    }
}

[Visual Basic]
Imports System
Imports MailBee
Imports MailBee.ImapMail

Module Sample
    Sub Main(ByVal args As String())
        Dim imp As New Imap

        ' Connect to the server, login and select inbox.
        imp.Connect("mail.company.com")
        imp.Login("jdoe@company.com", "secret")
        imp.SelectFolder("INBOX")

        ' Prepare the object that will receive copying results.
        Dim res As New UidPlusResult
        Dim range As String = (imp.MessageCount - 2).ToString() & ":*"

        ' Copy the messages into "Sent" and fill res with copying results.
        imp.CopyMessages(range, False, "Sent", res)

        If res.IsSupported Then
            Console.WriteLine("UIDs assigned to the copied messages are " & _
                res.DestUidString)
        Else
            Console.WriteLine("Sorry, UIDPLUS is not supported by the server")
        End If

        ' Disconnect from the server.
        imp.Disconnect()
    End Sub
End Module

See Also

Imap Class | MailBee.ImapMail Namespace | Imap.CopyMessages Overload List | MoveMessages

---