|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
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 the mailets and matchers when they are initialized.
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 minor 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. |
String |
getServerInfo()
Returns the name and version of the mailet container on which the mailet is running. |
boolean |
isLocalServer(String serverName)
Checks if a server is serviced by mail context |
boolean |
isLocalUser(String userAccount)
Checks if a user account is exists in the mail context. |
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(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(MimeMessage msg)
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 mail into local accounts (POP3 by default) |
Method Detail |
public void bounce(Mail mail, String message) throws MessagingException
mail
- - the message that is to be bounced and sender to whom to return the messagemessage
- - a descriptive message as to why the message bounced
MessagingException
public void bounce(Mail mail, String message, MailAddress bouncer) throws MessagingException
mail
- - the message that is to be bounced and sender to whom to return the messagemessage
- - a descriptive message as to why the message bouncedbouncer
- - the address to give as the sender of the bounced message
MessagingException
public Collection getMailServers(String host)
host
- - the domain name for which to find mail servers
public MailAddress getPostmaster()
public Object getAttribute(String name)
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.*
name
- - a String specifying the name of the attribute
public Iterator getAttributeNames()
public int getMajorVersion()
public int getMinorVersion()
public String getServerInfo()
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).
public boolean isLocalServer(String serverName)
serverName
- - name of server.
public boolean isLocalUser(String userAccount)
userAccount
- - user identifier.
public void log(String message)
public void log(String message, Throwable t)
message
- - a String that describes the error or exceptionpublic void removeAttribute(String name)
name
- - a String specifying the name of the attribute to be removedpublic void sendMail(MimeMessage msg) throws MessagingException
msg
- - the MimeMessage of the headers and body content of the outgoing message
MessagingException
- - if the message fails to parsepublic void sendMail(MailAddress sender, Collection recipients, MimeMessage msg) throws MessagingException
sender
- - the sender of the messagerecipients
- - a Collection of MailAddress objects of recipientsmsg
- - the MimeMessage of the headers and body content of the outgoing message
MessagingException
- - if the message fails to parsepublic void sendMail(MailAddress sender, Collection recipients, MimeMessage msg, String state) throws MessagingException
sender
- - the sender of the messagerecipients
- - a Collection of MailAddress objects of recipientsmsg
- - the MimeMessage of the headers and body content of the outgoing messagestate
- - the state of the message, indicates which processor to use
MessagingException
- - if the message fails to parsepublic void setAttribute(String name, Object object)
Attribute names should follow the same convention as package names. The Java Mailet API specification reserves names matching java.*, javax.*, and sun.*.
name
- - a String specifying the name of the attributeobject
- - an Object representing the attribute to be boundpublic void storeMail(MailAddress sender, MailAddress recipient, MimeMessage msg) throws MessagingException
sender
- - the sender of the incoming messagerecipient
- - the user who is receiving this message (as a complete email address)msg
- - the MimeMessage to store in a local mailbox
MessagingException
- - if the message fails to parse
|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |