Changeset 262

Timestamp:

08/02/08 05:15:29 PM (4 months ago)

Author:

octorian

Message:

UID support for messages

Location:

trunk/LogicMail/src/org/logicprobe/LogicMail

Files:

• mail/imap/ImapClient.java (modified) (9 diffs)
• mail/imap/ImapParser.java (modified) (2 diffs)
• mail/imap/ImapProtocol.java (modified) (11 diffs)
• mail/pop/PopClient.java (modified) (1 diff)
• mail/pop/PopProtocol.java (modified) (1 diff)
• message/FolderMessage.java (modified) (3 diffs)

trunk/LogicMail/src/org/logicprobe/LogicMail/mail/imap/ImapClient.java

@@ -377 +377 @@
         FolderMessage[] folderMessages = new FolderMessage[response.length];
         for(int i=0;i<response.length;i++) {
-            folderMessages[i] = new FolderMessage(response[i].envelope, response[i].index);
+            folderMessages[i] = new FolderMessage(response[i].envelope, response[i].index, response[i].uid);
             folderMessages[i].setSeen(response[i].flags.seen);
             folderMessages[i].setAnswered(response[i].flags.answered);
@@ -391 +391 @@
 
     public Message getMessage(FolderMessage folderMessage) throws IOException, MailException {
-        ImapParser.MessageSection structure = getMessageStructure(folderMessage.getIndex());
+        ImapParser.MessageSection structure = getMessageStructure(folderMessage.getUid());
         MessagePart rootPart =
-            getMessagePart(folderMessage.getIndex(),
+            getMessagePart(folderMessage.getUid(),
                            structure, globalConfig.getImapMaxMsgSize());
         Message msg = new Message(folderMessage.getEnvelope(), rootPart);
@@ -399 +399 @@
     }
 
-    private MessagePart getMessagePart(int index,
+    private MessagePart getMessagePart(int uid,
                                        ImapParser.MessageSection structure,
                                        int maxSize)
@@ -411 +411 @@
             else {
                 if(structure.size < maxSize) {
-                    data = getMessageBody(index, structure.address);
+                    data = getMessageBody(uid, structure.address);
                     maxSize -= structure.size;
                 }
@@ -426 +426 @@
         if((part instanceof MultiPart)&&(structure.subsections != null)&&(structure.subsections.length > 0)) {
             for(int i=0;i<structure.subsections.length;i++) {
-                MessagePart subPart = getMessagePart(index, structure.subsections[i], maxSize);
+                MessagePart subPart = getMessagePart(uid, structure.subsections[i], maxSize);
                 if(subPart != null) {
                     ((MultiPart)part).addPart(subPart);
@@ -439 +439 @@
      * This tree is used to build the final message tree.
      */
-    private ImapParser.MessageSection getMessageStructure(int msgIndex) throws IOException, MailException {
+    private ImapParser.MessageSection getMessageStructure(int uid) throws IOException, MailException {
         if(activeMailbox.equals("")) {
             throw new MailException("Mailbox not selected");
         }
 
-        return imapProtocol.executeFetchBodystructure(msgIndex);
+        return imapProtocol.executeFetchBodystructure(uid);
     }
 
@@ -466 +466 @@
     }
 
-    private String getMessageBody(int index, String address) throws IOException, MailException {
+    private String getMessageBody(int uid, String address) throws IOException, MailException {
         if(activeMailbox.equals("")) {
             throw new MailException("Mailbox not selected");
         }
         
-        return imapProtocol.executeFetchBody(index, address);
+        return imapProtocol.executeFetchBody(uid, address);
     }
     
     public void deleteMessage(FolderMessage folderMessage) throws IOException, MailException {
         ImapProtocol.MessageFlags updatedFlags =
-            imapProtocol.executeStore(folderMessage.getIndex(), true, new String[] { "\\Deleted" });
+            imapProtocol.executeStore(folderMessage.getUid(), true, new String[] { "\\Deleted" });
         refreshMessageFlags(updatedFlags, folderMessage);
     }
@@ -483 +483 @@
     public void undeleteMessage(FolderMessage folderMessage) throws IOException, MailException {
         ImapProtocol.MessageFlags updatedFlags =
-            imapProtocol.executeStore(folderMessage.getIndex(), false, new String[] { "\\Deleted" });
+            imapProtocol.executeStore(folderMessage.getUid(), false, new String[] { "\\Deleted" });
         refreshMessageFlags(updatedFlags, folderMessage);
     }
@@ -495 +495 @@
     public void messageAnswered(FolderMessage folderMessage) throws IOException, MailException {
         ImapProtocol.MessageFlags updatedFlags =
-            imapProtocol.executeStore(folderMessage.getIndex(), true, new String[] { "\\Answered" });
+            imapProtocol.executeStore(folderMessage.getUid(), true, new String[] { "\\Answered" });
         refreshMessageFlags(updatedFlags, folderMessage);
     }

trunk/LogicMail/src/org/logicprobe/LogicMail/mail/imap/ImapParser.java

@@ -257 +257 @@
 
         // Sanity checking
-        if(parsedText.size() < 2 ||
-           !(parsedText.elementAt(1) instanceof Vector)) {
+        if(parsedText.size() < 4 ||
+           !(parsedText.elementAt(3) instanceof Vector)) {
            EventLogger.logEvent(
                AppInfo.GUID,
@@ -266 +266 @@
         }
         
-        Vector parsedStruct = (Vector)parsedText.elementAt(1);
+        Vector parsedStruct = (Vector)parsedText.elementAt(3);
         MessageSection msgStructure = parseMessageStructureHelper(null, 1, parsedStruct);
         fixMessageStructure(msgStructure);

trunk/LogicMail/src/org/logicprobe/LogicMail/mail/imap/ImapProtocol.java

@@ -454 +454 @@
     public static class FetchEnvelopeResponse {
         public int index;
+        public int uid;
         public MessageFlags flags;
         public MessageEnvelope envelope;
@@ -459 +460 @@
 
     /**
-     * Execute the "FETCH (ENVELOPE)" command
+     * Execute the "FETCH (FLAGS UID ENVELOPE)" command
      * @param firstIndex Index of the first message
      * @param lastIndex Index of the last message
@@ -475 +476 @@
                                    Integer.toString(firstIndex) + ":" +
                                    Integer.toString(lastIndex) +
-                                   " (FLAGS ENVELOPE)");
+                                   " (FLAGS UID ENVELOPE)");
         
         FetchEnvelopeResponse[] envResponses = new FetchEnvelopeResponse[(lastIndex - firstIndex)+1];
@@ -526 +527 @@
                             envRespItem.flags = ImapParser.parseMessageFlags((Vector)parsedText.elementAt(j+1));
                         }
+                        else if(((String)parsedText.elementAt(j)).equals("UID") &&
+                                        parsedSize > j+1 &&
+                                        parsedText.elementAt(j+1) instanceof String) {
+                                try {
+                                        envRespItem.uid = Integer.parseInt((String)parsedText.elementAt(j+1));
+                                } catch (NumberFormatException e) {
+                                        envRespItem.uid = -1;
+                                }
+                        }
                         else if(((String)parsedText.elementAt(j)).equals("ENVELOPE") &&
                                 parsedSize > j+1 &&
@@ -559 +569 @@
     /**
      * Execute the "FETCH (BODYSTRUCTURE)" command
-     * @param index Index of the message
+     * @param uid Unique ID of the message
      * @return Body structure tree
      */
-    public ImapParser.MessageSection executeFetchBodystructure(int index) throws IOException, MailException {
-        if(EventLogger.getMinimumLevel() >= EventLogger.DEBUG_INFO) {
-            EventLogger.logEvent(
-            AppInfo.GUID,
-            ("ImapProtocol.executeFetchBodyStructure("+index+")").getBytes(),
-            EventLogger.DEBUG_INFO);
-        }
-        
-        String[] rawList = execute("FETCH", index + " (BODYSTRUCTURE)");
+    public ImapParser.MessageSection executeFetchBodystructure(int uid) throws IOException, MailException {
+        if(EventLogger.getMinimumLevel() >= EventLogger.DEBUG_INFO) {
+            EventLogger.logEvent(
+            AppInfo.GUID,
+            ("ImapProtocol.executeFetchBodyStructure("+uid+")").getBytes(),
+            EventLogger.DEBUG_INFO);
+        }
+        
+        String[] rawList = execute("UID FETCH", uid + " (BODYSTRUCTURE)");
 
         // Pre-process the returned text to clean up mid-field line breaks
@@ -607 +617 @@
     /**
      * Execute the "FETCH (BODY)" command
-     * @param index Index of the message
+     * @param uid Unique ID of the message
      * @param address Address of the body section (i.e. "1", "1.2")
      * @return Body text as a string
      */
-    public String executeFetchBody(int index, String address) throws IOException, MailException {
-        if(EventLogger.getMinimumLevel() >= EventLogger.DEBUG_INFO) {
-            EventLogger.logEvent(
-            AppInfo.GUID,
-            ("ImapProtocol.executeFetchBody("+index+", \""+address+"\")").getBytes(),
-            EventLogger.DEBUG_INFO);
-        }
-
-        String[] rawList = execute("FETCH", index + " (BODY["+ address +"])");
+    public String executeFetchBody(int uid, String address) throws IOException, MailException {
+        if(EventLogger.getMinimumLevel() >= EventLogger.DEBUG_INFO) {
+            EventLogger.logEvent(
+            AppInfo.GUID,
+            ("ImapProtocol.executeFetchBody("+uid+", \""+address+"\")").getBytes(),
+            EventLogger.DEBUG_INFO);
+        }
+
+        String[] rawList = execute("UID FETCH", uid + " (BODY["+ address +"])");
 
         if(rawList.length <= 1) {
@@ -636 +646 @@
     /**
      * Execute the "STORE" command to update message flags.
-     * @param index The message index to modify.
+     * @param uid The message unique ID to modify.
      * @param addOrRemove True to add flags, false to remove them.
      * @param flags Array of flags to change.  (i.e. "\Seen", "\Answered")
      * @return Updated standard message flags, or null if there was a parse error.
      */
-    public MessageFlags executeStore(int index, boolean addOrRemove, String[] flags) throws IOException, MailException {
+    public MessageFlags executeStore(int uid, boolean addOrRemove, String[] flags) throws IOException, MailException {
         if(EventLogger.getMinimumLevel() >= EventLogger.DEBUG_INFO) {
             StringBuffer buf = new StringBuffer();
@@ -654 +664 @@
             EventLogger.logEvent(
             AppInfo.GUID,
-            ("ImapProtocol.executeStore("+index+", "+(addOrRemove?"add":"remove")+", {"+buf.toString()+"})").getBytes(),
+            ("ImapProtocol.executeStore("+uid+", "+(addOrRemove?"add":"remove")+", {"+buf.toString()+"})").getBytes(),
             EventLogger.DEBUG_INFO);
         }
 
         StringBuffer buf = new StringBuffer();
-        buf.append(index);
+        buf.append(uid);
         buf.append(' ');
         buf.append(addOrRemove?'+':'-');
@@ -670 +680 @@
         }
         buf.append(')');
-        String[] rawList = execute("STORE", buf.toString());
+        String[] rawList = execute("UID STORE", buf.toString());
         if(rawList.length < 1) {
             throw new MailException("Unable to set message flags");
@@ -676 +686 @@
         
         try {
-            int p = rawList[0].indexOf(' ');
-            int q = rawList[0].indexOf(' ', p+1);
-            int fetchIndex = Integer.parseInt(rawList[0].substring(p+1, q));
-            if(fetchIndex != index) {
-                return null;
+            int p = rawList[0].indexOf("UID");
+            int q = rawList[0].lastIndexOf(')');
+            if(p != -1 && q != -1 && p < q) {
+                int fetchIndex = Integer.parseInt(rawList[0].substring(p+4, q));
+                if(fetchIndex != uid) {
+                    return null;
+                }
             }
             p = rawList[0].indexOf("FLAGS (");
-            q = rawList[0].indexOf("))");
+            q = rawList[0].indexOf(") UID");
             if(p == -1 || q == -1) {
                 return null;
@@ -702 +714 @@
      * Execute the "APPEND" command to add a message to an existing mailbox.
      * @param mboxName Mailbox name.
-     * @param rawMessage The raw message text, in RFC2822-compliant format.
+     * @param rawMessage The raw message text, in RFC2822-complaint format.
      * @param flags Flags to store the message with.
      */

trunk/LogicMail/src/org/logicprobe/LogicMail/mail/pop/PopClient.java

@@ -235 +235 @@
         int index = 0;
         String[] headerText;
+        String uid;
         MessageEnvelope env;
         for(int i=firstIndex; i<=lastIndex; i++) {
             headerText = popProtocol.executeTop(i, 0);
+            uid = popProtocol.executeUidl(i);
             env = PopParser.parseMessageEnvelope(headerText);
-            folderMessages[index++] = new FolderMessage(env, i);
+            folderMessages[index++] = new FolderMessage(env, i, uid.hashCode());
         }
         return folderMessages;

trunk/LogicMail/src/org/logicprobe/LogicMail/mail/pop/PopProtocol.java

@@ -130 +130 @@
         return executeFollow("TOP " + index + " " + lines);
     }
-
+    
+    /**
+     * Execute the "UIDL" command
+     * @param index Message index
+     */
+    public String executeUidl(int index) throws IOException, MailException {
+        if(EventLogger.getMinimumLevel() >= EventLogger.DEBUG_INFO) {
+            EventLogger.logEvent(
+            AppInfo.GUID,
+            ("PopProtocol.executeUidl("+index+")").getBytes(),
+            EventLogger.DEBUG_INFO);
+        }
+        String result = execute("UIDL " + index);
+        int p = result.lastIndexOf(' ');
+        if(p < result.length() - 2) {
+                return result.substring(p+1);
+        }
+        else {
+                return null;
+        }
+    }
+    
     /**
      * Execute the "DELE" command.

trunk/LogicMail/src/org/logicprobe/LogicMail/message/FolderMessage.java

@@ -40 +40 @@
     private MessageEnvelope envelope;
     private int index;
+    private int uid;
     private MessageFlags messageFlags;
     
@@ -47 +48 @@
      * @param index The index of the message within the folder
      */
-    public FolderMessage(MessageEnvelope envelope, int index) {
+    public FolderMessage(MessageEnvelope envelope, int index, int uid) {
         this.envelope = envelope;
         this.index = index;
+        this.uid = uid;
         this.messageFlags = new MessageFlags();
     }
@@ -69 +71 @@
     }
 
+    /**
+     * Get the unique ID of this message
+     * @return unique ID
+     */
+    public int getUid() {
+        return uid;
+    }
+    
     /**
      * Gets the flags associated with this message.