Documentation – Работа с IMAP клиент

Java: Свързване към IMAP сървър

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

Този ImapClient класът позволява на приложенията да управляват IMAP пощенски кутии, използвайки IMAP протокола. The ImapClient класът се използва за свързване към IMAP пощенски сървъри и управление на имейли в 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 прокси протокола. Тази статия предоставя работен пример за достъп до пощенската кутия чрез прокси имейл сървър. За достъп до пощенската кутия чрез прокси сървър:

Инициализиране 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 proxy

// 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);

Свързване към сървъра в режим само за четене

Този 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...
}

Как да ограничим Greeting Timeout

IMAP клиентът може да използва автоматичен режим за установяване на връзка. В този режим клиентът преминава през всички възможни параметри за връзка, докато се установи връзка. При правилна връзка IMAP сървърът изпраща поздравителен низ към клиента. Сървърите могат да използват имплицитно или експлицитно (START TLS) иницииране на SSL/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());
}

Извличане на съобщения от сървъра и запазване на диск

Този ImapClient клас може да извлича съобщения от IMAP сървър и да ги запазва във формат EML на локален диск. Необходими са следните стъпки за запазване на съобщенията на диск:

Създайте инстанция на ImapClient клас.
Посочете име на хост, порт, потребителско име и парола в ImapClient constructor.
Изберете папката, използвайки 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 клас. Този 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());
}

Нишки на имейли/Организиране на имейли в разговори

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

Следните функции за нишки на имейли са налични за ползване:

getMessageThreads метод - Получава нишки от съобщения чрез ImapClient.
boolean getGmExt1Supported - Получава информация дали разширението Gmail X-GM-EXT-1 се поддържа.
boolean getThreadSupported - Получава информация дали разширението THREAD се поддържа.
String[] getThreadAlgorithms - Получава поддържаните THREAD алгоритми.

Следните примерни кодове показват използването на тези функции за получаване на имейл нишки от 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())

Създайте подходящите условия за търсене за нишка:

 ThreadSearchConditions conditions = new ThreadSearchConditions();

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

conditions.setUseUId(true);

Изброяване на съобщения с поддръжка на странициране

В сценарии, където имейл сървърът съдържа голям брой съобщения в кутията, често е желателно да се изброяват или извличат съобщенията с поддръжка на странициране. Aspose.Email API 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 или пореден номер на съобщение

Aspose.Email публичният API предоставя следните функции за получаване на информация за идентификация на съобщението, като 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. The 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

Този ImapClient клас предоставя 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();

Филтриране на съобщения с поддръжка на странициране

Този 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

Изтриване на съобщения

Този ImapClient класът може да изтрива съобщения от IMAP сървър. The ImapClient клас deleteMessage() функцията се използва за изтриване на съобщения. Тя приема номера на последователност на съобщението или уникалното ID като параметър. The ImapClient осигурява deleteMessage и deleteMessages методи за изтриване на съобщения едно по едно или по множество. Следният кодов пример показва как да изтриете имейл съобщение с ID 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. The deleteMessages методът предоставя редица опции за изтриване на множество съобщения от сървъра, използвайки уникални ID, номера на последователност или 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:

Този 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 клас. Този 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 за Java позволява преместване на съобщение от една папка на пощенската кутия към друга, използвайки ImapClient API. The 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();
}

Копиране на съобщения в друга папка на пощенската кутия

Aspose.Email API предоставя възможност за копиране на съобщение от една папка на пощенска кутия към друга. Той позволява копиране на едно или многократно съобщения, използвайки copyMessage и copyMessages методи. The 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

Този 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

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");

Java: Поддръжка на IMAP IDLE команда и разширения

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

Поддръжка за 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 разширения. Тези разширения не се поддържат от всички сървъри.

// 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 за 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);