|
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
Wrap a MimeMessage with routing information (from SMTP) such as SMTP specified recipients, sender, and ip address and hostname of sending server. It also contains its state which represents which processor in the mailet container it is currently running. Special processor names are "root" and "error".
Field Summary | |
static java.lang.String |
DEFAULT
|
static java.lang.String |
ERROR
|
static java.lang.String |
GHOST
|
static java.lang.String |
TRANSPORT
|
Fields inherited from class java.io.Serializable |
serialVersionUID |
Method Summary | |
java.lang.String |
getErrorMessage()
The error message, if any, associated with this message. |
javax.mail.internet.MimeMessage |
getMessage()
Returns the MimeMessage stored in this message |
java.util.Collection |
getRecipients()
Returns a Collection of MailAddress objects that are recipients of this message |
java.lang.String |
getRemoteAddr()
The remote ip address of the server that connected to send this message |
java.lang.String |
getRemoteHost()
The remote hostname of the server that connected to send this message |
MailAddress |
getSender()
The sender of the message, as specified by the MAIL FROM header, or internally defined |
java.lang.String |
getState()
The current state of the message, such as GHOST, ERROR, or DEFAULT |
void |
setErrorMessage(java.lang.String msg)
Sets the error message associated with this message. |
void |
setMessage(java.io.InputStream in)
Sets the MimeMessage associated with this message via an inputstream. |
void |
setMessage(javax.mail.internet.MimeMessage message)
Sets the MimeMessage associated with this message via the object. |
void |
setState(java.lang.String state)
Sets the state of this message. |
void |
writeContentTo(java.io.OutputStream out,
int lines)
Dumps X many number of lines from this message to an output stream |
void |
writeMessageTo(java.io.OutputStream out)
Dumps this message to an output stream |
Field Detail |
public static final java.lang.String GHOST
public static final java.lang.String DEFAULT
public static final java.lang.String ERROR
public static final java.lang.String TRANSPORT
Method Detail |
public javax.mail.internet.MimeMessage getMessage() throws javax.mail.MessagingException
public java.util.Collection getRecipients()
public MailAddress getSender()
public java.lang.String getState()
public java.lang.String getRemoteHost()
public java.lang.String getRemoteAddr()
public java.lang.String getErrorMessage()
public void setErrorMessage(java.lang.String msg)
msg
- - a descriptive error messagepublic void setMessage(java.io.InputStream in) throws javax.mail.MessagingException
in
- - the inputstream to read to construct the MimeMessagepublic void setMessage(javax.mail.internet.MimeMessage message)
message
- - the new MimeMessage that this Mail object will wrappublic void setState(java.lang.String state)
state
- - the new state of this messagepublic void writeMessageTo(java.io.OutputStream out) throws java.io.IOException, javax.mail.MessagingException
out
- - the outputstream to send the MimeMessage headers and body contentpublic void writeContentTo(java.io.OutputStream out, int lines) throws java.io.IOException, javax.mail.MessagingException
out
- - the outputstream to send the MimeMessage headers and body contentlines
- - the number of lines to return of the message
|
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |