railo.runtime.tag
Class Mail

java.lang.Object
  extended by railo.runtime.ext.tag.TagImpl
      extended by railo.runtime.ext.tag.BodyTagImpl
          extended by railo.runtime.tag.Mail
All Implemented Interfaces:
javax.servlet.jsp.tagext.BodyTag, javax.servlet.jsp.tagext.IterationTag, javax.servlet.jsp.tagext.Tag

public final class Mail
extends BodyTagImpl

Sends e-mail messages by an SMTP server.


Field Summary
 
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
Mail()
           
 
Method Summary
 void addPart(MailPart part)
           
 int doAfterBody()
           
 int doEndTag()
           
 void doInitBody()
           
 int doStartTag()
           
 String getCharset()
           
 void release()
           
 void setBcc(Object bcc)
          set the value bcc Indicates addresses to copy the e-mail message to, without listing them in the message header.
 void setCc(Object cc)
          set the value cc Indicates addresses to copy the e-mail message to; "cc" stands for "carbon copy."
 void setCharset(String charset)
           
 void setFailto(Object failto)
           
 void setFrom(Object from)
          set the value from The sender of the e-mail message.
 void setGroup(String group)
          set the value group Specifies the query column to use when you group sets of records together to send as an e-mail message.
 void setGroupcasesensitive(boolean groupcasesensitive)
          set the value groupcasesensitive Boolean indicating whether to group with regard to case or not.
 void setMailerid(String mailerid)
          set the value mailerid
 void setMaxrows(double maxrows)
          set the value maxrows Specifies the maximum number of e-mail messages to send.
 void setMimeattach(String strMimeattach)
           
 void setMimeattach(String strMimeattach, String type, String disposition, String contentID, boolean removeAfterSend)
          set the value mimeattach Specifies the path of the file to be attached to the e-mail message.
 void setParam(String type, String file, String name, String value, String disposition, String contentID, Boolean oRemoveAfterSend)
          sets a mail param
 void setPassword(String password)
           
 void setPort(double port)
          set the value port The TCP/IP port on which the SMTP server listens for requests.
 void setPriority(String strPriority)
           
 void setProxypassword(String proxypassword)
          set the value password When required by a proxy server, a valid password.
 void setProxyport(double proxyport)
          set the value proxyport The port number on the proxy server from which the object is requested.
 void setProxyserver(String proxyserver)
           
 void setProxyuser(String proxyuser)
          set the value username When required by a proxy server, a valid username.
 void setQuery(String query)
          set the value query The name of the cfquery from which to draw data for message(s) to send.
 void setRemove(boolean remove)
           
 void setReplyto(Object replyto)
           
 void setSecure(boolean ssl)
           
 void setServer(String strServer)
          set the value server
 void setSpoolenable(boolean spoolenable)
           
 void setSsl(boolean ssl)
           
 void setStartrow(double startrow)
          set the value startrow Specifies the row in the query to start from.
 void setStarttls(boolean tls)
           
 void setSubject(String subject)
          set the value subject The subject of the mail message.
 void setTimeout(double timeout)
          set the value timeout The number of seconds to wait before timing out the connection to the SMTP server.
 void setTls(boolean tls)
           
 void setTo(Object to)
          set the value to The name of the e-mail message recipient.
 void setType(String type)
          set the value type Specifies extended type attributes for the message.
 void setUsername(String username)
           
 void setUsessl(boolean ssl)
           
 void setUsetls(boolean tls)
           
 void setWraptext(double wraptext)
           
 
Methods inherited from class railo.runtime.ext.tag.BodyTagImpl
setBodyContent
 
Methods inherited from class railo.runtime.ext.tag.TagImpl
getParent, required, required, required, required, setPageContext, setPageContext, setParent
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface javax.servlet.jsp.tagext.Tag
getParent, setPageContext, setParent
 

Constructor Detail

Mail

public Mail()
Method Detail

release

public void release()
Specified by:
release in interface javax.servlet.jsp.tagext.Tag
Overrides:
release in class BodyTagImpl
See Also:
Tag.release()

setRemove

public void setRemove(boolean remove)
Parameters:
remove - the remove to set

setProxyserver

public void setProxyserver(String proxyserver)
                    throws ApplicationException
Parameters:
proxyserver - The proxyserver to set.
Throws:
ApplicationException

setProxyport

public void setProxyport(double proxyport)
                  throws ApplicationException
set the value proxyport The port number on the proxy server from which the object is requested. Default is 80. When used with resolveURL, the URLs of retrieved documents that specify a port number are automatically resolved to preserve links in the retrieved document.

Parameters:
proxyport - value to set
Throws:
ApplicationException

setProxyuser

public void setProxyuser(String proxyuser)
                  throws ApplicationException
set the value username When required by a proxy server, a valid username.

Parameters:
proxyuser - value to set
Throws:
ApplicationException

setProxypassword

public void setProxypassword(String proxypassword)
                      throws ApplicationException
set the value password When required by a proxy server, a valid password.

Parameters:
proxypassword - value to set
Throws:
ApplicationException

setFrom

public void setFrom(Object from)
             throws PageException
set the value from The sender of the e-mail message.

Parameters:
strForm - value to set
Throws:
PageException

setTo

public void setTo(Object to)
           throws ApplicationException
set the value to The name of the e-mail message recipient.

Parameters:
strTo - value to set
Throws:
ApplicationException

setCc

public void setCc(Object cc)
           throws ApplicationException
set the value cc Indicates addresses to copy the e-mail message to; "cc" stands for "carbon copy."

