com.google.gerrit.server.mail.receive

Class MailReceiver

java.lang.Object

com.google.gerrit.server.mail.receive.MailReceiver

All Implemented Interfaces:

LifecycleListener, java.util.EventListener

Direct Known Subclasses:

ImapMailReceiver, Pop3MailReceiver

public abstract class MailReceiver
extends java.lang.Object
implements LifecycleListener

MailReceiver implements base functionality for receiving emails.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	MailReceiver.Module

Field Summary

Fields

Modifier and Type	Field and Description
protected EmailSettings	mailSettings
protected java.util.Set<java.lang.String>	pendingDeletion

Method Summary

Modifier and Type	Method and Description
protected void	dispatchMailProcessor(java.util.List<com.google.gerrit.mail.MailMessage> messages, boolean async)
abstract void	handleEmails(boolean async) handleEmails will open a connection to the mail server, remove emails where deletion is pending, read new email and close the connection.
void	requestDeletion(java.lang.String messageId) requestDeletion will enqueue an email for deletion and delete it the next time we connect to the email server.
void	start() Invoked when the server is starting.
void	stop() Invoked when the server is stopping.

Methods inherited from class java.lang.Object

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

Field Detail

mailSettings

protected EmailSettings mailSettings

pendingDeletion

protected java.util.Set<java.lang.String> pendingDeletion

Method Detail

start

public void start()

Description copied from interface: LifecycleListener

Invoked when the server is starting.

Specified by:

start in interface LifecycleListener

stop

public void stop()

Description copied from interface: LifecycleListener

Invoked when the server is stopping.

Specified by:

stop in interface LifecycleListener

requestDeletion

public void requestDeletion(java.lang.String messageId)

requestDeletion will enqueue an email for deletion and delete it the next time we connect to the email server. This does not guarantee deletion as the Gerrit instance might fail before we connect to the email server.

Parameters:

messageId -

handleEmails

public abstract void handleEmails(boolean async)
                           throws MailTransferException,
                                  java.io.IOException

handleEmails will open a connection to the mail server, remove emails where deletion is pending, read new email and close the connection.

Parameters:

async - determines if processing messages should happen asynchronously

Throws:

MailTransferException - in case of a known transport failure

java.io.IOException - in case of a low-level transport failure

dispatchMailProcessor

protected void dispatchMailProcessor(java.util.List<com.google.gerrit.mail.MailMessage> messages,
                                     boolean async)