Jakarta Project: Mailer Tag library

Used to create an e-mail message. Most attributes set via a tag within the body of this tag will take precedence and override any value that was set as an attribute in this tag. In the case of the three add tags, however, an address set as an attribute will not be overridden, but will be the first address in the list.

None

This attribute allows you to set the SMTP host if it is going to be other than localhost.

This attribute allows a message to be created using a predefined, JNDI named Session object.

This attribute allows a message to be created using a predefined, JNDI named MimePartDataSource.

A value of true of false tells the mailer taglib if the mail server uses authentication. The default value is false. If the value is set to true and the mail server uses authentication, there are two methods which can be used to authenticate the user to the mail server.
1. Provide the user and password attributes.
2. Do not provide the user and password attributes, the user will be prompted for a name and password before the mail is sent.

This attribute allows you to set the SMTP user to login

This attribute allows you to set the SMTP user password to login

The To address of the e-mail. Accepts a comma separated list of addresses.

The Reply-To address of the e-mail. Accepts a comma separated list of addresses.

The From address of the e-mail.

The Carbon Copy address of the e-mail. Accepts a comma separated list of addresses.

The Blind Carbon Copy address of the e-mail. Accepts a comma separated list of addresses.

The Subject of the e-mail.

 
<mt:mail to="foo@home.net" from="bar@home.net"subject="mail taglib">
     <mt:message>[body of message]</mt:message>
     <mt:send/> 
</mt:mail> 
       
          

Used to set the mail server that will send the mail.

Must be nested within a mail tag.
Must occur before send tag.

   
      
<mt:mail to="foo@home.net" from="bar@home.net"subject="mail taglib">
     <mt:server>some.mailserver.com</mt:server>
     <mt:message>[body of message]</mt:message>
     <mt:send/> 
</mt:mail> 
               
          

Used to set the body of the message. Message will appear as it is written, any carriage returns and spaces in the JSP will be present in the delivered message.

Must be nested within a mail tag.
Must occur before send tag.

This attribute has two possible values text or html. If text is selected the body of the message is just plain text (it has no html tags within it). If html is selected then the body of the message can contain HTML tags. The default value for this attribute is text.

   
      
<mt:mail to="foo@home.net" from="bar@home.net"subject="mail taglib">
     <mt:message>[body of message]</mt:message>
     <mt:send/> 
</mt:mail> 
               
             
      
<mt:mail to="foo@home.net" from="bar@home.net" subject="mail taglib">
     <mt:message type="html">
        [body of message containing html formatting]
     </mt:message>
     <mt:send/>
</mt:mail> 
               
          

Used to set extra headers in the message. See Documentation for further information on other e-mail headers.

Must be nested within a mail tag.
Must occur before send tag.

The name of the header to be set.

The value of the extra header to be set. This can also be placed in the body of the tag (see example).

   
         
<mt:mail to="foo@home.net" from="bar@home.net" subject="mail taglib">
     <mt:header name="Precedence" value="bulk"/>
     <mt:message>[body of message]</mt:message>
     <mt:send/>
</mt:mail> 

          

<mt:mail to="foo@home.net" from="bar@home.net" subject="mail taglib">
     <mt:header name="Precedence">bulk</mt:header>
     <mt:message>[body of message]</mt:message>
     <mt:send/>
</mt:mail> 

	  

Used to set any type of recipient to an e-mail. Two attributes are required, type and address. Type may be either "to", "cc", or "bcc" and address should be a string representation of the recipients e-mail address.

Must be nested within a mail tag.
Must occur before send tag.

The type of address to be set either "to", "cc", or "bcc".

The valid address that is to be set.

   
         
<mt:mail from="bar@home.net" subject="mailer taglib">
     <mt:setrecipient type="to" address="jdoe@home.net"/>
     <mt:message>[body of message]</mt:message>
     <mt:send/>
</mt:mail> 

          

<mt:mail to="jdoe@home.net" from="bar@home.net" subject="mailer taglib">
     <mt:setrecipient type="cc">foo@home.net,geo@place.net</mt:setrecipient>
     <mt:message>[body of message]</mt:message>
     <mt:send/>
</mt:mail> 

	  

Used to add any type of recipient to an already existant list of recipients in an e-mail message. Two attributes are required, type and address. Type may be either "to", "cc", or "bcc" and address should be a string representation of the recipients e-mail address.

Must be nested within a mail tag.
Must occur before send tag.

The type of address list either "to", "cc", or "bcc" this address is to be added to.

The valid address that is to be set.

   
         
