com.northconcepts.datapipeline.email

Class EmailReader

java.lang.Object

com.northconcepts.datapipeline.core.DataObject

com.northconcepts.datapipeline.core.Endpoint

com.northconcepts.datapipeline.core.DataEndpoint

com.northconcepts.datapipeline.core.DataReader

com.northconcepts.datapipeline.internal.lang.IntegrationReader

com.northconcepts.datapipeline.email.EmailReader

public class EmailReader
extends IntegrationReader

Reads emails (and their attachments) from IMAP mailboxes.

Nested Class Summary

Nested classes/interfaces inherited from class com.northconcepts.datapipeline.core.DataEndpoint

DataEndpoint.State

Field Summary

Fields inherited from class com.northconcepts.datapipeline.core.DataReader

fieldLineage, recordLineage

Fields inherited from class com.northconcepts.datapipeline.core.DataEndpoint

lastRecord, PRODUCT, PRODUCT_VERSION, VENDOR, XML_INPUT_FACTORY_KEY

Fields inherited from class com.northconcepts.datapipeline.core.Endpoint

BUFFER_SIZE, captureElapsedTime, DEFAULT_READ_BUFFER_SIZE

Fields inherited from class com.northconcepts.datapipeline.core.DataObject

id, log, name, TIMESTAMP_FORMAT

Constructor Summary

Constructors

Constructor and Description
EmailReader(MailStore mailStore, String host, int port, String user, String password)
EmailReader(MailStore mailStore, String host, String user, String password)

Method Summary

Modifier and Type	Method and Description
DataException	addExceptionProperties(DataException exception) Adds this endpoint's current state to a DataException.
void	close() Indicates that this endpoint has finished reading or writing.
EmailReadDirection	getDirection()
String	getFolderName()
String	getHost()
MailStore	getMailStore()
int	getPort()
Properties	getProperties()
SearchTerm	getSearchTerm()
String	getUser()
boolean	isDebug()
void	open() Makes this endpoint ready for reading or writing.
protected Record	readImpl() Overridden by subclasses to read the next record from this DataReader.
EmailReader	setDebug(boolean debug)
EmailReader	setDirection(EmailReadDirection direction)
EmailReader	setFolderName(String folderName)
EmailReader	setProperty(String key, String value)
EmailReader	setSearchTerm(SearchTerm searchTerm)

Methods inherited from class com.northconcepts.datapipeline.core.DataReader

addLineage, available, getBufferSize, getNestedEndpoint, getNestedReader, getReader, getRootEndpoint, getRootReader, isExhausted, isLineageSupported, isSaveLineage, peek, pop, push, read, setSaveLineage, skip

Methods inherited from class com.northconcepts.datapipeline.core.DataEndpoint

decrementRecordCount, enableJmx, getLastRecord, getRecordCount, getRecordCountAsBigInteger, getRecordCountAsString, incrementRecordCount, isRecordCountBigInteger, resetRecordCount, toString

Methods inherited from class com.northconcepts.datapipeline.core.Endpoint

addElapsedtime, assertClosed, assertNotOpened, assertOpened, finalize, getClosedOn, getDescription, getElapsedTime, getElapsedTimeAsString, getOpenedOn, getOpenElapsedTime, getOpenElapsedTimeAsString, getSelfTime, getSelfTimeAsString, getState, isCaptureElapsedTime, isClosed, isOpen, setCaptureElapsedTime, setDescription

Methods inherited from class com.northconcepts.datapipeline.core.DataObject

exception, exception, exception, getId, getName, resetID

Methods inherited from class java.lang.Object

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

Constructor Detail

EmailReader

public EmailReader(MailStore mailStore,
                   String host,
                   String user,
                   String password)

EmailReader

public EmailReader(MailStore mailStore,
                   String host,
                   int port,
                   String user,
                   String password)

Method Detail

getProperties

public Properties getProperties()

setProperty

public EmailReader setProperty(String key,
                               String value)

getMailStore

public MailStore getMailStore()

getHost

public String getHost()

getPort

public int getPort()

getUser

public String getUser()

getFolderName

public String getFolderName()

setFolderName

public EmailReader setFolderName(String folderName)

getSearchTerm

public SearchTerm getSearchTerm()

setSearchTerm

public EmailReader setSearchTerm(SearchTerm searchTerm)

getDirection

public EmailReadDirection getDirection()

setDirection

public EmailReader setDirection(EmailReadDirection direction)

isDebug

public boolean isDebug()

setDebug

public EmailReader setDebug(boolean debug)

open

public void open()
          throws DataException

Description copied from class: DataEndpoint

Makes this endpoint ready for reading or writing.

Overrides:

open in class IntegrationReader

Throws:

DataException

close

public void close()
           throws DataException

Description copied from class: DataEndpoint

Indicates that this endpoint has finished reading or writing.

Overrides:

close in class DataEndpoint

Throws:

DataException

readImpl

protected Record readImpl()
                   throws Throwable

Description copied from class: DataReader

Overridden by subclasses to read the next record from this DataReader. The default implementation of DataReader.read() now insures that this method will not be called again after it returns a null.

If no record is available, null will be returned.

Specified by:

readImpl in class DataReader

Throws:

Throwable

addExceptionProperties

public DataException addExceptionProperties(DataException exception)

Description copied from class: Endpoint

Adds this endpoint's current state to a DataException. Since this method is called whenever an exception is thrown, subclasses should override it to add their specific information.

Overrides:

addExceptionProperties in class DataReader