1 // Copyright 2000-2005 the Contributors, as shown in the revision logs.
2 // Licensed under the Apache Public Source License 2.0 ("the License").
3 // You may not use this file except in compliance with the License.
6 import org.ibex.crypto.*;
7 import org.ibex.util.*;
8 import org.ibex.mail.protocol.*;
11 import org.ibex.io.Fountain;
16 // FIXME: messages must NEVER contain 8-bit binary data; this is a violation of IMAP
17 // FIXME: RFC822 1,000-char limit per line [soft line limit (suggested): 78 chars / hard line limit: 998 chars]
19 // FEATURE: PGP-signature-parsing
20 // FEATURE: mailing list header parsing (?)
21 // FEATURE: threading as in http://www.jwz.org/doc/threading.html
24 * [immutable] This class encapsulates a message "floating in the
25 * ether": RFC2822 data but no storage-specific flags or other
28 public class Message extends MIME.Part {
30 // Parsed Headers //////////////////////////////////////////////////////////////////////////////
32 public final Address to;
33 public final Address from; // if multiple From entries, this is sender
34 public final Address envelopeFrom;
35 public final Address envelopeTo;
36 public final Date date;
37 public final Date arrival;
38 public final Address replyto; // if none provided, this is equal to sender
39 public final String subject;
40 public final String messageid;
41 public final Address[] cc;
42 public final Address[] bcc;
44 public static Message newMessage(Fountain in) throws Malformed { return new Message(in); }
46 public Message reply(Fountain in, Address from, boolean includeReInSubject) throws Malformed {
49 if (to==null) to = Address.parse(headers.get("reply-to"));
50 if (to==null) to = Address.parse(headers.get("from"));
51 if (to==null) to = envelopeFrom;
52 Message ret = newMessage(in, from, to);
53 ret.headers.put("In-Reply-To", messageid);
54 String references = headers.get("references");
55 ret.headers.put("References", messageid + (references==null?"":(" "+references)));
56 if (includeReInSubject && subject!=null && !subject.toLowerCase().trim().startsWith("re:"))
57 headers.put("subject", "Re: "+subject);
65 //public static Message newMessage(Headers headers, Fountain body, Address from, Address to) throws Malformed {
68 public static Message newMessage(Fountain in, Address from, Address to) throws Malformed {
69 StringBuffer sb = new StringBuffer();
70 if (from != null) sb.append("Return-Path: " + from.toString(true) + "\r\n");
71 Stream stream = in.getStream();
73 String s = stream.readln();
74 if (s == null || s.length() == 0) {
75 if (to != null) sb.append("Envelope-To: " + to.toString(true) + "\r\n");
79 if (to != null && s.toLowerCase().startsWith("envelope-to:")) continue;
80 if (s.toLowerCase().startsWith("return-path:")) continue;
84 for(String s = stream.readln(); s != null; s = stream.readln()) {
88 return new Message(new Fountain.StringFountain(sb.toString()));
91 private Message(Fountain in) throws Malformed {
94 this.envelopeTo = headers.get("Envelope-To") != null ? Address.parse(headers.get("Envelope-To")) : null;
95 this.envelopeFrom = headers.get("Return-Path") != null ? Address.parse(headers.get("Return-Path")) : null;
96 this.to = headers.get("To") != null ? Address.parse(headers.get("To")) : this.envelopeTo;
97 this.from = headers.get("From") != null ? Address.parse(headers.get("From")) : this.envelopeFrom;
98 this.replyto = headers.get("Reply-To") == null ? null : Address.parse(headers.get("Reply-To"));
99 this.subject = headers.get("Subject");
100 this.messageid = headers.get("Message-Id");
101 this.cc = Address.list(headers.get("Cc"));
102 this.bcc = Address.list(headers.get("Bcc"));
103 this.date = parseDate(headers.get("Date")) == null ? new Date() : parseDate(headers.get("Date"));
105 if (this.messageid==null)
106 throw new RuntimeException("every RFC2822 message must have a Message-ID: header");
109 // synthesize a message-id if not provided
110 this.messageid = headers.get("Message-Id") == null ? generateFreshMessageId(sha1(in.getStream())) : headers.get("Message-Id");
111 if (headers.get("Message-Id") == null) {
112 headers = headers.set("Message-Id", this.messageid);
113 Log.warn(Message.class, "synthesizing message-id for " + summary());
117 this.arrival = this.date; // FIXME wrong; grab this from traces?
121 private static String sha1(Stream stream) {
122 SHA1 sha1 = new SHA1();
123 byte[] b = new byte[1024];
125 int numread = stream.read(b, 0, b.length);
126 if (numread == -1) break;
127 sha1.update(b, 0, numread);
129 byte[] results = new byte[sha1.getDigestSize()];
130 sha1.doFinal(results, 0);
131 return new String(Encode.toBase64(results));
135 // Helpers /////////////////////////////////////////////////////////////////////////////
137 // http://www.jwz.org/doc/mid.html
138 private static final Random random = new Random();
139 public static String generateFreshMessageId() {
140 return generateFreshMessageId(Base36.encode(System.currentTimeMillis())+'.'+
141 Base36.encode(random.nextLong()));
143 public static String generateFreshMessageId(String seed) {
144 StringBuffer ret = new StringBuffer();
148 try { ret.append(InetAddress.getLocalHost().getHostName()); } catch (UnknownHostException e) { /* DELIBERATE */ }
150 return ret.toString();
153 public static Date parseDate(String s) {
154 // FIXME!!! this must be robust
155 // date/time parsing: see spec, 3.3
159 // this is belived to be compliant with QSBMF (http://cr.yp.to/proto/qsbmf.txt)
160 public Message bounce(String reason) {
161 if (envelopeFrom==null || envelopeFrom.toString().equals("")) return null;
163 Log.warn(Message.class, "bouncing message due to: " + reason);
164 Headers h = new Headers.Original(headers.getStream());
165 h = h.set(new String[] {
166 "Envelope-To", envelopeFrom.toString(),
168 "From", "MAILER-DAEMON <>",
169 "To", envelopeFrom.toString(),
170 "Subject", "failure notice"
174 "Hi. This is the Ibex Mail Server. I'm afraid I wasn't able to deliver\r\n"+
175 "your message to the following addresses. This is a permanent error;\r\n"+
176 "I've given up. Sorry it didn't work out\r\n."+
178 "<"+envelopeTo.toString()+">:\r\n"+
181 "--- Below this line is a copy of the message.\r\n"+
185 return newMessage(new Fountain.Concatenate(new Fountain.StringFountain(h.getString()+"\r\n"+error), getBody()));
186 } catch (Message.Malformed e) {
187 Log.error(this, "caught Message.Malformed in Message.bounce(); this should never happen");
193 public String toString() { throw new RuntimeException("Message.toString() called"); }
194 public final String summary() { return "[" + envelopeFrom + " -> " + envelopeTo + "] " + subject; }
196 public static class Malformed extends MailException { public Malformed(String s) { super(s); } }