oracle.ifs.protocols.email.beans

Class Rfc822Message

java.lang.Object

oracle.ifs.beans.LibraryObject

oracle.ifs.beans.TieLibraryObject

oracle.ifs.beans.PublicObject

oracle.ifs.beans.TiePublicObject

oracle.ifs.beans.Document

oracle.ifs.beans.TieDocument

oracle.ifs.protocols.email.beans.Rfc822Message

All Implemented Interfaces:

Comparable, IfsEventHandler, LibraryObjectInterface, LooselyBoundedCacheable, PublicObjectInterface, Traceable, MessageInterface

Direct Known Subclasses:

TieRfc822Message

public class Rfc822Message
extends TieDocument
implements MessageInterface

The Rfc822Message class is the main class to handle iFS email objects. All emails are accesible only through this class. This class in turn has relationships to a number of other objects that make up a message

Version:

1.0

Author:

Scott Harrison

(Published)

Field Summary

Fields

Modifier and Type	Field and Description
static String	ANSWERED_ATTRIBUTE Name of the Answered Attribute
static String	BCCADDRESS_ATTRIBUTE Name of the BccAddress Attribute
static String	CCADDRESS_ATTRIBUTE Name of the CcAddress Attribute
static String	CLASS_NAME This class name for this class.
static String	DRAFT_ATTRIBUTE Name of the Draft Attribute
static String	ENVELOPEFROM_ATTRIBUTE Name of the Sender Attribute
static String	ENVELOPERECIPIENTS_ATTRIBUTE Name of the Sender Attribute
static String	FLAGGED_ATTRIBUTE Name of the Flagged Attribute
static String	FROMADDRESS_ATTRIBUTE Name of the FromAddress Attribute
static String	LOOPDETECTED_ATTRIBUTE Name of the Loop Detected Attribute
static String	MESSAGEUID_ATTRIBUTE Name of the MessageUID Attribute
static String	RECENT_ATTRIBUTE Name of the Recent Attribute
static String	RFC822DATE_ATTRIBUTE Name of the RFC822Date Attribute
static String	RFC822HEADER_ATTRIBUTE Name of the RFC822Header Attribute
static String	RFC822SIZE_ATTRIBUTE Name of the RFC822Size Attribute
static String	SEEN_ATTRIBUTE Name of the Seen Attribute
static String	SENDER_ATTRIBUTE Name of the Sender Attribute
static String	SPAMFLAGS_ATTRIBUTE Name of the Spam Flag Attribute
static String	SUBJECT_ATTRIBUTE Name of the Subject Attribute
static String	TOADDRESS_ATTRIBUTE Name of the ToAddress Attribute

Fields inherited from class oracle.ifs.beans.Document

CONTENTOBJECT_ATTRIBUTE, CONTENTQUOTA_ATTRIBUTE, INITIALLIFECYCLEDATE_ATTRIBUTE, LIFECYCLEDATE_ATTRIBUTE, LIFECYCLEPOLICY_ATTRIBUTE, LIFECYCLEPOLICYENTRYID_ATTRIBUTE, LIFECYCLEPOLICYID_ATTRIBUTE, READBYOWNER_ATTRIBUTE, RETENTIONPOLICY_ATTRIBUTE

Fields inherited from class oracle.ifs.beans.PublicObject

ACL_ATTRIBUTE, CREATEDATE_ATTRIBUTE, CREATOR_ATTRIBUTE, DELETOR_ATTRIBUTE, DESCRIPTION_ATTRIBUTE, EXPIRATIONDATE_ATTRIBUTE, FAMILY_ATTRIBUTE, FLAG_CATEGORY_EXISTS, FLAG_CONFIGURATIONCATEGORY_EXISTS, FLAG_MARKED, FLAG_NOINFERIOR, FLAG_NOSELECT, FLAG_NTFS_ARCHIVE, FLAG_NTFS_HIDDEN, FLAG_NTFS_READONLY, FLAG_NTFS_SYSTEM, FLAG_UNMARKED, FLAGS_ATTRIBUTE, LASTMODIFIER_ATTRIBUTE, LASTMODIFYDATE_ATTRIBUTE, LOCKENTRIES_ATTRIBUTE, LOCKOBJECT_ATTRIBUTE, NAME_ATTRIBUTE, OWNER_ATTRIBUTE, POLICYBUNDLE_ATTRIBUTE, POLICYLISTS_ATTRIBUTE, PRIMARYPARENTFOLDER_ATTRIBUTE, PROPERTYBUNDLE_ATTRIBUTE, RESOLVEDPUBLICOBJECT_ATTRIBUTE, SECURINGPUBLICOBJECT_ATTRIBUTE

Fields inherited from class oracle.ifs.beans.LibraryObject

DOMAIN_UNIQUENAME_DEFAULT_DELIMITER, m_ClassId, m_Id, m_Session

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Rfc822Message(LibrarySession session, Long id, Long classId, S_LibraryObjectData data) Construct a Rfc822Message object - standard variant.

Method Summary

Modifier and Type	Method and Description
void	clearRecent() clearRecent() Clear the recent flag
String[]	getBccList()
BodyPart	getBodyPart() getBodyPart Get the root body part
BodyPart	getBodyPart(String index) getBodyPart Get the indicated body part.
String[]	getCcList()
int	getCount() getCount() Get the number of body parts in the message This is part of the MultipartDataSource interface.
String	getEnvelopeFrom()
String[]	getEnvelopeRecipientList()
String[]	getFromList()
InputStream	getInputStream() getInputStream() Get an input stream representing the data This is part of the DataSource interface.
OutputStream	getOutputStream() getOutputStream() Get an OutputStream to write data to the message.
Date	getReceivedDate()
Date	getRFC822Date() getRFC822Date() Get the RFC822 Date
String[]	getRfc822Header() getBodyPart() Get the indicated body part.
long	getRFC822Size()
String[]	getSenderList()
Dictionary	getSpamFlags() getSpamFlags() Get the Spam Flag list
String	getSubject()
String[]	getToList()
long	getUid() getUid() Get the uid
boolean	inLoop()
boolean	isAnswered() isAnswered() Check is the Answered attribute
boolean	isDraft() isDraft() Check if the message is a draft
boolean	isFlagged() isFlagged() Check if the flagged attribute is true
boolean	isRecent()
boolean	isSeen() isSeen() Check is the message isSeen
boolean	setAnswered(boolean flag) setAnswered() Set the answered attribute
boolean	setDraft(boolean flag) setDraft() Set the draft attribute to be true
boolean	setFlagged(boolean flag) setFlagged() set the flagged attribute
boolean	setSeen(boolean flag) setSeen() Set the seen attribute
protected void	setUid(long uid) setUid() Get the uid

Methods inherited from class oracle.ifs.beans.Document

auditContentRead, auditLifecyclePolicyCleared, auditLifecyclePolicySet, auditLifecycleStateUpdated, auditPublicObjectLocked, auditPublicObjectUnlocked, auditRetentionPolicyCleared, auditRetentionPolicySet, auditUpdated, capabilities, constructDocument, constructDocumentVector, filterContent, generateFilename, generateSummary, generateThemes, getCharacterSet, getClassId, getContentByRandomAccess, getContentModificationDate, getContentObject, getContentQuota, getContentReader, getContentRowId, getContentSize, getContentStream, getCurrentLifecyclePolicyEntry, getFilteredContent, getFormat, getInitialLifecycleDate, getLanguage, getLifecycleDate, getLifecyclePolicy, getLifecycleState, getMedia, getMimeType, getNextLifecyclePolicyEntry, getRandomAccessContent, getRandomAccessContent, getRetentionPolicy, getSummary, getThemes, isBinaryFormat, isReadByOwner, isReadByUser, isValidEventType, postCreate, preCreate, preFree, preUpdate, reportDocumentCreated, reportDocumentFreed, setCharacterSet, setContent, setContentQuota, setFormat, setLanguage, setLifecycleDate, setLifecyclePolicy, setReadByUser, setRetentionPolicy, updateContentByRandomAccess, vectorDocumentElement, vectorToDocumentArray, verifyContentObject

Methods inherited from class oracle.ifs.beans.PublicObject

addAccess, addAttachment, addCategory, addFlags, addMessageList, addRelationship, canAcquireManualLock, canReleaseDavLock, canReleaseLock, canReleaseManualLock, checkAuditViewCapability, checkCapabilities, checkCapability, checkEffectiveAccess, checkEffectiveAccess, checkLockAccess, checkParentFolderCapability, checkVersioned, clearFlags, constructPublicObject, constructPublicObjectArray, constructPublicObjectVector, containsLockEntry, copy, coreAutoFolderingEnabled, createCategories, createDedicatedPolicyPropertyBundle, delete, deriveEffectiveAccessLevel, findAttachmentRelation, findOrAddActivityRecord, findOrAddActivityRecord, findOrAddActor, findOrAddActor, findOrAddMessageList, findOrAddMessageList, free, getAcl, getActivityRecord, getActor, getAllFolderPaths, getAllFolderPaths, getAllFolderPaths, getAnyFolderPath, getAnyFolderPath, getAnyFolderPath, getAttachmentRelation, getAttachmentRelations, getAttachments, getCapabilities, getCategories, getCategories, getCategories, getCategories, getCategories, getCategory, getConsumedStorage, getCreateDate, getCreator, getDefaultAccessLevel, getDefinitionForSimplePropertyUpdates, getDeletor, getDescription, getEffectiveAccessLevel, getEffectiveAccessLevel, getExpirationDate, getFamily, getFirstCategory, getFirstVersion, getFlags, getFolderReferences, getFolderReferences, getFolderReferencesSortSpecification, getLastModifier, getLastModifyDate, getLastVersion, getLeftwardRelationshipObjects, getLeftwardRelationshipObjects, getLeftwardRelationships, getLeftwardRelationships, getLeftwardRelationshipsCount, getLeftwardRelationshipsCount, getLinks, getLockEntries, getLockEntries, getLockObject, getLockRestrictions, getLockTypeAuditProperties, getMessageList, getNextVersion, getOwner, getPolicyBundle, getPolicyLists, getPreviousVersion, getPrimaryFolderPath, getPrimaryFolderPathIds, getPrimaryParentFolder, getPrimaryParentFolder, getRelations, getReservationComment, getReservationDate, getReservor, getResolvedPublicObject, getRestrictingLockEntries, getRightwardRelationshipObjects, getRightwardRelationshipObjects, getRightwardRelationships, getRightwardRelationships, getSecuringPublicObject, getSingletonVersionDescription, getVersionNumber, getVersions, getVersionSeries, getWorkingCopy, grantAccess, handleCopy, handleCreate, handleUnlockAll, hasActivityRecord, hasActor, hasAttachmentRelation, hasCategories, hasCategory, hasConfigurationCategories, hasMessageList, hasNameAttribute, hasPropertyBundleAttribute, isAttachment, isDeleted, isLatestVersion, isLocked, isLockingSupported, isOwner, isReserved, isReservedByCurrentUser, isVersionable, isVersioned, isWorkingCopy, listLeftwardRelationships, listRightwardRelationships, lock, lock, lock, lock, newVersion, postCopy, postSecurityChangedEvent, postUpdate, preCopy, putPolicy, reassociateLinks, removeAllPolicies, removeAttachment, removePolicy, removePolicy, removeRelationship, reserveNext, resetFolderReferences, resolveFolderReferenceSortSpecification, revokeAccess, revokeAllAccess, setAcl, setDescription, setExpirationDate, setFlags, setFolderReferencesSortSpecification, setLockEntries, setLockEntrySecurity, setOwner, setOwnerByName, setPolicyBundle, setPolicyLists, setSecuringPublicObject, toPublicObjectArray, undelete, unlock, unlock, unlockAll, unReserve, updateFlags, updateLock, vectorPublicObjectElement, vectorToPublicObjectArray, verifyAddRelationshipCapability, verifyCapabilities, verifyCapability, verifyDeleteCapability, verifyLockCapability, verifyRemoveRelationshipCapability, verifyUnlockCapability, verifyVersionSeries

