atg.service.email.pop

Class POP3Service

java.lang.Object

atg.nucleus.logging.VariableArgumentApplicationLoggingImpl

atg.nucleus.GenericService

atg.service.email.pop.StoreService

atg.service.email.pop.POP3Service

All Implemented Interfaces:

atg.core.logging.Logging, atg.core.logging.TraceLogging, atg.naming.AbsoluteNameable, NameContextBindingListener, NameContextElement, atg.naming.NameContextParentable, NameResolver, AdminableService, atg.nucleus.Configured, ApplicationLogging, atg.nucleus.logging.ApplicationLoggingSender, atg.nucleus.logging.TraceApplicationLogging, VariableArgumentApplicationLogging, ComponentNameResolver, Service, ServiceListener, atg.service.email.pop.POP3StatusListener, Schedulable, java.util.EventListener

Deprecated.

Use the atg.service.email.StoreService instead of this class.

public class POP3Service
extends StoreService
implements atg.service.email.pop.POP3StatusListener

Utility class to to check email at regular intervals, and parse for bounced messages. NOTE: This active checker's only purpose in life is to scan for bounced messages. A new class (with new behavior) should be designed to take advantage of this package's other email features. This type of email retrieval is called "active email checking." Programmatically retrieving email information is called "passive email checking," and is allowed under this schema. In fact, both forms of checking can be activated on the same POP3 instance without interferance.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	CLASS_VERSION Deprecated. Class version string
protected java.lang.String	mAttachmentDirectory Deprecated. The default attachment directory
protected atg.service.email.pop.POP3	mPop3 Deprecated. Specifies the POP3 instance
protected boolean	mUsingJavaMailProvider Deprecated. Flag indicating if we are using java mail to connect to the pop server, or if we are using our old style server connection.

Fields inherited from class atg.service.email.pop.StoreService

mBatchSize, mBounceListeners, mEmailExaminers, mEnabled, mFireBouncedMailEvents, mFireInboundMailEvents, mFolder, mHost, mInboundListeners, mJobId, mPassword, mPasswordAlias, mPasswordBroker, mPort, mProtocol, mRemoveBouncedEMail, mRemoveEMail, mRemoveMalformedEmail, mRemoveUnsupportedEncodingEMail, mSchedule, mScheduler, mUsername

Fields inherited from class atg.nucleus.GenericService

SERVICE_INFO_KEY

Fields inherited from interface atg.nucleus.logging.TraceApplicationLogging

DEFAULT_LOG_TRACE_STATUS

Fields inherited from interface atg.nucleus.logging.ApplicationLogging

DEFAULT_LOG_DEBUG_STATUS, DEFAULT_LOG_ERROR_STATUS, DEFAULT_LOG_INFO_STATUS, DEFAULT_LOG_WARNING_STATUS

Constructor Summary

Constructors

Constructor and Description
POP3Service() Deprecated. Create a disconnected POP3Service object

Method Summary

Modifier and Type	Method and Description
protected javax.mail.Message	createJavaMailMessage(atg.service.email.pop.POP3MailMessage pPOP3Message) Deprecated. Utility method to take a POP3MailMessage and construct a javax.mail.Message out of it.
void	fireInboundMailEvent(atg.service.email.pop.POP3MailMessage pMsg, boolean pBounced) Deprecated. Notify listening objects that an email has been received
java.lang.String	getAttachmentDirectory() Deprecated. Returns the directory where attachments are stored.
atg.service.email.pop.POP3	getPOP3Instance() Deprecated. Returns the current POP3 instance
boolean	isUsingJavaMailProvider() Deprecated. Flag indicating if we are using java mail to connect to the pop server, or if we are using our old style server connection.
void	performScheduledTask(Scheduler pScheduler, ScheduledJob pJob) Deprecated. Performs the scheduled task for this service.
void	pop3Status(atg.service.email.pop.MailStatusEvent evt) Deprecated. This method is called whenever POP3 commands are sent to/from the server.
void	setAttachmentDirectory(java.lang.String pAttachmentDirectory) Deprecated. Set the directory where attachments are stored.
void	setPOP3Instance(atg.service.email.pop.POP3 inPop) Deprecated. Sets the currently active POP3 instance with another.
void	setUsingJavaMailProvider(boolean pUsingJavaMailProvider) Deprecated. Flag indicating if we are using java mail to connect to the pop server, or if we are using our old style server connection.

Methods inherited from class atg.service.email.pop.StoreService

addBounceListener, addEmailExaminer, addInboundListener, doStartService, doStopService, fireInboundMailEvent, fireInboundMailEvent, fireMailBounceEvent, fireMailBounceEvent, getBatchSize, getEmailExaminers, getFolder, getHost, getPassword, getPasswordAlias, getPasswordBroker, getPort, getProtocol, getRemoveBouncedEMail, getRemoveEMail, getRemoveMalformedEmail, getRemoveUnsupportedEncodingEMail, getSchedule, getScheduler, getUsername, isEnabled, isFireBouncedMailEvents, isFireInboundMailEvents, removeBounceListener, removeEmailExaminer, removeInboundListener, setBatchSize, setEmailExaminers, setEnabled, setFireBouncedMailEvents, setFireInboundMailEvents, setFolder, setHost, setPassword, setPasswordAlias, setPasswordBroker, setPort, setProtocol, setRemoveBouncedEMail, setRemoveEMail, setRemoveMalformedEmail, setRemoveUnspportedEncodingEMail, setSchedule, setScheduler, setUsername

