org.nhindirect.gateway.smtp

Interface SmtpAgent

All Known Implementing Classes:

DefaultSmtpAgent

public interface SmtpAgent

The SmtpAgent is a generic gateway to the security trust agent that handles message over the SMTP protocol. It is intended to sit between an SMTP server implementation coupled with an server specific bridge and the security trust bridge. Because each SMTP server potentially handles custom message processing differently and creates server specific message/SMTP envelope wrappers, bridge implementations are specific to the servers that they are coupled with. The bridges are responsible for intercepting messages through the SMTP stack, gathers routing information (either from the message routing headers or the SMTP envelope headers), calling the SmtpAgent, and moving processed messages forward through the SMTP stack. Bridges are also responsible for relaying any bounce messages created by the SmtpAgent. NOTE: Bounce messages are also processed by the security and trust agent before being returned.

Author:

Greg Meyer

Method Summary

Modifier and Type	Method and Description
org.nhindirect.stagent.NHINDAgent	getAgent() Gets a references to the security and trust agent used by the SmtpAgent.
SmtpAgentSettings	getSmtpAgentSettings() Gets the configuration settings of the SmtpAgent.
MessageProcessResult	processMessage(javax.mail.internet.MimeMessage message, org.nhindirect.stagent.NHINDAddressCollection recipients, org.nhindirect.stagent.NHINDAddress sender) Processes an message from an SMTP stack.

Method Detail

processMessage

MessageProcessResult processMessage(javax.mail.internet.MimeMessage message,
                                    org.nhindirect.stagent.NHINDAddressCollection recipients,
                                    org.nhindirect.stagent.NHINDAddress sender)

Processes an message from an SMTP stack. The bridge component between the SMTP stack and the SMTP agent is responsible for extracting the message, the recipient list, and the sender. In some cases, the routing headers may have different information than what is populated in the SMTP MAIL FROM and RCTP TO headers. In these cases, the SMTP headers should be favored over the routing headers in the message and passed as the recipient collection and sender to this method.

Parameters:

message - The message in the SMTP envelope.

recipients - The recipients of the message. The RCTP TO headers should be used over the message routing headers.

sender - The send of the message. The MAIL FROM header should be used over the From: routing header in the message.

getAgent

org.nhindirect.stagent.NHINDAgent getAgent()

Gets a references to the security and trust agent used by the SmtpAgent.

Returns:

A references to the security and trust agent used by the SmtpAgent

getSmtpAgentSettings

SmtpAgentSettings getSmtpAgentSettings()

Gets the configuration settings of the SmtpAgent.

Returns:

The configuration settings of the SmtpAgent.