עבודה עם הודעות משרת IMAP

רשימת מזהי הודעות MIME מהשרת

מידע הודעה Imap מספק את ה-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 מספקת גרסה עם שני משתנים של 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());

רישום הודעות עם חיבור מרובה

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 מתודה לקבלת ה- אוסף מידע הודעה Imap אובייקט.
איטרציה דרך ה- אוסף מידע הודעה Imap אוסף, קרא ל- 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 מתודה המקבלת איטרביל של מספרי סדר או ID ייחודי ומחזירה רשימה של MailMessage. קוד הדוגמה הבא מדגים את השימוש ב- fetchMessages מתודה להבאת הודעות לפי מספרי סדר ו-ID ייחודי.

// 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 או מספר רצף של הודעה

ה-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 מאפיין של מידע הודעה Imap מחלקה. הדוגמה הבאה מציגה את השימוש ב- 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());
}

התחברות לשרת IMAP עבודה עם דגלי הודעה על השרת