org.masukomi.aspirin

Class Aspirin

java.lang.Object

org.masukomi.aspirin.Aspirin

public class Aspirin
extends Object

This is the facade class of the Aspirin package. You should to use this class to manage email sending.

How it works?

All email is represented by two main object:

A MimeMessage, which contains the RAW content of an email, so it could be very large. It is stored in a MailStore (there is two different implementation in Aspirin - one for simple in-memory usage SimpleMailStore and one for heavy usage FileMailStore, this stores all MimeMessage objects on filesystem.) If no one of these default stores is good for you, you can implement the MailStore interface.

A QueueInfo QueueInfo, which represents an email and a recipient together, so one email could associated to more QueueInfo objects. This is an inside object, which contains all control informations of a mail item. In Aspirin package there is a QueueStore for in-memory use SimpleQueueStore, this is the default implementation to store QueueInfo objects. You can find an additional package, which use SQLite (based on SQLJet) to store QueueInfo object.

Hint: If you need a Quality-of-Service mail sending, use FileMailStore and additional SqliteQueueStore, they could preserve emails in queue between runs or on Java failure.

Author:

Laszlo Solova

Field Summary

Fields

Modifier and Type	Field and Description
static String	HEADER_EXPIRY Name of expiration time header placed in MimeMessage object.
static String	HEADER_MAIL_ID Name of ID header placed in MimeMessage object.

Constructor Summary

Constructors

Constructor and Description
Aspirin()

Method Summary

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

HEADER_MAIL_ID

public static final String HEADER_MAIL_ID

Name of ID header placed in MimeMessage object. If no such header is defined in a MimeMessage, then MimeMessage's toString() method is used to generate a new one.

See Also:

Constant Field Values

HEADER_EXPIRY

public static final String HEADER_EXPIRY

Name of expiration time header placed in MimeMessage object. Default expiration time is -1, unlimited. Expiration time is an epoch timestamp in milliseconds.

See Also:

Constant Field Values

Constructor Detail

Aspirin

public Aspirin()