1 package org.ibex.mail.target;
2 import org.ibex.mail.*;
3 import org.ibex.util.*;
4 import org.ibex.mail.*;
10 /** abstract superclass for mailboxes, which store messages along with their flags */
11 public abstract class Mailbox extends Target {
13 public static final String STORAGE_ROOT =
14 System.getProperty("ibex.mail.root", File.separatorChar + "var" + File.separatorChar + "org.ibex.mail");
17 // Required Methods //////////////////////////////////////////////////////////////////////////////
19 public abstract Mailbox.Iterator iterator(Query q);
20 public abstract void add(Message message);
21 public abstract void add(Message message, int flags);
22 public abstract void move(Query q, Mailbox dest);
23 public abstract void copy(Query q, Mailbox dest);
24 public abstract int count(Query q);
25 public abstract int uidNext();
26 public abstract int uidValidity();
27 public abstract void rename(String newName); /* FIXME: IMAP semantics require creating parent dirs */
28 public abstract void destroy();
29 public abstract Mailbox slash(String name, boolean create);
30 public abstract String[] children();
33 // Thunks ////////////////////////////////////////////////////////////////////////////
35 public final void accept(Message m) { add(m); }
36 public Mailbox.Iterator iterator() { return iterator(Query.all()); }
39 // Default Implementation //////////////////////////////////////////////////////////////////////////////
41 /** default, inefficient implementation of Mailbox; only requires a few methods to be implemented */
42 public static abstract class Default extends Mailbox {
43 public Mailbox.Iterator iterator(Query q) { return new Mailbox.Iterator.QueryIterator(q, this); }
44 public void copy(Query q, Mailbox dest) { for(Mailbox.Iterator it = iterator(q); it.next();) dest.add(it.cur()); }
45 public int count(Query q) { int count = 0; for(Mailbox.Iterator it = iterator(q); it.next();) count++; return count; }
46 public void rename(String newName) { throw new MailException("not supported"); }
47 public void destroy() { throw new MailException("not supported"); }
48 public Mailbox slash(String name, boolean create) { throw new MailException("not supported"); }
49 public String[] children() { return new String[] { }; }
50 public void move(Query q, Mailbox dest) {
51 for(Mailbox.Iterator it = iterator(q);it.next();) { dest.add(it.cur()); it.delete(); }
53 public static abstract class Iterator implements Mailbox.Iterator {
56 (deleted() ? Flag.DELETED : 0) |
57 (seen() ? Flag.SEEN : 0) |
58 (answered() ? Flag.ANSWERED : 0) |
59 (draft() ? Flag.DRAFT : 0) |
60 (recent() ? Flag.RECENT : 0);
62 public void addFlags(int flags) {
63 if ((flags & Flag.DELETED) == Flag.DELETED) deleted(true);
64 if ((flags & Flag.SEEN) == Flag.SEEN) seen(true);
65 if ((flags & Flag.FLAGGED) == Flag.FLAGGED) flagged(true);
66 if ((flags & Flag.DRAFT) == Flag.DRAFT) draft(true);
67 if ((flags & Flag.RECENT) == Flag.RECENT) recent(true);
69 public void removeFlags(int flags) {
70 if ((flags & Flag.DELETED) == Flag.DELETED) deleted(false);
71 if ((flags & Flag.SEEN) == Flag.SEEN) seen(false);
72 if ((flags & Flag.FLAGGED) == Flag.FLAGGED) flagged(false);
73 if ((flags & Flag.DRAFT) == Flag.DRAFT) draft(false);
74 if ((flags & Flag.RECENT) == Flag.RECENT) recent(false);
76 public void setFlags(int flags) {
77 if ((flags & Flag.DELETED) == Flag.DELETED) deleted(true); else deleted(false);
78 if ((flags & Flag.SEEN) == Flag.SEEN) seen(true); else seen(false);
79 if ((flags & Flag.FLAGGED) == Flag.FLAGGED) flagged(true); else flagged(false);
80 if ((flags & Flag.DRAFT) == Flag.DRAFT) draft(true); else draft(false);
81 if ((flags & Flag.RECENT) == Flag.RECENT) recent(true); else recent(false);
87 // Iterator Definition //////////////////////////////////////////////////////////////////////////////
89 public static interface Iterator {
90 public abstract int flags();
91 public abstract Message cur();
92 public abstract boolean next();
93 public abstract int uid();
94 public abstract int num();
95 public abstract void delete();
96 public abstract void set(String key, String val);
97 public abstract String get(String key);
98 public abstract boolean seen();
99 public abstract boolean deleted();
100 public abstract boolean flagged();
101 public abstract boolean draft();
102 public abstract boolean answered();
103 public abstract boolean recent();
104 public abstract void seen(boolean on);
105 public abstract void deleted(boolean on);
106 public abstract void flagged(boolean on);
107 public abstract void draft(boolean on);
108 public abstract void answered(boolean on);
109 public abstract void recent(boolean on);
110 public abstract void addFlags(int flags);
111 public abstract void removeFlags(int flags);
112 public abstract void setFlags(int flags);
114 public static class Wrapper implements Iterator {
116 public Wrapper(Iterator it) { this.it = it; }
117 public Message cur() { return it.cur(); }
118 public boolean next() { return it.next(); }
119 public int uid() { return it.uid(); }
120 public int flags() { return it.flags(); }
121 public int num() { return it.num(); }
122 public void set(String key, String val) { it.set(key, val); }
123 public String get(String key) { return it.get(key); }
124 public void delete() { it.delete(); }
125 public boolean seen() { return it.seen(); }
126 public boolean deleted() { return it.deleted(); }
127 public boolean flagged() { return it.flagged(); }
128 public boolean draft() { return it.draft(); }
129 public boolean answered() { return it.answered(); }
130 public boolean recent() { return it.recent(); }
131 public void seen(boolean on) { it.seen(on); }
132 public void deleted(boolean on) { it.deleted(on); }
133 public void flagged(boolean on) { it.flagged(on); }
134 public void draft(boolean on) { it.draft(on); }
135 public void answered(boolean on) { it.answered(on); }
136 public void recent(boolean on) { it.recent(on); }
137 public void addFlags(int flags) { it.addFlags(flags); }
138 public void removeFlags(int flags) { it.removeFlags(flags); }
139 public void setFlags(int flags) { it.setFlags(flags); }
142 class QueryIterator extends Mailbox.Iterator.Wrapper {
144 public QueryIterator(Query q, Mailbox m) { super(m.iterator()); this.q = q; }
145 public boolean next() { do { if (!super.next()) return false; } while(!q.match(this)); return true; }
149 /** constants for the six IMAP flags */
150 public static class Flag {
151 public static final int DELETED = 0x0001;
152 public static final int SEEN = 0x0002;
153 public static final int FLAGGED = 0x0004;
154 public static final int DRAFT = 0x0008;
155 public static final int ANSWERED = 0x0010;
156 public static final int RECENT = 0x0020;