Package org.faceless.publisher.ext

Class MailExtension.Configuration

java.lang.Object

org.faceless.publisher.ext.MailExtension.Configuration

Enclosing class:

MailExtension

public abstract static class MailExtension.Configuration
extends Object

A Configuration controls how an arbitrary mail message is converted to input that can be used by BFO Publisher. A number of standard configurations are available, or a custom one can be created that optionally extends an existing configuration.

See Also:

• MailExtension.getAvailableConfigurations()

Constructor Summary

Constructors

Constructor	Description
Configuration()

Method Summary

Modifier and Type	Method	Description
void	apply(MailExtension.ParsedMimeMessage message, Report report)	Apply the supplied MailExtension.ParsedMimeMessage to the Report.
String	getMetadata(MailExtension.ParsedMimeMessage message, Report report)	Return any Metadata to add to the Report as a String.
abstract List<String>	getNames()	Return the list of names that this Configuration is known by
URL2	getTemplate()	Return the URL to use to format the message, or null to use the message without any additional formatting.
String	getTemplateAttachments(MailExtension.ParsedMimeMessage message, Report report)	Return the text to replace ${ATTACHMENTS} in the template loaded from getTemplate() method.
String	getTemplateHeaders(MailExtension.ParsedMimeMessage message, Report report)	Return the text to replace ${HEADERS} in the template loaded from getTemplate() method.
String	wrapXHTML(MailExtension.ParsedMimeMessage message, Report report, AbstractBlob blob)	Given the main part of the message, optionally wrap it in XHTML to include headers, footers and so on.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

Configuration

public Configuration()

Method Details

getNames

public abstract List<String> getNames()

Return the list of names that this Configuration is known by

apply

public void apply(MailExtension.ParsedMimeMessage message,
 Report report)
           throws IOException,
MessagingException

Apply the supplied MailExtension.ParsedMimeMessage to the Report. By default this method creates metadata by calling the getMetadata(org.faceless.publisher.ext.MailExtension.ParsedMimeMessage, org.faceless.publisher.Report) method, optionally wrapps the HTML by calling wrapXHTML(org.faceless.publisher.ext.MailExtension.ParsedMimeMessage, org.faceless.publisher.Report, org.faceless.publisher.type.AbstractBlob), adds the parts returned by MailExtension.ParsedMimeMessage.getParts() to the ResourceLoader used by the Report, then loads the main part for conversion

Parameters:

message - the MailExtension.ParsedMimeMessage to read as input

report - the Report to write to as output.

Throws:

IOException

MessagingException

getMetadata

public String getMetadata(MailExtension.ParsedMimeMessage message,
 Report report)
                   throws IOException,
MessagingException

Return any Metadata to add to the Report as a String. The returned String should be in application/rdf+xml or application/ld+json format.

Parameters:

message - the MailExtension.ParsedMimeMessage to read as input

report - the Report

Throws:

IOException

MessagingException

wrapXHTML

public String wrapXHTML(MailExtension.ParsedMimeMessage message,
 Report report,
 AbstractBlob blob)
                 throws IOException,
MessagingException

Given the main part of the message, optionally wrap it in XHTML to include headers, footers and so on. If the message is to be formatted as supplied, return null. Note the return value is XML, not HTML. The default implementation loads the template from getTemplate() for substitition, and if it's not-null subsitutes the values ${HEADERS}, ${ATTACHMENTS} and ${BODY} with the return values of getTemplateHeaders(org.faceless.publisher.ext.MailExtension.ParsedMimeMessage, org.faceless.publisher.Report), getTemplateAttachments(org.faceless.publisher.ext.MailExtension.ParsedMimeMessage, org.faceless.publisher.Report) and the message content respectively. If the template URL is null or not available, this method returns null.

Parameters:

message - the MailExtension.ParsedMimeMessage to read as input

report - the Report

blob - the main part of the message body, which will usually (but not always) be castable to MailExtension.PartBlob

Returns:

an XHTML string that should be used as the document body instead of the supplied blob, or null to use the blob

Throws:

IOException

MessagingException

getTemplate

public URL2 getTemplate()

Return the URL to use to format the message, or null to use the message without any additional formatting.

getTemplateHeaders

public String getTemplateHeaders(MailExtension.ParsedMimeMessage message,
 Report report)
                          throws IOException,
MessagingException

Return the text to replace ${HEADERS} in the template loaded from getTemplate() method. By default this is a simple table with From, Date, To and Subject set.

Parameters:

message - the message

Returns:

the text to replace ${HEADERS}

Throws:

IOException

MessagingException

getTemplateAttachments

public String getTemplateAttachments(MailExtension.ParsedMimeMessage message,
 Report report)
                              throws IOException,
MessagingException

Return the text to replace ${ATTACHMENTS} in the template loaded from getTemplate() method. By default this is a simple table with From, Date, To and Subject set.

Parameters:

message - the message

Returns:

the text to replace ${HEADERS}

Throws:

IOException

MessagingException