com.adaptris.mail

Interface MailReceiver

All Superinterfaces:

java.lang.AutoCloseable, java.io.Closeable, java.lang.Iterable<javax.mail.internet.MimeMessage>

All Known Implementing Classes:

MailboxClient, MailClientImp

public interface MailReceiver
extends java.lang.Iterable<javax.mail.internet.MimeMessage>, java.io.Closeable

Interface for Adaptris mail receiver clients

Method Summary

Modifier and Type	Method and Description
void	addCustomFilter(java.lang.String headerValue, java.lang.String filter) Add a custom filter
void	connect() Connect to the mailbox
void	disconnect() Deprecated. since 3.6.5 use Closeable.close() instead.
java.util.List<javax.mail.internet.MimeMessage>	getMessages() Deprecated. since 3.6.5 use iterator() instead.
java.util.Iterator<javax.mail.internet.MimeMessage>	iterator() Iterate over the list of messages in the mailbox.
void	purge(boolean delFlag) Specify whether to delete messages on disconnect / logout.
void	resetMessage(javax.mail.internet.MimeMessage msg) Reset the state of the message so that it is no longer marked as seen or deleted.
void	setFromFilter(java.lang.String filter) Set the sender filter.
void	setMessageRead(javax.mail.internet.MimeMessage msg) Mark the message as read and deleted, if purge 'on'.
void	setRecipientFilter(java.lang.String filter) Set the sender filter.
void	setRegularExpressionCompiler(java.lang.String type) Set the handler for regular expressions.
void	setSubjectFilter(java.lang.String filter) Set the subject filter.

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Methods inherited from interface java.io.Closeable

close

Method Detail

connect

void connect()
      throws MailException

Connect to the mailbox

Throws:

MailException - if the connection failed.

disconnect

@Deprecated
void disconnect()

Deprecated. since 3.6.5 use Closeable.close() instead.

Disconnect from the mail server.

setSubjectFilter

void setSubjectFilter(java.lang.String filter)

Set the subject filter.

Parameters:

filter - the filter.

setFromFilter

void setFromFilter(java.lang.String filter)

Set the sender filter.

Parameters:

filter - the filter.

setRecipientFilter

void setRecipientFilter(java.lang.String filter)

Set the sender filter.

Parameters:

filter - the filter.

addCustomFilter

void addCustomFilter(java.lang.String headerValue,
                     java.lang.String filter)

Add a custom filter

Parameters:

filter - the filter.

headerValue - the header value

setRegularExpressionCompiler

void setRegularExpressionCompiler(java.lang.String type)

Set the handler for regular expressions.

Parameters:

type - one of "GLOB", "AWK", "PERL5" or their respective compiler classnames

purge

void purge(boolean delFlag)

Specify whether to delete messages on disconnect / logout.

By default all messages that are retrived have the Flags.Flag.DELETED flag set, which means that if this is set to true then the messages will be deleted when disconnect is called

Parameters:

delFlag - true or false

getMessages

@Deprecated
java.util.List<javax.mail.internet.MimeMessage> getMessages()

Deprecated. since 3.6.5 use iterator() instead.

Return a filtered list of messages in the mailbox

Returns:

list of MimeMessages

iterator

java.util.Iterator<javax.mail.internet.MimeMessage> iterator()

Iterate over the list of messages in the mailbox.

Specified by:

iterator in interface java.lang.Iterable<javax.mail.internet.MimeMessage>

Returns:

an iterator of filtered messages.

Throws:

java.lang.RuntimeException - if we couldn't interact with the mailbox.

setMessageRead

void setMessageRead(javax.mail.internet.MimeMessage msg)
             throws MailException

Mark the message as read and deleted, if purge 'on'.

Parameters:

msg - message to be set

Throws:

MailException - on error

resetMessage

void resetMessage(javax.mail.internet.MimeMessage msg)
           throws java.lang.Exception

Reset the state of the message so that it is no longer marked as seen or deleted.

Parameters:

msg - the Message to reset.

Throws:

java.lang.Exception - on error.