Documentation – Робота з клієнтом IMAP

Java: Підключення до IMAP сервера

Mon, 01 Jan 0001 00:00:00 +0000

The ImapClient клас дозволяє застосункам керувати IMAP‑скриньками, використовуючи протокол IMAP. ImapClient клас використовується для підключення до IMAP‑mail серверів та керування електронними листами у IMAP‑папках. Щоб підключитися до IMAP‑сервера

Створіть екземпляр ImapClient клас.
Вкажіть ім’я хосту, ім’я користувача та пароль у Конструктор ImapClient.

Як тільки ImapClient екземпляр ініціалізовано, наступний виклик будь-якої операції з цим екземпляром підключиться до сервера. Нижче наведений фрагмент коду показує, як підключитися до IMAP‑сервера, використовуючи вищенаведені кроки.

// For complete examples and data files, please go to https://github.com/aspose-email/Aspose.Email-for-Java
// Create an imapclient with host, user and password
ImapClient client = new ImapClient("localhost", "user", "password");

Підключення до IMAP сервера з SSL

Підключення до IMAP сервера описано, як підключитися до IMAP‑сервера у чотири простих кроки:

Створіть екземпляр ImapClient клас.
Вкажіть ім’я хосту, ім’я користувача та пароль.
Вкажіть порт.
Вкажіть Опції безпеки.

Процес підключення до IMAP‑сервера з увімкненим SSL схожий, проте вимагає встановлення декількох додаткових властивостей:

Встановити Опції безпеки до SSLImplicit.

Нижче наведений фрагмент коду показує, як

Вкажіть ім’я користувача, пароль та порт.
Встановіть параметр безпеки.

// For complete examples and data files, please go to https://github.com/aspose-email/Aspose.Email-for-Java
// Create an instance of the ImapClient class
ImapClient client = new ImapClient("imap.domain.com", 993, "user@domain.com", "pwd");

// Set the security mode to implicit
client.setSecurityOptions(SecurityOptions.SSLImplicit);

Підключення до сервера через проксі

Проксі‑сервери часто використовуються для зв’язку зі світом. У таких випадках поштові клієнти не можуть підключитися до Інтернету без указання адреси проксі. Aspose.Email підтримує версії 4, 4a та 5 протоколу SOCKS. У цій статті представлений робочий приклад доступу до скриньки через проксі‑mail сервер. Щоб отримати доступ до скриньки через проксі‑сервер:

Ініціалізувати SocksProxy з необхідною інформацією, а саме адресою проксі, портом та версією SOCKS.
Ініціалізувати ImapClient з адресою хосту, ім’ям користувача, паролем та іншими налаштуваннями.
Встановити клієнт SocksProxy властивість до SocksProxy об’єкт, створений вище.

Нижче наведений фрагмент коду показує, як отримати поштову скриньку через проксі‑сервер.

// For complete examples and data files, please go to https://github.com/aspose-email/Aspose.Email-for-Java
// Connect and log in to IMAP and set SecurityOptions
ImapClient client = new ImapClient("imap.domain.com", "username", "password");
client.setSecurityOptions(SecurityOptions.Auto);

String proxyAddress = "192.168.203.142"; // proxy address
int proxyPort = 1080; // proxy port
SocksProxy proxy = new SocksProxy(proxyAddress, proxyPort, SocksVersion.SocksV5);

// Set the proxy
client.setProxy(proxy);

try {
    client.selectFolder("Inbox");
} catch (java.lang.RuntimeException ex) {
    System.out.println(ex.getMessage());
}

Підключення до сервера через HTTP‑проксі

// For complete examples and data files, please go to https://github.com/aspose-email/Aspose.Email-for-Java
HttpProxy proxy = new HttpProxy("18.222.124.59", 8080);
final ImapClient client = new ImapClient("imap.domain.com", "username", "password");
try {
    client.setProxy(proxy);
    client.selectFolder("Inbox");
} finally {
    if (client != null)
        client.dispose();
}

Налаштування механізму автентифікації

Отримати список механізмів автентифікації, підтримуваних IMAP‑сервером, використовуючи getSupportedAuthentication метод ImapClient клас. Цей метод дозволяє клієнту визначити, які методи автентифікації доступні для встановлення захищеного з’єднання з сервером. Потім, використовуючи setAllowedAuthentication метод, який отримує (або встановлює) перелік типів автентифікації, дозволених користувачем, обирайте найбільш підходящий механізм автентифікації для взаємодії клієнт‑сервер. Це дозволяє явно встановити метод автентифікації для поштового клієнта.

Нижче наведено зразок коду, який показує, як налаштувати автентифікацію клієнта електронної пошти:

imapClient.setAllowedAuthentication(ImapKnownAuthenticationType.Plain);

Підключення до сервера у режимі лише для читання

The ImapClient клас забезпечує ReadOnly властивість, яка при встановленому значенні true вказує, що не слід вносити зміни у постійний стан скриньки. Нижче наведений приклад коду демонструє використання ImapClient.ReadOnly властивості. Вона отримує кількість непрочитаних повідомлень, потім завантажує одне повідомлення і знову отримує кількість непрочитаних повідомлень у режимі лише для читання. Кількість непрочитаних повідомлень залишається такою ж, що вказує на те, що постійний стан скриньки не змінився.

// For complete examples and data files, please go to https://github.com/aspose-email/Aspose.Email-for-Java
ImapClient imapClient = new ImapClient();
imapClient.setHost("<HOST>");
imapClient.setPort(993);
imapClient.setUsername("<USERNAME>");
imapClient.setPassword("<PASSWORD>");
imapClient.setSupportedEncryption(EncryptionProtocols.Tls);
imapClient.setSecurityOptions(SecurityOptions.SSLImplicit);

ImapQueryBuilder imapQueryBuilder = new ImapQueryBuilder();
imapQueryBuilder.hasNoFlags(ImapMessageFlags.isRead()); /* get unread messages. */
MailQuery query = imapQueryBuilder.getQuery();

imapClient.setReadOnly(true);
imapClient.selectFolder("Inbox");
ImapMessageInfoCollection messageInfoCol = imapClient.listMessages(query);
System.out.println("Initial Unread Count: " + messageInfoCol.size());
if (messageInfoCol.size() > 0) {
    imapClient.fetchMessage(messageInfoCol.get_Item(0).getSequenceNumber());

    messageInfoCol = imapClient.listMessages(query);
    // This count will be equal to the initial count
    System.out.println("Updated Unread Count: " + messageInfoCol.size());
} else {
    System.out.println("No unread messages found");
}

Використання автентифікації CRAM‑MD5 для підключення до сервера

Щоб забезпечити безпечну автентифікацію та зв’язок з IMAP‑сервером, ви можете вказати та примусово використовувати CRAM-MD5 як дозволений метод автентифікації для IMAP‑клієнта. Нижче наведений фрагмент коду показує, як налаштувати дозволений тип автентифікації для ImapClient:

imapClient.setAllowedAuthentication(ImapKnownAuthenticationType.CramMD5);

Перевірка облікових даних поштового сервера без надсилання листа

Іноді необхідно перевірити облікові дані без надсилання листа. Aspose.Email надає validateCredentials() метод для виконання цієї операції. Якщо валідація успішна, виконується код всередині if, зазвичай використовується для подальших дій або отримання даних з IMAP‑сервера. Наступний фрагмент коду демонструє валідацію облікових даних без надсилання листа:

try (ImapClient imapClient = new ImapClient(
        server.ImapUrl, server.ImapPort, "username", "password", SecurityOptions.Auto)) {
    imapClient.setTimeout(4000);

    if (imapClient.validateCredentials()) {
        // to do something
    }
}

Як встановити тайм-аут для поштових операцій

Кожна поштові операція займає певний час залежно від багатьох факторів (затримки мережі, розмір даних, продуктивність сервера тощо). Ви можете встановити тайм-аут для всіх поштових операцій. Нижче наведено приклад коду, який демонструє, як це зробити за допомогою Тайм-аут властивість. Примітка: не варто встановлювати великі значення, аби уникнути тривалих очікувань у вашому застосунку.

try (ImapClient imapClient = new ImapClient("host", 993, "username", "password", SecurityOptions.SSLImplicit))
{
    imapClient.setTimeout(60000); // 60 seconds

    // some code...
}

Як обмежити тайм‑аут привітання

