public class MailBodyCreatorNode extends Node
This Node
tries to create the title page for an email that contains the most important
information of the mail header (To, From, CC, subject, ...) and a list of all attachments of this
mail (see AttachmentDirectory
).
If possible (i.e. the given stream is plain text oder HTML) the mail body part is merged together with the title page. Else, they occur in different pages.
Even though this Node
is located on client side, it is not recommended to use it directly
but via the script EmailConversion.groovy
Its worker respects PageCountLimit
s.
Node.Cardinality
Modifier and Type | Field and Description |
---|---|
static String |
BINARY_BODY_PLACEHOLDER_MIMETYPE
MIME type to signalize that the converted mail has a binary body that cannot be treated by this node.
|
static URI |
DEFAULT_STYLE_SHEET |
Constructor and Description |
---|
MailBodyCreatorNode() |
Modifier and Type | Method and Description |
---|---|
AttachmentDirectory |
getAttachmentDirectory() |
StreamDescriptor |
getHeaderInformation() |
URI |
getStyleSheet() |
String |
getWorkerClassName()
Return the node's associated
NodeWorker full qualified class's
name. |
boolean |
isAllowExternalHTTPResolution()
Get whether to allow the resolution (loading) of external HTTP resources.
|
boolean |
isGenerateHyperlinks() |
void |
setAllowExternalHTTPResolution(boolean allowExternalURLResolution)
Set whether to allow the resolution (loading) of external HTTP resources.
|
void |
setAttachmentDirectory(AttachmentDirectory attachmentDirectory) |
void |
setGenerateHyperlinks(boolean generate)
Determine if the resulting PDF document shall have hyperlinks to external locations
(default:
true . |
void |
setHeaderInformation(StreamDescriptor headerInformation)
Set a special
StreamDescriptor if this one contains the header
information that shall be rendered within the mail. |
void |
setStyleSheet(URI styleSheet) |
protected void |
validateConfiguration() |
addTransportReceiver, appendSuccessor, apply, equals, getInputCardinality, getJob, getOutputCardinality, getPredecessors, getSubsidiaryNodes, getSuccessors, getTransportSender, getUUID, hashCode, initialize, prependPredecessor, remove
public static final URI DEFAULT_STYLE_SHEET
public static final String BINARY_BODY_PLACEHOLDER_MIMETYPE
See usage in e.g. EmailConversion.groovy
public String getWorkerClassName()
Node
Return the node's associated
NodeWorker
full qualified class's
name. By default, the worker class name is
This behavior can be overridden in concrete subclasses.
getWorkerClassName
in class Node
public URI getStyleSheet()
public void setStyleSheet(URI styleSheet)
public AttachmentDirectory getAttachmentDirectory()
AttachmentDirectory
that lists all attachment of the
email to renderpublic void setAttachmentDirectory(AttachmentDirectory attachmentDirectory)
public StreamDescriptor getHeaderInformation()
StreamDescriptor
descriptor hat contains the
header information, if this property was set. Else null.public void setHeaderInformation(StreamDescriptor headerInformation)
StreamDescriptor
if this one contains the header
information that shall be rendered within the mail. If not set the
information is taken from the StreamBundle
s
StreamDescriptor
s.headerInformation
- contains the information of the mail headerpublic boolean isAllowExternalHTTPResolution()
true
iff resolution of external HTTP resources is allowed.public void setAllowExternalHTTPResolution(boolean allowExternalURLResolution)
allowExternalURLResolution
- protected void validateConfiguration() throws ConfigurationException
validateConfiguration
in class Node
ConfigurationException
public boolean isGenerateHyperlinks()
public void setGenerateHyperlinks(boolean generate)
true
. This setting is only evaluated for e-mails with HTML body.generate
- if true
hyperlinks will be embedded in the resulting PDF documentCopyright © 2018 levigo holding gmbh. All rights reserved.