public class MultipartReport extends MimeMultipart
A MultipartReport object is a special type of MimeMultipart object with a restricted set of body parts. A MultipartReport object contains:
DeliveryStatus
object containing the
details for why the report was generated.Modifier and Type | Field and Description |
---|---|
protected boolean |
constructed |
ds, parsed
contentType, parent, parts
Constructor and Description |
---|
MultipartReport()
Construct a multipart/report object with no content.
|
MultipartReport(javax.activation.DataSource ds)
Constructs a MultipartReport object and its bodyparts from the
given DataSource.
|
MultipartReport(java.lang.String text,
DeliveryStatus status)
Construct a multipart/report object with the specified plain
text and delivery status to be returned to the user.
|
MultipartReport(java.lang.String text,
DeliveryStatus status,
InternetHeaders hdr)
Construct a multipart/report object with the specified plain
text, delivery status, and headers from the original message
to be returned to the user.
|
MultipartReport(java.lang.String text,
DeliveryStatus status,
MimeMessage msg)
Construct a multipart/report object with the specified plain
text, delivery status, and original message to be returned to the user.
|
Modifier and Type | Method and Description |
---|---|
void |
addBodyPart(BodyPart part)
Adds a Part to the multipart.
|
void |
addBodyPart(BodyPart part,
int index)
Adds a BodyPart at position
index . |
DeliveryStatus |
getDeliveryStatus()
Get the delivery status associated with this multipart/report.
|
MimeMessage |
getReturnedMessage()
Get the original message that is being returned along with this
multipart/report.
|
java.lang.String |
getText()
Get the plain text to be presented to the user, if there is any.
|
MimeBodyPart |
getTextBodyPart()
Return the body part containing the message to be presented to
the user, usually just a text/plain part.
|
boolean |
removeBodyPart(BodyPart part)
Remove the specified part from the multipart message.
|
void |
removeBodyPart(int index)
Remove the part at specified location (starting from 0).
|
void |
setDeliveryStatus(DeliveryStatus status)
Set the delivery status associated with this multipart/report.
|
void |
setReturnedMessage(MimeMessage msg)
Set the original message to be returned as part of the
multipart/report.
|
void |
setSubType(java.lang.String subtype)
Set the subtype.
|
void |
setText(java.lang.String text)
Set the message to be presented to the user as just a text/plain
part containing the specified text.
|
void |
setTextBodyPart(MimeBodyPart mbp)
Set the body part containing the text to be presented to the
user.
|
createInternetHeaders, createMimeBodyPart, createMimeBodyPart, getBodyPart, getBodyPart, getCount, getPreamble, isComplete, parse, setPreamble, updateHeaders, writeTo
getContentType, getParent, setMultipartDataSource, setParent
public MultipartReport() throws MessagingException
MessagingException
public MultipartReport(java.lang.String text, DeliveryStatus status) throws MessagingException
MessagingException
public MultipartReport(java.lang.String text, DeliveryStatus status, MimeMessage msg) throws MessagingException
MessagingException
public MultipartReport(java.lang.String text, DeliveryStatus status, InternetHeaders hdr) throws MessagingException
MessagingException
public MultipartReport(javax.activation.DataSource ds) throws MessagingException
ds
- DataSource, can be a MultipartDataSourceMessagingException
public java.lang.String getText() throws MessagingException
getTextBodyPart
method may be used to extract the data.MessagingException
public void setText(java.lang.String text) throws MessagingException
MessagingException
public MimeBodyPart getTextBodyPart() throws MessagingException
MessagingException
public void setTextBodyPart(MimeBodyPart mbp) throws MessagingException
MessagingException
public DeliveryStatus getDeliveryStatus() throws MessagingException
MessagingException
public void setDeliveryStatus(DeliveryStatus status) throws MessagingException
MessagingException
public MimeMessage getReturnedMessage() throws MessagingException
MessagingException
public void setReturnedMessage(MimeMessage msg) throws MessagingException
MessagingException
public void setSubType(java.lang.String subtype) throws MessagingException
setSubType
in class MimeMultipart
subtype
- SubtypeMessagingException
- always; can't change subtypepublic boolean removeBodyPart(BodyPart part) throws MessagingException
removeBodyPart
in class MimeMultipart
part
- The part to removeMessagingException
- alwayspublic void removeBodyPart(int index) throws MessagingException
removeBodyPart
in class MimeMultipart
index
- Index of the part to removeMessagingException
- alwayspublic void addBodyPart(BodyPart part) throws MessagingException
addBodyPart
in class MimeMultipart
part
- The Part to be appendedMessagingException
- alwayspublic void addBodyPart(BodyPart part, int index) throws MessagingException
index
.
Not allowed on a multipart/report object.addBodyPart
in class MimeMultipart
part
- The BodyPart to be insertedindex
- Location where to insert the partMessagingException
- always