Skip navigation links

com.oracle.outsidein.options
Class MailHeaders

java.lang.Object
com.oracle.outsidein.options.MailHeaders

public class MailHeaders

extends java.lang.Object

Contains listings of e-mail headers to render or exclude when transforming source documents that contain e-mail file formats.

See Also:

OptionsCache.getEmailHeaders(), OptionsCache.setEmailHeaders(MailHeaders)

Nested Class Summary

static class	MailHeaders.BaselineValue The initial set of headers that make up the baseline.
static class	MailHeaders.MailHeaderValue The available fields in a mail message.
static class	MailHeaders.MailTypeValue The type(s) of mail documents in which to either show or hide headers

Constructor Summary

MailHeaders()
Creates a MailHeaders instance with STANDARD headers as the initial value

MailHeaders(MailHeaders.BaselineValue baseline)
Creates a MailHeaders object made up of only the headers defined by the specified baseline.

Method Summary

MailHeaders	excludeHeader(MailHeaders.MailTypeValue mtype, MailHeaders.MailHeaderValue mhdr) Indicates a specific e-mail header to exclude for the specified type of e-mails.
MailHeaders	excludeHeader(MailHeaders.MailTypeValue mtype, java.lang.String hdrName) Indicates a custom e-mail header to exclude for the specified type of e-mails.
MailHeaders.BaselineValue	getBaseline() Obtains the baseline set of headers.
MailHeaders	includeHeader(MailHeaders.MailTypeValue mtype, MailHeaders.MailHeaderValue mhdr) Indicates a specific e-mail header to include for the specified type of e-mails.
MailHeaders	includeHeader(MailHeaders.MailTypeValue mtype, java.lang.String hdrName, java.lang.String hdrValue) Indicates a custom e-mail header to include for the specified type of e-mails.
void	setBaseline(MailHeaders.BaselineValue baseline) Specifies a preset group of headers to use as the initial baseline.
void	setHiddenHeaders(java.util.Map<MailHeaders.MailTypeValue,java.util.List<java.lang.String>> headers) Assigns a group of custom headers to exclude when rendering source documents that are or contain an e-mail file format.
void	setVisibleHeaders(java.util.Map<MailHeaders.MailTypeValue,java.util.Map<java.lang.String,java.lang.String>> headers) Assigns a group of custom headers to include when rendering source documents that are or contain an e-mail file format.

Methods inherited from class java.lang.Object

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

Constructor Detail

MailHeaders

public MailHeaders()

Creates a MailHeaders instance with STANDARD headers as the initial value

MailHeaders

public MailHeaders(MailHeaders.BaselineValue baseline)

Creates a MailHeaders object made up of only the headers defined by the specified baseline.

Parameters:

baseline - the preset group of headers to use

Method Detail

getBaseline

public MailHeaders.BaselineValue getBaseline()

Obtains the baseline set of headers.

Returns:

the current baseline headers

setBaseline

public void setBaseline(MailHeaders.BaselineValue baseline)

Specifies a preset group of headers to use as the initial baseline.

Parameters:

baseline - the initial set of headers to use as the baseline

includeHeader

public MailHeaders includeHeader(MailHeaders.MailTypeValue mtype,
                                 MailHeaders.MailHeaderValue mhdr)

Indicates a specific e-mail header to include for the specified type of e-mails.

Parameters:

mtype - type of e-mail message to include the header

mhdr - the header to include

excludeHeader

public MailHeaders excludeHeader(MailHeaders.MailTypeValue mtype,
                                 MailHeaders.MailHeaderValue mhdr)

Indicates a specific e-mail header to exclude for the specified type of e-mails.

Parameters:

mtype - type of e-mail message to exclude the header

mhdr - the header to exclude

includeHeader

public MailHeaders includeHeader(MailHeaders.MailTypeValue mtype,
                                 java.lang.String hdrName,
                                 java.lang.String hdrValue)

Indicates a custom e-mail header to include for the specified type of e-mails. If a custom header with the same hdrName already exists in the included headers, the value will be overwritten by the new value.

Parameters:

mtype - type of e-mail message to include the custom e-mail header

hdrName - the field name of the custom e-mail header

hdrValue - the value of the custom e-mail header

excludeHeader

public MailHeaders excludeHeader(MailHeaders.MailTypeValue mtype,
                                 java.lang.String hdrName)

Indicates a custom e-mail header to exclude for the specified type of e-mails. If a custom header with the same hdrName already exists in the excluded headers, the value will be overwritten by the new value.

Parameters:

mtype - type of e-mail message to exclude the custom e-mail header

hdrName - the field name of the custom e-mail header

setVisibleHeaders

public void setVisibleHeaders(java.util.Map<MailHeaders.MailTypeValue,java.util.Map<java.lang.String,java.lang.String>> headers)

Assigns a group of custom headers to include when rendering source documents that are or contain an e-mail file format. All previously defined included headers will be cleared and replaced by the headers passed to this method.

Parameters:

headers - a mapping of e-mail types and their associated map of header names and values that should be included during rendering

setHiddenHeaders

public void setHiddenHeaders(java.util.Map<MailHeaders.MailTypeValue,java.util.List<java.lang.String>> headers)

Assigns a group of custom headers to exclude when rendering source documents that are or contain an e-mail file format. All previously defined excluded headers will be cleared and replaced by the headers passed to this method.

Parameters:

headers - a mapping of e-mail types and their associated list of custom headers that should be excluded during rendering

Skip navigation links