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 Object get(Object key) {
14 if (key instanceof String) return slash((String)key, true);
18 public static final String STORAGE_ROOT =
19 System.getProperty("ibex.mail.root", File.separatorChar + "var" + File.separatorChar + "org.ibex.mail");
22 // Required Methods //////////////////////////////////////////////////////////////////////////////
24 /** phantom mailboxes merely contain others; like the alt.binaries in alt.binaries.warez */
25 public abstract boolean phantom();
26 public abstract Mailbox.Iterator iterator(Query q);
27 public abstract void add(Message message);
28 public abstract void add(Message message, int flags);
29 public abstract void move(Query q, Mailbox dest);
30 public abstract void copy(Query q, Mailbox dest);
31 public abstract int count(Query q);
32 public abstract int uidNext();
33 public abstract int uidValidity();
34 public abstract void rename(String newName); /* FIXME: IMAP semantics require creating parent dirs */
35 public abstract void destroy(boolean recursive);
36 public abstract Mailbox slash(String name, boolean create);
37 public abstract String[] children();
40 // Thunks ////////////////////////////////////////////////////////////////////////////
42 public final void accept(Message m) { add(m); }
43 public Mailbox.Iterator iterator() { return iterator(Query.all()); }
46 // Default Implementation //////////////////////////////////////////////////////////////////////////////
48 /** default, inefficient implementation of Mailbox; only requires a few methods to be implemented */
49 public static abstract class Default extends Mailbox {
50 public Mailbox.Iterator iterator(Query q) { return new Mailbox.Iterator.QueryIterator(q, this); }
51 public boolean phantom() { return false; }
52 public void copy(Query q, Mailbox dest) { for(Mailbox.Iterator it = iterator(q); it.next();) dest.add(it.cur()); }
53 public int count(Query q) { int count = 0; for(Mailbox.Iterator it = iterator(q); it.next();) count++; return count; }
54 public void rename(String newName) { throw new MailException("not supported"); }
55 public void destroy(boolean recursive) { throw new MailException("not supported"); }
56 public Mailbox slash(String name, boolean create) { throw new MailException("not supported"); }
57 public String[] children() { return new String[] { }; }
58 public void move(Query q, Mailbox dest) {
59 for(Mailbox.Iterator it = iterator(q);it.next();) { dest.add(it.cur()); it.delete(); }
61 public static abstract class Iterator implements Mailbox.Iterator {
64 (deleted() ? Flag.DELETED : 0) |
65 (seen() ? Flag.SEEN : 0) |
66 (answered() ? Flag.ANSWERED : 0) |
67 (draft() ? Flag.DRAFT : 0) |
68 (recent() ? Flag.RECENT : 0);
70 public void addFlags(int flags) {
71 if ((flags & Flag.DELETED) == Flag.DELETED) deleted(true);
72 if ((flags & Flag.SEEN) == Flag.SEEN) seen(true);
73 if ((flags & Flag.FLAGGED) == Flag.FLAGGED) flagged(true);
74 if ((flags & Flag.DRAFT) == Flag.DRAFT) draft(true);
75 if ((flags & Flag.RECENT) == Flag.RECENT) recent(true);
77 public void removeFlags(int flags) {
78 if ((flags & Flag.DELETED) == Flag.DELETED) deleted(false);
79 if ((flags & Flag.SEEN) == Flag.SEEN) seen(false);
80 if ((flags & Flag.FLAGGED) == Flag.FLAGGED) flagged(false);
81 if ((flags & Flag.DRAFT) == Flag.DRAFT) draft(false);
82 if ((flags & Flag.RECENT) == Flag.RECENT) recent(false);
84 public void setFlags(int flags) {
85 if ((flags & Flag.DELETED) == Flag.DELETED) deleted(true); else deleted(false);
86 if ((flags & Flag.SEEN) == Flag.SEEN) seen(true); else seen(false);
87 if ((flags & Flag.FLAGGED) == Flag.FLAGGED) flagged(true); else flagged(false);
88 if ((flags & Flag.DRAFT) == Flag.DRAFT) draft(true); else draft(false);
89 if ((flags & Flag.RECENT) == Flag.RECENT) recent(true); else recent(false);
95 // Iterator Definition //////////////////////////////////////////////////////////////////////////////
97 public static interface Iterator {
98 public abstract Message cur();
99 public abstract Message head();
100 public abstract boolean next();
101 public abstract int uid();
102 public abstract int num();
103 public abstract void delete();
105 public abstract void set(String key, String val);
106 public abstract String get(String key);
108 public abstract boolean seen();
109 public abstract boolean deleted();
110 public abstract boolean flagged();
111 public abstract boolean draft();
112 public abstract boolean answered();
113 public abstract boolean recent();
115 public abstract void seen(boolean on);
116 public abstract void deleted(boolean on);
117 public abstract void flagged(boolean on);
118 public abstract void draft(boolean on);
119 public abstract void answered(boolean on);
120 public abstract void recent(boolean on);
122 public abstract int flags();
123 public abstract void addFlags(int flags);
124 public abstract void removeFlags(int flags);
125 public abstract void setFlags(int flags);
127 public static class Wrapper implements Iterator {
129 public Wrapper(Iterator it) { this.it = it; }
130 public Message cur() { return it.cur(); }
131 public Message head() { return it.head(); }
132 public boolean next() { return it.next(); }
133 public int uid() { return it.uid(); }
134 public int flags() { return it.flags(); }
135 public int num() { return it.num(); }
136 public void set(String key, String val) { it.set(key, val); }
137 public String get(String key) { return it.get(key); }
138 public void delete() { it.delete(); }
139 public boolean seen() { return it.seen(); }
140 public boolean deleted() { return it.deleted(); }
141 public boolean flagged() { return it.flagged(); }
142 public boolean draft() { return it.draft(); }
143 public boolean answered() { return it.answered(); }
144 public boolean recent() { return it.recent(); }
145 public void seen(boolean on) { it.seen(on); }
146 public void deleted(boolean on) { it.deleted(on); }
147 public void flagged(boolean on) { it.flagged(on); }
148 public void draft(boolean on) { it.draft(on); }
149 public void answered(boolean on) { it.answered(on); }
150 public void recent(boolean on) { it.recent(on); }
151 public void addFlags(int flags) { it.addFlags(flags); }
152 public void removeFlags(int flags) { it.removeFlags(flags); }
153 public void setFlags(int flags) { it.setFlags(flags); }
156 class QueryIterator extends Mailbox.Iterator.Wrapper {
158 public QueryIterator(Query q, Mailbox m) { super(m.iterator()); this.q = q; }
159 public boolean next() {
160 if (q == null) return false;
161 do { if (!super.next()) return false; } while(!q.match(this)); return true; }
164 public static class NullIterator extends Mailbox.Default.Iterator {
165 public NullIterator() { }
166 public Message cur() { return null; }
167 public Message head() { return null; }
168 public boolean next() { return false; }
169 public int uid() { return 0; }
170 public int flags() { return 0; }
171 public int num() { return 0; }
172 public void set(String key, String val) { }
173 public String get(String key) { return null; }
174 public void delete() { }
175 public boolean seen() { return false; }
176 public boolean deleted() { return false; }
177 public boolean flagged() { return false; }
178 public boolean draft() { return false; }
179 public boolean answered() { return false; }
180 public boolean recent() { return false; }
181 public void seen(boolean on) { }
182 public void deleted(boolean on) { }
183 public void flagged(boolean on) { }
184 public void draft(boolean on) { }
185 public void answered(boolean on) { }
186 public void recent(boolean on) { }
190 /** constants for the six IMAP flags */
191 public static class Flag {
192 public static final int DELETED = 0x0001;
193 public static final int SEEN = 0x0002;
194 public static final int FLAGGED = 0x0004;
195 public static final int DRAFT = 0x0008;
196 public static final int ANSWERED = 0x0010;
197 public static final int RECENT = 0x0020;