com.sendmail.jilter
public interface JilterHandler
Field Summary | |
---|---|
static int | PROCESS_BODY
Flag for getSupportedProcesses to
indicate that body is supported. |
static int | PROCESS_CONNECT
Flag for getSupportedProcesses to
indicate that connect is supported. |
static int | PROCESS_ENVFROM
Flag for getSupportedProcesses to
indicate that envfrom is supported. |
static int | PROCESS_ENVRCPT
Flag for getSupportedProcesses to
indicate that JilterHandler is supported. |
static int | PROCESS_HEADER
Flag for getSupportedProcesses to
indicate that header is supported. |
static int | PROCESS_HELO
Flag for getSupportedProcesses to
indicate that helo is supported. |
static int | SMFIF_ADDHDRS
Flag for getRequiredModifications to
indicate that headers may be added. |
static int | SMFIF_ADDRCPT
Flag for getRequiredModifications to
indicate that recipients may be added. |
static int | SMFIF_CHGBODY
Flag for getRequiredModifications to
indicate that the body may be changed. |
static int | SMFIF_CHGHDRS
Flag for getRequiredModifications to
indicate that headers may be changed or deleted. |
static int | SMFIF_DELRCPT
Flag for getRequiredModifications to
indicate that recipients may be deleted. |
static int | SMFIF_MODBODY
Flag for getRequiredModifications to
indicate that headers may be added. |
static int | SMFIF_NONE
Flag for getRequiredModifications to
indicate that no modifications will be made. |
Method Summary | |
---|---|
JilterStatus | abort()
Handle the current message being aborted. |
JilterStatus | body(ByteBuffer bodyp)
Handle a piece of a message's body. |
JilterStatus | close()
The current connection is being closed. |
JilterStatus | connect(String hostname, InetAddress hostaddr, Properties properties)
Called once at the start of each SMTP connection.
|
JilterStatus | envfrom(String[] argv, Properties properties)
Handle the envelope FROM command. |
JilterStatus | envrcpt(String[] argv, Properties properties)
Handle the envelope RCPT command. |
JilterStatus | eoh()
Handle the end of message headers. |
JilterStatus | eom(JilterEOMActions eomActions, Properties properties)
End of a message. |
int | getRequiredModifications()
Get the list of required modifications needed by this handler.
|
int | getSupportedProcesses()
Get the list of callbacks implemented by this handler.
|
JilterStatus | header(String headerf, String headerv)
Handle a message header. |
JilterStatus | helo(String helohost, Properties properties)
Handle the HELO/EHLO command. |
getSupportedProcesses
to
indicate that body
is supported.getSupportedProcesses
to
indicate that connect
is supported.getSupportedProcesses
to
indicate that envfrom
is supported.getSupportedProcesses
to
indicate that JilterHandler is supported.getSupportedProcesses
to
indicate that header
is supported.getSupportedProcesses
to
indicate that helo
is supported.getRequiredModifications
to
indicate that headers may be added.getRequiredModifications
to
indicate that recipients may be added.getRequiredModifications
to
indicate that the body may be changed.getRequiredModifications
to
indicate that headers may be changed or deleted.getRequiredModifications
to
indicate that recipients may be deleted.getRequiredModifications
to
indicate that headers may be added.getRequiredModifications
to
indicate that no modifications will be made.eom
).
Returns: SMFIS_
return codes from JilterStatus.
eoh
and eom
.
Parameters: bodyp This block of body data.
Returns: SMFIS_
return codes from JilterStatus.
Returns: SMFIS_
return codes from JilterStatus.
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 JilterStatus. NOTE: The MTA will currently
ignore any custom values (values other than SMFIS_
values). Specifically, values
created with JilterStatus.makeCustomStatus
will not be honored.
envrcpt
.
Parameters: argv An array of SMTP command arguments. argv[0]
is guaranteed to be the sender address.
Later arguments are the ESMTP arguments. properties Any properties (macros) received from the MTA.
Returns: SMFIS_
return codes from JilterStatus.
envfrom
.
Parameters: argv An array of SMTP command arguments. argv[0]
is guaranteed to be the recipient address.
Later arguments are the ESMTP arguments. properties Any properties (macros) received from the MTA.
Returns: SMFIS_
return codes from JilterStatus.
Returns: SMFIS_
return codes from JilterStatus.
body
for a given message.
Parameters: eomActions Interface for effecting message changes. properties Any properties (macros) received from the MTA.
Returns: SMFIS_
return codes from JilterStatus.
Returns: a combination of values from the SMFIF_
constants.
Returns: a combination of values from the PROCESS_
constants.
envrcpt
and eoh
, once per message header.
Parameters: headerf Header field name. headerv 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.
Returns: SMFIS_
return codes from JilterStatus.
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 JilterStatus.