com.sendmail.jilter
Class JilterStatus

java.lang.Object
  com.sendmail.jilter.JilterStatus

public abstract class JilterStatus
extends Object

Status class for methods in JilterHandler.

Field Summary

static JilterStatus	SMFIS_ACCEPT Acceptance.
static JilterStatus	SMFIS_CONTINUE Continue processing the current connection, message, or recipient.
static JilterStatus	SMFIS_DISCARD Message discard.
static JilterStatus	SMFIS_REJECT Rejection.
static JilterStatus	SMFIS_TEMPFAIL Return a temporary failure, i.e., the corresponding SMTP command will return an appropriate 4xx status code.

Constructor Summary

protected

JilterStatus()

Method Summary

static JilterStatus	makeCustomStatus(String rcode, String xcode, String[] messageLines) Creates a new JilterStatus with a custom error reply code.
abstract void	sendReplyPacket(WritableByteChannel writeChannel)

Methods inherited from class java.lang.Object

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

Field Detail

SMFIS_CONTINUE

public static final JilterStatus SMFIS_CONTINUE

Continue processing the current connection, message, or recipient.

SMFIS_REJECT

public static final JilterStatus 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

public static final JilterStatus 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

public static final JilterStatus 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_TEMPFAIL

public static final JilterStatus 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.

Constructor Detail

JilterStatus

protected JilterStatus()

Method Detail

sendReplyPacket

public abstract void sendReplyPacket(WritableByteChannel writeChannel)
                              throws IOException

Throws:

IOException

makeCustomStatus

public static JilterStatus makeCustomStatus(String rcode,
                                            String xcode,
                                            String[] messageLines)
                                     throws IllegalArgumentException

Creates a new JilterStatus with a custom error reply code.

Parameters:

rcode - The three-digit (RFC 821/2821) SMTP reply code. rcode cannot be null, and must be a valid 4XX or 5XX reply code.

xcode - The extended (RFC 1893/2034) reply code. If xcode is null, no extended code is used. Otherwise, xcode must conform to RFC 1893/2034.

messageLines - An array of single lines of text which will be used as the text part of the SMTP reply. If messageLines has zero lines, an empty message is used.

Returns:

the new status

Throws:

IllegalArgumentException - if rcode or xcode is invalid