com.sendmail.milter

Class AMilterHandlerAdapter

java.lang.Object

com.sendmail.milter.AMilterHandlerAdapter

All Implemented Interfaces:

IMilterHandler

public abstract class AMilterHandlerAdapter
extends Object
implements IMilterHandler

An adapter to implement methods in IMilterHandler interface so subclasses may override only those methods they desire.

Field Summary

Fields

Modifier and Type	Field and Description
protected IMilterStatus	DEFAULT_ACCEPT
protected IMilterStatus	DEFAULT_CONTINUE
protected IMilterStatus	DEFAULT_DISCARD
protected IMilterStatus	DEFAULT_REJECT
protected IMilterStatus	DEFAULT_TEMPFAIL

Constructor Summary

Constructors

Constructor and Description
AMilterHandlerAdapter()

Method Summary

Modifier and Type	Method and Description
IMilterStatus	abort() Handle the current message being aborted.
IMilterStatus	body(ByteBuffer bodyp) Handle a piece of a message's body.
IMilterStatus	close() The current connection is being closed.
IMilterStatus	connect(String hostname, InetAddress hostaddr, Properties properties) Called once at the start of each SMTP connection.
IMilterStatus	data(Properties properties) Handle the DATA command.
IMilterStatus	envfrom(byte[][] argv, Properties properties) Handle the envelope FROM command.
IMilterStatus	envrcpt(byte[][] argv, Properties properties) Handle the envelope RCPT command.
IMilterStatus	eoh(IMilterActions eomActions, Properties properties) End of a headers.
IMilterStatus	eom(IMilterActions eomActions, Properties properties) End of a message.
int	getActionFlags() Get the Milter Action flags as to what this milter uses.
Map<Integer,Set<String>>	getMacros() Get desired macros during negotiation.
int	getProtocolFlags() Get the list of calls the MTA should not await replies for.
IMilterStatus	header(byte[] name, byte[] value) Handle a message header.
IMilterStatus	helo(String helohost, Properties properties) Handle the HELO/EHLO command.
int	negotiateVersion(int mtaVersion, int actionFlags, int protocolFlags) Prepares for protocol version negotiation.
void	reset() Called when receiving a MilterConstants.SMFIC_QUIT_NC command from the MTA.
IMilterStatus	unknown(byte[] command, Properties properties) Handle an unknown SMTP command.

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_CONTINUE

protected final IMilterStatus DEFAULT_CONTINUE

DEFAULT_ACCEPT

protected final IMilterStatus DEFAULT_ACCEPT

DEFAULT_DISCARD

protected final IMilterStatus DEFAULT_DISCARD

DEFAULT_REJECT

protected final IMilterStatus DEFAULT_REJECT

DEFAULT_TEMPFAIL

protected final IMilterStatus DEFAULT_TEMPFAIL

Constructor Detail

AMilterHandlerAdapter

public AMilterHandlerAdapter()

Method Detail

connect

public IMilterStatus connect(String hostname,
                             InetAddress hostaddr,
                             Properties properties)

Description copied from interface: IMilterHandler

Called once at the start of each SMTP connection.

Specified by:

connect in interface IMilterHandler

Parameters:

hostname - The host name of the message sender, as determined by a reverse lookup on the host address.

hostaddr - The host address, as determined by a getpeername() call on the SMTP socket.

properties - Any properties (macros) received from the MTA.

Returns:

SMFIS_ return codes from IMilterStatus. NOTE: The MTA will currently ignore any custom values (values other than SMFIS_ values). Specifically, values created with CustomMilterStatus.CustomMilterStatus(java.lang.String, java.lang.String, java.lang.String[]) will not be honored.

helo

public IMilterStatus helo(String helohost,
                          Properties properties)

Description copied from interface: IMilterHandler

Handle the HELO/EHLO command. Called whenever the client sends a HELO/EHLO command. It may therefore be called between zero and three times.

Specified by:

helo in interface IMilterHandler

Parameters:

helohost - Value passed to HELO/EHLO command, which should be the domain name of the sending host (but is, in practice, anything the sending host wants to send).

properties - Any properties (macros) received from the MTA.

Returns:

SMFIS_ return codes from IMilterStatus.

envfrom

public IMilterStatus envfrom(byte[][] argv,
                             Properties properties)

Description copied from interface: IMilterHandler

Handle the envelope FROM command. Called once at the beginning of each message, before envrcpt.

Specified by:

envfrom in interface IMilterHandler

Parameters:

argv - An array of SMTP command arguments. argv[0] is guaranteed to be the sender address. Later arguments are the ESMTP arguments. While the default encoding should be presumed to be ASCII, the value decoding is left to the user. Often simply the default String.String(byte[]) constructor is enough.

