Chapter 3 TagLib: Mail

This chapter describes about the Tag Library Mail attributes:

The Calendar Tag Library consists of the following tags:

• attachment

• attachments

• config

• configs

• context

• deletefolder

• deletemessage

• fetch

• folder

• folders

• get

• indentparagraph

• indentparagraphs

• line

• lines

• message

• messages

• movemessage

• newfolder

• popcollect

• presetmsg

• presetmsgs

• renamefolder

• sendmessage

• set

• view

• views

attachment

Description

This tag denotes a reference to the current attachment bean within an enclosing <mail:attachments> tag. An attachment bean may be created and/or referenced by the use of the id or name attributes. Note that an attachment bean contains no accessable properties. This tag is provided as a means of referencing an attachment for the purpose of move/copy operations.

Tag Body

JSP

Tag Parent

<mailPrefix:attachments>

Restrictions

None.

Attributes

n/a

Properties

n/a

Example(s)

n/a

attachments

Description

The tag denotes reference to a collection of attachments. This tag will iterate upon its body until the collection is exhausted, or as constrained by the start and count properties. The start and count properties should only be set when the iterate attribute is set to "false".

Tag Body

JSP

Tag Parent

n/a

Restrictions

None.

Attributes

The tag has the following attributes for which the Required value is “No”:

id

Name of the attachments collection to create.

name

Name of the attachments collection to use.

iterate

A boolean that selects iteration. Default is "false", the collection will not iterate.

beanid

During iteration, specifies a name by which the current bean may be retrieved from the PageContext.

Properties

The tag provides the following bean properties for which the Type values are “Integer” and “Boolean” and the Access value is “Get/Set”:

index

Index of the current bean in the collection.

count

The number of iterations the collection should perform.

start

The zero-based index from which to begin iteration.

end

The zero-based index that denotes the item upon which iteration will terminate.

startOne

One-based start; suitable for presentation.

endOne

One-based end; suitable for presentation.

size

The size of the collection being paged.

nextPage

Whether or not there are more items in the collection, beyond the current iterations.

prevPage

Whether there are items in the collection preceding the current iterations.

Example(s)

n/a

config

Description

This tag denotes a reference to the current config bean within an enclosing <mail:configs> tag. A config bean may be created and/or referenced by the use of the id or name attributes. The body of this tag may contain get/set tags that will generate output derived from the contents of this bean tag.

Tag Body

JSP

Tag Parent

<mailPrefix:config>

Restrictions

None.

Attributes

The tag has the following attributes for which the Required value is “No”:

id

Name of the bean to create.

name

Name of the bean to use.

Properties

The tag provides the following bean properties for which the Type value is “String” and the Access value is “Get”:

configName

Name of the Configuration from which the information in this bean is derived.

protocol

Name of the protocol specified in this Configuration.

Example(s)

n/a

configs

Description

This tag denotes a reference to a collection of configs. This tag will iterate upon its body until the collection is exhausted, or as constrained by the start and count properties. The start and count properties should only be set when the iterate attribute is set to "false".

Tag Body

JSP

Tag Parent

n/a

Restrictions

None.

Attributes

The tag has the following attributes for which the Required value is “No”:

id

Name of the configs collection to create.

name

Name of the configs collection to use.

iterate

A boolean that selects iteration. Default is "false", the collection will not iterate.

beanid

During iteration, specifies a name by which the current bean may be retrieved from the PageContext.

Properties

The tag provides the following bean properties for which the Type values are “Integer” and “Boolean” and the Access value is “Get/Set”:

index

Index of the current bean in the collection.

count

The number of iterations the collection should perform.

start

The zero-based index from which to begin iteration.

end

The zero-based index that denotes the item upon which iteration will terminate.

startOne

One-based start; suitable for presentation.

endOne

One-based end; suitable for presentation.

size

The size of the collection being paged.

nextPage

Whether or not there are more items in the collection, beyond the current iterations. Boolean.

prevPage

Whether there are items in the collection preceding the current iterations. Boolean.

Example(s)

n/a

context

Description

