import java.util.*;
import java.text.*;
+/** abstract superclass for mailboxes, which store messages along with their flags */
public abstract class Mailbox extends Target {
- private static final String STORAGE_ROOT =
+ public static final String STORAGE_ROOT =
System.getProperty("ibex.mail.root", File.separatorChar + "var" + File.separatorChar + "org.ibex.mail");
- public static FileBased root = null;
- public static Transcript transcript = null;
- static {
- try {
- root = new FileBased(STORAGE_ROOT + File.separatorChar);
- transcript = new Transcript(STORAGE_ROOT + File.separatorChar + "transcript");
- } catch (Exception e) {
- e.printStackTrace();
+
+
+ // 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 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); /* 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 ////////////////////////////////////////////////////////////////////////////
+
+ public final void accept(Message m) { add(m); }
+ public Mailbox.Iterator iterator() { return iterator(Query.all()); }
+
+
+ // Default Implementation //////////////////////////////////////////////////////////////////////////////
+
+ /** 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(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);
+ }
}
}
- // metadata
- public void set(Message m, String key, String val) { throw new MailException.MetadataNotSupported(); }
- public String get(Message m, String key) { throw new MailException.MetadataNotSupported(); }
-
- // flags
- public final boolean getFlag(Message m, int flags) { return (flags(m) & flag) == flags; }
- public final void setFlag(Message m, int flag) { flags(m, flags | flag); }
- public final void clearFlag(Message m, int flag) { flags(m, flags & ~flag); }
- protected abstract void flags(Message m, int newFlags); // set the flags for a given message
- protected abstract int flags(Message m); // get the flags for a given message
- public abstract int uid(Message m); // get the uid for a given message (see IMAP RFC)
- public abstract int num(Message m); // get the "message number" for a given message (see IMAP RFC)
- public abstract int uidNext(); // get the next uid to be assigned
- public abstract int uidValidity(); // get the uid validity identifier (see IMAP RFC)
-
- // messages
- public abstract void visit(Message.Visitor v) throws MailException; // only abstract method
- public int add(Message message) throws MailException { throw new MailException("not implemented"); }
- public int delete(Message message) throws MailException { throw new MailException("not implemented"); }
- public void move(Query q, Mailbox dest, boolean copy) throws MailException { throw new MailException("not implemented"); }
- public int count(Query q) throws MailException { CounterVisitor cv = new CounterVisitor(this,q); visit(cv); return cv.count; }
- public void query(Query q, final Message.Visitor v) throws MailException {
- visit(new Message.Visitor() { public void visit(Message m) { if (q.match(Mailbox.this,m)) v.visit(Mailbox.this,m); } }); }
-
- // submailboxes
- public void rename(String newName) throws MailException { throw new MailException("you cannot rename this mailbox"); }
- public void destroy() throws MailException { throw new MailException("you cannot destroy this mailbox"); }
- public Mailbox slash(String name, boolean create) throws MailException { throw new MailException("no submailboxes"); }
-
- private static class CounterVisitor implements Message.Visitor {
- public int count = 0;
- public void visit(Message m) { if (q.match(Mailbox.this, m)) count++; }
+
+ // Iterator Definition //////////////////////////////////////////////////////////////////////////////
+
+ public static interface Iterator {
+ public abstract int flags();
+ public abstract Message cur();
+ public abstract boolean next();
+ public abstract int uid();
+ public abstract int num();
+ public abstract void delete();
+ public abstract void set(String key, String val);
+ public abstract String get(String key);
+ public abstract boolean seen();
+ public abstract boolean deleted();
+ public abstract boolean flagged();
+ public abstract boolean draft();
+ public abstract boolean answered();
+ public abstract boolean recent();
+ public abstract void seen(boolean on);
+ public abstract void deleted(boolean on);
+ public abstract void flagged(boolean on);
+ 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;
+ public Wrapper(Iterator it) { this.it = it; }
+ 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); }
+ public void delete() { it.delete(); }
+ public boolean seen() { return it.seen(); }
+ public boolean deleted() { return it.deleted(); }
+ public boolean flagged() { return it.flagged(); }
+ public boolean draft() { return it.draft(); }
+ public boolean answered() { return it.answered(); }
+ public boolean recent() { return it.recent(); }
+ public void seen(boolean on) { it.seen(on); }
+ public void deleted(boolean on) { it.deleted(on); }
+ public void flagged(boolean on) { it.flagged(on); }
+ 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 {
+ Query q;
+ public QueryIterator(Query q, Mailbox m) { super(m.iterator()); this.q = q; }
+ public boolean next() { do { if (!super.next()) return false; } while(!q.match(this)); return true; }
+ }
}
- public final void accept(Message m) throws MailException { add(m); }
+ /** 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;
+ }
+
}
projects / org.ibex.mail.git / blobdiff