org.apache.james.mailetcontainer.impl

Class JamesMailetContext

java.lang.Object

org.apache.james.mailetcontainer.impl.JamesMailetContext

All Implemented Interfaces:

Configurable, LogEnabled, org.apache.mailet.MailetContext

public class JamesMailetContext
extends Object
implements org.apache.mailet.MailetContext, LogEnabled, Configurable

Field Summary

Fields

Modifier and Type	Field and Description
protected DNSService	dns
protected org.slf4j.Logger	log

Constructor Summary

Constructors

Constructor and Description
JamesMailetContext()

Method Summary

Methods

Modifier and Type	Method and Description
void	bounce(org.apache.mailet.Mail mail, String message) This generates a response to the Return-Path address, or the address of the message's sender if the Return-Path is not available.
void	bounce(org.apache.mailet.Mail mail, String message, org.apache.mailet.MailAddress bouncer) This generates a response to the Return-Path address, or the address of the message's sender if the Return-Path is not available.
void	configure(org.apache.commons.configuration.HierarchicalConfiguration config) Configure the object.
Object	getAttribute(String key)
Iterator<String>	getAttributeNames()
Collection<String>	getMailServers(String host)
int	getMajorVersion()
int	getMinorVersion()
org.apache.mailet.MailAddress	getPostmaster()
String	getServerInfo()
Iterator<org.apache.mailet.HostAddress>	getSMTPHostAddresses(String domainName) Performs DNS lookups as needed to find servers which should or might support SMTP.
boolean	isLocalEmail(org.apache.mailet.MailAddress mailAddress)
boolean	isLocalServer(String name)
boolean	isLocalUser(String name)
void	log(String arg0)
void	log(String arg0, Throwable arg1)
void	removeAttribute(String key)
void	sendMail(org.apache.mailet.Mail mail) TODO: Should we use the MailProcessorList or the MailQueue here ?
void	sendMail(org.apache.mailet.MailAddress sender, Collection recipients, javax.mail.internet.MimeMessage message)
void	sendMail(org.apache.mailet.MailAddress sender, Collection recipients, javax.mail.internet.MimeMessage message, String state)
void	sendMail(javax.mail.internet.MimeMessage message) Place a mail on the spool for processing
void	setAttribute(String key, Object object)
void	setDNSService(DNSService dns)
void	setDomainList(DomainList domains)
void	setLog(org.slf4j.Logger log) Sets the service log.
void	setMailProcessor(MailProcessor processorList)
void	setUsersRepository(UsersRepository localusers)
void	storeMail(org.apache.mailet.MailAddress sender, org.apache.mailet.MailAddress recipient, javax.mail.internet.MimeMessage msg) Deprecated. since 2.2.0 look at the LocalDelivery code to find out how to do the local delivery.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

dns

protected DNSService dns

log

protected org.slf4j.Logger log

Constructor Detail

JamesMailetContext

public JamesMailetContext()

Method Detail

setMailProcessor

public void setMailProcessor(MailProcessor processorList)

setDNSService

public void setDNSService(DNSService dns)

setUsersRepository

public void setUsersRepository(UsersRepository localusers)

setDomainList

public void setDomainList(DomainList domains)

getMailServers

public Collection<String> getMailServers(String host)

Specified by:

getMailServers in interface org.apache.mailet.MailetContext

See Also:

MailetContext.getMailServers(String)

getAttribute

public Object getAttribute(String key)

Specified by:

getAttribute in interface org.apache.mailet.MailetContext

See Also:

MailetContext.getAttribute(java.lang.String)

setAttribute

public void setAttribute(String key,
                Object object)

Specified by:

setAttribute in interface org.apache.mailet.MailetContext

See Also:

MailetContext.setAttribute(java.lang.String, java.lang.Object)

removeAttribute

public void removeAttribute(String key)

Specified by:

removeAttribute in interface org.apache.mailet.MailetContext

See Also:

MailetContext.removeAttribute(java.lang.String)

getAttributeNames

public Iterator<String> getAttributeNames()

Specified by:

getAttributeNames in interface org.apache.mailet.MailetContext

See Also:

MailetContext.getAttributeNames()

bounce

public void bounce(org.apache.mailet.Mail mail,
          String message)
            throws javax.mail.MessagingException

This generates a response to the Return-Path address, or the address of the message's sender if the Return-Path is not available. Note that this is different than a mail-client's reply, which would use the Reply-To or From header. This will send the bounce with the server's postmaster as the sender.

Specified by:

bounce in interface org.apache.mailet.MailetContext

Throws:

javax.mail.MessagingException

See Also:

MailetContext.bounce(Mail, String)

bounce

public void bounce(org.apache.mailet.Mail mail,
          String message,
          org.apache.mailet.MailAddress bouncer)
            throws javax.mail.MessagingException

This generates a response to the Return-Path address, or the address of the message's sender if the Return-Path is not available. Note that this is different than a mail-client's reply, which would use the Reply-To or From header.

Bounced messages are attached in their entirety (headers and content) and the resulting MIME part type is "message/rfc822".

The attachment to the subject of the original message (or "No Subject" if there is no subject in the original message)

There are outstanding issues with this implementation revolving around handling of the return-path header.

MIME layout of the bounce message:

multipart (mixed)/ contentPartRoot (body) = mpContent (alternative)/ part (body) = message part (body) = original

Specified by:

bounce in interface org.apache.mailet.MailetContext

Throws:

