com.sendmail.milter

Interface IMilterActions

public interface IMilterActions

Contains the actions available during eom and eoh processing.

Method Summary

Modifier and Type	Method and Description
void	addheader(String name, String value) Add a header to the current message, replacing if exists.
void	addrcpt(String rcpt) Add a recipient for the current message.
void	chgheader(String name, int index, String value) Change or delete a message header.
void	delrcpt(String rcpt) Removes the named recipient from the current message's envelope.
void	finish(IMilterStatus status) Set the resulting EOM status.
void	insheader(String name, String value) Insert a header to the current message, without replacing.
void	progress() Notify the MTA that an operation is still in progress.
void	replacebody(ByteBuffer bodyp) Replaces the body of the current message.

Method Detail

addheader

void addheader(String name,
               String value)
        throws IOException

Add a header to the current message, replacing if exists.

Parameters:

name - The header name.

value - The header value.

Throws:

IOException - if a connection error occurs.

chgheader

void chgheader(String name,
               int index,
               String value)
        throws IOException

Change or delete a message header.

Parameters:

name - the header name.

index - header index value (1-based). A index value of 1 will modify the first occurrence of a header named name. If index is greater than the number of times name appears, a new copy of name will be added.

value - the new value of the given header. value == null indicates that the header should be deleted.

Throws:

IOException - if a connection error occurs.

insheader

void insheader(String name,
               String value)
        throws IOException

Insert a header to the current message, without replacing.

Parameters:

name - The header name.

value - The header value.

Throws:

IOException - if a connection error occurs.

addrcpt

void addrcpt(String rcpt)
      throws IOException

Add a recipient for the current message.

Parameters:

rcpt - the new recipient's address.

Throws:

IOException - if a connection error occurs.

delrcpt

void delrcpt(String rcpt)
      throws IOException

Removes the named recipient from the current message's envelope.

Parameters:

rcpt - the recipient address to be removed.

Throws:

IOException - if a connection error occurs.

replacebody

void replacebody(ByteBuffer bodyp)
          throws IOException

Replaces the body of the current message. If called more than once, subsequent calls result in data being appended to the new body.

Parameters:

bodyp - a buffer containing the new body data. Body data should be in CR/LF form.

Throws:

IOException - if a connection error occurs.

progress

void progress()
       throws IOException

Notify the MTA that an operation is still in progress.

Throws:

IOException - if a connection error occurs.

finish

void finish(IMilterStatus status)
     throws IOException

Set the resulting EOM status. Note: Calling the method essentially invalidates this object. The result of any subsequent calls to methods on this object is undefined.

Parameters:

status - send the following status code (optional).

Throws:

IOException - if a connection error occurs.