public abstract class MailBase
extends java.lang.Object
implements de.innovationgate.webgate.api.mail.WGMail
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
PROP_PASSWORD |
static java.lang.String |
PROP_PROTOCOL |
static java.lang.String |
PROP_ROOTURL |
static java.lang.String |
PROP_USER |
Constructor and Description |
---|
MailBase() |
Modifier and Type | Method and Description |
---|---|
void |
addAttachment(java.io.File file)
adds the given inputstream as attachment to the mail
|
void |
addAttachment(java.io.InputStream in,
java.lang.String filename) |
void |
addAttachment(de.innovationgate.webgate.api.WGDocument document,
java.lang.String filename) |
void |
addAttachment(de.innovationgate.webgate.api.WGDocument document,
java.lang.String filename,
java.lang.String altFilename)
adds the given file from the given container or content to the mail
|
void |
addAttachmentURL(java.lang.String url) |
void |
addAttachmentURL(java.lang.String url,
java.lang.String altFilename) |
java.util.List |
getAttachmentURLs() |
java.util.Map |
getAttachmentURLsMap() |
java.util.List<java.lang.String> |
getBcc() |
java.util.List<javax.mail.internet.InternetAddress> |
getBccAddresses() |
java.lang.String |
getBody() |
java.util.List<java.lang.String> |
getCc() |
java.util.List |
getCcAddresses() |
boolean |
getEncodeText() |
java.lang.String |
getFrom() |
javax.mail.internet.InternetAddress |
getFromAddress() |
java.lang.String |
getFromName() |
java.lang.String |
getMimeType() |
java.lang.String |
getReplyTo() |
javax.mail.internet.InternetAddress |
getReplyToAddress() |
java.lang.String |
getSubject() |
java.util.List |
getTo() |
java.util.List<javax.mail.internet.InternetAddress> |
getToAddresses() |
boolean |
isEncodeText() |
javax.mail.Message |
prepareMessage() |
void |
send() |
abstract void |
send(javax.mail.Message message) |
void |
setAttachmentURLs(java.util.List attachmentURLs) |
void |
setAttachmentURLs(java.util.Map attachmentURLs) |
void |
setBcc(java.util.List<java.lang.String> addresses) |
void |
setBcc(java.lang.String address) |
void |
setBccAddresses(java.util.List<javax.mail.internet.InternetAddress> addresses) |
void |
setBody(java.lang.String body) |
void |
setCc(java.util.List<java.lang.String> addresses) |
void |
setCc(java.lang.String address) |
void |
setCcAddresses(java.util.List<javax.mail.internet.InternetAddress> addresses) |
void |
setEncodeText(boolean encodeText) |
void |
setFrom(java.lang.String from) |
void |
setFrom(java.lang.String address,
java.lang.String name)
sets the given from address and from name
|
void |
setFromAddress(javax.mail.internet.InternetAddress from) |
void |
setMimeType(java.lang.String mimeType) |
void |
setReplyTo(java.lang.String address) |
void |
setReplyToAddress(javax.mail.internet.InternetAddress address) |
void |
setSubject(java.lang.String subject) |
void |
setTo(java.util.List<java.lang.String> addresses) |
void |
setTo(java.lang.String address) |
void |
setToAddresses(java.util.List<javax.mail.internet.InternetAddress> addresses) |
public static final java.lang.String PROP_PROTOCOL
public static final java.lang.String PROP_PASSWORD
public static final java.lang.String PROP_USER
public static final java.lang.String PROP_ROOTURL
public javax.mail.Message prepareMessage() throws de.innovationgate.webgate.api.mail.WGMailException, javax.mail.MessagingException, javax.mail.internet.AddressException
de.innovationgate.webgate.api.mail.WGMailException
javax.mail.MessagingException
javax.mail.internet.AddressException
public abstract void send(javax.mail.Message message) throws javax.mail.MessagingException
javax.mail.MessagingException
public void send() throws de.innovationgate.webgate.api.mail.WGMailException
send
in interface de.innovationgate.webgate.api.mail.WGMail
de.innovationgate.webgate.api.mail.WGMailException
public java.lang.String getSubject()
getSubject
in interface de.innovationgate.webgate.api.mail.WGMail
public void setSubject(java.lang.String subject)
setSubject
in interface de.innovationgate.webgate.api.mail.WGMail
public java.lang.String getBody()
getBody
in interface de.innovationgate.webgate.api.mail.WGMail
public void setBody(java.lang.String body)
setBody
in interface de.innovationgate.webgate.api.mail.WGMail
public java.util.List<java.lang.String> getCc()
public void setCc(java.util.List<java.lang.String> addresses) throws javax.mail.internet.AddressException
javax.mail.internet.AddressException
public void setCc(java.lang.String address) throws javax.mail.internet.AddressException
javax.mail.internet.AddressException
public java.lang.String getFrom()
public void setFrom(java.lang.String from) throws java.io.UnsupportedEncodingException, javax.mail.internet.AddressException
java.io.UnsupportedEncodingException
javax.mail.internet.AddressException
public java.lang.String getFromName()
public void setFrom(java.lang.String address, java.lang.String name) throws java.io.UnsupportedEncodingException
address
- e.g. john@example.comname
- e.g. John Muellerjava.io.UnsupportedEncodingException
public java.util.List getTo()
public void setTo(java.util.List<java.lang.String> addresses) throws javax.mail.internet.AddressException
javax.mail.internet.AddressException
public void setTo(java.lang.String address) throws javax.mail.internet.AddressException
javax.mail.internet.AddressException
public java.util.List<java.lang.String> getBcc()
public void setBcc(java.util.List<java.lang.String> addresses) throws javax.mail.internet.AddressException
javax.mail.internet.AddressException
public void setBcc(java.lang.String address) throws javax.mail.internet.AddressException
javax.mail.internet.AddressException
public java.lang.String getMimeType()
public void setMimeType(java.lang.String mimeType)
mimeType
- The mimeType to set.public java.util.List getAttachmentURLs()
public java.util.Map getAttachmentURLsMap()
public void setAttachmentURLs(java.util.List attachmentURLs)
public void setAttachmentURLs(java.util.Map attachmentURLs)
public void addAttachmentURL(java.lang.String url)
public void addAttachmentURL(java.lang.String url, java.lang.String altFilename)
public void addAttachment(java.io.InputStream in, java.lang.String filename) throws de.innovationgate.webgate.api.mail.WGMailException
addAttachment
in interface de.innovationgate.webgate.api.mail.WGMail
de.innovationgate.webgate.api.mail.WGMailException
public void addAttachment(java.io.File file) throws de.innovationgate.webgate.api.mail.WGMailException, java.io.FileNotFoundException
in
- InputStreamfilename
- filename to use for the attachmentTMLException
java.io.FileNotFoundException
de.innovationgate.webgate.api.mail.WGMailException
public void addAttachment(de.innovationgate.webgate.api.WGDocument document, java.lang.String filename) throws de.innovationgate.webgate.api.WGAPIException, TMLException
de.innovationgate.webgate.api.WGAPIException
TMLException
public void addAttachment(de.innovationgate.webgate.api.WGDocument document, java.lang.String filename, java.lang.String altFilename) throws de.innovationgate.webgate.api.WGAPIException, TMLException
document
- WGDocumentfilename
- altFilename
- de.innovationgate.webgate.api.WGAPIException
TMLException
public java.lang.String getReplyTo()
public void setReplyTo(java.lang.String address) throws java.io.UnsupportedEncodingException, javax.mail.internet.AddressException
java.io.UnsupportedEncodingException
javax.mail.internet.AddressException
public boolean isEncodeText()
public void setEncodeText(boolean encodeText)
setEncodeText
in interface de.innovationgate.webgate.api.mail.WGMail
public java.util.List<javax.mail.internet.InternetAddress> getBccAddresses()
getBccAddresses
in interface de.innovationgate.webgate.api.mail.WGMail
public java.util.List getCcAddresses()
getCcAddresses
in interface de.innovationgate.webgate.api.mail.WGMail
public javax.mail.internet.InternetAddress getFromAddress()
getFromAddress
in interface de.innovationgate.webgate.api.mail.WGMail
public javax.mail.internet.InternetAddress getReplyToAddress()
getReplyToAddress
in interface de.innovationgate.webgate.api.mail.WGMail
public java.util.List<javax.mail.internet.InternetAddress> getToAddresses()
getToAddresses
in interface de.innovationgate.webgate.api.mail.WGMail
public void setBccAddresses(java.util.List<javax.mail.internet.InternetAddress> addresses)
setBccAddresses
in interface de.innovationgate.webgate.api.mail.WGMail
public void setCcAddresses(java.util.List<javax.mail.internet.InternetAddress> addresses)
setCcAddresses
in interface de.innovationgate.webgate.api.mail.WGMail
public void setFromAddress(javax.mail.internet.InternetAddress from)
setFromAddress
in interface de.innovationgate.webgate.api.mail.WGMail
public void setReplyToAddress(javax.mail.internet.InternetAddress address)
setReplyToAddress
in interface de.innovationgate.webgate.api.mail.WGMail
public void setToAddresses(java.util.List<javax.mail.internet.InternetAddress> addresses)
setToAddresses
in interface de.innovationgate.webgate.api.mail.WGMail
public boolean getEncodeText()
getEncodeText
in interface de.innovationgate.webgate.api.mail.WGMail