Керування, переміщення та організація IMAP‑папок

Операції над папками

Отримати інформацію про папку

Отримати інформацію про папки з IMAP-сервера дуже легко за допомогою Aspose.Email. Викличте ListFolders() метод ImapClient клас. Повертає об’єкт ImapFolderInfoCollection тип. Ітеруйте цю колекцію та отримуйте інформацію про окремі папки у циклі. Метод перевантажений. Ви можете передати назву папки як параметр, щоб отримати список підпапок. Нижче наведено фрагмент коду, який показує, як отримати інформацію про папки з IMAP‑серверу за допомогою Aspose.Email, використовуючи описаний метод.

// Get all folders in the currently subscribed folder
ImapFolderInfoCollection folderInfoColl = client.ListFolders();

// Iterate through the collection to get folder info one by one
foreach (ImapFolderInfo folderInfo in folderInfoColl)
{
    // Folder name and get New messages in the folder
    Console.WriteLine("Folder name is " + folderInfo.Name);
    ImapFolderInfo folderExtInfo = client.GetFolderInfo(folderInfo.Name);
    Console.WriteLine("New message count: " + folderExtInfo.NewMessageCount);
    Console.WriteLine("Is it readonly? " + folderExtInfo.ReadOnly);
    Console.WriteLine("Total number of messages " + folderExtInfo.TotalMessageCount);
}

Видалити та перейменувати папки

Папку на IMAP-сервері можна видалити або перейменувати одним рядком за допомогою Aspose.Email:

  • The DeleteFolder() метод приймає назву папки як параметр.
  • Для RenameFolder() метод, вам потрібно передати поточну назву папки та нову назву папки. Нижчий фрагмент коду показує, як видалити папку з IMAP-сервера та як перейменувати папку. Кожна операція виконується одним рядком коду.
// Delete a folder and Rename a folder
client.DeleteFolder("foldername");
client.RenameFolder("foldername", "newfoldername");

Робота зі спеціальними папками поштових скриньок

Деякі сховища повідомлень IMAP містять спеціальні поштові скриньки, наприклад для чернеток чи надісланих листів. Багато поштових клієнтів дозволяють користувачам вказати, куди зберігати чернетки чи надіслані листи, але їх налаштування вимагає знання, які скриньки сервер виділив для цих цілей. Aspose.Email може ідентифікувати такі спеціальні скриньки, використовуючи ImapMailboxInfo клас, який спрощує роботу з ними. Наведений приклад коду демонструє, як отримати доступ до цих спеціальних поштових скриньок, використовуючи ImapMailboxInfo клас.

ImapClient imapClient = new ImapClient();
imapClient.Host = "<HOST>";
imapClient.Port = 993;
imapClient.Username = "<USERNAME>";
imapClient.Password = "<PASSWORD>";
imapClient.SupportedEncryption = EncryptionProtocols.Tls;
imapClient.SecurityOptions = SecurityOptions.SSLImplicit;
            
ImapMailboxInfo mailboxInfo = imapClient.MailboxInfo;
Console.WriteLine(mailboxInfo.Inbox);
Console.WriteLine(mailboxInfo.DraftMessages);
Console.WriteLine(mailboxInfo.JunkMessages);
Console.WriteLine(mailboxInfo.SentMessages);
Console.WriteLine(mailboxInfo.Trash);

Операції з повідомленнями у папках

Додати нове повідомлення у папку

Ви можете додати нове повідомлення у папку, використовуючи MailMessage і ImapClient класи. Спочатку створіть MailMessage об’єкт, вказавши значення теми, отримувача та відправника. Потім підписатись на папку та додати повідомлення туди. Нижче наведено фрагмент коду, який демонструє, як додати нове повідомлення у папку.

// Create a message
MailMessage msg = new MailMessage("user@domain1.com", "user@domain2.com", "subject", "message");

// Subscribe to the Inbox folder and Append the newly created message
client.SelectFolder(ImapFolderInfo.InBox);
client.SubscribeFolder(client.CurrentFolder.Name);
client.AppendMessage(client.CurrentFolder.Name, msg);

Додати кілька повідомлень за допомогою MultiConnection

Ви можете додати кілька повідомлень, використовуючи AppendMessages метод, наданий ImapClient класи. The AppendMessages метод приймає список MailMessage і додає його до поточної папки, якщо папка не передана як параметр. ImapClient також підтримує режим MultiConnection для інтенсивних операцій. Нижчий код демонструє, як додати декілька повідомлень за допомогою режиму MultiConnection.

ImapClient imapClient = new ImapClient();
imapClient.Host = "<HOST>";
imapClient.Port = 993;
imapClient.Username = "<USERNAME>";
imapClient.Password = "<PASSWORD>";
imapClient.SupportedEncryption = EncryptionProtocols.Tls;
imapClient.SecurityOptions = SecurityOptions.SSLImplicit;

List<MailMessage> messages = new List<MailMessage>();
for (int i = 0; i < 20; i++)
{
    MailMessage message = new MailMessage(
        "<EMAIL ADDRESS>",
        "<EMAIL ADDRESS>",
        "Test Message - " + Guid.NewGuid().ToString(),
        "IMAP Group Append with MultiConnection");
    messages.Add(message);
}

