|
Oracle Outside In Java API Reference 8.5.4 E91699-01 |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object
com.oracle.outsidein.options.MailHeaders
public class MailHeaders
Contains listings of e-mail headers to render or exclude when transforming source documents that contain e-mail file formats.
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 |
---|
public MailHeaders()
MailHeaders
instance with STANDARD
headers as the initial valuepublic MailHeaders(MailHeaders.BaselineValue baseline)
MailHeaders
object made up of only the headers defined by the specified baseline.
baseline
- the preset group of headers to useMethod Detail |
---|
public MailHeaders.BaselineValue getBaseline()
public void setBaseline(MailHeaders.BaselineValue baseline)
baseline
- the initial set of headers to use as the baselinepublic MailHeaders includeHeader(MailHeaders.MailTypeValue mtype, MailHeaders.MailHeaderValue mhdr)
mtype
- type of e-mail message to include the headermhdr
- the header to includepublic MailHeaders excludeHeader(MailHeaders.MailTypeValue mtype, MailHeaders.MailHeaderValue mhdr)
mtype
- type of e-mail message to exclude the headermhdr
- the header to excludepublic MailHeaders includeHeader(MailHeaders.MailTypeValue mtype, java.lang.String hdrName, java.lang.String hdrValue)
hdrName
already exists in the included headers, the value will be overwritten by the new value.mtype
- type of e-mail message to include the custom e-mail headerhdrName
- the field name of the custom e-mail headerhdrValue
- the value of the custom e-mail headerpublic MailHeaders excludeHeader(MailHeaders.MailTypeValue mtype, java.lang.String hdrName)
hdrName
already exists in the excluded headers, the value will be overwritten by the new value.mtype
- type of e-mail message to exclude the custom e-mail headerhdrName
- the field name of the custom e-mail headerpublic void setVisibleHeaders(java.util.Map<MailHeaders.MailTypeValue,java.util.Map<java.lang.String,java.lang.String>> headers)
headers
- a mapping of e-mail types and their associated map of header names and values that should be included during renderingpublic void setHiddenHeaders(java.util.Map<MailHeaders.MailTypeValue,java.util.List<java.lang.String>> headers)
headers
- a mapping of e-mail types and their associated list of custom headers that should be excluded during rendering
|
Oracle Outside In Java API Reference 8.5.4 E91699-01 |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |