|
Sun Adapter for e-Mail API | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.stc.connector.emailadapter.appconn.EmailClientAgent
public class EmailClientAgent
APIS for checking email, receiving email, and sending email.
Constructor Summary | |
---|---|
EmailClientAgent(com.stc.connector.management.util.ObjectReference mbeanObject)
Constructor for EmailClientAgent. |
Method Summary | |
---|---|
boolean |
hasMessage(EmailConfiguration configuration)
Determines whether there are message(s) to be received. |
protected void |
processInMessage(javax.mail.internet.MimeMessage msg,
EmailMessage emailMsg)
Process in the message specified in msg |
protected boolean |
processInSimpleMessage(javax.mail.internet.MimePart part,
EmailMessage emailMsg)
Process in the simple message specified in part |
protected void |
processOutAttachment(javax.mail.internet.MimeMultipart container,
EmailMessage emailMsg,
java.lang.String textencoding,
java.lang.String headerencoding)
Process out the Attachment parts of the message |
protected void |
processOutMsgTextHTML(javax.mail.internet.MimePart container,
EmailMessage emailMsg,
java.lang.String textencoding)
Process out the MsgText and MsgHTML parts of the message. |
protected void |
processRecipients(javax.mail.internet.MimeMessage msg,
javax.mail.Message.RecipientType type,
boolean dirIn,
EmailMessage emailMsg,
java.lang.String textencoding,
java.lang.String headerencoding)
Process out the recipients of this message by parsing the addresses. |
boolean |
receiveMessage(EmailConfiguration configuration,
EmailMessage emailMsg)
Receive the next available message. |
boolean |
sendMessage(EmailConfiguration configuration,
EmailMessage emailMsg)
Send the message specified in the end user properties. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public EmailClientAgent(com.stc.connector.management.util.ObjectReference mbeanObject)
mbeanObject
- The MBean object used for sending alerts.Method Detail |
---|
protected void processRecipients(javax.mail.internet.MimeMessage msg, javax.mail.Message.RecipientType type, boolean dirIn, EmailMessage emailMsg, java.lang.String textencoding, java.lang.String headerencoding) throws EmailApplicationException
dirIn
is true
process incoming message,
otherwise outgoing.
msg
- The MimeMessage which contains the email message
from the server.type
- The RecipientType to process.dirIn
- The email message flow (receive or send).emailMsg
- The EmailMessage instance to populate in the
case of receive or to read from in the case
of send.
EmailApplicationException
- upon error.protected void processOutMsgTextHTML(javax.mail.internet.MimePart container, EmailMessage emailMsg, java.lang.String textencoding) throws EmailApplicationException
container
- The MimePart of the mime message.emailMsg
- The EmailMessage containing the email message to
be sent.
EmailApplicationException
- upon error.protected void processOutAttachment(javax.mail.internet.MimeMultipart container, EmailMessage emailMsg, java.lang.String textencoding, java.lang.String headerencoding) throws EmailApplicationException
container
- The MimeMultipart message.emailMsg
- The EmailMessage instance to hold the email message.
EmailApplicationException
- upon error.protected void processInMessage(javax.mail.internet.MimeMessage msg, EmailMessage emailMsg) throws EmailApplicationException
msg
msg
- The MimeMessage which contains the email message
from the server.emailMsg
- The EmailMessage instance to store the results
from the server.
EmailApplicationException
- upon error.protected boolean processInSimpleMessage(javax.mail.internet.MimePart part, EmailMessage emailMsg) throws EmailApplicationException
part
part
- The message MimePart.emailMsg
- The EmailMessage instance to populate.
EmailApplicationException
- upon error.public boolean sendMessage(EmailConfiguration configuration, EmailMessage emailMsg) throws EmailApplicationException
configuration
- The EmailConfiguration instance which holds
the connection specific information.emailMsg
- The EmailMessage instance which contains
the email message to be sent.
EmailApplicationException
- upon error.public boolean receiveMessage(EmailConfiguration configuration, EmailMessage emailMsg) throws EmailApplicationException
configuration
- The EmailConfiguration instance containing
connection specific information.emailMsg
- The EmailMessage to put the email message
that gets received.
EmailApplicationException
- upon error.public boolean hasMessage(EmailConfiguration configuration) throws EmailApplicationException
configuration
- The EmailConfiguration instance containing
connection specific information.
EmailApplicationException
- upon error.
|
Sun Adapter for e-Mail API | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |