org.nhindirect.stagent

Interface MessageEnvelope

All Known Implementing Classes:

DefaultMessageEnvelope, IncomingMessage, OutgoingMessage

public interface MessageEnvelope

A wrapper around a MimeMessage that categorizes routing headers such as trusted and non trusted recipients.

Author:

Greg Meyer, Umesh Madan

Method Summary

Modifier and Type	Method and Description
void	ensureRecipientsCategorizedByDomain(Collection<String> domains)
NHINDAgent	getAgent() Gets the agent associated with the message.
NHINDAddressCollection	getDomainRecipients() Gets a list of recipients in the message that are part of the agent's domain.
Message	getMessage() Gets the mime message wrapped in the envelope.
Collection<NHINDAddress>	getOtherRecipients() Gets a list of recipients in the message that are not part of the agent's domain.
NHINDAddressCollection	getRecipients() The collection of message recipients.
NHINDAddressCollection	getRejectedRecipients() Gets a list of recipients in the message that are not trusted by the address.
NHINDAddress	getSender() Gets the sender of the message.
boolean	hasDomainRecipients() Indicates if the message has recipients that are in the agent's domain.
boolean	hasOtherRecipients() Indicates if the message has recipients that are not in the agent's domain.
boolean	hasRecipients() Indicates if the message has any recipients.
boolean	hasRejectedRecipients() Indicates if the message has recipients that are not trusted by the address.
String	serializeMessage() Serializes the wrapped message to a raw string representation.

Method Detail

serializeMessage

String serializeMessage()

Serializes the wrapped message to a raw string representation.

Returns:

The wrapped message to as a raw string representation.

getAgent

NHINDAgent getAgent()

Gets the agent associated with the message.

Returns:

The security and trust agent.

getMessage

Message getMessage()

Gets the mime message wrapped in the envelope.

Returns:

the mime message wrapped in the envelope.

getSender

NHINDAddress getSender()

Gets the sender of the message.

Returns:

The sender of the message.

getRecipients

NHINDAddressCollection getRecipients()

The collection of message recipients.

Returns:

Collection of message recipients.

hasRecipients

boolean hasRecipients()

Indicates if the message has any recipients.

Returns:

True if the message has recipients. False otherwise.

getRejectedRecipients

NHINDAddressCollection getRejectedRecipients()

Gets a list of recipients in the message that are not trusted by the address.

Returns:

A list of recipients in the message that are not trusted by the address.

hasRejectedRecipients

boolean hasRejectedRecipients()

Indicates if the message has recipients that are not trusted by the address.

Returns:

True if the message has recipients that are not trusted by the address. False otherwise.

getDomainRecipients

NHINDAddressCollection getDomainRecipients()

Gets a list of recipients in the message that are part of the agent's domain.

Returns:

A list of recipients in the agent's domain.

hasDomainRecipients

boolean hasDomainRecipients()

Indicates if the message has recipients that are in the agent's domain.

Returns:

True if the message has recipients that are in the agent's domain. False otherwise.

getOtherRecipients

Collection<NHINDAddress> getOtherRecipients()

Gets a list of recipients in the message that are not part of the agent's domain.

Returns:

A list of recipients that are not in the agent's domain.

hasOtherRecipients

boolean hasOtherRecipients()

Indicates if the message has recipients that are not in the agent's domain.

Returns:

True if the message has recipients that are not in the agent's domain. False otherwise.

ensureRecipientsCategorizedByDomain

void ensureRecipientsCategorizedByDomain(Collection<String> domains)