properties - Any properties (macros) received from the MTA.

Returns:

SMFIS_ return codes from IMilterStatus.

envrcpt

public IMilterStatus envrcpt(byte[][] argv,
                             Properties properties)

Description copied from interface: IMilterHandler

Handle the envelope RCPT command. Called once per recipient, hence one or more times per message, immediately after IMilterHandler.envfrom(byte[][], java.util.Properties).

Specified by:

envrcpt in interface IMilterHandler

Parameters:

argv - An array of SMTP command arguments. argv[0] is guaranteed to be the recipient address. Later arguments are the ESMTP arguments. While the default encoding should be presumed to be ASCII, the value decoding is left to the user. Often simply the default String.String(byte[]) constructor is enough.

properties - Any properties (macros) received from the MTA.

Returns:

SMFIS_ return codes from IMilterStatus.

header

public IMilterStatus header(byte[] name,
                            byte[] value)

Description copied from interface: IMilterHandler

Handle a message header. Called zero or more times between IMilterHandler.envrcpt(byte[][], java.util.Properties) and IMilterHandler.eoh(com.sendmail.milter.IMilterActions, java.util.Properties), once per message header.

Specified by:

header in interface IMilterHandler

Parameters:

name - Header field name.

value - Header field value. The content of the header may include folded white space (i.e. multiple lines with following white space). The trailing line terminator (CR/LF) is removed.

While the default encoding should be presumed to be ASCII, the value decoding is left to the user. Often simply the default String.String(byte[]) constructor is enough. String.String(byte[]) constructor is enough.

Returns:

SMFIS_ return codes from IMilterStatus.

body

public IMilterStatus body(ByteBuffer bodyp)

Description copied from interface: IMilterHandler

Handle a piece of a message's body. Called zero or more times between IMilterHandler.eoh(com.sendmail.milter.IMilterActions, java.util.Properties) and IMilterHandler.eom(com.sendmail.milter.IMilterActions, java.util.Properties).

Specified by:

body in interface IMilterHandler

Parameters:

bodyp - This block of body data.

Returns:

SMFIS_ return codes from IMilterStatus.

eoh

public IMilterStatus eoh(IMilterActions eomActions,
                         Properties properties)

Description copied from interface: IMilterHandler

End of a headers. Called once after all calls to IMilterHandler.header(byte[], byte[]) for a given message.

Specified by:

eoh in interface IMilterHandler

Parameters:

eomActions - Interface for effecting message changes.

properties - Any properties (macros) received from the MTA.

Returns:

SMFIS_ return codes from IMilterStatus.

eom

public IMilterStatus eom(IMilterActions eomActions,
                         Properties properties)

Description copied from interface: IMilterHandler

End of a message. Called once after all calls to IMilterHandler.body(java.nio.ByteBuffer) for a given message.

Specified by:

eom in interface IMilterHandler

Parameters:

eomActions - Interface for effecting message changes.

properties - Any properties (macros) received from the MTA.

Returns:

SMFIS_ return codes from IMilterStatus.

unknown

public IMilterStatus unknown(byte[] command,
                             Properties properties)

Description copied from interface: IMilterHandler

Handle an unknown SMTP command. The SMTP command will always be rejected by the server, it is only possible to return a different error code.

Specified by:

unknown in interface IMilterHandler

Parameters:

command - the incoming command.

properties - Any properties (macros) received from the MTA.

Returns:

SMFIS_ return codes from IMilterStatus.

data

public IMilterStatus data(Properties properties)

Description copied from interface: IMilterHandler

Handle the DATA command. Called between the IMilterHandler.eoh(com.sendmail.milter.IMilterActions, java.util.Properties) and IMilterHandler.body(java.nio.ByteBuffer) commands.

Specified by:

data in interface IMilterHandler

Parameters:

properties - Any properties (macros) received from the MTA.

Returns:

SMFIS_ return codes from IMilterStatus.

abort

public IMilterStatus abort()

Description copied from interface: IMilterHandler

Handle the current message being aborted. Called at any time during message processing (i.e. between some message-oriented routine and IMilterHandler.eom(com.sendmail.milter.IMilterActions, java.util.Properties)).

Specified by:

abort in interface IMilterHandler

Returns:

SMFIS_ return codes from IMilterStatus.

close

public IMilterStatus close()

Description copied from interface: IMilterHandler

The current connection is being closed. Always called at the end of each connection.

Specified by:

close in interface IMilterHandler

Returns:

SMFIS_ return codes from IMilterStatus.

getActionFlags

public int getActionFlags()

Description copied from interface: IMilterHandler

Get the Milter Action flags as to what this milter uses.

Specified by:

getActionFlags in interface IMilterHandler

Returns:

a combination of values from the MilterConstants.SMFIF_ADDHDRS, MilterConstants.SMFIF_CHGBODY, MilterConstants.SMFIF_ADDRCPT, MilterConstants.SMFIF_DELRCPT, MilterConstants.SMFIF_CHGHDRS, MilterConstants.SMFIF_QUARANTINE, MilterConstants.SMFIF_CHGFROM, MilterConstants.SMFIF_ADDRCPT_PAR, MilterConstants.SMFIF_SETSYMLIST constants.

getProtocolFlags

public int getProtocolFlags()

Description copied from interface: IMilterHandler

Get the list of calls the MTA should not await replies for.

Specified by:

getProtocolFlags in interface IMilterHandler

Returns:

A combination of MilterConstants.SMFIP_NOCONNECT, MilterConstants.SMFIP_NOHELO, MilterConstants.SMFIP_NOMAIL, MilterConstants.SMFIP_NORCPT, MilterConstants.SMFIP_NOBODY, MilterConstants.SMFIP_NOHDRS, MilterConstants.SMFIP_NOEOH, MilterConstants.SMFIP_NOUNKNOWN, MilterConstants.SMFIP_NODATA, MilterConstants.SMFIP_SKIP, MilterConstants.SMFIP_RCPT_REJ, MilterConstants.SMFIP_NR_HDR, MilterConstants.SMFIP_NR_CONN, MilterConstants.SMFIP_NR_HELO, MilterConstants.SMFIP_NR_MAIL, MilterConstants.SMFIP_NR_RCPT, MilterConstants.SMFIP_NR_DATA, MilterConstants.SMFIP_NR_UNKN, MilterConstants.SMFIP_NR_EOH, MilterConstants.SMFIP_NR_BODY, MilterConstants.SMFIP_HDR_LEADSPC or 0.

negotiateVersion

public int negotiateVersion(int mtaVersion,
                            int actionFlags,
                            int protocolFlags)

Description copied from interface: IMilterHandler

Prepares for protocol version negotiation. IMilterHandler.getActionFlags(), IMilterHandler.getProtocolFlags() and IMilterHandler.getMacros() are subsequently called and verified.

If IMilterHandler.getActionFlags() requires flags not supported by the MTA, the negotiation will fail and the connection will be terminated with a IMilterStatus.SMFIS_TEMPFAIL response.

If IMilterHandler.getProtocolFlags() requires flags not supported by the MTA, other than SMFIP_NR_ flags, the negotiation will fail and the connection will be terminated with a IMilterStatus.SMFIS_TEMPFAIL response.

If IMilterHandler.getProtocolFlags() requires SMFIP_NR_ flags not supported by the MTA, the Milter server will emulate them by sending IMilterStatus.SMFIS_CONTINUE responses.

Normally your filter's flags should be constant, but here we give you a chance to turn some features off or do workarounds. Note that your implemented handler functions are always called if a packet arrives for them, even if you report that you don't use them. Sendmail accepts the results and complains in the logs that your filter is a liar.

Specified by:

negotiateVersion in interface IMilterHandler

Parameters:

mtaVersion - Milter Protocol version of the Mail Transport Agent.

actionFlags - Actions flags for actions supported by the MTA. Prefixed with SMFIF_ in MilterConstants.

protocolFlags - Protocol flags supported by the MTA. Prefixed with SMFIP_ in MilterConstants.

Returns:

the protocol version. Minimum acceptable is 2. Current maximum is 6.

reset

public void reset()

Description copied from interface: IMilterHandler

Called when receiving a MilterConstants.SMFIC_QUIT_NC command from the MTA. A stateful Milter must reset itself to the same state it was in before the IMilterHandler.connect(java.lang.String, java.net.InetAddress, java.util.Properties) call, or after the calls to IMilterHandler.negotiateVersion(int, int, int), IMilterHandler.getActionFlags(), IMilterHandler.getProtocolFlags() and IMilterHandler.getMacros(), because it will be reused.

Specified by:

reset in interface IMilterHandler

getMacros

public Map<Integer,Set<String>> getMacros()

Description copied from interface: IMilterHandler

Get desired macros during negotiation.

The macros themselves are available scattered with no particular grouping or order, with little to no description in the Sendmail documentation and some of them, but with proper description in the Postfix Milter documents.

Specified by:

getMacros in interface IMilterHandler

Returns:

Map of Strings for each phase key defined from MilterConstants.Macros.

See Also:

Postfix Milter documentation, Sendmail documentation