Ensures that a mail context is present within the current pageContext. This tag must appear, at least once, before all other tags within the Mail taglib.  If config is not specified, then a search for a useable configuration name is performed in the following fashion:Attempt to retrieve the current mail configuration name from the page context.  If that succeeds, use it.  If the retrieval fails... Attempt to retrieve the current mail configuration name from the session.  If that succeeds, store it on the page context and use it. If the retrieval fails... From the list of all SSOAdapter configuration names, try to find the first useable mail configuration name.  If that succeeds, store it in the session and page context and use it.  If it is not possible to find a useable mail configuration name, the context tag will fail.Once a configuration name has been determined, an attempt is made to acquire an appropriate mail context object.  This is done in the following fashion:Attempt to retrieve a mail context from the page context, and verify it matches the configuration (using the previously acquired configuration name). If that succeeds, use it. If that fails... Attempt to retrieve a mail context from the user's cache of mail contexts.  If that succeeds, store it on the page context and use it.  If the retrieval fails... Create an SSOAdapter object using the previously acquired configuration name.  Create a mail context, and bind it with the SSOAdapter object.  Store the mail context in the context cache as well as the page context.In this way, if a mail context has been previously referenced on a page, or within the session, then the config attribute may be omitted, and the most recently referenced context will be retrieved.

Tag Body

JSP or Empty

Restrictions

None.

Attributes

The tag has the following attributes for which the Required value is “No”:

config

Specifies the "configuration" for which a mail context should be retrieved.

test

Permits testing of service availability. Operates according to the following table:

Service Available

Evaluate tag body when test = true and Skip tag body when test = false.

Service Not Available

Skip tag body when test = true and Evaluate tag body when test = false.

Properties

The tag provides the following bean properties for which for which the Type values are “String”, “Integer” and “Boolean” and the Access value is “Get”:

errorCode

Indicates the error code in case the execution of a command tag fails. Possible values:

• Empty error code indicates a generic tag execution failed error.

• MAIL_001 - Unable to send message because of Invalid email address.

• MAIL_002 - Unable to send message.

• MAIL_003 - Attempt to create a folder that already exists.

• MAIL_004 - Failed to create folder.

inboxNumMsgs

Number of messages in the INBOX.

inboxNumUnreadMsgs

Number of unread messages in the INBOX.

inboxNumNewMsgs

Number of new messages in the INBOX.

numMsgs

Number of messages in the current folder.

numUnreadMsgs

Number of unread messages in the current folder.

numNewMsgs

Number of new messages in the current folder.

signature

User's predefined signature.

atmsgend

A boolean that indicates if there is a message following the message from which was fetched the current lines collection.

atmsgstart

A boolean that indicates if there is a message prior to the message from which was fetched the current lines collection.

nextmsgidx

The index of the message following the message from which was fetched the current lines collection.

prevmsgidx

The index of the message prior to the message from which was fetched the current lines collection.

presetEmpty

A boolean that indicates whether or not the user has any predefined messages.

doMsgInclude

A boolean that indicates whether or not to include the original message within a reply message.

includeSig

A boolean that indicates whether or not to append the user's signature onto an outgoing message sent with sendmessage.

Example(s)

<%-- example of context tag usage --%>
<mail:context>
...
<mail:context>
<p>New Message:  <mail:get property="inboxNumNewMsgs"/>
</mail:context>

deletefolder

Description

Deletes a folder. If an error occurs during processing, the tag body will be evaluated and the remainder of the page will be skipped.

Tag Body

JSP

Restrictions

n/a

Attributes

The tag has the following attributes for which the Required value is “Yes”:

foldername

Specifies the name of the folder to delete.

Properties

n/a

Example(s)

<%-- deletefolder tag example --%>
...
<mail:context/>
...
...

deletemessage

Description

Deletes an email message from the current folder. If an error occurs during processing, the tag body will be evaluated and the remainder of the page will be skipped.

Tag Body

JSP

Restrictions

n/a

Attributes

The tag has the following attributes for which the Required value is “Yes”:

index

Identifies message to delete. index specifies an entry within the current messages collection.

Properties

n/a

Example(s)

<%-- deletemessage tag example --%>
<mail:context/>
...
...
<mail:deletemessage index="$(idx)">
<p>Fail.
</mail:deletemessage>
...

fetch

Description

This tag builds a collection of the type specified by the collection attribute. The Mail collections may be considered in the following fashion: A user possesses a collection of "folders". A folder possesses a collection of "messages". A message possesses a collection of "lines". A fetch of any given collection type creates a "current" collection of that type. For example, a fetch of a "messages" collection creates the current "messages" collection. These "current" collections are associated with the current Mail context. If an error occurs during processing, the tag body will be evaluated and the remainder of the page will be skipped.

Tag Body

JSP

Restrictions

n/a

Attributes

The tag has the following attributes for which the Required values are “Yes” and “See below”:

collection

Identifies the type of collection to fetch.

id

Identifies which collection to fetch.

sb

Indicates which "field" to sort by.

sd

Indicates which direction to sort.

• If collection is "folders":

  • id is ignored.

  • sb is ignored.

  • sd may be “up” or “down”.

• If collection is "messages":

  • id identifies from which folder to fetch the messages.

  • sb identifies by which message field to sort by.

  • sd may be "up" or "down".

• If collection is "lines":

  • id identifies which message to fetch.

  • sb is ignored.

  • sd is ignored.

  A fetch of a "lines" collection assumes that id refers to a message within a "messages" collection that was fetched previously, using the same mail context.

Properties

n/a

Example(s)

<%-- example of fetch tag --%>
<mail:context/>
...
<mail:fetch collection="messages" id="INBOX" sb="date" sd="down">
<p>Fail.
</mail:fetch>
...
<mail:fetch collection="lines" id="0">
<p>Fail.
</mail:fetch>
...
<mail:lines>
	<mail:line>
		<mail:get property="text"/>
	</mail:line>
</mail:lines>

folder

Description

This tag denotes a reference to the current folder "bean" within an enclosing <mail:folders> tag. The body of this tag may contain get tags that will generate output derived from the contents of this "bean" tag.

Tag Body

JSP

Tag Parent

<mailPrefix:folders>

Restrictions

None.

Attributes

The tag has the following attributes for which the Required value is “No”:

foldername

Specifies the full name of the folder represented by this bean.

Properties

The tag provides the following bean properties for which the Type values are “String”, “Integer” and “Boolean” and the Access value is “Get”:

folderExist

n/a

holdFolders

n/a

holdMessages

n/a

name

n/a

fullName

n/a

numFolders

n/a

numMsgs

n/a

readWrite

The state and contents of this folder can be modified.

Example(s)

<%-- folder tag example --%>

...
<mail:context/>

...
<mail:fetch collection="folders"/>

...
<mail:folders iterate="true">
	<mail:folder>
		<p>Folder Name:<mail:get property="name"/>
	</mail:folder>
</mail:folders>

folders

Description

This tag denotes a reference to a collection of folders. This tag will iterate upon its body until the collection is exhausted, or as constrained by the start and count properties. The start and count properties should only be set when the iterate attribute is set to "false".

Tag Body

JSP

Tag Parent

n/a

Restrictions

None.

Attributes

The tag has the following attributes for which the Required value is “No”:

id

Name of the folders collection to create.

name

Name of the folders collection to use.

iterate

A boolean that selects iteration. Default is "false", the collection will not iterate.

beanid

During iteration, specifies a name by which the current bean may be retrieved from the PageContext.

Properties

The tag provides the following bean properties for which the Type values are “Integer” and “Boolean” and the Access value is “Get/Set”:

index

Index of the current bean in the collection.

count

The number of iterations the collection should perform.

start

The zero based index from which to begin iteration.

end

The zero based index that denotes the item upon which iteration will terminate.

startOne

One-based start; suitable for presentation.

endOne

One-based end; suitable for presentation.

size

The size of the collection being paged.

nextPage

Whether or not there are more items in the collection, beyond the current iterations.

prevPage

Whether there are items in the collection preceding the current iterations.

Example(s)

<%-- folders tag example --%>
...
<mail:context/>
...
<mail:fetch collection="folders"/>
...
<mail:folders id="folderlist">
	<mail:set property="start" value="$(start)"/>
	<mail:set property="count" value="5"/>
