Module com.newmediaworks.taglib.email

Package com.newmediaworks.taglib.email

Class EmailTag

java.lang.Object

jakarta.servlet.jsp.tagext.TagSupport

jakarta.servlet.jsp.tagext.BodyTagSupport

com.newmediaworks.taglib.email.EmailTag

All Implemented Interfaces:

PartTag, BodyTag, IterationTag, JspTag, Tag, TryCatchFinally, Serializable

public class EmailTag
extends BodyTagSupport
implements PartTag, TryCatchFinally

Formats an email then sends the message or stores in an attribute. The message is constructed through nested tags.

Author:

New Media Works

See Also:

• Message
• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
static final ScopeEE.Request.Attribute<String>	ERROR_REQUEST_ATTRIBUTE	The request attribute that stores the error message.
static final String	ERROR_REQUEST_ATTRIBUTE_NAME	Deprecated, for removal: This API element is subject to removal in a future version. Please use ERROR_REQUEST_ATTRIBUTE instead.
static final String	ERROR_REQUEST_PARAMETER_NAME	Deprecated, for removal: This API element is subject to removal in a future version. Please use ERROR_REQUEST_ATTRIBUTE instead.
static final String	TAG_NAME

Fields inherited from class jakarta.servlet.jsp.tagext.BodyTagSupport

bodyContent

Fields inherited from class jakarta.servlet.jsp.tagext.TagSupport

id, pageContext

Fields inherited from interface jakarta.servlet.jsp.tagext.BodyTag

EVAL_BODY_BUFFERED, EVAL_BODY_TAG

Fields inherited from interface jakarta.servlet.jsp.tagext.IterationTag

EVAL_BODY_AGAIN

Fields inherited from interface jakarta.servlet.jsp.tagext.Tag

EVAL_BODY_INCLUDE, EVAL_PAGE, SKIP_BODY, SKIP_PAGE

Constructor Summary

Constructors

Constructor	Description
EmailTag()

Method Summary

Modifier and Type	Method	Description
void	addHeader(String name, String value)
void	addToAddress(String to)	Adds a to address.
void	doCatch(Throwable throwable)
int	doEndTag()
void	doFinally()
int	doStartTag()
void	setContent(Multipart content)
void	setContent(Object o, String type)
void	setDataHandler(DataHandler dh)
void	setFileName(String filename)
void	setFrom(String from)	Sets the from address.
void	setHeader(String name, String value)
void	setScope(String scope)
void	setSmtpHost(String smtpHost)
void	setSmtpPort(Integer smtpPort)
void	setSubject(String subject, String charset)	Sets the subject.
void	setVar(String var)

Methods inherited from class jakarta.servlet.jsp.tagext.BodyTagSupport

doAfterBody, doInitBody, getBodyContent, getPreviousOut, release, setBodyContent

Methods inherited from class jakarta.servlet.jsp.tagext.TagSupport

findAncestorWithClass, getId, getParent, getValue, getValues, removeValue, setId, setPageContext, setParent, setValue

Methods inherited from class java.lang.Object

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

Methods inherited from interface jakarta.servlet.jsp.tagext.Tag

getParent, setPageContext, setParent

Field Details

TAG_NAME

public static final String TAG_NAME

See Also:

• Constant Field Values

ERROR_REQUEST_ATTRIBUTE_NAME

@Deprecated(forRemoval=true)
public static final String ERROR_REQUEST_ATTRIBUTE_NAME

Deprecated, for removal: This API element is subject to removal in a future version.

Please use ERROR_REQUEST_ATTRIBUTE instead.

The request attribute name that stores the error message.

ERROR_REQUEST_ATTRIBUTE

public static final ScopeEE.Request.Attribute<String> ERROR_REQUEST_ATTRIBUTE

The request attribute that stores the error message.

ERROR_REQUEST_PARAMETER_NAME

@Deprecated(forRemoval=true)
public static final String ERROR_REQUEST_PARAMETER_NAME

Deprecated, for removal: This API element is subject to removal in a future version.

Please use ERROR_REQUEST_ATTRIBUTE instead.

The request attribute name that stores the error message.

Constructor Details

EmailTag

public EmailTag()

Method Details

setSmtpHost

public void setSmtpHost(String smtpHost)

setSmtpPort

public void setSmtpPort(Integer smtpPort)

setVar

public void setVar(String var)

setScope

public void setScope(String scope)

doStartTag

public int doStartTag()
               throws JspException

Specified by:

doStartTag in interface Tag

Overrides:

doStartTag in class BodyTagSupport

Throws:

JspException

addToAddress

public void addToAddress(String to)
                  throws MessagingException

Adds a to address.

Throws:

MessagingException

setFrom

public void setFrom(String from)
             throws MessagingException

Sets the from address.

Throws:

MessagingException

setSubject

public void setSubject(String subject,
 String charset)
                throws MessagingException

Sets the subject.

Throws:

MessagingException

addHeader

public void addHeader(String name,
 String value)
               throws MessagingException

Specified by:

addHeader in interface PartTag

Throws:

MessagingException

setHeader

public void setHeader(String name,
 String value)
               throws MessagingException

Specified by:

setHeader in interface PartTag

Throws:

MessagingException

setContent

public void setContent(Multipart content)
                throws MessagingException

Specified by:

setContent in interface PartTag

Throws:

MessagingException

setContent

public void setContent(Object o,
 String type)
                throws MessagingException

Specified by:

setContent in interface PartTag

Throws:

MessagingException

setDataHandler

public void setDataHandler(DataHandler dh)
                    throws MessagingException

Specified by:

setDataHandler in interface PartTag

Throws:

MessagingException

setFileName

public void setFileName(String filename)
                 throws MessagingException

Specified by:

setFileName in interface PartTag

Throws:

MessagingException

doEndTag

public int doEndTag()
             throws JspException

Specified by:

doEndTag in interface Tag

Overrides:

doEndTag in class BodyTagSupport

Throws:

JspException

doCatch

public void doCatch(Throwable throwable)
             throws Throwable

Specified by:

doCatch in interface TryCatchFinally

Throws:

Throwable

doFinally

public void doFinally()

Specified by:

doFinally in interface TryCatchFinally