org.apache.james.transport.mailets

Class RemoteDelivery

java.lang.Object

org.apache.mailet.base.GenericMailet

org.apache.james.transport.mailets.RemoteDelivery

All Implemented Interfaces:

Runnable, org.apache.mailet.Mailet, org.apache.mailet.MailetConfig

public class RemoteDelivery
extends org.apache.mailet.base.GenericMailet
implements Runnable

The RemoteDelivery mailet delivers messages to a remote SMTP server able to deliver or forward messages to their final destination.

The remote SMTP server through which each mail is delivered is resolved using MX lookup for each message destination unless the <gateway/> parameter is set. The <gateway/> parameter enables the definition of one or more gateway servers through which all messages are sent.

If an attempt to deliver a message fails, a redelivery attempt is scheduled according to the scheme defined by the <delayTime/> parameter, retrying up to the limit defined by the <maxRetries/> parameter. When the retry limit is exceeded, delivery failure is processed according to the setting of the <bounceProcessor/> parameter.

These are the parameters that control the operation of the RemoteDelivery mailet:

• deliveryThreads (required) - an Integer for the number of threads this mailet will use to deliver mail.
• outgoing (required) - a String containing the URL for the repository that will hold messages being processed by this mailet.
• bind (optional) - a String describing the local IP address to which the mailet should be bound while delivering emails. This tag is useful for multihomed machines. Default is to bind to the default local address of the machine.
  Note: The same IP address must be used for all of those RemoteDelivery instances where you explicitly supply a bind address.
