org.apache.taglibs.mailer
Class SetRecipientTag

java.lang.Object
  extended byjavax.servlet.jsp.tagext.TagSupport
      extended byjavax.servlet.jsp.tagext.BodyTagSupport
          extended byorg.apache.taglibs.mailer.SetRecipientTag
All Implemented Interfaces:
javax.servlet.jsp.tagext.BodyTag, javax.servlet.jsp.tagext.IterationTag, java.io.Serializable, javax.servlet.jsp.tagext.Tag

public class SetRecipientTag
extends javax.servlet.jsp.tagext.BodyTagSupport

SetRecipientTag - JSP tag setrecipient is used to set any type of recipient to an e-mail. Two attributes are required, type and setress. Type may be either "to", "cc", or "bcc" and address should be a string representation of the recipients e-mail address. setrecipient org.apache.taglibs.mailer.SetRecipientTag JSP Append a recipient to the current recipients of the e-mail. type true false address false false

Version:
1.0
Author:
Rich Catlett Jayson Falkner
See Also:
Serialized Form

Field Summary
 
Fields inherited from class javax.servlet.jsp.tagext.BodyTagSupport
bodyContent
 
Fields inherited from class javax.servlet.jsp.tagext.TagSupport
id, pageContext
 
Fields inherited from interface javax.servlet.jsp.tagext.BodyTag
EVAL_BODY_BUFFERED, EVAL_BODY_TAG
 
Fields inherited from interface javax.servlet.jsp.tagext.IterationTag
EVAL_BODY_AGAIN
 
Fields inherited from interface javax.servlet.jsp.tagext.Tag
EVAL_BODY_INCLUDE, EVAL_PAGE, SKIP_BODY, SKIP_PAGE
 
Constructor Summary
SetRecipientTag()
           
 
Method Summary
protected  void addToParent(java.lang.String addr)
           
 int doAfterBody()
          implementation of the method from the tag interface that tells the JSP page what to do after the body of this tag
 int doStartTag()
          implementation of the method from the tag interface that tells the JSP page what to do at the start of this tag
 void setAddress(java.lang.String address)
          set the value for an address to be later added to the email
 void setType(java.lang.String type)
          set the type of recipient for the address
 
Methods inherited from class javax.servlet.jsp.tagext.BodyTagSupport
doEndTag, doInitBody, getBodyContent, getPreviousOut, release, setBodyContent
 
Methods inherited from class javax.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 javax.servlet.jsp.tagext.Tag
getParent, setPageContext, setParent
 

Constructor Detail

SetRecipientTag

public SetRecipientTag()
Method Detail

doStartTag

public int doStartTag()
               throws javax.servlet.jsp.JspException
implementation of the method from the tag interface that tells the JSP page what to do at the start of this tag

Returns:
SKIP_BODY int telling the tag handler to not evaluate the body of this tag EVAL_BODY_TAG int telling the tag handler to evaluate the body of this tag
Throws:
javax.servlet.jsp.JspTagException - thrown when an error occurs while processing the body of this method
javax.servlet.jsp.JspException

doAfterBody

public int doAfterBody()
                throws javax.servlet.jsp.JspException
implementation of the method from the tag interface that tells the JSP page what to do after the body of this tag

Returns:
SKIP_BODY int telling the tag handler to not evaluate the body of this tag again
Throws:
javax.servlet.jsp.JspException - thrown when an error occurs while processing the body of this method

setType

public void setType(java.lang.String type)
             throws javax.servlet.jsp.JspTagException
set the type of recipient for the address

Parameters:
type - string that is the type of the address either "to", "cc", or "bcc".
Throws:
javax.servlet.jsp.JspTagException

setAddress

public void setAddress(java.lang.String address)
set the value for an address to be later added to the email

Parameters:
address - string that is an address to be added to the "to", "cc", or "bcc" lists of addresses.

addToParent

protected void addToParent(java.lang.String addr)
                    throws javax.servlet.jsp.JspTagException
Throws:
javax.servlet.jsp.JspTagException


Copyright ? 2000-2004 The Apache Software Foundation. All Rights Reserved.