org.apache.james.queue.api

Interface MailQueue

All Known Subinterfaces:

ManageableMailQueue

All Known Implementing Classes:

ActiveMQMailQueue, FileMailQueue, JMSMailQueue

public interface MailQueue

A Queue/Spool for Mails. How the Queue handles the ordering of the dequeuing is up to the implementation.

IMPORTANT:
Implementations does not need to keep all Mail Attributes when enqueue emails. The implementations are only in the need of supporting at least this kind of Primitives as values:

• Long
• Byte
• Integer
• String
• Boolean
• Short
• Float
• Double

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	MailQueue.MailQueueException Exception which will get thrown if any problems occur while working the MailQueue
static interface	MailQueue.MailQueueItem

Field Summary

Fields

Modifier and Type	Field and Description
static int	NO_DELAY No delay for queued MailQueue.MailQueueItem

Method Summary

Methods

Modifier and Type	Method and Description
MailQueue.MailQueueItem	deQueue() Dequeue the next ready-to-process Mail of the queue.
void	enQueue(org.apache.mailet.Mail mail) Enqueue the Mail to the queue
void	enQueue(org.apache.mailet.Mail mail, long delay, TimeUnit unit) Enqueue the Mail to the queue.

Field Detail

NO_DELAY

static final int NO_DELAY

No delay for queued MailQueue.MailQueueItem

See Also:

Constant Field Values

Method Detail

enQueue

void enQueue(org.apache.mailet.Mail mail,
           long delay,
           TimeUnit unit)
             throws MailQueue.MailQueueException

Enqueue the Mail to the queue. The given delay and unit are used to calculate the time when the Mail will be available for deQueue

Parameters:

mail -

delay -

unit -

Throws:

MailQueue.MailQueueException

enQueue

void enQueue(org.apache.mailet.Mail mail)
             throws MailQueue.MailQueueException

Enqueue the Mail to the queue

Parameters:

mail -

Throws:

MailQueue.MailQueueException

deQueue

MailQueue.MailQueueItem deQueue()
                                throws MailQueue.MailQueueException

Dequeue the next ready-to-process Mail of the queue. This method will block until a Mail is ready and then process the operation. Implementations should take care todo some kind of transactions to not loose any mail on error

Throws:

MailQueue.MailQueueException