• delayTime (optional> a String containing a comma separated list of patterns defining the number of and delays between delivery attempts. The pattern is [attempts\*]delay [unit] where:
  • attempts (optional) - an Integer for the number of delivery attempts. Default is 1.
  • delay (required) - a Long for the delay between attempts.
  • unit (optional) - a String with the value of one of 'msec', 'sec', 'minute', 'hour', or 'day'. Default is msec.
  Default is one attempt after 6 hours, which if explicitly declared would be written as <delayTime>1 * 6 hour</delayTime>
• maxRetries (optional) an Integer for the number of times an attempt is made to deliver a particular mail. Default is the greater of five and the sum of the attempts for each <delayTime/> specified.
• maxDnsProblemRetries (optional) - an Integer for the number of times to retry if DNS problems for a domain occur. Default is 0.
• timeout (optional) - an Integer for the Socket I/O timeout in milliseconds. Default is 180000
• connectionTimeout (optional) - an Integer for the Socket connection timeout in milliseconds. Default is 60000
• bounceProcessor (optional) - a String containing the name of the mailet processor to pass messages that cannot be delivered to for DSN bounce processing. Default is to send a traditional message containing the bounce details.
• startTLS (optional) - a Boolean (true/false) indicating whether the STARTTLS command (if supported by the server) to switch the connection to a TLS-protected connection before issuing any login commands. Default is false.
• sslEnable (optional) - a Boolean (true/false) indicating whether to use SSL to connect and use the SSL port unless explicitly overridden. Default is false.
• gateway (optional) - a String containing a comma separated list of patterns defining the gateway servers to be used to deliver mail regardless of the recipient address. If multiple gateway servers are defined, each will be tried in definition order until delivery is successful. If none are successful, the mail is bounced. The pattern is host[:port] where:
  • host (required) - the FQN of the gateway server.
  • port (optional) - the port of the gateway server. Default is the value defined in the <gatewayPort/> parameter if set, else the default port for the specified connection type.
  Default is to resolve the destination SMTP server for each mail using MX lookup.
• gatewayPort (optional) - an Integer for the gateway port to be used for each defined gateway server for which a port is not explicitly defined in the <gateway/> parameter. Default is the default port for the specified connection type.
• gatewayUsername (optional) - a String containing the user name to be used to authenticate the user using the AUTH command. Default is not to issue the AUTH command.
• gatewayPassword (required if gatewayUsername) is set - a String representing the password to be used to authenticate the user using the AUTH command.
• heloName (optional) - a String containing the name used in the SMTP HELO and EHLO commands. Default is the default domain, which is typically localhost.
• mail.* (optional) - Any property beginning with mail. described in the Javadoc for package com.sun.mail.smtp can be set with a parameter of the corresponding name. For example the parameter <mail.smtp.ssl.enable>true</mail.smtp.ssl.enable> is equivalent to the Java code props.put("mail.smtp.ssl.enable", "true");. Properties set by this facility override settings made within the mailet code.
  Note: This facility should be used with extreme care by expert users with a thorough knowledge of the relevant RFCs and the ability to perform their own problem resolutions.
• debug (optional) - a Boolean (true/false) indicating whether debugging is on. Default is false.

Constructor Summary

Constructors

Constructor and Description
RemoteDelivery()

Method Summary

Methods

Modifier and Type	Method and Description
void	destroy() Stops all the worker threads that are waiting for messages.
protected String	getErrorMsg(javax.mail.MessagingException me) Utility method for getting the error message from the (nested) exception.
protected String	getHeloName()
String	getMailetInfo()
void	init() Initializes all arguments based on configuration values specified in the James configuration file.
protected javax.mail.Session	obtainSession(Properties props) Returns the javamail Session object.
void	run() Handles checking the outgoing spool for new mail and delivering them if there are any
void	service(org.apache.mailet.Mail mail) For this message, we take the list of recipients, organize these into distinct servers, and duplicate the message for each of these servers, and then call the deliver (messagecontainer) method for each server-specific messagecontainer ...
void	setDNSService(DNSService dnsService)
void	setDomainList(DomainList domainList)
void	setMailQueueFactory(MailQueueFactory queueFactory)

Methods inherited from class org.apache.mailet.base.GenericMailet

arrayToString, checkInitParameters, getInitParameter, getInitParameter, getInitParameter, getInitParameterNames, getMailetConfig, getMailetContext, getMailetName, init, log, log

Methods inherited from class java.lang.Object

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

Constructor Detail

RemoteDelivery

public RemoteDelivery()

Method Detail

setMailQueueFactory

public void setMailQueueFactory(MailQueueFactory queueFactory)

setDNSService

public void setDNSService(DNSService dnsService)

setDomainList

public void setDomainList(DomainList domainList)

init

public void init()
          throws javax.mail.MessagingException

Initializes all arguments based on configuration values specified in the James configuration file.

Overrides:

init in class org.apache.mailet.base.GenericMailet

Throws:

javax.mail.MessagingException - on failure to initialize attributes.

getMailetInfo

public String getMailetInfo()

Specified by:

getMailetInfo in interface org.apache.mailet.Mailet

Overrides:

getMailetInfo in class org.apache.mailet.base.GenericMailet

service

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

For this message, we take the list of recipients, organize these into distinct servers, and duplicate the message for each of these servers, and then call the deliver (messagecontainer) method for each server-specific messagecontainer ... that will handle storing it in the outgoing queue if needed.

Specified by:

service in interface org.apache.mailet.Mailet

Specified by:

service in class org.apache.mailet.base.GenericMailet

Parameters:

mail - org.apache.mailet.Mail

Throws:

javax.mail.MessagingException

destroy

public void destroy()

Stops all the worker threads that are waiting for messages. This method is called by the Mailet container before taking this Mailet out of service.

Specified by:

destroy in interface org.apache.mailet.Mailet

Overrides:

destroy in class org.apache.mailet.base.GenericMailet

run

public void run()

Handles checking the outgoing spool for new mail and delivering them if there are any

Specified by:

run in interface Runnable

getErrorMsg

protected String getErrorMsg(javax.mail.MessagingException me)

Utility method for getting the error message from the (nested) exception.

Parameters:

me - MessagingException

Returns:

error message

obtainSession

protected javax.mail.Session obtainSession(Properties props)

Returns the javamail Session object.

Parameters:

props -

Returns:

the java mail session

getHeloName

protected String getHeloName()