|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object atg.nucleus.logging.VariableArgumentApplicationLoggingImpl atg.nucleus.GenericService atg.service.email.pop.StoreService atg.service.email.pop.POP3Service
public class POP3Service
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 | |
---|---|
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 | |
---|---|
POP3Service()
Deprecated. Create a disconnected POP3Service object |
Method Summary | |
---|---|
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.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, toString, wait, wait, wait |
Field Detail |
---|
public static java.lang.String CLASS_VERSION
protected atg.service.email.pop.POP3 mPop3
protected java.lang.String mAttachmentDirectory
protected boolean mUsingJavaMailProvider
Constructor Detail |
---|
public POP3Service()
POP3Service
object
Method Detail |
---|
public boolean isUsingJavaMailProvider()
public void setUsingJavaMailProvider(boolean pUsingJavaMailProvider)
pUsingJavaMailProvider
- true if we should use the
javamail provider, false
if we should be using our
old style parser.public void setPOP3Instance(atg.service.email.pop.POP3 inPop)
newPop3
- The new Pop3 instancepublic atg.service.email.pop.POP3 getPOP3Instance()
POP3
public void setAttachmentDirectory(java.lang.String pAttachmentDirectory)
pAttachmentDirectory
- The directory where attachments are
going to be storedpublic java.lang.String getAttachmentDirectory()
public void fireInboundMailEvent(atg.service.email.pop.POP3MailMessage pMsg, boolean pBounced)
pMsg
- The POP3MailMessage that was created for this emailpBounced
- whether or not this message was bouncedpublic void pop3Status(atg.service.email.pop.MailStatusEvent evt)
pop3Status
in interface atg.service.email.pop.POP3StatusListener
evt
- COMMAND, RESPONSE, PROGRESS, START, DONEpublic void performScheduledTask(Scheduler pScheduler, ScheduledJob pJob)
performScheduledTask
in interface Schedulable
performScheduledTask
in class StoreService
pScheduler
- the scheduler that alerts this service to perform
its scheduled taskpJob
- the ScheduledJob for this serviceprotected javax.mail.Message createJavaMailMessage(atg.service.email.pop.POP3MailMessage pPOP3Message) throws javax.mail.MessagingException
javax.mail.Message
out of it.
pPOP3Message
- the POP3MailMessage we'll use to construct
a javax.mail.Message
javax.mail.MessagingException
- if anything goes wrong while
trying to create the Message
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |