org.apache.james.queue.api

Interface MailQueueManagementMBean

All Known Implementing Classes:

MailQueueManagement

public interface MailQueueManagementMBean

Method Summary

Methods

Modifier and Type	Method and Description
List<CompositeData>	browse() Allow to browse the content of the queue
long	clear() Clear the queue
long	flush() Flush queue to make every Mail ready to consume.
long	getSize() Return the size of the queue or -1 if the size could not get calculated
long	removeWithName(String name) Remove mail with name from the queue
long	removeWithRecipient(String address) Remove mail with specific recipient from the queue
long	removeWithSender(String address) Remove mail with specific sender from the queue

Method Detail

getSize

long getSize()
             throws Exception

Return the size of the queue or -1 if the size could not get calculated

Returns:

size the size or -1 if it could not get calculated

Throws:

Exception

flush

long flush()
           throws Exception

Flush queue to make every Mail ready to consume.

Returns:

count the count of all flushed mails or -1 if the flush was not possible

Throws:

Exception

clear

long clear()
           throws Exception

Clear the queue

Returns:

count the count of all removed mails or -1 if clear was not possible

Throws:

Exception

removeWithName

long removeWithName(String name)
                    throws Exception

Remove mail with name from the queue

Returns:

count the count of all removed mails or -1 if clear was not possible

Throws:

Exception

removeWithSender

long removeWithSender(String address)
                      throws Exception

Remove mail with specific sender from the queue

Returns:

count the count of all removed mails or -1 if clear was not possible

Throws:

Exception

removeWithRecipient

long removeWithRecipient(String address)
                         throws Exception

Remove mail with specific recipient from the queue

Returns:

count the count of all removed mails or -1 if clear was not possible

Throws:

Exception

browse

List<CompositeData> browse()
                           throws Exception

Allow to browse the content of the queue

Returns:

data

Throws:

Exception