</mail:folders>
<mail:folders name="folderlist" iterate="true">
	<mail:folder>
		<p>Folder Name:<mail:get property="name"/>
	</mail:folder>
</mail:folders>

get

Description

This tag retrieves the specified property. This tag operates exactly like the <util:get> tag and is imported into the mail taglib for convenience. See the util:get tag description for details on how to use this tag.

Tag Body

util:get

Restrictions

util:get

Attributes

util:get

Properties

util:get

Example(s)

<%-- get the subject property --%>
<mail:message>
	<mail:get property="subject"/>
</mail:message>

indentparagraph

Description

This tag denotes reference to the current indentparagraph bean within an enclosing <mail:indentparagraphs> tag. A indentparagraph bean may be created and/or referenced by the use of the id or name attributes. The body of this tag may contain get/set tags that will generate output derived from the contents of this bean tag.

Tag Body

JSP

Tag Parent

<mailPrefix:indentparagraphs>

Restrictions

None.

Attributes

The tag has the following attributes for which the Required value is “No”:

id

Name of the bean to create.

name

Name of the bean to use.

index

Specifies the index into the current indentparagraph list of the indentparagraph bean to find.

Properties

The tag provides the following bean properties for which the Type values are “Integer”, “String” and Access value is “Get/Set”:

quoteLevel

None

paragraph

None

Example(s)

n/a

indentparagraphs

Description

This tag denotes reference to a collection of indentparagraph beans. This tag will iterate upon its body until the collection is exhausted, or as constrained by the start and count properties. The start and count properties should only be set when the iterate attribute is set to "false".

Tag Body

JSP

Tag Parent

n/a

Restrictions

None.

Attributes

This tag has the following attributes for which the Required value is “No”:

id

Name of the indentparagraphs collection to create.

name

Name of the indentparagraphs collection to use.

iterate

A boolean that selects iteration. Default is "false", the collection will not iterate.

beanid

A boolean that selects iteration. Default is "false", the collection will not iterate.

quoteString

During iteration, specifies a name by which the current bean may be retrieved from the PageContext.

Properties

This tag provides the following bean properties for which the Type values are “Integer”, “Boolean” and Access value is “Get/Set”:

index

Index of the current bean in the collection.

count

The number of iterations the collection should perform.

start

The zero based index from which to begin iteration.

end

The zero based index that denotes the item upon which iteration will terminate.

startOne

One-based start; suitable for presentation.

endOne

One-based end; suitable for presentation.

size

The size of the collection being paged.

nextPage

Whether or not there are more items in the collection, beyond the current iterations.

prevPage

Whether there are items in the collection preceding the current iterations.

Example(s)

n/a

line

Description

This tag denotes a reference to the current line"bean" within an enclosing <mail:lines> tag. The body of this tag may contain get tags that will generate output derived from the contents of this "bean" tag.

Tag Body

JSP

Tag Parent

<mailPrefix:lines>

Restrictions

None.

Attributes

n/a

Properties

The tag provides the following bean properties for which the Type value is “String” and the Access value is “Get”:

text

Current line of text.

Example(s)

<%-- line tag example --%>
...
<mail:context/>
...
<mail:fetch collection="lines" id="$(msgidx)"/>
...
<mail:lines id="llist">
	<mail:set property="start" value="$(start)"/>
	<mail:set property="count" value="5"/>
</mail:lines>
<mail:lines name="llist" iterate="true">
	<mail:line>
		<mail:get property="text"/>
	</mail:line>
</mail:lines>

lines

Description

The tag denotes a reference to a collection of lines. This collection is expected to reside within the MailContext object, "mail", stored on the current page context. This tag will iterate upon its body until the collection is exhausted, or as constrained by the start and count properties. The start and count properties should only be set when the iterate attribute is set to "false".

Tag Body

JSP

Tag Parent

n/a

Restrictions

None.

Attributes

The tag has the following attributes for which the Required value is “No”:

id

Name of the entries collection to create.

name

Name of the entries collection to use.

iterate