<mt:mail from="bar@home.net" subject="mailer taglib">
     <mt:addrecipient type="to" address="jdoe@home.net"/>
     <mt:message>[body of message]</mt:message>
     <mt:send/>
</mt:mail> 

          

<mt:mail to="jdoe@home.net" from="bar@home.net" subject="mailer taglib">
     <mt:addrecipient type="bcc">foo@home.net,geo@place.net</mt:addrecipient>
     <mt:message>[body of message]</mt:message>
     <mt:send/>
</mt:mail> 

	  

Used to set one or more Reply-To addresses in the message.

Must be nested within a mail tag.
Must occur before send tag.

   
      
<mt:mail to="foo@home.net" from="bar@home.net" subject="mailer taglib">
     <mt:replyto>sax@home.net</mt:replyto>
     <mt:message>[body of message]</mt:message>
     <mt:send/>
</mt:mail>
               
             
      
<mt:mail to="foo@home.net" from="bar@home.net" subject="mailer taglib">
     <mt:replyto>sax@home.net,cur@blank.com</mt:replyto>
     <mt:message>[body of message]</mt:message>
     <mt:send/>
</mt:mail>
               
          

Used to set the From address of the message.

Must be nested within a mail tag.
Must occur before send tag.

   
      
<mt:mail to="joe@place.home">
     <mt:from>bar@home.net</mt:from>
     <mt:message>[body of message]</mt:message>
     <mt:send/>
</mt:mail> 
               
          

Used to add an attachment to an e-mail message. It is possible to add an attachment in one of three ways. First give the name of the file that is to be added. Second give the URL that points to the resource that is to be added. Third include the attachment in the body of the attach tag, in this case it is necessary to use the type attribute and give the mime type of the attachment.

Must be nested within a mail tag.
Must occur before send tag.

The name of the file to be included as an attachment. The name of the file must be a path or file name realative to the root directory of the web application. If the value of the file attribute equals "" (it is left empty) the tag will extract the name of the file from the body of the tag.

The URL of a resource to be included as an attachment. The URL must be given as the full url like http://www.somedomain.com. If the value of the url attribute equals "" (it is left empty) the url will be extracted from the body of the tag.

The mime type of the attachment that is included within the body of the attach tag.

   
      
<mt:mail to="foo@home.net" from="bar@home.net" subject="test">
     <mt:message>[body of message]</mt:message>
     <mt:attach file="mail/duck.gif"/>
     <mt:send/>
</mt:mail>
               
             
      
<mt:mail to="foo@home.net" from="bar@home.net" subject="test">
     <mt:message>[body of message]</mt:message>
     <mt:attach url="">
        http://www.someplace.com/stuff.html
     </mt:attach>
     <mt:send/>
</mt:mail>
               
             
      
<mt:mail to="foo@home.net" from="bar@home.net" subject="test">
     <mt:message>[body of message]</mt:message>
     <mt:attach type="text/html">
        <h1>This is just a test</h1>
     </mt:attach>
     <mt:send/>
</mt:mail> 
               
          

Used to set the subject in the message.

Must be nested within a mail tag.
Must occur before send tag.

   
      
<mt:mail>
     <mt:setrecipient>foo@home.net</mt:setrecipient>
     <mt:from>bar@home.net</mt:from>
     <mt:subject>learning about the mail tag library</mt:subject>
     <mt:message>[body of message]</mt:message>
     <mt:send/>
</mt:mail> 
               
          

Used to send the message. If an error occured while creating the e-mail message and it cannot be sent, the body of this tag will be output to the browser. It is within the body of this tag where the page author can include an error message if it is desired.

Must be nested within a mail tag.
Must be the last tag nested within the mail tag.

   
      
<mt:mail to="foo@home.net" from="bar@home.net">
     <mt:subject>learning about the mail tag library</mt:subject>
     <mt:message>[body of message]</mt:message>
     <mt:send>
       An error has occurred, please back up and check that the 
       addresses you gave are in the correct format.
     </mt:send>
</mt:mail> 
               
          

Used to get messages explaining errors that occurred in setting any of the addresses.

Must be nested within send tag.

Script variable id for use with standard jsp:getProperty tag.

Name used to retrieve the random string later in the page.

The current error in the error list as a string.

   
      
<mt:mail to="foo@home.net" from="bar@home.net">
     <mt:subject>learning about the mail tag library</mt:subject>
     <mt:message>[body of message]</mt:message>
     <mt:send>
        The following error(s) have occured: 
      <mt:error id="err">
         <jsp:getProperty name="err" property="error"/>
       </mt:error>
     </mt:send>
</mt:mail>