| org.apache.mailet.MailetContext
All known Subclasses: org.apache.james.James, org.apache.james.test.mock.mailet.MockMailContext,
| MailetContext | | public interface MailetContext (Code) | | Defines a set of methods that a mailet or matcher uses to communicate
with its mailet container, for example, to send a new message, to
deliver a message locally, or write to a log file.
The MailetContext object is contained within the MailetConfig and
MatcherConfig objects, which the mailet container provides to the
mailets and matchers when they are initialized.
version:
1.0.0, 24/04/1999 |
| Method Summary | |
| void | bounce(Mail mail, String message)
Bounces the message using a standard format with the given message. | | void | bounce(Mail mail, String message, MailAddress bouncer)
Bounces the email message using the provided email address as the
sender of the bounce. | | Object | getAttribute(String name)
Returns the mailet container attribute with the given name, or null
if there is no attribute by that name. | | Iterator | getAttributeNames()
Returns an Iterator containing the attribute names available within
this mailet context. | | Collection | getMailServers(String host)
Returns a Collection of Strings of hostnames or ip addresses that
are specified as mail server listeners for the given hostname. | | int | getMajorVersion()
Returns the major version of the Mailet API that this mailet
container supports. | | int | getMinorVersion()
Returns the minor version of the Mailet API that this mailet
container supports. | | MailAddress | getPostmaster()
Returns the postmaster's address for this mailet context. | | Iterator | getSMTPHostAddresses(String domainName)
Returns an Iterator over HostAddress, a specialized subclass of
javax.mail.URLName, which provides location information for
servers that are specified as mail handlers for the given
hostname. | | String | getServerInfo()
Returns the name and version of the mailet container on which
the mailet is running.
The form of the returned string is servername/versionnumber. | | boolean | isLocalServer(String serverName)
Checks if a server is serviced by mail context
Parameters:
serverName - - name of server. | | boolean | isLocalUser(String userAccount)
Checks if a user account is exists in the mail context.
Parameters:
userAccount - - user identifier. | | void | log(String message)
Writes the specified message to a mailet log file, usually an event
log. | | void | log(String message, Throwable t)
Writes an explanatory message and a stack trace for a given Throwable
exception to the mailet log file. | | void | removeAttribute(String name)
Removes the attribute with the given name from the mailet context. | | void | sendMail(MimeMessage msg)
Send an outgoing message to the top of this mailet container's root queue. | | void | sendMail(MailAddress sender, Collection recipients, MimeMessage msg)
Send an outgoing message to the top of this mailet container's root queue. | | void | sendMail(MailAddress sender, Collection recipients, MimeMessage msg, String state)
Send an outgoing message to the top of this mailet container queue for the
appropriate processor that is specified. | | void | sendMail(Mail mail)
Send an outgoing message to the top of this mailet container's root queue. | | void | setAttribute(String name, Object object)
Binds an object to a given attribute name in this mailet context. | | void | storeMail(MailAddress sender, MailAddress recipient, MimeMessage msg)
Stores the message is in the local repository associated with
recipient for later retrieval, e.g., by a POP3 or IMAP service. |
| bounce | | void bounce(Mail mail, String message) throws MessagingException(Code) | | Bounces the message using a standard format with the given message.
The message will be sent back to the sender from the postmaster as specified for
this mailet context, adding message to top of mail server queue using
sendMail().
Parameters:
mail - - the message that is to be bounced and sender to whom to return the message
Parameters:
message - - a descriptive message as to why the message bounced |
| bounce | | void bounce(Mail mail, String message, MailAddress bouncer) throws MessagingException(Code) | | Bounces the email message using the provided email address as the
sender of the bounce.
Parameters:
mail - - the message that is to be bounced and sender to whom to return the message
Parameters:
message - - a descriptive message as to why the message bounced
Parameters:
bouncer - - the address to give as the sender of the bounced message |
| getAttribute | | Object getAttribute(String name)(Code) | | Returns the mailet container attribute with the given name, or null
if there is no attribute by that name. An attribute allows a mailet container
to give the mailet additional information not already provided by this interface.
See your server documentation for information about its attributes. A list of
supported attributes can be retrieved using getAttributeNames.
The attribute is returned as a java.lang.Object or some subclass. Attribute
names should follow the same convention as package names. The Java Mailet API
specification reserves names matching java.*, javax.*, and sun.*
Parameters:
name - - a String specifying the name of the attribute an Object containing the value of the attribute, or null if no attributeexists matching the given name |
| getAttributeNames | | Iterator getAttributeNames()(Code) | | Returns an Iterator containing the attribute names available within
this mailet context. Use the getAttribute(java.lang.String) method with an
attribute name to get the value of an attribute.
an Iterator of attribute names |
| getMailServers | | Collection getMailServers(String host)(Code) | | Returns a Collection of Strings of hostnames or ip addresses that
are specified as mail server listeners for the given hostname.
This is done using MX records, and the hostnames or ip addresses
are returned sorted by MX priority.
Parameters:
host - - the domain name for which to find mail servers a Collection of Strings of hostnames, sorted by priority |
| getMajorVersion | | int getMajorVersion()(Code) | | Returns the major version of the Mailet API that this mailet
container supports. All implementations that comply with Version 1.2 must have
this method return the integer 1.
1 |
| getMinorVersion | | int getMinorVersion()(Code) | | Returns the minor version of the Mailet API that this mailet
container supports. All implementations that comply with Version 1.2 must have
this method return the integer 2.
2 |
| getPostmaster | | MailAddress getPostmaster()(Code) | | Returns the postmaster's address for this mailet context.
a MailAddress of the Postmaster's address |
| getSMTPHostAddresses | | Iterator getSMTPHostAddresses(String domainName)(Code) | | Returns an Iterator over HostAddress, a specialized subclass of
javax.mail.URLName, which provides location information for
servers that are specified as mail handlers for the given
hostname. This is done using MX records, and the HostAddress
instances are returned sorted by MX priority. If no host is
found for domainName, the Iterator returned will be empty and the
first call to hasNext() will return false.
since:
Mailet API v2.2.0a16-unstable
Parameters:
domainName - - the domain for which to find mail servers an Iterator over HostAddress instances, sorted by priority |
| getServerInfo | | String getServerInfo()(Code) | | Returns the name and version of the mailet container on which
the mailet is running.
The form of the returned string is servername/versionnumber. For example,
JAMES may return the string JAMES/1.2.
The mailet container may return other optional information after the primary
string in parentheses, for example, JAMES/1.2 (JDK 1.3.0; Windows NT 4.0 x86).
a String containing at least the mailet container name and version number |
| isLocalServer | | boolean isLocalServer(String serverName)(Code) | | Checks if a server is serviced by mail context
Parameters:
serverName - - name of server. true if server is local, i.e. serviced by this mail context |
| isLocalUser | | boolean isLocalUser(String userAccount)(Code) | | Checks if a user account is exists in the mail context.
Parameters:
userAccount - - user identifier. true if the acount is a local account |
| log | | void log(String message)(Code) | | Writes the specified message to a mailet log file, usually an event
log. The name and type of the mailet log file is specific to the mailet
container.
Parameters:
message - - a String specifying the message to be written to the log file |
| log | | void log(String message, Throwable t)(Code) | | Writes an explanatory message and a stack trace for a given Throwable
exception to the mailet log file.
Parameters:
message - - a String that describes the error or exception
Parameters:
throwable - - the Throwable error or exception |
| removeAttribute | | void removeAttribute(String name)(Code) | | Removes the attribute with the given name from the mailet context. After
removal, subsequent calls to getAttribute(java.lang.String) to retrieve
the attribute's value will return null.
Parameters:
name - - a String specifying the name of the attribute to be removed |
| sendMail | | void sendMail(MimeMessage msg) throws MessagingException(Code) | | Send an outgoing message to the top of this mailet container's root queue.
This is the equivalent of opening an SMTP session to localhost.
This uses sender and recipients as specified in the message itself.
Parameters:
msg - - the MimeMessage of the headers and body content of the outgoing message
throws:
MessagingException - - if the message fails to parse |
| sendMail | | void sendMail(MailAddress sender, Collection recipients, MimeMessage msg) throws MessagingException(Code) | | Send an outgoing message to the top of this mailet container's root queue.
This is the equivalent of opening an SMTP session to localhost.
Parameters:
sender - - the sender of the message
Parameters:
recipients - - a Collection of MailAddress objects of recipients
Parameters:
msg - - the MimeMessage of the headers and body content of the outgoing message
throws:
MessagingException - - if the message fails to parse |
| sendMail | | void sendMail(MailAddress sender, Collection recipients, MimeMessage msg, String state) throws MessagingException(Code) | | Send an outgoing message to the top of this mailet container queue for the
appropriate processor that is specified.
Parameters:
sender - - the sender of the message
Parameters:
recipients - - a Collection of MailAddress objects of recipients
Parameters:
msg - - the MimeMessage of the headers and body content of the outgoing message
Parameters:
state - - the state of the message, indicates which processor to useThis is a String that names a processor for which the message will be queued
throws:
MessagingException - - if the message fails to parse |
| sendMail | | void sendMail(Mail mail) throws MessagingException(Code) | | Send an outgoing message to the top of this mailet container's root queue.
This is the equivalent of opening an SMTP session to localhost.
The Mail object provides all envelope and content information
Parameters:
mail - - the message that is to sent
throws:
MessagingException - - if the message fails to spool |
| setAttribute | | void setAttribute(String name, Object object)(Code) | | Binds an object to a given attribute name in this mailet context. If the name
specified is already used for an attribute, this method will remove the old
attribute and bind the name to the new attribute.
Attribute names should follow the same convention as package names. The Java
Mailet API specification reserves names matching java.*, javax.*, and sun.*.
Parameters:
name - - a String specifying the name of the attribute
Parameters:
object - - an Object representing the attribute to be bound |
| storeMail | | void storeMail(MailAddress sender, MailAddress recipient, MimeMessage msg) throws MessagingException(Code) | | Stores the message is in the local repository associated with
recipient for later retrieval, e.g., by a POP3 or IMAP service.
Parameters:
sender - - the sender of the incoming message
Parameters:
recipient - - the user who is receiving this message (as a complete email address)
Parameters:
msg - - the MimeMessage to store in a local mailbox
throws:
MessagingException - - if the message fails to parse |
|
|