|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object com.sendmail.jilter.JilterHandlerAdapter
public abstract class JilterHandlerAdapter
An adapter to implement methods in JilterHander interface so subclasses may override only those methods they desire.
Field Summary |
---|
Fields inherited from interface com.sendmail.jilter.JilterHandler |
---|
PROCESS_BODY, PROCESS_CONNECT, PROCESS_ENVFROM, PROCESS_ENVRCPT, PROCESS_HEADER, PROCESS_HELO, SMFIF_ADDHDRS, SMFIF_ADDRCPT, SMFIF_CHGBODY, SMFIF_CHGHDRS, SMFIF_DELRCPT, SMFIF_MODBODY, SMFIF_NONE |
Constructor Summary | |
---|---|
JilterHandlerAdapter()
|
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. |
JilterStatus |
header(String headerf,
String headerv)
Handle a message header. |
JilterStatus |
helo(String helohost,
Properties properties)
Handle the HELO/EHLO command. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Methods inherited from interface com.sendmail.jilter.JilterHandler |
---|
getSupportedProcesses |
Constructor Detail |
---|
public JilterHandlerAdapter()
Method Detail |
---|
public JilterStatus connect(String hostname, InetAddress hostaddr, Properties properties)
JilterHandler
connect
in interface JilterHandler
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.
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.public JilterStatus helo(String helohost, Properties properties)
JilterHandler
helo
in interface JilterHandler
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.
SMFIS_
return codes from JilterStatus
.public JilterStatus envfrom(String[] argv, Properties properties)
JilterHandler
envrcpt
.
envfrom
in interface JilterHandler
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.
SMFIS_
return codes from JilterStatus
.public JilterStatus envrcpt(String[] argv, Properties properties)
JilterHandler
envfrom
.
envrcpt
in interface JilterHandler
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.
SMFIS_
return codes from JilterStatus
.public JilterStatus header(String headerf, String headerv)
JilterHandler
envrcpt
and eoh
, once per message header.
header
in interface JilterHandler
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.
SMFIS_
return codes from JilterStatus
.public JilterStatus eoh()
JilterHandler
eoh
in interface JilterHandler
SMFIS_
return codes from JilterStatus
.public JilterStatus body(ByteBuffer bodyp)
JilterHandler
eoh
and eom
.
body
in interface JilterHandler
bodyp
- This block of body data.
SMFIS_
return codes from JilterStatus
.public JilterStatus eom(JilterEOMActions eomActions, Properties properties)
JilterHandler
body
for a given message.
eom
in interface JilterHandler
eomActions
- Interface for effecting message changes.properties
- Any properties (macros) received from the MTA.
SMFIS_
return codes from JilterStatus
.public JilterStatus abort()
JilterHandler
eom
).
abort
in interface JilterHandler
SMFIS_
return codes from JilterStatus
.public JilterStatus close()
JilterHandler
close
in interface JilterHandler
SMFIS_
return codes from JilterStatus
.public int getRequiredModifications()
JilterHandler
getRequiredModifications
in interface JilterHandler
SMFIF_
constants.
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |