de.innovationgate.wgpublisher.mail

Class MailBase

java.lang.Object

de.innovationgate.wgpublisher.mail.MailBase

All Implemented Interfaces:

de.innovationgate.webgate.api.mail.WGMail

Direct Known Subclasses:

DevModeMail, SmtpMail

public abstract class MailBase
extends java.lang.Object
implements de.innovationgate.webgate.api.mail.WGMail

Field Summary

Fields

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 Summary

Constructors

Constructor and Description
MailBase()

Method Summary

Methods

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)

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

PROP_PROTOCOL

public static final java.lang.String PROP_PROTOCOL

See Also:

Constant Field Values

PROP_PASSWORD

public static final java.lang.String PROP_PASSWORD

See Also:

Constant Field Values

PROP_USER

public static final java.lang.String PROP_USER

See Also:

Constant Field Values

PROP_ROOTURL

public static final java.lang.String PROP_ROOTURL

See Also:

Constant Field Values

Constructor Detail

MailBase

public MailBase()

Method Detail

prepareMessage

public javax.mail.Message prepareMessage()
                                  throws de.innovationgate.webgate.api.mail.WGMailException,
                                         javax.mail.MessagingException,
                                         javax.mail.internet.AddressException

Throws:

de.innovationgate.webgate.api.mail.WGMailException

javax.mail.MessagingException

javax.mail.internet.AddressException

send

public abstract void send(javax.mail.Message message)
                   throws javax.mail.MessagingException

Throws:

javax.mail.MessagingException

send

public void send()
          throws de.innovationgate.webgate.api.mail.WGMailException

Specified by:

send in interface de.innovationgate.webgate.api.mail.WGMail

Throws:

de.innovationgate.webgate.api.mail.WGMailException

getSubject

public java.lang.String getSubject()

Specified by:

getSubject in interface de.innovationgate.webgate.api.mail.WGMail

setSubject

public void setSubject(java.lang.String subject)

Specified by:

setSubject in interface de.innovationgate.webgate.api.mail.WGMail

getBody

public java.lang.String getBody()

Specified by:

getBody in interface de.innovationgate.webgate.api.mail.WGMail

setBody

public void setBody(java.lang.String body)

Specified by:

setBody in interface de.innovationgate.webgate.api.mail.WGMail

getCc

public java.util.List<java.lang.String> getCc()

setCc

public void setCc(java.util.List<java.lang.String> addresses)
           throws javax.mail.internet.AddressException

Throws:

javax.mail.internet.AddressException

setCc

public void setCc(java.lang.String address)
           throws javax.mail.internet.AddressException

Throws:

javax.mail.internet.AddressException

getFrom

public java.lang.String getFrom()

setFrom

public void setFrom(java.lang.String from)
             throws java.io.UnsupportedEncodingException,
                    javax.mail.internet.AddressException

Throws:

java.io.UnsupportedEncodingException

javax.mail.internet.AddressException

getFromName

public java.lang.String getFromName()

setFrom

public void setFrom(java.lang.String address,
           java.lang.String name)
             throws java.io.UnsupportedEncodingException

sets the given from address and from name

Parameters:

address - e.g. john@example.com

name - e.g. John Mueller

Throws:

java.io.UnsupportedEncodingException

getTo

public java.util.List getTo()

setTo

public void setTo(java.util.List<java.lang.String> addresses)
           throws javax.mail.internet.AddressException

Throws:

javax.mail.internet.AddressException

setTo

public void setTo(java.lang.String address)
           throws javax.mail.internet.AddressException

Throws:

javax.mail.internet.AddressException

getBcc

public java.util.List<java.lang.String> getBcc()

setBcc

public void setBcc(java.util.List<java.lang.String> addresses)
            throws javax.mail.internet.AddressException

Throws:

javax.mail.internet.AddressException

setBcc

public void setBcc(java.lang.String address)
            throws javax.mail.internet.AddressException

Throws:

javax.mail.internet.AddressException

getMimeType

public java.lang.String getMimeType()

Returns:

Returns the mimeType.

setMimeType

public void setMimeType(java.lang.String mimeType)

Parameters:

mimeType - The mimeType to set.

getAttachmentURLs

public java.util.List getAttachmentURLs()

getAttachmentURLsMap

public java.util.Map getAttachmentURLsMap()

setAttachmentURLs

public void setAttachmentURLs(java.util.List attachmentURLs)

setAttachmentURLs

public void setAttachmentURLs(java.util.Map attachmentURLs)

addAttachmentURL

public void addAttachmentURL(java.lang.String url)

addAttachmentURL

public void addAttachmentURL(java.lang.String url,
                    java.lang.String altFilename)

addAttachment

public void addAttachment(java.io.InputStream in,
                 java.lang.String filename)
                   throws de.innovationgate.webgate.api.mail.WGMailException

Specified by:

addAttachment in interface de.innovationgate.webgate.api.mail.WGMail

Throws:

de.innovationgate.webgate.api.mail.WGMailException

addAttachment

public void addAttachment(java.io.File file)
                   throws de.innovationgate.webgate.api.mail.WGMailException,
                          java.io.FileNotFoundException

adds the given inputstream as attachment to the mail

Parameters:

in - InputStream

filename - filename to use for the attachment

Throws:

TMLException

java.io.FileNotFoundException

de.innovationgate.webgate.api.mail.WGMailException

addAttachment

public void addAttachment(de.innovationgate.webgate.api.WGDocument document,
                 java.lang.String filename)
                   throws de.innovationgate.webgate.api.WGAPIException,
                          TMLException

Throws:

de.innovationgate.webgate.api.WGAPIException

TMLException

addAttachment

public void addAttachment(de.innovationgate.webgate.api.WGDocument document,
                 java.lang.String filename,
                 java.lang.String altFilename)
                   throws de.innovationgate.webgate.api.WGAPIException,
                          TMLException

adds the given file from the given container or content to the mail

Parameters:

document - WGDocument

filename -

altFilename -

Throws:

de.innovationgate.webgate.api.WGAPIException

TMLException

getReplyTo

public java.lang.String getReplyTo()

setReplyTo

public void setReplyTo(java.lang.String address)
                throws java.io.UnsupportedEncodingException,
                       javax.mail.internet.AddressException

Throws:

java.io.UnsupportedEncodingException

javax.mail.internet.AddressException

isEncodeText

public boolean isEncodeText()

setEncodeText

public void setEncodeText(boolean encodeText)

Specified by:

setEncodeText in interface de.innovationgate.webgate.api.mail.WGMail

getBccAddresses

public java.util.List<javax.mail.internet.InternetAddress> getBccAddresses()

Specified by:

getBccAddresses in interface de.innovationgate.webgate.api.mail.WGMail

getCcAddresses

public java.util.List getCcAddresses()

Specified by:

getCcAddresses in interface de.innovationgate.webgate.api.mail.WGMail

getFromAddress

public javax.mail.internet.InternetAddress getFromAddress()

Specified by:

getFromAddress in interface de.innovationgate.webgate.api.mail.WGMail

getReplyToAddress

public javax.mail.internet.InternetAddress getReplyToAddress()

Specified by:

getReplyToAddress in interface de.innovationgate.webgate.api.mail.WGMail

getToAddresses

public java.util.List<javax.mail.internet.InternetAddress> getToAddresses()

Specified by:

getToAddresses in interface de.innovationgate.webgate.api.mail.WGMail

setBccAddresses

public void setBccAddresses(java.util.List<javax.mail.internet.InternetAddress> addresses)

Specified by:

setBccAddresses in interface de.innovationgate.webgate.api.mail.WGMail

setCcAddresses

public void setCcAddresses(java.util.List<javax.mail.internet.InternetAddress> addresses)

Specified by:

setCcAddresses in interface de.innovationgate.webgate.api.mail.WGMail

setFromAddress

public void setFromAddress(javax.mail.internet.InternetAddress from)

Specified by:

setFromAddress in interface de.innovationgate.webgate.api.mail.WGMail

setReplyToAddress

public void setReplyToAddress(javax.mail.internet.InternetAddress address)

Specified by:

setReplyToAddress in interface de.innovationgate.webgate.api.mail.WGMail

setToAddresses

public void setToAddresses(java.util.List<javax.mail.internet.InternetAddress> addresses)

Specified by:

setToAddresses in interface de.innovationgate.webgate.api.mail.WGMail

getEncodeText

public boolean getEncodeText()

Specified by:

getEncodeText in interface de.innovationgate.webgate.api.mail.WGMail