A boolean that selects iteration. Default is "false", the collection will not iterate.

Properties

The tag provides the following bean properties for which the Type values are “Integer”, “Boolean” and Access value is “Get/Set”:

index

Index of the current bean in the collection.

count

The number of iterations the collection should perform. Integer.

start

The zero-based index from which to begin iteration.

end

The zero-based index that denotes the item upon which iteration will terminate. Integer.

startOne

One-based start; suitable for presentation.

endOne

One-based end; suitable for presentation.

size

The size of the collection being paged.

nextPage

Whether or not there are more items in the collection, beyond the current iterations.

prevPage

Whether there are items in the collection preceding the current iterations.

Example(s)

<%-- lines tag example --%>
...
<mail:context/>
...
<mail:fetch collection="lines" id="$(msgidx)"/>
...
<mail:lines id="llist">
	<mail:set property="start" value="$(start)"/>
	<mail:set property="count" value="5"/>
</mail:lines>
<mail:lines name="llist" iterate="true">
	<mail:line>
		<mail:get property="text"/>
	</mail:line>
</mail:lines>

message

Description

This tag denotes reference to the current message bean within an enclosing <mail:messages> tag. A message bean may be created and/or referenced by the use of the id or name attributes. The body of this tag may contain get/set tags that will generate output derived from the contents of this bean tag.

Tag Body

JSP

Tag Parent

<mailPrefix:messages>

Restrictions

None.

Attributes

The tag has the following attributes for which the Required value is “No”:

id

Name of the bean to create.

name

Name of the bean to use.

index

Specifies the index into the current message list of the message bean to find.

Properties

The tag provides the following bean properties for which the Type values are “String”, “Boolean” and Access value is “Get/Set”:

from

Provides access to the full address specified in the "From:" header. (example: John Doe <jdoe@somedomain.com>)

fromAddress

Provides access to just the address specified in the "From:" header, excluding the comment field.

fromPersonal

Provides access to the comment specified in the "From:" header if there is one, excluding the actual address.

replyTo

Provides access to the "Reply-To:" header if the header exists. In the event that it doesn't, the same value as the "from" property is returned.

replyToAddress

Provides access to just the address portions of the "Reply-To:" header if the header exists. In the event that it doesn't, the same value as the "fromAddress" property is returned.

replyToPersonal

Provides access to just the comment portions of the "Reply-To:" header if the header exists and has a comment. In the event that it doesn't, the same value as the "fromPersonal" property is returned.

to

Provides access to the entire "To:" message header.

toAddress

Provides access to just the address portions of the "To:" header.

toAddressReply

Provides access to just the address portions of the "To:" header, exluding any address that matches the user's.

cc

Provides access to the entire "Cc:" message header.

ccAddress

Provides access to just the address portions of the "Cc:" header.

ccAddressReply

Provides access to just the address portions of the "Cc:" header, excluding any address that matches the user's.

bcc

Message bcc.

seen

A boolean that indicates if the message has been seen.

recent

A boolean that indicates if the message is recent.

deleted

A boolean that indicates if the message is deleted.

subject

Message subject.

date

Message date.

text

Message text.

Example(s)

<%-- message tag example --%>
...
<mail:context/>
...
<mail:fetch collection="messages" id="INBOX" sb="date" sd="down"/>
...
<mail:messages id="msgs">
	<mail:set property="start" value="$(start)"/>
	<mail:set property="count" value="5"/>
</mail:messages>
<mail:messages name="msgs" iterate="true">
	<mail:message>
		<p>Subject:  <mail:get property="subject"/>
	</mail:message>
</mail:messages>

messages

Description

This tag denotes a reference to a collection of messages. This tag will iterate upon its body until the collection is exhausted, or as constrained by the start and count properties. The start and count properties should only be set when the iterate attribute is set to "false".

Tag Body

JSP

Tag Parent

n/a

Restrictions

None.

Attributes

This tag has the following attributes for which the Required value is “No”:

id

Name of the entries collection to create.

name

Name of the entries collection to use.

iterate

A boolean that selects iteration. Default is "false", the collection will not iterate.

beanid