Methods inherited from class oracle.ifs.beans.LibraryObject

added, addSimpleProperty, addSimpleProperty, applyProperties, auditCreated, canPurge, checkIfPropertyBundleSupported, checkRequiredAttributeSet, clearCopyContext, clearFreeContext, clearUpdateContext, compareTo, constructIdArray, constructIdArray, constructLibraryObject, constructLibraryObjectVector, createDedicatedPropertyBundle, createInstance, deriveDomainUniqueName, dispose, equals, equals, free, freeAll, get, getAttribute, getAttributeByUpperCaseName, getAttributes, getAttributesByUpperCaseNames, getAuditDomainContext, getAuditEventFolderContext, getClassId, getClassname, getClassName, getClassObject, getCommonName, getCommonNameAndClass, getCopyContext, getCreateContext, getData, getDefinition, getEffectivePolicyListElements, getEventualAttributeByUpperCaseName, getFreeContext, getId, getLabel, getName, getObjectReferenceAttribute, getOperationActionSpecificationContext, getPropertyBundle, getPropertyValue, getPublicObjectAttribute, getResourceString, getResourceString, getSchemaObjectAttribute, getSession, getSessionInterface, getSharedStateFactory, getSimpleObjectAttribute, getSimpleProperties, getSimpleProperty, getSimplePropertyValue, getStringIdentifier, getSystemObjectAttribute, getTraceLogger, getUpdateContext, handleAdminModeChange, handleEvent, handleFree, handleUpdate, hashCode, invalidateState, invokeOperation, invokeOperation, invokeServerMethod, isConnected, isCoreEventPostingEnabled, isInstanceOf, isPersistent, isTraced, lockRows, lookupInstanceLabel, performPostCreateExtensions, performPostFreeExtensions, performPostUpdateExtensions, performPreCreateExtensions, performPreFreeExtensions, performPreUpdateExtensions, postEvent, postEvent, postFree, prePostAuditEvent, putProperty, putProperty, removeAllProperties, removeAllSimpleProperties, removeAllSimpleProperties, removed, removeProperty, removeSimpleProperty, removeSimpleProperty, renderAsRandomAccessContent, renderAsReader, renderAsStream, setAttribute, setAttribute, setAttributes, setAttributes, setCopyContext, setFreeContext, setId, setName, setPropertyBundle, setPropertyValue, setUpdateContext, toString, trace, trustHandleCreate, trustHandleCreateAsAdmin, trustHandleFree, trustHandleFreeAsAdmin, trustHandleUpdate, trustHandleUpdateAsAdmin, update, updateAndExposeDefinition, validatePropertyValues, vectorLibraryObjectElement, vectorToLibraryObjectArray, verifyAdministrationMode, verifyConnected, verifyPersistent, verifySystemUserAccess, verifyTargetObject

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface oracle.ifs.protocols.email.beans.MessageInterface

free, getCreateDate, getId, getLastModifyDate, getName, getSession

Methods inherited from interface oracle.ifs.common.LibraryObjectInterface

getAttributeByUpperCaseName, getClassId, getId, getSessionInterface

Methods inherited from interface oracle.ifs.common.Traceable

getTraceLogger, isTraced, trace

Field Detail

CLASS_NAME

public static final String CLASS_NAME

This class name for this class. Useful for methods that take a class name argument.

See Also:

Constant Field Values

(Published)

ENVELOPEFROM_ATTRIBUTE

public static final String ENVELOPEFROM_ATTRIBUTE

Name of the Sender Attribute

See Also:

Constant Field Values

(Published)

ENVELOPERECIPIENTS_ATTRIBUTE