Methods inherited from class atg.nucleus.GenericService

addLogListener, createAdminServlet, getAbsoluteName, getAdminServlet, getAdminServletOutputStreamEncoding, getLoggingForVlogging, getLogListenerCount, getLogListeners, getName, getNameContext, getNucleus, getRoot, getServiceConfiguration, getServiceInfo, isAdminServletUseServletOutputStream, isLoggingDebug, isLoggingError, isLoggingInfo, isLoggingTrace, isLoggingWarning, isRunning, logDebug, logDebug, logDebug, logError, logError, logError, logInfo, logInfo, logInfo, logTrace, logTrace, logTrace, logWarning, logWarning, logWarning, nameContextElementBound, nameContextElementUnbound, removeLogListener, reResolveThis, resolveName, resolveName, resolveName, resolveName, sendLogEvent, setAdminServletOutputStreamEncoding, setAdminServletUseServletOutputStream, setLoggingDebug, setLoggingError, setLoggingInfo, setLoggingTrace, setLoggingWarning, setNucleus, setServiceInfo, startService, stopService, toString

Methods inherited from class atg.nucleus.logging.VariableArgumentApplicationLoggingImpl

vlogDebug, vlogDebug, vlogDebug, vlogDebug, vlogDebugTrace, vlogError, vlogError, vlogError, vlogError, vlogInfo, vlogInfo, vlogInfo, vlogInfo, vlogTrace, vlogTrace, vlogTrace, vlogTrace, vlogWarning, vlogWarning, vlogWarning, vlogWarning

Methods inherited from class java.lang.Object

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

Field Detail

CLASS_VERSION

public static java.lang.String CLASS_VERSION

Deprecated.

Class version string

mPop3

protected atg.service.email.pop.POP3 mPop3

Deprecated.

Specifies the POP3 instance

mAttachmentDirectory

protected java.lang.String mAttachmentDirectory

Deprecated.

The default attachment directory

mUsingJavaMailProvider

protected boolean mUsingJavaMailProvider

Deprecated.

Flag indicating if we are using java mail to connect to the pop server, or if we are using our old style server connection.

Constructor Detail

POP3Service

public POP3Service()

Deprecated.

Create a disconnected POP3Service object

Method Detail

isUsingJavaMailProvider

public boolean isUsingJavaMailProvider()

Deprecated.

Flag indicating if we are using java mail to connect to the pop server, or if we are using our old style server connection.

Returns:

true if we should use the javamail provider, false if we should be using our old style parser.

setUsingJavaMailProvider

public void setUsingJavaMailProvider(boolean pUsingJavaMailProvider)

Deprecated.

Flag indicating if we are using java mail to connect to the pop server, or if we are using our old style server connection.

Parameters:

pUsingJavaMailProvider - true if we should use the javamail provider, false if we should be using our old style parser.

setPOP3Instance

public void setPOP3Instance(atg.service.email.pop.POP3 inPop)

Deprecated.

Sets the currently active POP3 instance with another. NOTE: This will permenantly lose the original POP3 instance.

Parameters:

newPop3 - The new Pop3 instance

getPOP3Instance

public atg.service.email.pop.POP3 getPOP3Instance()

Deprecated.

Returns the current POP3 instance

Returns:

The POP3 instance class

See Also:

POP3

setAttachmentDirectory

public void setAttachmentDirectory(java.lang.String pAttachmentDirectory)

Deprecated.

Set the directory where attachments are stored.

Parameters:

pAttachmentDirectory - The directory where attachments are going to be stored

getAttachmentDirectory

public java.lang.String getAttachmentDirectory()

Deprecated.

Returns the directory where attachments are stored.

Returns:

The directory where attachments are stored

fireInboundMailEvent

public void fireInboundMailEvent(atg.service.email.pop.POP3MailMessage pMsg,
                                 boolean pBounced)

Deprecated.

Notify listening objects that an email has been received

Parameters:

pMsg - The POP3MailMessage that was created for this email

pBounced - whether or not this message was bounced

pop3Status

public void pop3Status(atg.service.email.pop.MailStatusEvent evt)

Deprecated.

This method is called whenever POP3 commands are sent to/from the server. This can be used for UI status progress, or other info presentations

Specified by:

pop3Status in interface atg.service.email.pop.POP3StatusListener

Parameters:

evt - COMMAND, RESPONSE, PROGRESS, START, DONE

performScheduledTask

public void performScheduledTask(Scheduler pScheduler,
                                 ScheduledJob pJob)

Deprecated.

Performs the scheduled task for this service. This includes checking the pop3 server for email, and firing InboundMailEvents and MailBounceEvents.

Specified by:

performScheduledTask in interface Schedulable

Overrides:

performScheduledTask in class StoreService

Parameters:

pScheduler - the scheduler that alerts this service to perform its scheduled task

pJob - the ScheduledJob for this service

createJavaMailMessage

protected javax.mail.Message createJavaMailMessage(atg.service.email.pop.POP3MailMessage pPOP3Message)
                                            throws javax.mail.MessagingException

Deprecated.

Utility method to take a POP3MailMessage and construct a javax.mail.Message out of it.

Parameters:

pPOP3Message - the POP3MailMessage we'll use to construct a javax.mail.Message

Throws:

javax.mail.MessagingException - if anything goes wrong while trying to create the Message