almost there

[org.ibex.mail.git] / src / org / ibex / mail / target / Mailbox.java

diff --git a/src/org/ibex/mail/target/Mailbox.java b/src/org/ibex/mail/target/Mailbox.java
index 5e3e67f..8d4e286 100644 (file)
--- a/src/org/ibex/mail/target/Mailbox.java
+++ b/src/org/ibex/mail/target/Mailbox.java
@@ -7,6 +7,7 @@ import java.net.*;
 import java.util.*;
 import java.text.*;
 
+/** abstract superclass for mailboxes, which store messages along with their flags */
 public abstract class Mailbox extends Target {
 
     public static final String STORAGE_ROOT =
@@ -15,16 +16,20 @@ public abstract class Mailbox extends Target {
 
     // Required Methods //////////////////////////////////////////////////////////////////////////////
 
+    /** phantom mailboxes merely contain others; like the alt.binaries in alt.binaries.warez */
+    public abstract boolean          phantom();
     public abstract Mailbox.Iterator iterator(Query q);
-    public abstract int              add(Message message);
+    public abstract void             add(Message message);
+    public abstract void             add(Message message, int flags);
     public abstract void             move(Query q, Mailbox dest);
     public abstract void             copy(Query q, Mailbox dest);
     public abstract int              count(Query q);
     public abstract int              uidNext();
     public abstract int              uidValidity();
-    public abstract void             rename(String newName);
-    public abstract void             destroy();
+    public abstract void             rename(String newName);      /* FIXME: IMAP semantics require creating parent dirs */
+    public abstract void             destroy(boolean recursive);
     public abstract Mailbox          slash(String name, boolean create);
+    public abstract String[]         children();
 
 
     // Thunks ////////////////////////////////////////////////////////////////////////////
@@ -38,20 +43,54 @@ public abstract class Mailbox extends Target {
     /** default, inefficient implementation of Mailbox; only requires a few methods to be implemented */
     public static abstract class Default extends Mailbox {
         public Mailbox.Iterator iterator(Query q) { return new Mailbox.Iterator.QueryIterator(q, this); }
+        public boolean phantom() { return false; }
         public void copy(Query q, Mailbox dest) { for(Mailbox.Iterator it = iterator(q); it.next();) dest.add(it.cur()); }
         public int count(Query q) { int count = 0; for(Mailbox.Iterator it = iterator(q); it.next();) count++; return count; }
         public void rename(String newName) { throw new MailException("not supported"); }
-        public void  destroy() { throw new MailException("not supported"); }
+        public void  destroy(boolean recursive) { throw new MailException("not supported"); }
         public Mailbox slash(String name, boolean create) { throw new MailException("not supported"); }
+        public String[] children() { return new String[] { }; }
         public void move(Query q, Mailbox dest) {
             for(Mailbox.Iterator it = iterator(q);it.next();) { dest.add(it.cur()); it.delete(); }
         }
+        public static abstract class Iterator implements Mailbox.Iterator {
+            public int flags() {
+                return 
+                    (deleted() ? Flag.DELETED : 0) |
+                    (seen() ? Flag.SEEN : 0) |
+                    (answered() ? Flag.ANSWERED : 0) |
+                    (draft() ? Flag.DRAFT : 0) |
+                    (recent() ? Flag.RECENT : 0);
+            }
+            public void addFlags(int flags) {
+                if ((flags & Flag.DELETED) == Flag.DELETED) deleted(true);
+                if ((flags & Flag.SEEN) == Flag.SEEN) seen(true);
+                if ((flags & Flag.FLAGGED) == Flag.FLAGGED) flagged(true);
+                if ((flags & Flag.DRAFT) == Flag.DRAFT) draft(true);
+                if ((flags & Flag.RECENT) == Flag.RECENT) recent(true);
+            }
+            public void removeFlags(int flags) {
+                if ((flags & Flag.DELETED) == Flag.DELETED) deleted(false);
+                if ((flags & Flag.SEEN) == Flag.SEEN) seen(false);
+                if ((flags & Flag.FLAGGED) == Flag.FLAGGED) flagged(false);
+                if ((flags & Flag.DRAFT) == Flag.DRAFT) draft(false);
+                if ((flags & Flag.RECENT) == Flag.RECENT) recent(false);
+            }
+            public void setFlags(int flags) {
+                if ((flags & Flag.DELETED) == Flag.DELETED) deleted(true); else deleted(false);
+                if ((flags & Flag.SEEN) == Flag.SEEN) seen(true); else seen(false);
+                if ((flags & Flag.FLAGGED) == Flag.FLAGGED) flagged(true); else flagged(false);
+                if ((flags & Flag.DRAFT) == Flag.DRAFT) draft(true); else draft(false);
+                if ((flags & Flag.RECENT) == Flag.RECENT) recent(true); else recent(false);
+            }
+        }
     }
 
 
     // Iterator Definition //////////////////////////////////////////////////////////////////////////////
 
     public static interface Iterator {
+        public abstract int flags();
         public abstract Message cur();
         public abstract boolean next();
         public abstract int     uid();
@@ -71,6 +110,9 @@ public abstract class Mailbox extends Target {
         public abstract void    draft(boolean on);
         public abstract void    answered(boolean on);
         public abstract void    recent(boolean on);
+        public abstract void    addFlags(int flags);
+        public abstract void    removeFlags(int flags);
+        public abstract void    setFlags(int flags);
 
         public static class Wrapper implements Iterator {
             private Iterator it;
@@ -78,6 +120,7 @@ public abstract class Mailbox extends Target {
             public Message cur() { return it.cur(); }
             public boolean next() { return it.next(); }
             public int     uid() { return it.uid(); }
+            public int     flags() { return it.flags(); }
             public int     num() { return it.num(); }
             public void    set(String key, String val) { it.set(key, val); }
             public String  get(String key) { return it.get(key); }
@@ -94,6 +137,9 @@ public abstract class Mailbox extends Target {
             public void    draft(boolean on) { it.draft(on); }
             public void    answered(boolean on) { it.answered(on); }
             public void    recent(boolean on) { it.recent(on); }
+            public void    addFlags(int flags) { it.addFlags(flags); }
+            public void    removeFlags(int flags) { it.removeFlags(flags); }
+            public void    setFlags(int flags) { it.setFlags(flags); }
         }
 
         class QueryIterator extends Mailbox.Iterator.Wrapper {
@@ -102,5 +148,15 @@ public abstract class Mailbox extends Target {
             public boolean next() { do { if (!super.next()) return false; } while(!q.match(this)); return true; }
         }
     }
+
+    /** constants for the six IMAP flags */
+    public static class Flag {
+        public static final int DELETED  = 0x0001;
+        public static final int SEEN     = 0x0002;
+        public static final int FLAGGED  = 0x0004;
+        public static final int DRAFT    = 0x0008;
+        public static final int ANSWERED = 0x0010;
+        public static final int RECENT   = 0x0020;
+    }
     
 }