|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object org.apache.commons.mail.Email org.apache.commons.mail.MultiPartEmail
public class MultiPartEmail
A multipart email.
This class is used to send multi-part internet email like messages with attachments.
To create a multi-part email, call the default constructor and then you can call setMsg() to set the message and call the different attach() methods.
Field Summary |
---|
Constructor Summary | |
---|---|
MultiPartEmail()
|
Method Summary | |
---|---|
Email |
addPart(javax.mail.internet.MimeMultipart multipart)
Add a new part to the email. |
Email |
addPart(javax.mail.internet.MimeMultipart multipart,
int index)
Add a new part to the email. |
Email |
addPart(String partContent,
String partContentType)
Add a new part to the email. |
MultiPartEmail |
attach(DataSource ds,
String name,
String description)
Attach a file specified as a DataSource interface. |
MultiPartEmail |
attach(DataSource ds,
String name,
String description,
String disposition)
Attach a file specified as a DataSource interface. |
MultiPartEmail |
attach(EmailAttachment attachment)
Attach an EmailAttachment. |
MultiPartEmail |
attach(URL url,
String name,
String description)
Attach a file located by its URL. |
MultiPartEmail |
attach(URL url,
String name,
String description,
String disposition)
Attach a file located by its URL. |
void |
buildMimeMessage()
Builds the actual MimeMessage |
protected javax.mail.BodyPart |
createBodyPart()
Creates a body part object. |
protected javax.mail.internet.MimeMultipart |
createMimeMultipart()
Creates a mime multipart object. |
protected javax.mail.internet.MimeMultipart |
getContainer()
Gets the message container. |
protected javax.mail.BodyPart |
getPrimaryBodyPart()
Gets first body part of the message. |
String |
getSubType()
Get the MIME subtype of the email. |
protected void |
init()
Initialize the multipart email. |
boolean |
isBoolHasAttachments()
Checks whether there are attachments. |
protected boolean |
isInitialized()
Checks if this object is initialized. |
void |
setBoolHasAttachments(boolean b)
Sets whether there are attachments. |
protected void |
setInitialized(boolean b)
Sets the initialized status of this object. |
Email |
setMsg(String msg)
Set the message of the email. |
void |
setSubType(String aSubType)
Set the MIME subtype of the email. |
Methods inherited from class org.apache.commons.mail.Email |
---|
addBcc, addBcc, addBcc, addCc, addCc, addCc, addHeader, addReplyTo, addReplyTo, addReplyTo, addTo, addTo, addTo, createMimeMessage, getBccAddresses, getCcAddresses, getFromAddress, getHostName, getMailSession, getMimeMessage, getReplyToAddresses, getSentDate, getSmtpPort, getSocketConnectionTimeout, getSocketTimeout, getSslSmtpPort, getSubject, getToAddresses, isSSL, isTLS, send, sendMimeMessage, setAuthentication, setAuthenticator, setBcc, setBounceAddress, setCc, setCharset, setContent, setContent, setDebug, setFrom, setFrom, setFrom, setHeaders, setHostName, setMailSession, setMailSessionFromJNDI, setPopBeforeSmtp, setReplyTo, setSentDate, setSmtpPort, setSocketConnectionTimeout, setSocketTimeout, setSSL, setSslSmtpPort, setSubject, setTLS, setTo, toInternetAddressArray, updateContentType |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public MultiPartEmail()
Method Detail |
---|
public void setSubType(String aSubType)
aSubType
- MIME subtype of the emailpublic String getSubType()
public Email addPart(String partContent, String partContentType) throws EmailException
partContent
- The content.partContentType
- The content type.
EmailException
- see javax.mail.internet.MimeBodyPart
for definitionspublic Email addPart(javax.mail.internet.MimeMultipart multipart) throws EmailException
multipart
- The MimeMultipart.
EmailException
- see javax.mail.internet.MimeBodyPart
for definitionspublic Email addPart(javax.mail.internet.MimeMultipart multipart, int index) throws EmailException
multipart
- The part to add.index
- The index to add at.
EmailException
- An error occured while adding the part.protected void init()
public Email setMsg(String msg) throws EmailException
setMsg
in class Email
msg
- A String.
EmailException
- see javax.mail.internet.MimeBodyPart
for definitionspublic void buildMimeMessage() throws EmailException
buildMimeMessage
in class Email
EmailException
- see javax.mail.internet.MimeBodyPart
for definitionspublic MultiPartEmail attach(EmailAttachment attachment) throws EmailException
attachment
- An EmailAttachment.
EmailException
- see javax.mail.internet.MimeBodyPart
for definitionspublic MultiPartEmail attach(URL url, String name, String description) throws EmailException
url
- The URL of the file (may be any valid URL).name
- The name field for the attachment.description
- A description for the attachment.
EmailException
- see javax.mail.internet.MimeBodyPart
for definitionspublic MultiPartEmail attach(URL url, String name, String description, String disposition) throws EmailException
url
- The URL of the file (may be any valid URL).name
- The name field for the attachment.description
- A description for the attachment.disposition
- Either mixed or inline.
EmailException
- see javax.mail.internet.MimeBodyPart
for definitionspublic MultiPartEmail attach(DataSource ds, String name, String description) throws EmailException
ds
- A DataSource interface for the file.name
- The name field for the attachment.description
- A description for the attachment.
EmailException
- see javax.mail.internet.MimeBodyPart
for definitionspublic MultiPartEmail attach(DataSource ds, String name, String description, String disposition) throws EmailException
ds
- A DataSource interface for the file.name
- The name field for the attachment.description
- A description for the attachment.disposition
- Either mixed or inline.
EmailException
- see javax.mail.internet.MimeBodyPart
for definitionsprotected javax.mail.BodyPart getPrimaryBodyPart() throws javax.mail.MessagingException
javax.mail.MessagingException
- An error occured while getting the primary body part.protected javax.mail.internet.MimeMultipart getContainer()
protected javax.mail.BodyPart createBodyPart()
protected javax.mail.internet.MimeMultipart createMimeMultipart()
public boolean isBoolHasAttachments()
public void setBoolHasAttachments(boolean b)
b
- the attachments flagprotected boolean isInitialized()
protected void setInitialized(boolean b)
b
- the initialized status flag
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |