org.myrobotlab.service

Class ImapEmailConnector

java.lang.Object

org.myrobotlab.framework.MessageService

org.myrobotlab.framework.Service

org.myrobotlab.document.connector.AbstractConnector

org.myrobotlab.service.ImapEmailConnector

All Implemented Interfaces:

java.io.Serializable, java.lang.Runnable, Attachable, Invoker, LoggingSink, MessageSender, MessageSubscriber, NameProvider, NameTypeProvider, ServiceInterface, ServiceQueue, StateSaver, TypeProvider, DocumentConnector, DocumentPublisher, QueueReporter

public class ImapEmailConnector
extends AbstractConnector

ImapEmailConnector - This connector can crawl the folders on an IMAP email server. you can provide the user/pass/email server hostname. It publishes documents that represents the emails messages that were crawled.

See Also:

Serialized Form

Field Summary

Fields inherited from class org.myrobotlab.framework.Service

cfgDir, dnaPool, log, MESSAGE_RECORDING_FORMAT_BINARY, MESSAGE_RECORDING_FORMAT_XML

Constructor Summary

Constructors

Constructor and Description
ImapEmailConnector(java.lang.String name)

Method Summary

Modifier and Type	Method and Description
javax.mail.Store	connect()
void	disconnect()
java.lang.String	getDocIdPrefix()
java.lang.String	getEmailServer()
java.lang.String	getFolderName()
static ServiceType	getMetaData() This static method returns all the details of the class without it having to be constructed.
java.lang.String	getPassword()
java.lang.String	getUsername()
static void	main(java.lang.String[] args)
void	parseBodyPart(javax.mail.Part p, Document doc)
javax.mail.Message	publishEmail(javax.mail.Message m)
void	setConfig(ConnectorConfig config)
void	setDocIdPrefix(java.lang.String docIdPrefix)
void	setEmailServer(java.lang.String emailServer)
void	setFolderName(java.lang.String folderName)
void	setPassword(java.lang.String password)
void	setUsername(java.lang.String username)
void	startCrawling()
void	startListeningForEmail()
void	stopCrawling()

Methods inherited from class org.myrobotlab.document.connector.AbstractConnector

addDocumentListener, feed, flush, getBatchSize, getConnectorState, getState, publishDocument, publishDocuments, publishFlush, setBatchSize, setState

Methods inherited from class org.myrobotlab.framework.Service

addListener, addListener, addTask, addTask, addTask, addTaskOneShot, allowDisplay, allowDisplay, attach, attach, broadcastState, buildDna, buildDna, buildDnaKeys, buildDnaNames, clearLastError, close, containsTask, copyShallowFrom, createPeer, createPeer, createRootReserved, detach, detach, detach, echoHeartbeat, error, error, error, getAttached, getCfgDir, getComm, getDeclaredMethodNames, getDeclaredMethods, getDescription, getDna, getDnaString, getHostName, getInbox, getInstanceId, getIntanceName, getInterfaceSet, getLastError, getMessageSet, getMetaData, getMethodMap, getMethodNames, getMethods, getMethodToolTip, getMsg, getName, getNotifyList, getNotifyListKeySet, getOutbox, getPeerKey, getPeerName, getServiceResourceFile, getSimpleName, getTasks, getThisThread, getType, hasError, hasPeers, help, help, in, info, info, invoke, invoke, invoke, invokeOn, isAttached, isAttached, isLocal, isReady, isRunning, isRuntime, isVirtual, load, load, logTimeEnable, mergeDna, mergeDna, mergePeerDna, movePeerDna, out, out, preProcessHook, preRoutingHook, publishError, publishQueueStats, publishState, publishStats, publishStatus, purgeTask, purgeTasks, releasePeers, releaseService, removeAllListeners, removeListener, requiresSecurity, reserve, reserve, reserveRoot, reserveRoot, reserveRootAs, run, save, save, save, send, send, send, send, sendBlocking, sendBlocking, sendBlocking, sendBlocking, sendPeer, setInstanceId, setName, setPeer, setSecurityProvider, setState, setThisThread, setVirtual, sleep, stackToString, startHeartbeat, startPeer, startPeer, startRecording, startService, stopHeartbeat, stopMsgRecording, stopService, subscribe, subscribe, subscribe, toString, unsubscribe, unsubscribe, unsubscribe, updateStats, warn, warn

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.myrobotlab.service.interfaces.DocumentPublisher

getName

Constructor Detail

ImapEmailConnector

public ImapEmailConnector(java.lang.String name)

Method Detail

setConfig

public void setConfig(ConnectorConfig config)

Specified by:

setConfig in class AbstractConnector

startCrawling

public void startCrawling()

startListeningForEmail

public void startListeningForEmail()
                            throws javax.mail.MessagingException

Throws:

javax.mail.MessagingException

publishEmail

public javax.mail.Message publishEmail(javax.mail.Message m)

parseBodyPart

public void parseBodyPart(javax.mail.Part p,
                          Document doc)
                   throws java.lang.Exception

Throws:

java.lang.Exception

stopCrawling

public void stopCrawling()

disconnect

public void disconnect()

connect

public javax.mail.Store connect()

getEmailServer

public java.lang.String getEmailServer()

setEmailServer

public void setEmailServer(java.lang.String emailServer)

getUsername

public java.lang.String getUsername()

setUsername

public void setUsername(java.lang.String username)

getPassword

public java.lang.String getPassword()

setPassword

public void setPassword(java.lang.String password)

getFolderName

public java.lang.String getFolderName()

setFolderName

public void setFolderName(java.lang.String folderName)

getDocIdPrefix

public java.lang.String getDocIdPrefix()

Overrides:

getDocIdPrefix in class AbstractConnector

setDocIdPrefix

public void setDocIdPrefix(java.lang.String docIdPrefix)

Overrides:

setDocIdPrefix in class AbstractConnector

getMetaData

public static ServiceType getMetaData()

This static method returns all the details of the class without it having to be constructed. It has description, categories, dependencies, and peer definitions.

Returns:

ServiceType - returns all the data

main

public static void main(java.lang.String[] args)
                 throws java.lang.Exception

Throws:

java.lang.Exception