IMilterHandler (sendmail-filter-api 2.0.0 API)

All Known Implementing Classes:

AMilterHandlerAdapter
```
public interface IMilterHandler
```
The main handler interface for writing a Java-based milter (mail filter).

Method Summary

All Methods Instance Methods Abstract Methods
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 eohActions, 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.

- Method Detail
  - connect
```
IMilterStatus connect(String hostname,
                      InetAddress hostaddr,
                      Properties properties)
```
    Called once at the start of each SMTP connection.
    
    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
```
IMilterStatus helo(String helohost,
                   Properties properties)
```
    Handle the HELO/EHLO command. Called whenever the client sends a HELO/EHLO command. It may therefore be called between zero and three times.
    
    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
```
IMilterStatus envfrom(byte[][] argv,
                      Properties properties)
```
    Handle the envelope FROM command. Called once at the beginning of each message, before envrcpt.
    
    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
```
IMilterStatus envrcpt(byte[][] argv,
                      Properties properties)
```
    Handle the envelope RCPT command. Called once per recipient, hence one or more times per message, immediately after envfrom(byte[][], java.util.Properties).
    
    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
```
IMilterStatus header(byte[] name,
                     byte[] value)
```
    Handle a message header. Called zero or more times between envrcpt(byte[][], java.util.Properties) and eoh(com.sendmail.milter.IMilterActions, java.util.Properties), once per message header.
    
    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.
  - eoh
```
IMilterStatus eoh(IMilterActions eohActions,
                  Properties properties)
```
    End of a headers. Called once after all calls to header(byte[], byte[]) for a given message.
    
    Parameters:
    
    eohActions - Interface for effecting message changes.
    
    properties - Any properties (macros) received from the MTA.
    
    Returns:
    
    SMFIS_ return codes from IMilterStatus.
  - data
```
IMilterStatus data(Properties properties)
```
    Handle the DATA command. Called between the eoh(com.sendmail.milter.IMilterActions, java.util.Properties) and body(java.nio.ByteBuffer) commands.
    
    Parameters:
    
    properties - Any properties (macros) received from the MTA.
    
    Returns:
    
    SMFIS_ return codes from IMilterStatus.
  - body
```
IMilterStatus body(ByteBuffer bodyp)
```
    Handle a piece of a message's body. Called zero or more times between eoh(com.sendmail.milter.IMilterActions, java.util.Properties) and eom(com.sendmail.milter.IMilterActions, java.util.Properties).
    
    Parameters:
    
    bodyp - This block of body data.
    
    Returns:
    
    SMFIS_ return codes from IMilterStatus.
  - eom
```
IMilterStatus eom(IMilterActions eomActions,
                  Properties properties)
```
    End of a message. Called once after all calls to body(java.nio.ByteBuffer) for a given message.
    
    Parameters:
    
    eomActions - Interface for effecting message changes.
    
    properties - Any properties (macros) received from the MTA.
    
    Returns:
    
    SMFIS_ return codes from IMilterStatus.
  - abort
```
IMilterStatus abort()
```
    Handle the current message being aborted. Called at any time during message processing (i.e. between some message-oriented routine and eom(com.sendmail.milter.IMilterActions, java.util.Properties)).
    
    Returns:
    
    SMFIS_ return codes from IMilterStatus.
  - close
```
IMilterStatus close()
```
    The current connection is being closed. Always called at the end of each connection.
    
    Returns:
    
    SMFIS_ return codes from IMilterStatus.
  - unknown
```
IMilterStatus unknown(byte[] command,
                      Properties properties)
```
    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.
    
    Parameters:
    
    command - the incoming command.
    
    properties - Any properties (macros) received from the MTA.
    
    Returns:
    
    SMFIS_ return codes from IMilterStatus.
  - getActionFlags
```
int getActionFlags()
```
    Get the Milter Action flags as to what this milter uses.
    
    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
```
int getProtocolFlags()
```
    Get the list of calls the MTA should not await replies for.
    
    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
```
int negotiateVersion(int mtaVersion,
                     int actionFlags,
                     int protocolFlags)
```
    Prepares for protocol version negotiation. getActionFlags(), getProtocolFlags() and getMacros() are subsequently called and verified.
    If 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 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 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.
    
    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
```
void reset()
```
    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 connect(java.lang.String, java.net.InetAddress, java.util.Properties) call, or after the calls to negotiateVersion(int, int, int), getActionFlags(), getProtocolFlags() and getMacros(), because it will be reused.
  - getMacros
```
Map<Integer,Set<String>> getMacros()
```
    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.
    
    Returns:
    
    Map of Strings for each phase key defined from MilterConstants.Macros.
    
    See Also:
    
    Postfix Milter documentation, Sendmail documentation

Interface IMilterHandler

Method Summary

Method Detail

connect

helo

envfrom

envrcpt

header

eoh

data

body

eom

abort

close

unknown

getActionFlags

getProtocolFlags

negotiateVersion

reset

getMacros