]> JSP taglib encapsulating the JavaMail API.

]]>&tld_description;

Both implementations are interoperable and may be used simultaneously under different prefixes.

The structure of the tags matches that of the underlying JavaMail API with the following mapping:

<email:email> ⟶ Message
<email:to> ⟶ Message.addRecipient(…)
<email:from> ⟶ Message.setFrom(…)
<email:subject> ⟶ Message.setSubject(…)
<email:multipart> ⟶ Multipart
<email:bodypart> ⟶ BodyPart
<email:header> ⟶ Part.addHeader(…) or Part.setHeader(…)
- <email:contentId> ⟶ Sets the Content-ID: header while trimming the body and surrounding with <…>.
<email:content> ⟶ Part.setContent(…)
<email:file> ⟶ Part.setDataHandler(…)
<email:data> ⟶ Part.setDataHandler(…)

The nesting allowed is:

<email:email>
- + <email:to>
- ! <email:from>
- ! <email:subject>
- * <email:header>
- ? <email:contentId>
- ! Exactly one of:
  - ! <email:content>
  - ! <email:file>
  - ! <email:data>
  - ! <email:multipart>
    - + <email:bodypart>
      - * <email:header>
      - ? <email:contentId>
      - ! Exactly one of:
        
        ! <email:content>
        
        ! <email:file>
        
        ! <email:data>
        
        ! <email:multipart>
        
        + …

* indicates zero or more uses allowed
? indicates zero or one use allowed
+ indicates one or more uses required
! indicates exactly one use required

This taglib is part of an extensible suite of interoperable, context-aware, auto-encoding taglibs. All auto-encoding tags generate correct output for their context, provide context information for nested tags, and validate the output of nested tags. For example, <ao:message> within <email:subject> will write its output encoded as TEXT, while within <email:content> (of type "text/html") will write its output encoded as XHTML.

This suite includes, but is not limited to:

]]>

&tld_displayName;

3.0.0

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

The <email:error> and <email:success> tags may be used to determine the results.

]]> email

com.newmediaworks.taglib.email.EmailTag

JSP

The SMTP host to use for sending email. Defaults to the mail.smtp.host system property.

]]> smtpHost false true java.lang.String The SMTP port to use for sending email. Defaults to the mail.smtp.port system property.

]]> smtpPort false true java.lang.Integer When provided, the email will not be sent. Instead, it will be converted to a byte[] binary format and stored in the variable with this name.

]]> var false true java.lang.String Provides the scope of the variable that will be set when the var attribute is provided.

Must be one of:

page (the default)
request
session
application

]]> scope false true java.lang.String The To: recipient of the email. Multiple tags will send email to multiple recipients.

Only allowed within an <email:email> tag.

]]> to

&package;.ToTag

&JSP;

Provides the To: address. When provided, the body is not invoked. When not provided, the body content trimmed will be used as the address

]]> address false true java.lang.String The From: address of the sender of the email.

Only allowed within an <email:email> tag.

]]> from

&package;.FromTag

&JSP;

Provides the From: address. When provided, the body is not invoked. When not provided, the body content will be used as the address.

]]> address false true java.lang.String The Subject: of the email.

Only allowed within an <email:email> tag.

]]> subject

&package;.SubjectTag

&JSP;

The optional charset for the subject.

]]> charset false true java.lang.String Provides the subject. When provided, the body is not invoked. When not provided, the body content trimmed will be used as the subject.

]]> value false true java.lang.String Adds or sets a header value to the email or any of its parts.

Allowed within <email:email> or <email:bodypart> tags.

]]> header

&package;.HeaderTag

&JSP;

The name of the header.

]]> name true true java.lang.String Provides the header value. When provided, the body is not invoked. When not provided, the body content trimmed will be used as the value.

]]> value false true java.lang.String When true (the default), any existing headers will be replaced.

When false, the header will be added to any existing values.

]]> replace false true boolean Sets the Content-ID: header while surrounding with <…>.

Allowed within <email:email> or <email:bodypart> tags.

]]> contentId

&package;.ContentIdTag

&JSP;

Provides the Content-ID: header value, will be surrounding with <…>. When provided, the body is not invoked. When not provided, the body content trimmed will be used as the value.

]]> value false true java.lang.String The body of this tag provides the content to the email or any of its parts.

Leading and trailing whitespace on the content is trimmed.

Allowed within <email:email> or <email:bodypart> tags.

The content type depends on the value provided to the type attribute, and defaults to either text/html or application/xhtml+xml, depending on the current serialization. The content is checked for well-formedness based on its type:

javascript, application/javascript, or text/javascript - no validation
json or application/json - no validation
ld_json or application/ld+json - no validation
text or text/plain - no validation
url or text/url - must be a valid URL
xhtml or application/xhtml+xml - must be well-formed XHTML content. (Note: Currently only checks character values.)
xhtml_attribute or application/xhtml+xml+attribute - must be a valid XHTML attribute.
mysql or text/x+mysql - must be valid for the MySQL command line "mysql"
psql or text/x+psql - must be valid for the PostgreSQL command line "psql"
sh or text/x+sh - must be valid shell script

]]> content

&package;.ContentTag

&JSP;

Specifies the type of content as either short form for a recognized media type or the full MIME type.

Defaults to the content type of the current serialization, which in-turn, defaults to "text/html".

]]> type false true java.lang.String When SGML (the default), sets the content-type to text/html. When XML, sets the content-type to application/xhtml+xml.

]]> serialization false true java.lang.String The <!DOCTYPE> to use, must be one of default, HTML5, STRICT, TRANSITIONAL, FRAMESET, or NONE.

Defaults to default, which is currently HTML5.

Note: The doctype is not written by this tag, however this setting affects the output of nested context-aware tags. To write the doctype, see <ao:html>

]]> doctype false true java.lang.String Reads the contents of this email or part from a file.

Allowed within <email:email> or <email:bodypart> tags.

]]> file

&package;.FileTag

&JSP;

Provides the context path (starting with "/") or page-relative path to the file. When provided, the body is not invoked. When not provided, the body content will be used as the path. The path is not trimmed so be careful of any extra whitespace.

]]> path false true java.lang.String Provides the raw data of this email or part content.

Allowed within <email:email> or <email:bodypart> tags.

]]> data

com.newmediaworks.taglib.email.DataTag

empty

Specifies the type of content as either short form for a recognized media type or the full MIME type.

]]> type true true java.lang.String The filename used for the attached content.

]]> filename false true java.lang.String Must be one of:

]]> data true true java.lang.Object A multipart component of the email.

Must contain one or more nested <email:bodypart> tags.

Allowed within <email:email> or <email:bodypart> tags.

]]> multipart

com.newmediaworks.taglib.email.MultipartTag

JSP

The multipart subtype. Defaults to mixed. Some other values include alternative and related.

]]> subtype false true java.lang.String A single part of a multipart component.

Only allowed within an <email:multipart> tag.

]]> bodypart

com.newmediaworks.taglib.email.BodyPartTag

JSP

The body of this tag will be processed when there was any type of error while formatting or sending the email.

May then use <email:getErrorReason> or ${email:getErrorReason()} to get the reason for the error.

Must follow an <email:email> tag.

]]> error

com.newmediaworks.taglib.email.ErrorTag

JSP

Gets the error reason for an email attempt.

]]> getErrorReason

&package;.GetErrorReasonTag

empty

The body of this tag will be processed when the email was successfully formatted and sent (or stored in a variable).

Must follow an <email:email> tag.

]]> success

com.newmediaworks.taglib.email.SuccessTag

JSP

Gets the error reason for an email attempt.

]]> getErrorReason

com.newmediaworks.taglib.email.Functions

java.lang.String getErrorReason()

${email:getErrorReason()}]]> Determines if the last email resulted in an error.

]]> isError

com.newmediaworks.taglib.email.Functions

boolean isError()

${email:isError()}]]> Determines if the last email was successful.

]]> isSuccess

com.newmediaworks.taglib.email.Functions

boolean isSuccess()

${email:isSuccess()}]]>