Parameters:
strCc - value to set
Throws:
ApplicationException

setBcc

public void setBcc(Object bcc)
            throws ApplicationException
set the value bcc Indicates addresses to copy the e-mail message to, without listing them in the message header. "bcc" stands for "blind carbon copy."

Parameters:
strBcc - value to set
Throws:
ApplicationException

setFailto

public void setFailto(Object failto)
               throws ApplicationException
Parameters:
strFailto - The failto to set.
Throws:
ApplicationException

setReplyto

public void setReplyto(Object replyto)
                throws ApplicationException
Parameters:
strReplyto - The replyto to set.
Throws:
ApplicationException

setType

public void setType(String type)
             throws ApplicationException
set the value type Specifies extended type attributes for the message.

Parameters:
type - value to set
Throws:
ApplicationException

setSubject

public void setSubject(String subject)
set the value subject The subject of the mail message. This field may be driven dynamically on a message-by-message basis

Parameters:
subject - value to set

setUsername

public void setUsername(String username)
Parameters:
username - The username to set.

setPassword

public void setPassword(String password)
Parameters:
password - The password to set.

setMimeattach

public void setMimeattach(String strMimeattach,
                          String type,
                          String disposition,
                          String contentID,
                          boolean removeAfterSend)
                   throws PageException
set the value mimeattach Specifies the path of the file to be attached to the e-mail message. An attached file is MIME-encoded.

Parameters:
strMimeattach - value to set
type - mimetype of the file
contentID -
disposition -
Throws:
PageException

setMimeattach

public void setMimeattach(String strMimeattach)
                   throws PageException
Throws:
PageException

setSpoolenable

public void setSpoolenable(boolean spoolenable)
Parameters:
spoolenable - The spoolenable to set.

setServer

public void setServer(String strServer)
               throws PageException
set the value server

Parameters:
strServer - value to set
Throws:
PageException

setMailerid

public void setMailerid(String mailerid)
set the value mailerid

Parameters:
mailerid - value to set

setPort

public void setPort(double port)
set the value port The TCP/IP port on which the SMTP server listens for requests. This is normally 25.

Parameters:
port - value to set

setWraptext

public void setWraptext(double wraptext)
Parameters:
wraptext - The wraptext to set.

setTimeout

public void setTimeout(double timeout)
set the value timeout The number of seconds to wait before timing out the connection to the SMTP server.

Parameters:
timeout - value to set

setCharset

public void setCharset(String charset)
Parameters:
charset - The charset to set.

setGroup

public void setGroup(String group)
set the value group Specifies the query column to use when you group sets of records together to send as an e-mail message. For example, if you send a set of billing statements to customers, you might group on "Customer_ID." The group attribute, which is case sensitive, eliminates adjacent duplicates when the data is sorted by the specified field. See the Usage section for exceptions.

Parameters:
group - value to set

setGroupcasesensitive

public void setGroupcasesensitive(boolean groupcasesensitive)
set the value groupcasesensitive Boolean indicating whether to group with regard to case or not. The default value is YES; case is considered while grouping. If the query attribute specifies a query object that was generated by a case-insensitive SQL query, set the groupCaseSensitive attribute to NO to keep the recordset intact.

Parameters:
groupcasesensitive - value to set

setQuery

public void setQuery(String query)
set the value query The name of the cfquery from which to draw data for message(s) to send. Specify this attribute to send more than one mail message, or to send the results of a query within a message.

Parameters:
query - value to set

setMaxrows

public void setMaxrows(double maxrows)
set the value maxrows Specifies the maximum number of e-mail messages to send.

Parameters:
maxrows - value to set

setTls

public void setTls(boolean tls)

setUsetls

public void setUsetls(boolean tls)

setStarttls

public void setStarttls(boolean tls)

setSsl

public void setSsl(boolean ssl)

setUsessl

public void setUsessl(boolean ssl)

setSecure

public void setSecure(boolean ssl)

setPriority

public void setPriority(String strPriority)
                 throws ExpressionException
Throws:
ExpressionException

setStartrow

public void setStartrow(double startrow)
set the value startrow Specifies the row in the query to start from.

Parameters:
startrow - value to set

addPart

public void addPart(MailPart part)
Parameters:
part -

doStartTag

public int doStartTag()
               throws ApplicationException
Specified by:
doStartTag in interface javax.servlet.jsp.tagext.Tag
Overrides:
doStartTag in class TagImpl
Throws:
ApplicationException
See Also:
Tag.doStartTag()

doInitBody

public void doInitBody()
Specified by:
doInitBody in interface javax.servlet.jsp.tagext.BodyTag
Overrides:
doInitBody in class BodyTagImpl
See Also:
BodyTag.doInitBody()

doAfterBody

public int doAfterBody()
Specified by:
doAfterBody in interface javax.servlet.jsp.tagext.IterationTag
Overrides:
doAfterBody in class BodyTagImpl
See Also:
IterationTag.doAfterBody()

doEndTag

public int doEndTag()
             throws PageException
Specified by:
doEndTag in interface javax.servlet.jsp.tagext.Tag
Overrides:
doEndTag in class TagImpl
Throws:
PageException
See Also:
Tag.doEndTag()

setParam

public void setParam(String type,
                     String file,
                     String name,
                     String value,
                     String disposition,
                     String contentID,
                     Boolean oRemoveAfterSend)
              throws PageException
sets a mail param

Parameters:
type -
file -
name -
value -
contentID -
disposition -
Throws:
PageException

getCharset

public String getCharset()
Returns:
the charset


Copyright © 2012 Railo