imapClient.ConnectionsQuantity = 5;
imapClient.UseMultiConnection = MultiConnectionMode.Enable;
imapClient.AppendMessages(messages);

Переміщення повідомлень між папками

Aspose.Email для .NET дозволяє переміщати повідомлення з однієї папки поштової скриньки в іншу, використовуючи ImapClient API. Цей MoveMessage метод використовує унікальний ідентифікатор повідомлення та назву папки призначення для переміщення повідомлення у папку призначення. Наступний фрагмент коду показує, як перемістити повідомлення в іншу папку поштової скриньки.

///<summary>
/// This example shows how to move a message from one folder of a mailbox to another one using the ImapClient API of Aspose.Email for .NET
/// Available from Aspose.Email for .NET 6.4.0 onwards
/// -------------- Available API Overload Members --------------
/// Void ImapClient.MoveMessage(IConnection iConnection, int sequenceNumber, string folderName, bool commitDeletions)
/// Void ImapClient.MoveMessage(IConnection iConnection, string uniqueId, string folderName, bool commitDeletions)
/// Void ImapClient.MoveMessage(int sequenceNumber, string folderName, bool commitDeletions)
/// Void ImapClient.MoveMessage(string uniqueId, string folderName, bool commitDeletions)
/// Void ImapClient.MoveMessage(IConnection iConnection, int sequenceNumber, string folderName)
/// Void ImapClient.MoveMessage(IConnection iConnection, string uniqueId, string folderName)
/// Void ImapClient.MoveMessage(int sequenceNumber, string folderName)
/// Void ImapClient.MoveMessage(string uniqueId, string folderName)
///</summary>

using (ImapClient client = new ImapClient("host.domain.com", 993, "username", "password"))
{
    string folderName = "EMAILNET-35151";
    if (!client.ExistFolder(folderName))
        client.CreateFolder(folderName);
    try
    {
        MailMessage message = new MailMessage(
            "from@domain.com",
            "to@domain.com",
            "EMAILNET-35151 - " + Guid.NewGuid(),
            "EMAILNET-35151 ImapClient: Provide option to Move Message");
        client.SelectFolder(ImapFolderInfo.InBox);
        // Append the new message to Inbox folder
        string uniqueId = client.AppendMessage(ImapFolderInfo.InBox, message);
        ImapMessageInfoCollection messageInfoCol1 = client.ListMessages();
        Console.WriteLine(messageInfoCol1.Count);
        // Now move the message to the folder EMAILNET-35151
        client.MoveMessage(uniqueId, folderName);
        client.CommitDeletes();
        // Verify that the message was moved to the new folder
        client.SelectFolder(folderName);
        messageInfoCol1 = client.ListMessages();
        Console.WriteLine(messageInfoCol1.Count);
        // Verify that the message was moved from the Inbox
        client.SelectFolder(ImapFolderInfo.InBox);
        messageInfoCol1 = client.ListMessages();
        Console.WriteLine(messageInfoCol1.Count);
    }
    finally
    {
        try { client.DeleteFolder(folderName); }
        catch { }
    }
}

Копіювати повідомлення між папками

API Aspose.Email забезпечує можливість копіювати повідомлення з однієї папки поштової скриньки в іншу. Це дозволяє копіювати як одне, так і кілька повідомлень, використовуючи CopyMessage і CopyMessages методи. CopyMessages метод забезпечує можливість копіювати кілька повідомлень з вихідної папки скриньки до папки призначення. Наведений нижче фрагмент коду показує, як копіювати повідомлення в іншу папку скриньки.

using (ImapClient client = new ImapClient("exchange.aspose.com", "username", "password"))
{
    // Create the destination folder
    string folderName = "EMAILNET-35242";
    if (!client.ExistFolder(folderName))
        client.CreateFolder(folderName);
    try
    {
        // Append a couple of messages to the server
        MailMessage message1 = new MailMessage(
            "asposeemail.test3@aspose.com",
            "asposeemail.test3@aspose.com",
            "EMAILNET-35242 - " + Guid.NewGuid(),
            "EMAILNET-35242 Improvement of copy method.Add ability to 'copy' multiple messages per invocation.");
        string uniqueId1 = client.AppendMessage(message1);

        MailMessage message2 = new MailMessage(
            "asposeemail.test3@aspose.com",
            "asposeemail.test3@aspose.com",
            "EMAILNET-35242 - " + Guid.NewGuid(),
            "EMAILNET-35242 Improvement of copy method.Add ability to 'copy' multiple messages per invocation.");
        string uniqueId2 = client.AppendMessage(message2);

        // Verify that the messages have been added to the mailbox
        client.SelectFolder(ImapFolderInfo.InBox);
        ImapMessageInfoCollection msgsColl = client.ListMessages();
        foreach (ImapMessageInfo msgInfo in msgsColl)
            Console.WriteLine(msgInfo.Subject);

        // Copy multiple messages using the CopyMessages command and Verify that messages are copied to the destination folder
        client.CopyMessages(new[] { uniqueId1, uniqueId2 }, folderName);

        client.SelectFolder(folderName);
        msgsColl = client.ListMessages();
        foreach (ImapMessageInfo msgInfo in msgsColl)
            Console.WriteLine(msgInfo.Subject);
    }
    finally
    {
        try
        {
            client.DeleteFolder(folderName);
        }
        catch { }
    }
}