Package adams.flow.transformer.imaptransformer

Class ReceiveEmail

java.lang.Object

adams.core.logging.LoggingObject

adams.core.logging.CustomLoggingLevelObject

adams.core.option.AbstractOptionHandler

adams.flow.transformer.imaptransformer.AbstractIMAPOperation<I,O>

adams.flow.transformer.imaptransformer.AbstractIMAPFolderOperation<String,jodd.mail.ReceivedEmail>

adams.flow.transformer.imaptransformer.ReceiveEmail

All Implemented Interfaces:

Destroyable, GlobalInfoSupporter, LoggingLevelHandler, LoggingSupporter, OptionHandler, QuickInfoSupporter, SizeOfHandler, Serializable

public class ReceiveEmail
extends AbstractIMAPFolderOperation<String,jodd.mail.ReceivedEmail>

Loads the email from the specified folder using its message ID.

Author:

fracpete (fracpete at waikato dot ac dot nz)

See Also:

Serialized Form

Field Summary

Fields inherited from class adams.flow.transformer.imaptransformer.AbstractIMAPFolderOperation

m_Folder

Fields inherited from class adams.core.option.AbstractOptionHandler

m_OptionManager

Fields inherited from class adams.core.logging.LoggingObject

m_Logger, m_LoggingIsEnabled, m_LoggingLevel

Constructor Summary

Constructors

Constructor	Description
ReceiveEmail()

Method Summary

Modifier and Type	Method	Description
Class	accepts()	Returns the type of input the operation accepts.
protected jodd.mail.ReceivedEmail	doExecute(IMAPConnection conn, String input, MessageCollection errors)	Executes the operation and returns the generated output.
Class	generates()	Returns the type of output the operation generates.
String	globalInfo()	Returns a string describing the object.

Methods inherited from class adams.flow.transformer.imaptransformer.AbstractIMAPFolderOperation

check, defineOptions, folderTipText, getDefaultFolder, getFolder, getQuickInfo, setFolder

Methods inherited from class adams.flow.transformer.imaptransformer.AbstractIMAPOperation

execute

Methods inherited from class adams.core.option.AbstractOptionHandler

cleanUpOptions, destroy, finishInit, getDefaultLoggingLevel, getOptionManager, initialize, loggingLevelTipText, newOptionManager, reset, setLoggingLevel, toCommandLine, toString

Methods inherited from class adams.core.logging.LoggingObject

configureLogger, getLogger, getLoggingLevel, initializeLogging, isLoggingEnabled, sizeOf

Methods inherited from class java.lang.Object

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

Methods inherited from interface adams.core.logging.LoggingLevelHandler

getLoggingLevel

Constructor Detail

ReceiveEmail

public ReceiveEmail()

Method Detail

globalInfo

public String globalInfo()

Returns a string describing the object.

Specified by:

globalInfo in interface GlobalInfoSupporter

Specified by:

globalInfo in class AbstractOptionHandler

Returns:

a description suitable for displaying in the gui

accepts

public Class accepts()

Returns the type of input the operation accepts.

Specified by:

accepts in class AbstractIMAPOperation<String,jodd.mail.ReceivedEmail>

Returns:

the class

generates

public Class generates()

Returns the type of output the operation generates.

Specified by:

generates in class AbstractIMAPOperation<String,jodd.mail.ReceivedEmail>

Returns:

the class

doExecute

protected jodd.mail.ReceivedEmail doExecute(IMAPConnection conn,
                                            String input,
                                            MessageCollection errors)

Executes the operation and returns the generated output.

Specified by:

doExecute in class AbstractIMAPOperation<String,jodd.mail.ReceivedEmail>

Parameters:

conn - the connection to use

input - the input data

errors - for collecting errors

Returns:

the generated output, null in case of error or failed check