public static final String ENVELOPERECIPIENTS_ATTRIBUTE

Name of the Sender Attribute

See Also:

Constant Field Values

(Published)

SENDER_ATTRIBUTE

public static final String SENDER_ATTRIBUTE

Name of the Sender Attribute

See Also:

Constant Field Values

(Published)

FROMADDRESS_ATTRIBUTE

public static final String FROMADDRESS_ATTRIBUTE

Name of the FromAddress Attribute

See Also:

Constant Field Values

(Published)

TOADDRESS_ATTRIBUTE

public static final String TOADDRESS_ATTRIBUTE

Name of the ToAddress Attribute

See Also:

Constant Field Values

(Published)

CCADDRESS_ATTRIBUTE

public static final String CCADDRESS_ATTRIBUTE

Name of the CcAddress Attribute

See Also:

Constant Field Values

(Published)

BCCADDRESS_ATTRIBUTE

public static final String BCCADDRESS_ATTRIBUTE

Name of the BccAddress Attribute

See Also:

Constant Field Values

(Published)

SUBJECT_ATTRIBUTE

public static final String SUBJECT_ATTRIBUTE

Name of the Subject Attribute

See Also:

Constant Field Values

(Published)

RFC822DATE_ATTRIBUTE

public static final String RFC822DATE_ATTRIBUTE

Name of the RFC822Date Attribute

See Also:

Constant Field Values

(Published)

RFC822SIZE_ATTRIBUTE

public static final String RFC822SIZE_ATTRIBUTE

Name of the RFC822Size Attribute

See Also:

Constant Field Values

(Published)

MESSAGEUID_ATTRIBUTE

public static final String MESSAGEUID_ATTRIBUTE

Name of the MessageUID Attribute

See Also:

Constant Field Values

(Published)

RECENT_ATTRIBUTE

public static final String RECENT_ATTRIBUTE

Name of the Recent Attribute

See Also:

Constant Field Values

(Published)

SEEN_ATTRIBUTE

public static final String SEEN_ATTRIBUTE

Name of the Seen Attribute

See Also:

Constant Field Values

(Published)

FLAGGED_ATTRIBUTE

public static final String FLAGGED_ATTRIBUTE

Name of the Flagged Attribute

See Also:

Constant Field Values

(Published)

ANSWERED_ATTRIBUTE

public static final String ANSWERED_ATTRIBUTE

Name of the Answered Attribute

See Also:

Constant Field Values

(Published)

SPAMFLAGS_ATTRIBUTE

public static final String SPAMFLAGS_ATTRIBUTE

Name of the Spam Flag Attribute

See Also:

Constant Field Values

(Published)

DRAFT_ATTRIBUTE

public static final String DRAFT_ATTRIBUTE

Name of the Draft Attribute

See Also:

Constant Field Values

(Published)

RFC822HEADER_ATTRIBUTE

public static final String RFC822HEADER_ATTRIBUTE

Name of the RFC822Header Attribute

See Also:

Constant Field Values

(Published)

LOOPDETECTED_ATTRIBUTE

public static final String LOOPDETECTED_ATTRIBUTE

Name of the Loop Detected Attribute

See Also:

Constant Field Values

(Published)

Constructor Detail

Rfc822Message

protected Rfc822Message(LibrarySession session,
                        Long id,
                        Long classId,
                        S_LibraryObjectData data)
                 throws IfsException

Construct a Rfc822Message object - standard variant.

Parameters:

session - current LibrarySession

id - the object ID

data - LibraryObjectData

Throws:

IfsException

(Published)

Method Detail

getUid

public long getUid()
            throws IfsException

getUid() Get the uid

Throws:

IfsException

(Unpublished)

setUid

protected void setUid(long uid)
               throws IfsException

setUid() Get the uid

Throws:

IfsException

(Unpublished)

getEnvelopeFrom

public String getEnvelopeFrom()
                       throws IfsException

Throws:

IfsException

getEnvelopeRecipientList

public String[] getEnvelopeRecipientList()
                                  throws IfsException

Throws:

IfsException

getSenderList

public String[] getSenderList()
                       throws IfsException

Specified by:

getSenderList in interface MessageInterface

Throws:

IfsException

getFromList

public String[] getFromList()
                     throws IfsException

Specified by:

getFromList in interface MessageInterface

Throws:

IfsException

getToList

public String[] getToList()
                   throws IfsException

Specified by:

getToList in interface MessageInterface

Throws:

IfsException

getCcList

public String[] getCcList()
                   throws IfsException

Specified by:

getCcList in interface MessageInterface

Throws:

IfsException

getBccList

public String[] getBccList()
                    throws IfsException

Specified by:

getBccList in interface MessageInterface

Throws:

IfsException

isRecent

public boolean isRecent()
                 throws IfsException

Throws:

IfsException

clearRecent

public void clearRecent()
                 throws IfsException

clearRecent() Clear the recent flag

Throws:

IfsException

(Unpublished)

isSeen

public boolean isSeen()
               throws IfsException

isSeen() Check is the message isSeen

Throws:

IfsException

(Unpublished)

setSeen

public boolean setSeen(boolean flag)
                throws IfsException

setSeen() Set the seen attribute

Throws:

IfsException

(Unpublished)

isDraft

public boolean isDraft()
                throws IfsException

isDraft() Check if the message is a draft

Throws:

IfsException

(Unpublished)

setDraft

public boolean setDraft(boolean flag)
                 throws IfsException

setDraft() Set the draft attribute to be true

Throws:

IfsException

(Unpublished)

isFlagged

public boolean isFlagged()
                  throws IfsException

isFlagged() Check if the flagged attribute is true

Throws:

IfsException

(Unpublished)

setFlagged

public boolean setFlagged(boolean flag)
                   throws IfsException

setFlagged() set the flagged attribute

Throws:

IfsException

(Unpublished)

isAnswered

public boolean isAnswered()
                   throws IfsException

isAnswered() Check is the Answered attribute

Throws:

IfsException

(Unpublished)

setAnswered

public boolean setAnswered(boolean flag)
                    throws IfsException

setAnswered() Set the answered attribute

Throws:

IfsException

(Unpublished)

getSpamFlags

public Dictionary getSpamFlags()
                        throws IfsException

getSpamFlags() Get the Spam Flag list

Throws:

IfsException

(Unpublished)

getReceivedDate

public Date getReceivedDate()
                     throws IfsException

Throws:

IfsException

getRFC822Date

public Date getRFC822Date()
                   throws IfsException

getRFC822Date() Get the RFC822 Date

Throws:

IfsException

(Published)

getSubject

public String getSubject()
                  throws IfsException

Throws:

IfsException

getRFC822Size

public long getRFC822Size()
                   throws IfsException

Throws:

IfsException

getInputStream

public InputStream getInputStream()

getInputStream() Get an input stream representing the data This is part of the DataSource interface.

(Unpublished)

getOutputStream

public OutputStream getOutputStream()
                             throws IOException

getOutputStream() Get an OutputStream to write data to the message. This is part of the DataSource interface.

Throws:

IOException

(Unpublished)

getCount

public int getCount()

getCount() Get the number of body parts in the message This is part of the MultipartDataSource interface.

(Unpublished)

getBodyPart

public BodyPart getBodyPart()
                     throws IfsException

getBodyPart Get the root body part

Returns:

the root BodyPart

Throws:

IfsException

(Published)

getBodyPart

public BodyPart getBodyPart(String index)
                     throws IfsException

getBodyPart Get the indicated body part.

Parameters:

index -

Returns:

BodyPart corresponding to index

Throws:

IfsException

(Published)

getRfc822Header

public String[] getRfc822Header()
                         throws IfsException

getBodyPart() Get the indicated body part. This is part of the MultipartDataSource interface.

Throws:

IfsException

(Unpublished)

inLoop

public boolean inLoop()
               throws IfsException

Throws:

IfsException