IMAP‑клієнт може використовувати автоматичний режим встановлення з’єднання. У цьому режимі IMAP‑клієнт перебирає всі можливі параметри з’єднання, доки не встановиться з’єднання. У випадку успішного підключення IMAP‑сервер надсилає рядок привітання клієнту. Сервери можуть ініціювати SSL/TLS з’єднання явно (START TLS) або неявно. Якщо режим з’єднання не відповідає (наприклад, сервер очікує неявне SSL‑з’єднання, а клієнт намагається встановити незахищене або явне SSL‑з’єднання), сервер не надсилає рядок привітання, і користувач довго чекає, доки не спливе тайм‑аут, після чого клієнт переходить до наступної опції підключення. Щоб уникнути цієї проблеми, було введено властивість GreetingTimeout. Ця властивість дозволяє встановити тайм‑аут для рядка привітання та скоротити час автоматичного встановлення з’єднання.

ImapClient imapClient = new ImapClient();
imapClient.setGreetingTimeout(4000);

Java: Робота з повідомленнями з IMAP‑сервера

Mon, 01 Jan 0001 00:00:00 +0000

Перелік MIME ідентифікаторів повідомлень з сервера

ImapMessageInfo надає MIME MessageId для ідентифікації повідомлення без витягнення повного повідомлення. Нижче наведений фрагмент коду показує, як перелічити MIME‑messageId.

// For complete examples and data files, please go to https://github.com/aspose-email/Aspose.Email-for-Java
ImapClient client = new ImapClient();
client.setHost("domain.com");
client.setUsername("username");
client.setPassword("password");

try {
    ImapMessageInfoCollection messageInfoCol = client.listMessages("Inbox");
    for (ImapMessageInfo info : messageInfoCol) {
        // Display MIME Message ID
        System.out.println("Message Id = " + info.getMessageId());
    }
} catch (java.lang.RuntimeException ex) {
    System.out.println(ex.getMessage());
}

Перелічення повідомлень з сервера

Aspose.Email надає 2‑членну перевантажену варіанту listMessages() для отримання вказаної кількості повідомлень за запитом. Нижче наведений фрагмент коду показує, як перелічити повідомлення.

// For complete examples and data files, please go to https://github.com/aspose-email/Aspose.Email-for-Java
// Create an imapclient with host, user and password
ImapClient client = new ImapClient("localhost", "user", "password");

// Select the inbox folder and Get the message info collection
ImapQueryBuilder builder = new ImapQueryBuilder();
MailQuery query = builder
        .or(builder.or(builder.or(builder.or(builder.getSubject().contains(" (1) "), builder.getSubject().contains(" (2) ")), builder.getSubject().contains(" (3) ")),
                builder.getSubject().contains(" (4) ")), builder.getSubject().contains(" (5) "));
ImapMessageInfoCollection messageInfoCol4 = client.listMessages(query, 4);
System.out.println((messageInfoCol4.size() == 4) ? "Success" : "Failure");

Рекурсивне перелічення повідомлень з сервера

Протокол IMAP підтримує рекурсивне перелічення повідомлень у папці скриньки. Це дозволяє також перелічати повідомлення з підпапок. Нижче наведений фрагмент коду показує, як рекурсивно перелічити повідомлення.

// For complete examples and data files, please go to https://github.com/aspose-email/Aspose.Email-for-Java
// Create an imapclient with host, user and password
ImapClient client = new ImapClient();
client.setHost("domain.com");
client.setUsername("username");
client.setPassword("password");
client.selectFolder("InBox");
ImapMessageInfoCollection msgsColl = client.listMessages(true);
System.out.println("Total Messages: " + msgsColl.size());

Перелік повідомлень з MultiConnection

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

// For complete examples and data files, please go to https://github.com/aspose-email/Aspose.Email-for-Java
ImapClient imapClient = new ImapClient();
imapClient.setHost("<HOST>");
imapClient.setPort(993);
imapClient.setUsername("<USERNAME>");
imapClient.setPassword("<PASSWORD>");
imapClient.setSupportedEncryption(EncryptionProtocols.Tls);
imapClient.setSecurityOptions(SecurityOptions.SSLImplicit);

imapClient.selectFolder("Inbox");
imapClient.setConnectionsQuantity(5);
imapClient.setUseMultiConnection(MultiConnectionMode.Enable);
long multiConnectionModeStartTime = System.currentTimeMillis();
ImapMessageInfoCollection messageInfoCol1 = imapClient.listMessages(true);
long multiConnectionModeTimeSpan = System.currentTimeMillis() - multiConnectionModeStartTime;

imapClient.setUseMultiConnection(MultiConnectionMode.Disable);
long singleConnectionModeStartTime = System.currentTimeMillis();
ImapMessageInfoCollection messageInfoCol2 = imapClient.listMessages(true);
long singleConnectionModeTimeSpan = System.currentTimeMillis() - singleConnectionModeStartTime;

double performanceRelation = singleConnectionModeTimeSpan / multiConnectionModeTimeSpan;
System.out.println("Performance Relation: " + performanceRelation);

Зауважте, що використання режиму мультипідключення не гарантує підвищення продуктивності.

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

Aspose.Email надає ImapClient.listMessagesByPage метод, який перелічує повідомлення з підтримкою пагінації. Деякі перегрузки ImapClient.listMessagesByPage приймає PageSettings як параметр. PageSettings надає AscendingSorting властивість, яка при встановленні значення false, повертає листи у зворотному порядку.

Наведений нижче приклад коду демонструє використання AscendingSorting властивість PageSettings клас для зміни порядку листів.

// For complete examples and data files, please go to https://github.com/aspose-email/Aspose.Email-for-Java
ImapClient imapClient = new ImapClient();
imapClient.setHost("<HOST>");
imapClient.setPort(993);
imapClient.setUsername("<USERNAME>");
imapClient.setPassword("<PASSWORD>");
imapClient.setSupportedEncryption(EncryptionProtocols.Tls);
imapClient.setSecurityOptions(SecurityOptions.SSLImplicit);

PageSettings pageSettings = new PageSettings();
pageSettings.setAscendingSorting(false);
ImapPageInfo pageInfo = imapClient.listMessagesByPage(5, pageSettings);
ImapMessageInfoCollection messages = pageInfo.getItems();

for (ImapMessageInfo message : messages) {
    System.out.println(message.getSubject() + " -> " + message.getDate().toString());
}

Отримати повідомлення з сервера та зберегти на диск

The ImapClient клас може отримувати повідомлення з IMAP-сервера та зберігати їх у форматі EML на локальний диск. Для збереження повідомлень на диск необхідно виконати наступні кроки:

Створіть екземпляр ImapClient клас.
Вкажіть ім’я хоста, порт, ім’я користувача та пароль у ImapClient конструктор.
Виберіть папку за допомогою selectFolder() метод.
Викличте listMessages метод для отримання ImapMessageInfoCollection об’єкт.
Ітеруйте через ImapMessageInfoCollection колекція, викличте saveMessage() метод і вказати шлях до виводу та ім’я файлу.

Наведений нижче фрагмент коду показує, як отримати листи з сервера та зберегти їх.

// For complete examples and data files, please go to https://github.com/aspose-email/Aspose.Email-for-Java
// Select the inbox folder and Get the message info collection
client.selectFolder(ImapFolderInfo.IN_BOX);
ImapMessageInfoCollection list = client.listMessages();

// Download each message
for (int i = 0; i < list.size(); i++) {
    // Save the EML file locally
    client.saveMessage(list.get_Item(i).getUniqueId(), dataDir + list.get_Item(i).getUniqueId() + ".eml");
}

Збереження повідомлень у форматі MSG

У наведеному вище прикладі, листи зберігаються у форматі EML. Щоб зберегти листи у форматі MSG, ImapClient.fetchMessage() метод потрібно викликати. Він повертає повідомлення у екземплярі MailMessage клас. The MailMessage.save() метод можна викликати для збереження повідомлення у форматі MSG. Наведений нижче фрагмент коду показує, як зберігати повідомлення у форматі MSG.

// For complete examples and data files, please go to https://github.com/aspose-email/Aspose.Email-for-Java
// The path to the file directory.
String dataDir = "data/";

// Create an imapclient with host, user and password
ImapClient client = new ImapClient("localhost", "user", "password");

// Select the inbox folder and Get the message info collection
client.selectFolder(ImapFolderInfo.IN_BOX);
ImapMessageInfoCollection list = client.listMessages();

// Download each message
for (int i = 0; i < list.size(); i++) {
    // Save the message in MSG format
    MailMessage message = client.fetchMessage(list.get_Item(i).getUniqueId());
    message.save(dataDir + list.get_Item(i).getUniqueId() + "_out.msg", SaveOptions.getDefaultMsgUnicode());
}

Групове отримання повідомлень

ImapClient надає fetchMessages метод, який приймає ітерабельну колекцію номерів послідовності або унікальних ідентифікаторів і повертає список MailMessage. Наступний фрагмент коду демонструє використання fetchMessages метод для отримання повідомлень за номерами послідовності та унікальним ідентифікатором.

// For complete examples and data files, please go to https://github.com/aspose-email/Aspose.Email-for-Java
ImapClient imapClient = new ImapClient();
imapClient.setHost("<HOST>");
imapClient.setPort(993);
imapClient.setUsername("<USERNAME>");
imapClient.setPassword("<PASSWORD>");
imapClient.setSupportedEncryption(EncryptionProtocols.Tls);
imapClient.setSecurityOptions(SecurityOptions.SSLImplicit);

ImapMessageInfoCollection messageInfoCol = imapClient.listMessages();
System.out.println("ListMessages Count: " + messageInfoCol.size());

List<Integer> sequenceNumberAr = new ArrayList<Integer>();
List<String> uniqueIdAr = new ArrayList<String>();
for (ImapMessageInfo mi : messageInfoCol) {
    sequenceNumberAr.add(mi.getSequenceNumber());
    uniqueIdAr.add(mi.getUniqueId());
}

for (MailMessage m : imapClient.fetchMessagesBySequences(sequenceNumberAr)) {
    System.out.println("FetchMessages-sequenceNumberAr : " + m.getSubject());
}

for (MailMessage m : imapClient.fetchMessagesByUids(uniqueIdAr)) {
    System.out.println("FetchMessages-uniqueIdAr : " + m.getSubject());
}

Групування email / Організація листів у розмови

Aspose.Email дозволяє групувати всі переслані, відповіді та відповіді всім, що стосуються однієї розмови, у ієрархічному вигляді. По суті, протокол IMAP може підтримувати можливість THREAD, визначену в RFC-5256. Окрім того, існує інше розширення IMAP, надане Gmail і описане як X-GM-EXT-1.

Нижченаведені функції групування email доступні для використання:

getMessageThreads метод – отримує ланцюжки повідомлень за допомогою ImapClient.
boolean getGmExt1Supported - Отримує інформацію про підтримку розширення Gmail X-GM-EXT-1.
boolean getThreadSupported - Отримує інформацію про підтримку розширення THREAD.
String[] getThreadAlgorithms - Отримує підтримувані алгоритми THREAD.

Наведені нижче приклади коду демонструють використання цих можливостей для отримання ланцюжків email у Gmail:

  ImapClient client = new ImapClient("imap.gmail.com", 993, "username", "password", SecurityOptions.SSLImplicit);

try {

    client.selectFolder(ImapFolderInfo.IN_BOX);

   // get a list of messages that we'll group by conversation

   ImapMessageInfoCollection messages = client.listMessages();

   // make sure the IMAP server supports X-GM-EXT-1 extension

   if (client.getGmExt1Supported()) {

       // gets unique conversationId for our example

       Set<String> conversationIds = new HashSet<String>();

       for (ImapMessageInfo messageInfo : messages) {

           if (messageInfo.getConversationId() != null)

                conversationIds.add(messageInfo.getConversationId());

       }

       for (String conversationId : conversationIds) {

           // create the necessary search conditions for a thread

           XGMThreadSearchConditions conditions = new XGMThreadSearchConditions();

            conditions.setConversationId(conversationId);

            conditions.setUseUId(true);

           // get results

           List<MessageThreadResult> conversation = client.getMessageThreads(conditions);

           // print the email conversation in hierarchically manner

           printConversaton("", conversation, messages);

            System.out.println("--------------------");

       }

   }

} finally {

    client.dispose();

}

/**

 * <p>

 * Prints the email conversation in hierarchically manner

 * </p>

 */

public static void printConversaton(String indent, Iterable<MessageThreadResult> conversation,

    Iterable<ImapMessageInfo> messages) {

   for (MessageThreadResult thread : conversation) {

       for (ImapMessageInfo messageInfo : messages) {

           if (thread.getUniqueId().equals(messageInfo.getUniqueId())) {

                System.out.println(indent + " (" + thread.getUniqueId() + ") " + messageInfo.getSubject());

               break;

           }

       }

       if (thread.getChildMessages().size() != 0) {

            printConversaton(indent += "-", thread.getChildMessages(), messages);

       }

   }

}

Код трохи змінюється, якщо IMAP-сервер підтримує можливість THREAD:

Перевірте, чи підтримує IMAP-сервер розширення THREAD:

 if (client.getThreadSupported())

Створіть відповідні умови пошуку для гілки (thread):

 ThreadSearchConditions conditions = new ThreadSearchConditions();

conditions.setAlgorithm(client.getThreadAlgorithms()[0]);

conditions.setUseUId(true);

Перелік повідомлень з підтримкою посторінкового перегляду

У випадках, коли на email-сервері знаходиться велика кількість повідомлень у поштовій скринці, часто потрібно перелічати або отримувати повідомлення з підтримкою посторінкового перегляду. API Aspose.Email ImapClient дозволяє отримувати повідомлення з сервера з підтримкою посторінкового перегляду.

// For complete examples and data files, please go to https://github.com/aspose-email/Aspose.Email-for-Java
// This example shows the paging support of ImapClient for listing messages from the server
// Available in Aspose.Email for Java and onwards
final ImapClient client = new ImapClient("host.domain.com", 993, "username", "password");
try {
    try {
        int messagesNum = 12;
        int itemsPerPage = 5;
        MailMessage message = null;
        // Create some test messages and append these to server's inbox
        for (int i = 0; i < messagesNum; i++) {
            message = new MailMessage("from@domain.com", "to@domain.com", "EMAILNET-35157 - " + UUID.randomUUID(),
                    "EMAILNET-35157 Move paging parameters to separate class");
            client.appendMessage(ImapFolderInfo.IN_BOX, message);
        }

        // List messages from inbox
        client.selectFolder(ImapFolderInfo.IN_BOX);
        ImapMessageInfoCollection totalMessageInfoCol = client.listMessages();
        // Verify the number of messages added
        System.out.println(totalMessageInfoCol.size());

        ////////////////// RETREIVE THE MESSAGES USING PAGING SUPPORT////////////////////////////////////

        List<ImapPageInfo> pages = new ArrayList<ImapPageInfo>();
        PageSettings pageSettings = new PageSettings();
        ImapPageInfo pageInfo = client.listMessagesByPage(itemsPerPage, 0, pageSettings);
        System.out.println(pageInfo.getTotalCount());
        pages.add(pageInfo);
        while (!pageInfo.getLastPage()) {
            pageInfo = client.listMessagesByPage(itemsPerPage, pageInfo.getNextPage().getPageOffset(), pageSettings);
            pages.add(pageInfo);
        }
        int retrievedItems = 0;

        // foreach to while statements conversion
        for (ImapPageInfo folderCol : pages) {
            retrievedItems += folderCol.getItems().size();
        }
        System.out.println(retrievedItems);
    } finally {
    }
} finally {
    if (client != null)
        client.dispose();
}

Отримання папок та читання повідомлень рекурсивно

У цій статті більшість ImapClient Функції використовуються для створення застосунку, який рекурсивно перераховує всі папки та підпапки з IMAP-сервера. Він також зберігає повідомлення в кожній папці та підпапці у форматі MSG на локальному диску. На диску папки та повідомлення створюються і зберігаються у такій же ієрархічній структурі, як на IMAP-сервері. Наведений нижче фрагмент коду показує, як отримати повідомлення та інформацію про підпапки рекурсивно.

// For complete examples and data files, please go to https://github.com/aspose-email/Aspose.Email-for-Java
public static void run() throws Exception {
    // Create an instance of the ImapClient class
    ImapClient client = new ImapClient();

    // Specify host, username, password, Port and SecurityOptions for your client
    client.setHost("imap.gmail.com");
    client.setUsername("your.username@gmail.com");
    client.setPassword("your.password");
    client.setPort(993);
    client.setSecurityOptions(SecurityOptions.Auto);
    try {
        // The root folder (which will be created on disk) consists of host and username
        String rootFolder = client.getHost() + "-" + client.getUsername();

        // Create the root folder and List all the folders from IMAP server
        new File(rootFolder).mkdirs();
        ImapFolderInfoCollection folderInfoCollection = client.listFolders();
        for (ImapFolderInfo folderInfo : folderInfoCollection) {
            // Call the recursive method to read messages and get sub-folders
            listMessagesInFolder(folderInfo, rootFolder, client);
        }
        // Disconnect to the remote IMAP server
        client.dispose();
    } catch (java.lang.RuntimeException ex) {
        System.out.println(ex);
    }

    System.out.println("Downloaded messages recursively from IMAP server.");
}

/// Recursive method to get messages from folders and sub-folders
private static void listMessagesInFolder(ImapFolderInfo folderInfo, String rootFolder, ImapClient client) {
    // Create the folder in disk (same name as on IMAP server)
    String currentFolder = "data/";
    new File(currentFolder).mkdirs();

    // Read the messages from the current folder, if it is selectable
    if (folderInfo.getSelectable()) {
        // Send status command to get folder info
        ImapFolderInfo folderInfoStatus = client.getFolderInfo(folderInfo.getName());
        System.out.println(folderInfoStatus.getName() + " folder selected. New messages: " + folderInfoStatus.getNewMessageCount() + ", Total messages: "
                + folderInfoStatus.getTotalMessageCount());

        // Select the current folder and List messages
        client.selectFolder(folderInfo.getName());
        ImapMessageInfoCollection msgInfoColl = client.listMessages();
        System.out.println("Listing messages....");
        for (ImapMessageInfo msgInfo : msgInfoColl) {
            // Get subject and other properties of the message
            System.out.println("Subject: " + msgInfo.getSubject());
            System.out.println("Read: " + msgInfo.isRead() + ", Recent: " + msgInfo.getRecent() + ", Answered: " + msgInfo.getAnswered());

            // Get rid of characters like ? and :, which should not be included in a file name and Save the message in MSG format
            String fileName = msgInfo.getSubject().replace(":", " ").replace("?", " ");
            MailMessage msg = client.fetchMessage(msgInfo.getSequenceNumber());
            msg.save(currentFolder + "\\" + fileName + "-" + msgInfo.getSequenceNumber() + ".msg", SaveOptions.getDefaultMsgUnicode());
        }
        System.out.println("============================\n");
    } else {
        System.out.println(folderInfo.getName() + " is not selectable.");
    }

    try {
        // If this folder has sub-folders, call this method recursively to get messages
        ImapFolderInfoCollection folderInfoCollection = client.listFolders(folderInfo.getName());
        for (ImapFolderInfo subfolderInfo : folderInfoCollection) {
            listMessagesInFolder(subfolderInfo, rootFolder, client);
        }
    } catch (java.lang.RuntimeException e) {
    }
}

Отримати UID повідомлення або порядковий номер

Публічний API Aspose.Email надає такі можливості для отримання ідентифікаційної інформації повідомлення, такої як UID або порядковий номер, що може знадобитися під час обробки повідомлень, отриманих з сервера:

MailboxInfo клас — представляє ідентифікаційну інформацію про повідомлення у поштовій скриньці.

getSequenceNumber() метод – отримує порядковий номер повідомлення.
getUniqueId() метод – отримує унікальний ідентифікатор повідомлення.

MailMessage клас – представляє електронне повідомлення та дозволяє отримати доступ до властивостей повідомлення, напр. тема, тіло, відправник та адреси отримувачів тощо.

getItemId метод – представляє ідентифікаційну інформацію про повідомлення у поштовій скринці.

Нижчий приклад коду демонструє, як отримати та відобразити деталі повідомлень з папки "INBOX" на IMAP-сервері за допомогою ImapClient клас:

try (ImapClient client = new ImapClient(imapHost, port, emailAddress, password, securityOption)) {
    ImapMessageInfoCollection msgs = client.listMessages("INBOX");
    List<Integer> seqIds = new ArrayList<>();
    for (ImapMessageInfo msg : msgs) {
        seqIds.add(msg.getSequenceNumber());
    }
    Iterable<MailMessage> msgsViaFetch = client.fetchMessagesBySequences(seqIds);
    for (MailMessage thisMsg : msgsViaFetch) {
        System.out.println("Message ID: " + thisMsg.getItemId().getUniqueId()
                + " SequenceNumber: " + thisMsg.getItemId().getSequenceNumber()
                + " Subject: " + thisMsg.getSubject());
    }
}

Отримання додаткових параметрів як підсумкової інформації

// For complete examples and data files, please go to https://github.com/aspose-email/Aspose.Email-for-Java
final ImapClient client = new ImapClient("host.domain.com", "username", "password");
try {
    MailMessage message = new MailMessage("from@domain.com", "to@doman.com", "EMAILNET-38466 - " + UUID.randomUUID().toString(),
            "EMAILNET-38466 Add extra parameters for UID FETCH command");

    // append the message to the server
    String uid = client.appendMessage(message);

    // wait for the message to be appended
    Thread.sleep(5000);

    // Define properties to be fetched from server along with the message
    List<String> messageExtraFields = Arrays.asList("X-GM-MSGID", "X-GM-THRID");

    // retreive the message summary information using it's UID
    ImapMessageInfo messageInfoUID = client.listMessage(uid, messageExtraFields);

    // retreive the message summary information using it's sequence number
    ImapMessageInfo messageInfoSeqNum = client.listMessage(1, messageExtraFields);

    // List messages in general from the server based on the defined properties
    ImapMessageInfoCollection messageInfoCol = client.listMessages(messageExtraFields);

    ImapMessageInfo messageInfoFromList = messageInfoCol.get_Item(0);

    // verify that the parameters are fetched in the summary information
    for (String paramName : messageExtraFields) {
        System.out.println(messageInfoFromList.getExtraParameters().containsKey(paramName));
        System.out.println(messageInfoUID.getExtraParameters().containsKey(paramName));
        System.out.println(messageInfoSeqNum.getExtraParameters().containsKey(paramName));
    }
} finally {
    if (client != null)
        client.dispose();
}

Отримання інформації про заголовок List-Unsubscribe

Заголовок List-Unsubscribe містить URL для відписки від електронних розсилок, наприклад реклами, новинних листів тощо. Щоб отримати заголовок List-Unsubscribe, використайте listUnsubscribe властивість ImapMessageInfo клас. Наведений нижче приклад демонструє використання listUnsubscribe властивість для отримання заголовка List-Unsubscribe.

// For complete examples and data files, please go to https://github.com/aspose-email/Aspose.Email-for-Java
ImapClient imapClient = new ImapClient();
imapClient.setHost("<HOST>");
imapClient.setPort(993);
imapClient.setUsername("<USERNAME>");
imapClient.setPassword("<PASSWORD>");
imapClient.setSupportedEncryption(EncryptionProtocols.Tls);
imapClient.setSecurityOptions(SecurityOptions.SSLImplicit);

ImapMessageInfoCollection messageInfoCol = imapClient.listMessages();
for (ImapMessageInfo imapMessageInfo : messageInfoCol) {
    System.out.println("ListUnsubscribe Header: " + imapMessageInfo.getListUnsubscribe());
}

Java: Робота з вкладеннями повідомлень за допомогою IMAP

Mon, 01 Jan 0001 00:00:00 +0000

Список вкладень повідомлень за допомогою IMAP‑клієнта

Щоб отримати інформацію про вкладення, таку як назва, розмір, без завантаження даних вкладення, використайте наступні можливості API:

ImapAttachmentInfo - Представляє інформацію про вкладення.
ImapAttachmentInfoCollection - Представляє колекцію ImapAttachmentInfo.
listAttachments(int sequenceNumber) - Отримує інформацію про кожне вкладення у повідомленні.

Наступний приклад коду показує, як використовувати IMAP‑клієнт для отримання інформації про електронні листи та їх вкладення з сервера, а потім відображення деталей вкладень для кожного листа. Це дозволяє отримувати доступ до вкладень електронних листів та обробляти їх за допомогою протоколу IMAP.

ImapMessageInfoCollection messageInfoCollection = imapClient.listMessages();

for (ImapMessageInfo message : messageInfoCollection) {
    ImapAttachmentInfoCollection attachmentInfoCollection =
            imapClient.listAttachments(message.getSequenceNumber());

    for (ImapAttachmentInfo attachmentInfo : attachmentInfoCollection) {
        System.out.println(
                "Attachment: " + attachmentInfo.getName() + " (size: " + attachmentInfo.getSize() + ")");
    }
}

Java: Робота з прапорцями повідомлень на сервері

Mon, 01 Jan 0001 00:00:00 +0000

Зміна прапорців повідомлення

Ви можете змінити прапори повідомлення, використовуючи changeMessageFlags() метод. Цей метод приймає два параметри.

Номер послідовності повідомлення або унікальний ID.
MessageFlag.

Наступні прапорці можна встановити:

Налаштування прапорців повідомлень

Наведений фрагмент коду показує, як змінити прапорці повідомлень на IMAP сервері за допомогою Aspose.Email.

// For complete examples and data files, please go to https://github.com/aspose-email/Aspose.Email-for-Java
// Mark the message as read
client.changeMessageFlags(1, ImapMessageFlags.isRead());

Видалення прапорців повідомлень

Прапорці повідомлень також можна видалити за допомогою removeMessageFlags() метод. Використання схоже на те, що в changeMessageFlags() метод. Він приймає номер послідовності або унікальний ID повідомлення і MessageFlag. Наведений фрагмент коду показує, як видалити прапорці повідомлення.

// For complete examples and data files, please go to https://github.com/aspose-email/Aspose.Email-for-Java
// Remove the message flag
client.removeMessageFlags(1, ImapMessageFlags.isRead());

Налаштування користувацьких прапорців

Ви також можете встановити користувацькі прапорці повідомленню, використовуючи ImapClient з API. ImapClient AddMessageFlags надає можливість встановлювати користувацькі прапорці на повідомленнях.

// For complete examples and data files, please go to https://github.com/aspose-email/Aspose.Email-for-Java
// Create a message
MailMessage message = new MailMessage("user@domain1.com", "user@domain2.com", "subject", "message");

// Append the message to mailbox
String uid = client.appendMessage(ImapFolderInfo.IN_BOX, message);

// Add custom flags to the added messge
client.addMessageFlags(uid, com.aspose.email.ImapMessageFlags.op_BitwiseOr(ImapMessageFlags.keyword("custom1"), ImapMessageFlags.keyword("custom1_0")));

// Retreive the messages for checking the presence of custom flag
client.selectFolder(ImapFolderInfo.IN_BOX);

ImapMessageInfoCollection messageInfos = client.listMessages();
for (ImapMessageInfo inf : messageInfos) {
    ImapMessageFlags[] flags = inf.getFlags().split();

    if (inf.containsKeyword("custom1"))
        System.out.println("Keyword found");
}

Java: Фільтрація повідомлень з сервера за допомогою IMAP-клієнта

Mon, 01 Jan 0001 00:00:00 +0000

The ImapClient class надає listMessages() метод, який отримує всі повідомлення зі скриньки. Щоб отримати лише повідомлення, що відповідають певній умові, використовуйте перевантажений listMessages() метод, який приймає MailQuery як аргумент. MailQuery клас надає різноманітні властивості для зазначення умов, наприклад, дата, тема, відправник, отримувач тощо. Перший приклад ілюструє, як фільтрувати повідомлення за датою та темою. Ми також показуємо, як фільтрувати за іншими критеріями та як будувати більш складні запити. API також забезпечує можливість застосовувати чутливі до регістру критерії пошуку для точного фільтрування. API також дозволяє вказувати кодування рядка пошуку для фільтрації повідомлень з поштової скриньки.

Фільтрація повідомлень зі скриньки

Підключитися та ввійти на IMAP сервер
Створіть екземпляр MailQuery і встановити властивості
Викличте ImapClient.listMessages(MailQuery query) метод і передаєте MailQuery з параметрами для отримання лише відфільтрованих повідомлень.

Нижче наведений фрагмент коду показує, як підключитися до IMAP‑скриньки та отримати повідомлення, які надійшли сьогодні і містять слово "newsletter" у темі.

// For complete examples and data files, please go to https://github.com/aspose-email/Aspose.Email-for-Java
// Connect and log in to IMAP
final String host = "host";
final int port = 143;
final String username = "user@host.com";
final String password = "password";
ImapClient client = new ImapClient(host, port, username, password);
client.selectFolder("Inbox");
// Set conditions, Subject contains "Newsletter", Emails that arrived today
ImapQueryBuilder builder = new ImapQueryBuilder();
builder.getSubject().contains("Newsletter");
builder.getInternalDate().on(new Date());
// Build the query and Get list of messages
MailQuery query = builder.getQuery();
ImapMessageInfoCollection messages = client.listMessages(query);
System.out.println("Imap: " + messages.size() + " message(s) found.");
// Disconnect from IMAP
client.dispose();

Отримати повідомлення, що відповідають певним критеріям

Кодові приклади вище фільтрувати повідомлення за темою листа та датою. Ми також можемо використати інші властивості для встановлення інших підтримуваних умов. Нижче наведено кілька прикладів встановлення умов за допомогою MailQuery. Наведені нижче фрагменти коду показують, як фільтрувати листи за:

Сьогоднішня дата.
Діапазон дат.
Від конкретного відправника.
З конкретного домену.
Від конкретного отримувача.

Сьогоднішня дата

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

// For complete examples and data files, please go to https://github.com/aspose-email/Aspose.Email-for-Java
// Emails that arrived today
MailQueryBuilder builder = new MailQueryBuilder();
builder.getInternalDate().on(new Date());
~~
### **Date Range*
The following code snippet shows you how to filter emails on the date range.

~~~Java
// For complete examples and data files, please go to https://github.com/aspose-email/Aspose.Email-for-Java
// Emails that arrived in last 7 days
Calendar cal = Calendar.getInstance();
builder.getInternalDate().before(cal.getTime());
cal.add(Calendar.DATE, -7);
builder.getInternalDate().since(cal.getTime());

Конкретний відправник

Нижче наведений фрагмент коду показує, як фільтрувати листи за конкретним відправником.

// For complete examples and data files, please go to https://github.com/aspose-email/Aspose.Email-for-Java
// Get emails from specific sender
builder.getFrom().contains("saqib.razzaq@127.0.0.1");

Конкретний домен

Нижче наведений фрагмент коду показує, як фільтрувати листи за конкретним доменом.

// For complete examples and data files, please go to https://github.com/aspose-email/Aspose.Email-for-Java
// Get emails from specific domain
builder.getFrom().contains("SpecificHost.com");

Конкретний отримувач

Нижче наведений фрагмент коду показує, як фільтрувати листи за конкретним отримувачем.

// For complete examples and data files, please go to https://github.com/aspose-email/Aspose.Email-for-Java
// Get emails sent to specific recipient
builder.getTo().contains("recipient");

Створення складних запитів

Якщо різні MailQueryBuilder властивості встановлюються в окремих інструкціях, після чого будуть виконані всі умови. Наприклад, якщо ми хочемо отримати повідомлення в діапазоні дат і від конкретного хоста, нам треба написати три інструкції.

Комбінування запитів за допомогою AND

Наступний фрагмент коду показує, як поєднувати запити за допомогою AND.

// For complete examples and data files, please go to https://github.com/aspose-email/Aspose.Email-for-Java
// Emails from specific host, get all emails that arrived before today and all emails that arrived since 7 days ago
builder.getFrom().contains("SpecificHost.com");

Calendar cal = Calendar.getInstance();
builder.getInternalDate().before(cal.getTime());
cal.add(Calendar.DATE, -7);
builder.getInternalDate().since(cal.getTime());

Комбінування запитів за допомогою OR

MailQueryBuilder надає or() метод, який приймає два MailQuery екземпляри як параметри. Отримуються повідомлення, що відповідають будь-якій із вказаних двох умов. Нижче наведений фрагмент коду показує, як фільтрувати повідомлення, які мають у темі слово “test” або відправника “noreply@host.com”. Нижче наведений фрагмент коду показує, як комбінувати запити за допомогою OR.

// For complete examples and data files, please go to https://github.com/aspose-email/Aspose.Email-for-Java
// Specify OR condition
builder.or(builder.getSubject().contains("test"), builder.getFrom().contains("noreply@host.com"));

Фільтрація за InternalDate

Повідомлення можна отримати з сервера, орієнтуючись на InternalDate, однак іноді сервер не повертає всі повідомлення, які видно в вхідних. Причиною може бути часовий пояс сервера, оскільки він може не бути UTC для всіх серверів, наприклад Gmail. Aspose надсилає команди типу 008 SEARCH ON 4-May-2014 згідно з протокол IMAP проте результат може відрізнятися через налаштування часового поясу сервера. Новий елемент додано в ImapMessageInfo as InternalDate що додатково допомагає у фільтрації повідомлень. Нижче наведений фрагмент коду показує використання InternalDate для фільтрації повідомлень.

// For complete examples and data files, please go to https://github.com/aspose-email/Aspose.Email-for-Java
// Connect and log in to IMAP
final String host = "host";
final int port = 143;
final String username = "user@host.com";
final String password = "password";
ImapClient client = new ImapClient(host, port, username, password);
client.selectFolder("Inbox");

// Set conditions, Subject contains "Newsletter", Emails that arrived today
ImapQueryBuilder builder = new ImapQueryBuilder();
builder.getSubject().contains("Newsletter");
builder.getInternalDate().on(new Date());

// Build the query and Get list of messages
MailQuery query = builder.getQuery();
ImapMessageInfoCollection messages = client.listMessages(query);
for (ImapMessageInfo info : messages) {
    System.out.println("Internal Date: " + info.getInternalDate());
}

// Disconnect from IMAP
client.dispose();

Чутливе до регістру фільтрування електронних листів

Нижче наведений фрагмент коду показує, як використовувати чутливе до регістру фільтрування електронних листів.

// For complete examples and data files, please go to https://github.com/aspose-email/Aspose.Email-for-Java
// Set conditions, Subject contains "Newsletter", Emails that arrived today
ImapQueryBuilder builder = new ImapQueryBuilder();
builder.getSubject().contains("Newsletter", true);
builder.getInternalDate().on(new Date());
MailQuery query = builder.getQuery();

Вказати кодування для будівника запитів

API ImapQueryBuilder конструктор може бути використаний для вказання кодування рядка пошуку. Це також можна встановити за допомогою DefaultEncoding властивість MailQueryBuilder. Нижче наведений фрагмент коду показує, як вказати кодування для будівника запитів.

// For complete examples and data files, please go to https://github.com/aspose-email/Aspose.Email-for-Java
// Set conditions
ImapQueryBuilder builder = new ImapQueryBuilder(Charset.forName("utf-8"));
builder.getSubject().contains("ğüşıöç", true);
MailQuery query = builder.getQuery();

Фільтрація повідомлень з підтримкою пагінації

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

// For complete examples and data files, please go to https://github.com/aspose-email/Aspose.Email-for-Java
/// <summary>
/// This example shows how to search for messages using ImapClient of the API with paging support
/// Introduced in Aspose.Email for .NET 6.4.0
/// </summary>
final ImapClient client = new ImapClient("host.domain.com", 84, "username", "password");
try {
    try {
        // Append some test messages
        int messagesNum = 12;
        int itemsPerPage = 5;
        MailMessage message = null;
        for (int i = 0; i < messagesNum; i++) {
            message = new MailMessage("from@domain.com", "to@domain.com", "EMAILNET-35128 - " + UUID.randomUUID(), "111111111111111");
            client.appendMessage(ImapFolderInfo.IN_BOX, message);
        }
        String body = "2222222222222";
        for (int i = 0; i < messagesNum; i++) {
            message = new MailMessage("from@domain.com", "to@domain.com", "EMAILNET-35128 - " + UUID.randomUUID(), body);
            client.appendMessage(ImapFolderInfo.IN_BOX, message);
        }

        client.selectFolder("Inbox");
        ImapQueryBuilder iqb = new ImapQueryBuilder();
        iqb.getBody().contains(body);
        MailQuery query = iqb.getQuery();

        client.selectFolder(ImapFolderInfo.IN_BOX);
        ImapMessageInfoCollection totalMessageInfoCol = client.listMessages(query);
        System.out.println(totalMessageInfoCol.size());

        //////////////////////////////////////////////////////

        List<ImapPageInfo> pages = new ArrayList<ImapPageInfo>();

        PageSettings ps = new PageSettings();
        ps.setFolderName(ImapFolderInfo.IN_BOX);
        PageInfo pi = new PageInfo(itemsPerPage);
        ImapPageInfo pageInfo = client.listMessagesByPage(query, pi, ps);

        pages.add(pageInfo);
        while (!pageInfo.getLastPage()) {
            pageInfo = client.listMessagesByPage(query, pageInfo.getNextPage(), ps);
            pages.add(pageInfo);
        }
        int retrievedItems = 0;
        // foreach to while statements conversion
        for (ImapPageInfo folderCol : pages) {
            retrievedItems += folderCol.getItems().size();
        }
    } finally {
    }
} finally {
    if (client != null)
        client.dispose();
}

Фільтрація повідомлень з власним прапором

// For complete examples and data files, please go to https://github.com/aspose-email/Aspose.Email-for-Java
ImapQueryBuilder queryBuilder = new ImapQueryBuilder();

queryBuilder.hasFlags(ImapMessageFlags.keyword("custom1"));

queryBuilder.hasNoFlags(ImapMessageFlags.keyword("custom2"));

Фільтрація повідомлень за допомогою кастомного пошуку

Наприклад, стандарт RFC 3501 не дозволяє шукати повідомлення за наявністю вкладень у листах. Але Gmail забезпечує Розширення IMAP які дозволяють виконати такий пошук. Aspose.Email надає customSearch метод ImapQueryBuilder клас для створення відповідного запиту.

Нижче наведений приклад коду показує, як отримати список електронних листів з сервера, які містять вкладення, використовуючи протокол IMAP та власний критерій пошуку:

ImapQueryBuilder builder = new ImapQueryBuilder();
builder.customSearch("X-GM-RAW \"has:attachment\"");
MailQuery query = builder.getQuery();
messageInfoCol = client.listMessages(query);

Java: Видалення повідомлень з сервера

Mon, 01 Jan 0001 00:00:00 +0000

Видалення повідомлень

The ImapClient клас може видаляти повідомлення з IMAP сервера. Це ImapClient клас deleteMessage() функція використовується для видалення повідомлень. Вона приймає номер послідовності повідомлення або унікальний ID як параметр. Це ImapClient надає deleteMessage і deleteMessages методи для видалення повідомлень по одному або кількох. Наведений фрагмент коду показує, як видалити електронний лист з ідентифікатором повідомлення 1 з IMAP сервера.

try (ImapClient client = new ImapClient("host", "username", "password")) {
    client.setSecurityOptions(SecurityOptions.SSLImplicit);

    // Append test message
    client.selectFolder(ImapFolderInfo.IN_BOX);

    MailMessage eml = new MailMessage("from@from.com", "to@to.com");
    eml.setSubject("Message to delete");
    eml.setBody("Hey! This Message will be deleted!");
    String emlId = client.appendMessage(eml);

    // Delete appended message
    client.deleteMessage(emlId);
    client.commitDeletes();
}

Видалення кількох повідомлень

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

try (ImapClient client = new ImapClient("host", "username", "password")) {
    client.selectFolder(ImapFolderInfo.IN_BOX);

    // Append test messages
    List<MailMessage> emlList = new ArrayList<>();
    for (int i = 0; i < 3; i++) {
        MailMessage eml = new MailMessage("from@from.com", "to@to.com");
        eml.setSubject("Message to delete " + i);
        eml.setBody("Hey! This Message will be deleted!");

        emlList.add(eml);
    }

    AppendMessagesResult appendMessagesResult = client.appendMessages(emlList);
    List<String> uidList = new ArrayList<>();
    for (String uid : appendMessagesResult.getSucceeded().getValues()) {
        uidList.add(uid);
    }

    // Bulk Delete appended Messages
    client.deleteMessagesByUids(uidList, true);
    client.commitDeletes();
}

Java: Робота з папками на IMAP-сервері

Mon, 01 Jan 0001 00:00:00 +0000

Отримання інформації про папки

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

// For complete examples and data files, please go to https://github.com/aspose-email/Aspose.Email-for-Java
// Get all folders in the currently subscribed folder
ImapFolderInfoCollection folderInfoColl = client.listFolders();

// Iterate through the collection to get folder info one by one
for (ImapFolderInfo folderInfo : (Iterable<ImapFolderInfo>) folderInfoColl) {
    // Folder name and get New messages in the folder
    System.out.println("Folder name is " + folderInfo.getName());
    ImapFolderInfo folderExtInfo = client.getFolderInfo(folderInfo.getName());
    System.out.println("New message count: " + folderExtInfo.getNewMessageCount());
    System.out.println("Is it readonly? " + folderExtInfo.getReadOnly());
    System.out.println("Total number of messages " + folderExtInfo.getTotalMessageCount());
}

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

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

The deleteFolder() метод приймає назву папки як параметр.
Для renameFolder() метод, вам потрібно передати поточну назву папки та нову назву папки. Нижчий фрагмент коду показує, як видалити папку з IMAP-сервера та як перейменувати папку. Кожна операція виконується одним рядком коду.

// For complete examples and data files, please go to https://github.com/aspose-email/Aspose.Email-for-Java
// Delete a folder and Rename a folder
client.deleteFolder("foldername");
client.renameFolder("foldername", "newfoldername");

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

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

// For complete examples and data files, please go to https://github.com/aspose-email/Aspose.Email-for-Java
// 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.IN_BOX);
client.subscribeFolder(client.getCurrentFolder().getName());
client.appendMessage(client.getCurrentFolder().getName(), msg);

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

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

// For complete examples and data files, please go to https://github.com/aspose-email/Aspose.Email-for-Java
ImapClient imapClient = new ImapClient();
imapClient.setHost("<HOST>");
imapClient.setPort(993);
imapClient.setUsername("<USERNAME>");
imapClient.setPassword("<PASSWORD>");
imapClient.setSupportedEncryption(EncryptionProtocols.Tls);
imapClient.setSecurityOptions(SecurityOptions.SSLImplicit);

List<MailMessage> messages = new ArrayList<MailMessage>();
for (int i = 0; i < 20; i++) {
    MailMessage message = new MailMessage("<EMAIL ADDRESS>", "<EMAIL ADDRESS>", "Test Message - " + UUID.randomUUID().toString(), "IMAP Group Append with MultiConnection");
    messages.add(message);
}

imapClient.setConnectionsQuantity(5);
imapClient.setUseMultiConnection(MultiConnectionMode.Enable);
imapClient.appendMessages(messages);

Зауважте, що використання режиму мультипідключення не гарантує підвищення продуктивності.

Перемістити повідомлення в іншу папку поштової скриньки

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

// For complete examples and data files, please go to https://github.com/aspose-email/Aspose.Email-for-Java
// 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 Java
// Available from Aspose.Email for Java onwards
// -------------- Available API Overload Members --------------
// void ImapClient.moveMessage(IConnection iConnection, int sequenceNumber, String folderName, boolean commitDeletions)
// void ImapClient.moveMessage(IConnection iConnection, String uniqueId, String folderName, boolean commitDeletions)
// void ImapClient.moveMessage(int sequenceNumber, String folderName, boolean commitDeletions)
// void ImapClient.moveMessage(String uniqueId, String folderName, boolean 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)

final ImapClient client = new ImapClient("host.domain.com", 993, "username", "password");
try {
    String folderName = "EMAILNET-35151";
    if (!client.existFolder(folderName))
        client.createFolder(folderName);
    try {
        MailMessage message = new MailMessage("from@domain.com", "to@domain.com", "EMAILNET-35151 - " + UUID.randomUUID(),
                "EMAILNET-35151 ImapClient: Provide option to Move Message");
        client.selectFolder(ImapFolderInfo.IN_BOX);
        // Append the new message to Inbox folder
        String uniqueId = client.appendMessage(ImapFolderInfo.IN_BOX, message);
        ImapMessageInfoCollection messageInfoCol1 = client.listMessages();
        System.out.println(messageInfoCol1.size());
        // 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();
        System.out.println(messageInfoCol1.size());
        // Verify that the message was moved from the Inbox
        client.selectFolder(ImapFolderInfo.IN_BOX);
        messageInfoCol1 = client.listMessages();
        System.out.println(messageInfoCol1.size());
    } finally {
        try {
            client.deleteFolder(folderName);
        } catch (java.lang.RuntimeException e) {
        }
    }
} finally {
    if (client != null)
        client.dispose();
}

Копіювати повідомлення в іншу папку поштової скриньки

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

// For complete examples and data files, please go to https://github.com/aspose-email/Aspose.Email-for-Java
final ImapClient client = new ImapClient("exchange.aspose.com", "username", "password");
try {
    // 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 - " + UUID.randomUUID(),
                "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 - " + UUID.randomUUID(),
                "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.IN_BOX);
        ImapMessageInfoCollection msgsColl = client.listMessages();
        for (ImapMessageInfo msgInfo : msgsColl)
            System.out.println(msgInfo.getSubject());

        // Copy multiple messages using the CopyMessages command and Verify that messages are copied to the destination folder
        client.copyMessagesByUids(Arrays.asList(uniqueId1, uniqueId2), folderName);

        client.selectFolder(folderName);
        msgsColl = client.listMessages();
        for (ImapMessageInfo msgInfo : msgsColl)
            System.out.println(msgInfo.getSubject());
    } finally {
        try {
            client.deleteFolder(folderName);
        } catch (java.lang.RuntimeException e) {
        }
    }
} finally {
    if (client != null)
        client.dispose();
}

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

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

// For complete examples and data files, please go to https://github.com/aspose-email/Aspose.Email-for-Java
ImapClient imapClient = new ImapClient();
imapClient.setHost("<HOST>");
imapClient.setPort(993);
imapClient.setUsername("<USERNAME>");
imapClient.setPassword("<PASSWORD>");
imapClient.setSupportedEncryption(EncryptionProtocols.Tls);
imapClient.setSecurityOptions(SecurityOptions.SSLImplicit);

ImapMailboxInfo mailboxInfo = imapClient.getMailboxInfo();
System.out.println(mailboxInfo.getInbox());
System.out.println(mailboxInfo.getDraftMessages());
System.out.println(mailboxInfo.getJunkMessages());
System.out.println(mailboxInfo.getSentMessages());
System.out.println(mailboxInfo.getTrash());

Java: Робота з ImapClient асинхронно

Mon, 01 Jan 0001 00:00:00 +0000

Повідомлення можна отримати з поштової скриньки асинхронно, використовуючи Aspose.Email ImapClient. У цій статті показано отримання повідомлень з поштової скриньки асинхронно. У статті також показано, як перелічити повідомлення, використовуючи критерії пошуку за допомогою MailQuery.

Отримання повідомлень асинхронно

Нижче наведений фрагмент коду показує, як отримати повідомлення асинхронно.

// For complete examples and data files, please go to https://github.com/aspose-email/Aspose.Email-for-Java
// Connect and log in to IMAP
try (ImapClient client = new ImapClient("host", "username", "password")) {
    client.selectFolder("Issues/SubFolder");
    ImapMessageInfoCollection messages = client.listMessages();
    IAsyncResult ar = client.beginFetchMessage(messages.get_Item(0).getSequenceNumber());
    MailMessage message = client.endFetchMessage(ar);
}

Список повідомлень асинхронно за допомогою MailQuery

The MailQuery клас може бути використаний для зазначення критеріїв пошуку при отриманні вказаного списку повідомлень асинхронно, як показано у наведеному нижче прикладі коду.

// For complete examples and data files, please go to https://github.com/aspose-email/Aspose.Email-for-Java
ImapQueryBuilder builder = new ImapQueryBuilder();
builder.getSubject().contains("Subject");
MailQuery query = builder.getQuery();
IAsyncResult asyncResult = client.beginListMessages(query);
ImapMessageInfoCollection messages = client.endListMessages(asyncResult);

Java: Перелік розширень IMAP-сервера

Mon, 01 Jan 0001 00:00:00 +0000

Aspose.Email ImapClient дозволяє отримати розширення сервера, які підтримуються, такі як IDLE, UNSELECT, QUOTA тощо. Це допомагає визначити наявність розширення перед використанням клієнта для конкретної функції. The getCapabilities() метод повертає підтримувані типи розширень у вигляді масиву рядків. Нижчий фрагмент коду показує, як отримати розширення.

// For complete examples and data files, please go to https://github.com/aspose-email/Aspose.Email-for-Java
// Connect and log in to IMAP
ImapClient client = new ImapClient("imap.gmail.com", "username", "password");
String[] getCapabilities = client.getCapabilities();
for (String getCap : getCapabilities) {
    System.out.println(getCap);
}

Java: Підтримка команди IMAP IDLE

Mon, 01 Jan 0001 00:00:00 +0000

Aspoe.Email API ImapClient надає можливість відкрити з’єднання з сервером і чекати на надходження електронного листа. Це дозволяє уникнути постійного опитування сервера щодо вхідних листів. Нижче наведено фрагмент коду, який показує, як підтримати команду IMAP Idle.

// For complete examples and data files, please go to https://github.com/aspose-email/Aspose.Email-for-Java
// Connect and log in to IMAP
ImapClient client = new ImapClient("imap.domain.com", "username", "password");

client.startMonitoring(new ImapMonitoringEventHandler() {
    public void invoke(Object sender, ImapMonitoringEventArgs e) {
        System.out.println(e.getNewMessages().length);
        System.out.println(e.getDeletedMessages().length);
    }
});
client.stopMonitoring("Inbox");

Java: Підтримка команди IMAP IDLE та розширень

Mon, 01 Jan 0001 00:00:00 +0000

Підтримка команди IMAP Idle

Aspose.Email API ImapClient надає можливість відкрити з’єднання з сервером і чекати на надходження електронного листа. Це дозволяє уникнути постійного опитування сервера щодо вхідних листів. Нижче наведено фрагмент коду, який показує, як підтримати команду IMAP Idle.

// For complete examples and data files, please go to https://github.com/aspose-email/Aspose.Email-for-Java
// Connect and log in to IMAP
ImapClient client = new ImapClient("imap.domain.com", "username", "password");

client.startMonitoring(new ImapMonitoringEventHandler() {
    public void invoke(Object sender, ImapMonitoringEventArgs e) {
        System.out.println(e.getNewMessages().length);
        System.out.println(e.getDeletedMessages().length);
    }
});
client.stopMonitoring("Inbox");

Підтримка розширень IMAP

Aspose.Email API забезпечує підтримку розширень IMAP. На даний момент API підтримує наступні розширення IMAP. Ці розширення IMAP не підтримуються всіма серверами.

// For complete examples and data files, please go to https://github.com/aspose-email/Aspose.Email-for-Java
final ImapClient client = new ImapClient("imap.gmail.com", 993, "username", "password");
try {
    // Set SecurityOptions
    client.setSecurityOptions(SecurityOptions.Auto);
    System.out.println(client.getIdSupported());

    ImapIdentificationInfo serverIdentificationInfo1 = client.introduceClient();
    ImapIdentificationInfo serverIdentificationInfo2 = client.introduceClient(ImapIdentificationInfo.getDefaultValue());

    // Display ImapIdentificationInfo properties
    System.out.println(serverIdentificationInfo1.toString() + serverIdentificationInfo2.toString());
    System.out.println(serverIdentificationInfo1.getName());
    System.out.println(serverIdentificationInfo1.getVendor());
    System.out.println(serverIdentificationInfo1.getSupportUrl());
    System.out.println(serverIdentificationInfo1.getVersion());
} finally {
    if (client != null)
        client.dispose();
}

Розширена команда LIST IMAP4

Наступний фрагмент коду показує, як використовувати розширену команду LIST IMAP4.

// For complete examples and data files, please go to https://github.com/aspose-email/Aspose.Email-for-Java
final ImapClient client = new ImapClient("imap.gmail.com", 993, "username", "password");
try {
    ImapFolderInfoCollection folderInfoCol = client.listFolders("*");
    System.out.println("Extended List Supported: " + client.getExtendedListSupported());
    for (ImapFolderInfo folderInfo : (Iterable<ImapFolderInfo>) folderInfoCol) {
        if (folderInfo.getName().equals("[Gmail]/All Mail"))
            System.out.println("Has Children: " + folderInfo.hasChildren());
        if (folderInfo.getName().equals("[Gmail]/Bin"))
            System.out.println("Bin has children? " + folderInfo.hasChildren());
        if (folderInfo.getName().equals("[Gmail]/Drafts"))
            System.out.println("Drafts has children? " + folderInfo.hasChildren());
        if (folderInfo.getName().equals("[Gmail]/Important"))
            System.out.println("Important has Children? " + folderInfo.hasChildren());
        if (folderInfo.getName().equals("[Gmail]/Sent Mail"))
            System.out.println("Sent Mail has Children? " + folderInfo.hasChildren());
        if (folderInfo.getName().equals("[Gmail]/Spam"))
            System.out.println("Spam has Children? " + folderInfo.hasChildren());
        if (folderInfo.getName().equals("[Gmail]/Starred"))
            System.out.println("Starred has Children? " + folderInfo.hasChildren());
    }
} finally {
    if (client != null)
        client.dispose();
}

Java: Операція резервного копіювання та відновлення IMAP

Mon, 01 Jan 0001 00:00:00 +0000

Aspose.Email for Java забезпечує можливість резервного копіювання та відновлення повідомлень. Для цього API надає наступні методи.

У цій статті показано, як резервно копіювати та відновлювати повідомлення за допомогою ImapClient клас.

Резервне копіювання повідомлень

Щоб створити резервну копію повідомлень, використайте ImapClient.backup метод, як продемонстровано у наступному фрагменті коду.

// For complete examples and data files, please go to https://github.com/aspose-email/Aspose.Email-for-Java
// The path to the File directory.
String dataDir = "data/";
// Create an instance of the ImapClient class
ImapClient imapClient = new ImapClient();

// Specify host, username and password, and set port for your client
imapClient.setHost("imap.gmail.com");
imapClient.setUsername("your.username@gmail.com");
imapClient.setPassword("your.password");
imapClient.setPort(993);
imapClient.setSecurityOptions(SecurityOptions.Auto);

ImapMailboxInfo mailboxInfo = imapClient.getMailboxInfo();

ImapFolderInfo info = imapClient.getFolderInfo(mailboxInfo.getInbox().getName());
ImapFolderInfoCollection infos = new ImapFolderInfoCollection();
infos.addItem(info);

imapClient.backup(infos, dataDir + "\\ImapBackup.pst", com.aspose.email.BackupSettings.to_BackupSettings(BackupOptions.Recursive));

Відновити повідомлення

Щоб створити резервну копію повідомлень, використайте ImapClient.restore метод, як продемонстровано у наступному фрагменті коду.

// For complete examples and data files, please go to https://github.com/aspose-email/Aspose.Email-for-Java
// The path to the File directory.
String dataDir = "data/";
// Create an instance of the ImapClient class
ImapClient imapClient = new ImapClient();

// Specify host, username and password, and set port for your client
imapClient.setHost("imap.gmail.com");
imapClient.setUsername("your.username@gmail.com");
imapClient.setPassword("your.password");
imapClient.setPort(993);
imapClient.setSecurityOptions(SecurityOptions.Auto);

ImapRestoreSettings settings = new ImapRestoreSettings();
settings.setRecursive(true);
PersonalStorage pst = PersonalStorage.fromFile(dataDir + "\\ImapBackup.pst");
imapClient.restore(pst, settings);

Операція резервного копіювання та відновлення IMAP з MultiConnection

Під час роботи з великою кількістю повідомлень операція резервного копіювання/відновлення може займати багато часу. Для цього API забезпечує підтримку декількох з’єднань під час резервного копіювання та відновлення. Щоб увімкнути режим MultiConnection, встановіть ImapClient.UseMultiConnection властивість для MultiConnectionMode.Enable. Наступні фрагменти коду демонструють операції резервного копіювання та відновлення з увімкненим режимом MultiConnection.

Резервне копіювання повідомлень з MultiConnection

Наступні фрагменти коду демонструють операцію резервного копіювання з увімкненим режимом MultiConnection.

// For complete examples and data files, please go to https://github.com/aspose-email/Aspose.Email-for-Java
// The path to the File directory.
String dataDir = "data/";
// Create an instance of the ImapClient class
ImapClient imapClient = new ImapClient();

// Specify host, username and password, and set port for your client
imapClient.setHost("imap.gmail.com");
imapClient.setUsername("your.username@gmail.com");
imapClient.setPassword("your.password");
imapClient.setPort(993);
imapClient.setSecurityOptions(SecurityOptions.Auto);

imapClient.setUseMultiConnection(MultiConnectionMode.Enable);

ImapMailboxInfo mailboxInfo = imapClient.getMailboxInfo();

ImapFolderInfo info = imapClient.getFolderInfo(mailboxInfo.getInbox().getName());
ImapFolderInfoCollection infos = new ImapFolderInfoCollection();
infos.addItem(info);

imapClient.backup(infos, dataDir + "\\ImapBackup.pst", com.aspose.email.BackupSettings.to_BackupSettings(BackupOptions.Recursive));

Відновлення повідомлень з MultiConnection

Наступні фрагменти коду демонструють операцію відновлення з увімкненим режимом MultiConnection.

// For complete examples and data files, please go to https://github.com/aspose-email/Aspose.Email-for-Java
// The path to the File directory.
String dataDir = "data/";
// Create an instance of the ImapClient class
ImapClient imapClient = new ImapClient();

// Specify host, username and password, and set port for your client
imapClient.setHost("imap.gmail.com");
imapClient.setUsername("your.username@gmail.com");
imapClient.setPassword("your.password");
imapClient.setPort(993);
imapClient.setSecurityOptions(SecurityOptions.Auto);

imapClient.setUseMultiConnection(MultiConnectionMode.Enable);

ImapRestoreSettings settings = new ImapRestoreSettings();
settings.setRecursive(true);
PersonalStorage pst = PersonalStorage.fromFile(dataDir + "\\Outlook.pst");
imapClient.restore(pst, settings);