Package org.faceless.publisher.ext

Interface MailExtension.Configuration

Enclosing class:

MailExtension

public static interface MailExtension.Configuration

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()

Method Summary

Modifier and Type	Method	Description
void	apply(MailExtension.Message message, Report report)	Apply the supplied MailExtension.MyMessage to the Report.
void	augmentJson(Json json, org.faceless.publisher.ext.MailExtension.Part part)	Modify the Json returned from MailExtension.Part.toJson(org.faceless.publisher.ext.MailExtension.Configuration)
List<String>	getNames()	Return the list of names that this Configuration is known by
Map<String,String>	getProperties()	Return a list of properties to include in the message

Method Details

getNames

List<String> getNames()

Return the list of names that this Configuration is known by

apply

void apply(MailExtension.Message message,
 Report report)
    throws IOException

Apply the supplied MailExtension.MyMessage to the Report. By default this method creates metadata by calling the #getMetadata method, optionally wrapps the HTML by calling #wrapXHTML, adds the parts returned by MyMessage#getParts to the ResourceLoader used by the Report, then loads the main part for conversion

Parameters:

message - the MailExtension.MyMessage to read as input

report - the Report to write to as output.

Throws:

IOException

getProperties

Map<String,String> getProperties()

Return a list of properties to include in the message

augmentJson

void augmentJson(Json json,
 org.faceless.publisher.ext.MailExtension.Part part)

Modify the Json returned from MailExtension.Part.toJson(org.faceless.publisher.ext.MailExtension.Configuration)

Parameters:

json - the output of MailExtension.Part.toJson(org.faceless.publisher.ext.MailExtension.Configuration)

part - the part object