javax.mail.MessagingException

See Also:

MailetContext.bounce(Mail, String, MailAddress)

isLocalUser

public boolean isLocalUser(String name)

Specified by:

isLocalUser in interface org.apache.mailet.MailetContext

See Also:

MailetContext.isLocalUser(String)

isLocalEmail

public boolean isLocalEmail(org.apache.mailet.MailAddress mailAddress)

Specified by:

isLocalEmail in interface org.apache.mailet.MailetContext

See Also:

MailetContext.isLocalEmail(org.apache.mailet.MailAddress)

getPostmaster

public org.apache.mailet.MailAddress getPostmaster()

Specified by:

getPostmaster in interface org.apache.mailet.MailetContext

See Also:

MailetContext.getPostmaster()

getMajorVersion

public int getMajorVersion()

Specified by:

getMajorVersion in interface org.apache.mailet.MailetContext

See Also:

MailetContext.getMajorVersion()

getMinorVersion

public int getMinorVersion()

Specified by:

getMinorVersion in interface org.apache.mailet.MailetContext

See Also:

MailetContext.getMinorVersion()

getSMTPHostAddresses

public Iterator<org.apache.mailet.HostAddress> getSMTPHostAddresses(String domainName)

Performs DNS lookups as needed to find servers which should or might support SMTP. 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.

Specified by:

getSMTPHostAddresses in interface org.apache.mailet.MailetContext

Parameters:

domainName - - the domain for which to find mail servers

Returns:

an Iterator over HostAddress instances, sorted by priority

Since:

Mailet API v2.2.0a16-unstable

See Also:

DNSService.getHostName(java.net.InetAddress)

getServerInfo

public String getServerInfo()

Specified by:

getServerInfo in interface org.apache.mailet.MailetContext

See Also:

MailetContext.getServerInfo()

isLocalServer

public boolean isLocalServer(String name)

Specified by:

isLocalServer in interface org.apache.mailet.MailetContext

See Also:

MailetContext.isLocalServer(java.lang.String)

log

public void log(String arg0)

Specified by:

log in interface org.apache.mailet.MailetContext

See Also:

MailetContext.log(java.lang.String)

log

public void log(String arg0,
       Throwable arg1)

Specified by:

log in interface org.apache.mailet.MailetContext

See Also:

MailetContext.log(java.lang.String, java.lang.Throwable)

sendMail

public void sendMail(javax.mail.internet.MimeMessage message)
              throws javax.mail.MessagingException

Place a mail on the spool for processing

Specified by:

sendMail in interface org.apache.mailet.MailetContext

Parameters:

message - the message to send

Throws:

javax.mail.MessagingException - if an exception is caught while placing the mail on the spool

sendMail

public void sendMail(org.apache.mailet.MailAddress sender,
            Collection recipients,
            javax.mail.internet.MimeMessage message)
              throws javax.mail.MessagingException

Specified by:

sendMail in interface org.apache.mailet.MailetContext

Throws:

javax.mail.MessagingException

See Also:

MailetContext.sendMail(org.apache.mailet.MailAddress, java.util.Collection, javax.mail.internet.MimeMessage)

sendMail

public void sendMail(org.apache.mailet.Mail mail)
              throws javax.mail.MessagingException

TODO: Should we use the MailProcessorList or the MailQueue here ?

Specified by:

sendMail in interface org.apache.mailet.MailetContext

Throws:

javax.mail.MessagingException

See Also:

MailetContext.sendMail(org.apache.mailet.Mail)

sendMail

public void sendMail(org.apache.mailet.MailAddress sender,
            Collection recipients,
            javax.mail.internet.MimeMessage message,
            String state)
              throws javax.mail.MessagingException

Specified by:

sendMail in interface org.apache.mailet.MailetContext

Throws:

javax.mail.MessagingException

See Also:

MailetContext.sendMail(org.apache.mailet.MailAddress, java.util.Collection, javax.mail.internet.MimeMessage, java.lang.String)

storeMail

public void storeMail(org.apache.mailet.MailAddress sender,
             org.apache.mailet.MailAddress recipient,
             javax.mail.internet.MimeMessage msg)
               throws javax.mail.MessagingException

Deprecated. since 2.2.0 look at the LocalDelivery code to find out how to do the local delivery.

This method has been moved to LocalDelivery (the only client of the method). Now we can safely remove it from the Mailet API and from this implementation of MailetContext.

The local field localDeliveryMailet will be removed when we remove the storeMail method.

Specified by:

storeMail in interface org.apache.mailet.MailetContext

Throws:

javax.mail.MessagingException

See Also:

MailetContext.storeMail(org.apache.mailet.MailAddress, org.apache.mailet.MailAddress, javax.mail.internet.MimeMessage)

setLog

public void setLog(org.slf4j.Logger log)

Description copied from interface: LogEnabled

Sets the service log.

Specified by:

setLog in interface LogEnabled

Parameters:

log - not null

See Also:

LogEnabled.setLog(org.slf4j.Logger)

configure

public void configure(org.apache.commons.configuration.HierarchicalConfiguration config)
               throws org.apache.commons.configuration.ConfigurationException

Description copied from interface: Configurable

Configure the object. Be aware that no services are injected when this is called. If you need to access injected stuff do it in a method annotated with @PostConstruct

Specified by:

configure in interface Configurable

Throws:

org.apache.commons.configuration.ConfigurationException

See Also:

Configurable.configure(HierarchicalConfiguration)