com.sendmail.milter

Interface IMilterStatus

All Known Implementing Classes:

CustomMilterStatus, SimpleMilterStatus

public interface IMilterStatus

Status class for methods in IMilterHandler.

Field Summary

Fields

Modifier and Type	Field and Description
static IMilterStatus	SMFIS_ACCEPT Acceptance.
static IMilterStatus	SMFIS_CONTINUE Continue processing the current connection, message, or recipient.
static IMilterStatus	SMFIS_DISCARD Message discard.
static IMilterStatus	SMFIS_NOREPLY Do not send a reply back to the MTA.
static IMilterStatus	SMFIS_REJECT Rejection.
static IMilterStatus	SMFIS_SKIP Skip further body processing.
static IMilterStatus	SMFIS_TEMPFAIL Return a temporary failure, i.e., the corresponding SMTP command will return an appropriate 4xx status code.

Method Summary

Modifier and Type	Method and Description
int	getCode()
ByteBuffer	getMessage()

Field Detail

SMFIS_CONTINUE

static final IMilterStatus SMFIS_CONTINUE

Continue processing the current connection, message, or recipient.

SMFIS_REJECT

static final IMilterStatus SMFIS_REJECT

Rejection. For a connection-oriented routine, reject this connection; call close. For a message-oriented routine (except eom or abort), reject this message. For a recipient-oriented routine, reject the current recipient (but continue processing the current message).

SMFIS_DISCARD

static final IMilterStatus SMFIS_DISCARD

Message discard. For a message- or recipient-oriented routine, accept this message, but silently discard it. SMFIS_DISCARD should not be returned by a connection-oriented routine.

SMFIS_ACCEPT

static final IMilterStatus SMFIS_ACCEPT

Acceptance. For a connection-oriented routine, accept this connection without further filter processing; call close. For a message- or recipient-oriented routine, accept this message without further filtering.

SMFIS_SKIP

static final IMilterStatus SMFIS_SKIP

Skip further body processing. MTA should not send any more BODY chunks. Skip directly to End of Message processing.

SMFIS_TEMPFAIL

static final IMilterStatus SMFIS_TEMPFAIL

Return a temporary failure, i.e., the corresponding SMTP command will return an appropriate 4xx status code. For a message-oriented routine (except envfrom), fail for this message. For a connection-oriented routine, fail for this connection; call close. For a recipient-oriented routine, only fail for the current recipient; continue message processing.

SMFIS_NOREPLY

static final IMilterStatus SMFIS_NOREPLY

Do not send a reply back to the MTA. If you set the SMFIP_NR_* protocol action for a callback, that callback must always reply with SMFIS_NOREPLY. If the MTA does not support NOREPLY, send CONTINUE for backwards compatibility.

Method Detail

getCode

int getCode()

Returns:

The response code. Must be one of MilterConstants#SMFIR_CONTINUE, MilterConstants#SMFIR_REJECT, MilterConstants#SMFIR_DISCARD, MilterConstants#SMFIR_ACCEPT, MilterConstants#SMFIR_TEMPFAIL, MilterConstants#SMFIR_REPLYCODE, unless you really, really know what you're doing.

getMessage

ByteBuffer getMessage()

Returns:

null or a ByteBuffer containing an error/warning message.