During iteration, specifies a name by which the current bean may be retrieved from the PageContext.

Properties

This tag provides the following bean properties for which the Type values are “Integer”, “Boolean” and Access value is “Get/Set”:

index

Index of the current bean in the collection. Integer.

count

The number of iterations the collection should perform. Integer.

start

The zero based index from which to begin iteration. Integer.

end

The zero based index that denotes the item upon which iteration will terminate. Integer.

startOne

One-based start; suitable for presentation.

endOne

One-based end; suitable for presentation.

size

The size of the collection being paged. Integer.

nextPage

Whether or not there are more items in the collection, beyond the current iterations. Boolean

prevPage

Whether there are items in the collection preceding the current iterations. Boolean

Example(s)

<%-- messages tag example --%>
...
<mail:context/>
...
<mail:fetch collection="messages" id="INBOX" sb="date" sd="down"/>
...
<mail:messages id="msgs">
	<mail:set property="start" value="$(start)"/>
	<mail:set property="count" value="5"/>
</mail:messages>
<mail:messages name="msgs" iterate="true">
	<mail:message>
		<p>Subject:  <mail:get property="subject"/>
	</mail:message>
</mail:messages>

movemessage

Description

Moves or copies a message from one folder to another. If an error occurs during processing, the tag body will be evaluated and the remainder of the page will be skipped.

Tag Body

JSP

Restrictions

n/a

Attributes

The tag has the following attributes for which the Type values are “Integer”, “String” and the Required value is “Yes”, “No”:

dest

Destination folder name.

index

If src is specified, then index references a message within that folder. If src is not specified, then index references a message within the current messages collection.

op

If "copy", message is copied, otherwise, message is moved. If not specified, message is moved.

Properties

n/a

Example(s)

n/a

newfolder

Description

Creates a new folder. If an error occurs during processing, the tag body will be evaluated and the remainder of the page will be skipped.

Tag Body

JSP

Restrictions

n/a

Attributes

The tag has the following attributes for which the Type value is “String” and the Required value is “Yes” and “No”:

foldername

Name of the folder to create.

path

If specified, a "/" is appended and the result is prepended to the value specified by foldername.

Properties

n/a

Example(s)

n/a

popcollect

Description

Transfers messages from the POP server described by the Configuration identified by config, to the designated folder on the mail server to which the current mail context has reference. If an error occurs during processing, the tag body will be evaluated and the remainder of the page will be skipped.

Tag Body

JSP

Restrictions

n/a

Attributes

The tag has the following attributes for which the Type value is “String” and the Required value is “Yes”:

config

Name of the Configuration that references a POP server.

Properties

n/a

Example(s)

n/a

presetmsg

Description

The presetmsg tag provides access to the preset message properties of the current message in the preset messages collection.

Tag Body

JSP

Restrictions

Unlike most bean tags, the presetmsg tag can only be used with the presetmsgs collection tag to provide a handle on the current preset message in the collection.

Attributes

None

Properties

The tag provides the following bean properties for which the Type values are “String”, “Integer” and the Required value is “Get/Set”:

msg

Text of the preset message.

number

Number of the preset message.

Example(s)

<%-- list all the preset messages --%>
<mail:presetmsgs iterate="true">
	<mail:presetmsg>
	preset msg text = <mail:get property="msg"/>
	</mail:presetmsg>
</mail:presetmsgs>

presetmsgs

Description

This tag provides access to the collection of preset messages. The tag body will be evaluated once for each item in the collection, unless constrained by the start and count properties. The start and count properties should only be set when the iterate attribute is set to "false".

Tag Body

JSP

Restrictions

Use the presetmsg tag to access the current preset message item in the collection iteration.

Attributes

The tag has the following attributes for which the Required value is “No”:

id

Name of the presetmsgs collection to create.

name

Name of the presetmsgs collection to use.

iterate

A boolean that selects iteration. Default is "false", the collection will not iterate.

beanid

During iteration, specifies a name by which the current bean may be retrieved from the PageContext.

Properties

The tag provides the following bean properties for which the Type values are “Boolean”, “Integer” and the Required value is “Get/Set”:

index

Index of the current bean in the collection.

count

The number of iterations the collection should perform.

start

The zero-based index from which to begin iteration.

end

The zero-based index that denotes the item upon which iteration will terminate.

startOne

One-based start; suitable for presentation.

endOne

One-based end; suitable for presentation.

size

The size of the collection being paged.

nextPage

Whether or not there are more items in the collection, beyond the current iterations.

prevPage

Whether there are items in the collection preceding the current iterations.

Example(s)

<%-- list all the preset messages --%>
<mail:presetmsgs iterate="true">
	<mail:presetmsg>
	preset msg text = <mail:get property="msg"/>
	</mail:presetmsg>
</mail:presetmsgs>

renamefolder

Description

Renames a folder.  If an error occurs during processing, the tag body will be evaluated and the remainder of the page will be skipped.

Tag Body

JSP

Restrictions

n/a

Attributes

This tag has the following attributes for which the Required values are “Yes” and “No”:

foldername

Specifies the new name of the folder.

oldname

Specifies the name of the folder to be renamed.

path

If specified, a "/" is appended and the result is prepended to the value specified by foldername.

Properties

n/a

Example(s)

n/a

sendmessage

Description

Sends an email message. If an error occurs during processing, the tag body will be evaluated and the remainder of the page will be skipped.

Tag Body

JSP

Restrictions

None.

Attributes

The tag has the following attributes for which the Required values are “Yes” and “No”:

masgname

Name of Message bean relating to message to send.

fwdindex

Specifies index of message to forward.

replyindex

Specified index of message to reply to.

Properties

n/a

Example(s)

<%-- sendmessage tag example --%>
...
<mail:context/>
...
<mail:message id="foo">
	<mail:set property="to" value="$(to)"/>
	<mail:set property="subject" value="$(subject)"/>
	<mail:set property="text" value="$(text)"/>
</mail:message>
...
<mail:sendmessage msgname="foo">
<p>Fail.
</mail:sendmessage>
...

set

Description

This tag updates the specified property. It operates exactly like the <util:set> tag and is imported into the mail taglib for convenience. See the util:set tag description for details on how to use this tag.

Tag Body

util:set

Restrictions

util:set

Attributes

util:set

Properties

util:set

Example(s)

<%-- set the message subject property --%>
<mail:message>
	<mail:set property="subject" value="new subject"/>
</mail:message>

view

Description

This tag denotes reference to the current view bean within an enclosing <mail:views> tag. A view bean may be created and/or referenced by the use of the id or name attributes. The body of this tag may contain get/set tags that will generate output derived from the contents of this bean tag.

Tag Body

JSP

Tag Parent

<mailPrefix:views>

Restrictions

None.

Attributes

This tag has the following attributes for which the Required value is “No”:

id

Name of the bean to create.

name

Name of the bean to use.

Properties

This tag provides the following bean properties for which the Type values are “String”, Integer, and the Access value is “Get”:

name

None

index

None

Example(s)

n/a

views

Description

The tag denotes reference to a collection of views. This tag will iterate upon its body until the collection is exhausted, or as constrained by the start and count properties. The start and count properties should only be set when the iterate attribute is set to "false".

Tag Body

JSP

Tag Parent

n/a

Restrictions

None.

Attributes

The tag has the following attributes for which the Required value is “No”:

id

Name of the views collection to create.

name

Name of the views collection to use.

iterate

A boolean that selects iteration. Default is "false", the collection will not iterate.

beanid

During iteration, specifies a name by which the current bean may be retrieved from the PageContext.

Properties

The tag provides the following bean properties for which the Type values are “Integer”, “Boolean” and the Access value is “Get/Set”:

index

Index of the current bean in the collection.

count

The number of iterations the collection should perform.

start

The zero based index from which to begin iteration.

end

The zero based index that denotes the item upon which iteration will terminate.

startOne

One-based start; suitable for presentation.

endOne

One-based end; suitable for presentation.

size

The size of the collection being paged.

nextPage

Whether or not there are more items in the collection, beyond the current iterations.

prevPage

Whether there are items in the collection preceding the current iterations.

Example(s)

n/a