|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
All the handlers access this interface to communicate with SMTPHandler object
Field Summary | |
static String |
CURRENT_HELO_MODE
|
static String |
MESG_FAILED
|
static String |
RCPT_LIST
|
static String |
SENDER
|
Method Summary | |
void |
abortMessage()
this makes the message to be dropped inprotocol |
String |
clearResponseBuffer()
Clears the response buffer, returning the String of characters in the buffer. |
void |
endSession()
this makes the session to close |
String |
getCommandArgument()
Returns currently process command argument |
String |
getCommandName()
Returns currently process command name |
SMTPHandlerConfigurationData |
getConfigurationData()
Returns SMTPHandler service wide configuration |
InputStream |
getInputStream()
Returns Inputstream for handling messages and commands |
Mail |
getMail()
Returns Mail object for message handlers to process |
String |
getRemoteHost()
Returns host name of the client |
String |
getRemoteIPAddress()
Returns host ip address of the client |
StringBuffer |
getResponseBuffer()
Returns ResponseBuffer, this optimizes the unecessary creation of resources by each handler object |
String |
getSessionID()
Returns the SMTP session id |
HashMap |
getState()
Returns Map that consists of the state of the SMTPSession |
String |
getUser()
Returns the user name associated with this SMTP interaction. |
Watchdog |
getWatchdog()
Returns Watchdog object used for handling timeout |
boolean |
isAuthRequired()
Returns whether Authentication is required or not |
boolean |
isBlockListed()
Returns the blocklisted status |
boolean |
isRelayingAllowed()
Returns whether Relaying is allowed or not |
boolean |
isSessionEnded()
Returns the session status |
String |
readCommandLine()
Reads a line of characters off the command line. |
void |
resetState()
Resets message-specific, but not authenticated user, state. |
void |
setBlockListed(boolean blocklisted)
Sets the blocklisted value |
void |
setMail(Mail mail)
Sets the MailImpl object for further processing |
void |
setUser(String user)
Sets the user name associated with this SMTP interaction. |
boolean |
useHeloEhloEnforcement()
Returns whether remote server needs to send HELO/EHLO |
void |
writeResponse(String respString)
Writes response string to the client |
Field Detail |
public static final String MESG_FAILED
public static final String SENDER
public static final String RCPT_LIST
public static final String CURRENT_HELO_MODE
Method Detail |
public void writeResponse(String respString)
respString
- String that needs to send to the clientpublic String readCommandLine() throws IOException
IOException
- if an exception is generated reading in the input characterspublic StringBuffer getResponseBuffer()
public String clearResponseBuffer()
public InputStream getInputStream()
public String getCommandName()
public String getCommandArgument()
public Mail getMail()
public void setMail(Mail mail)
mail
- MailImpl objectpublic String getRemoteHost()
public String getRemoteIPAddress()
public void abortMessage()
public void endSession()
public boolean isSessionEnded()
public HashMap getState()
public void resetState()
public SMTPHandlerConfigurationData getConfigurationData()
public void setBlockListed(boolean blocklisted)
blocklisted
- public boolean isBlockListed()
public boolean isRelayingAllowed()
public boolean isAuthRequired()
public boolean useHeloEhloEnforcement()
public String getUser()
public void setUser(String user)
public Watchdog getWatchdog()
public String getSessionID()
|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |