|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface SMTPSession
All the handlers access this interface to communicate with SMTPHandler object
Field Summary | |
---|---|
static java.lang.String |
CURRENT_HELO_MODE
|
static java.lang.String |
CURRENT_HELO_NAME
|
static java.lang.Object |
CURRENT_RECIPIENT
|
static java.lang.String |
MESG_FAILED
|
static java.lang.String |
RCPT_LIST
|
static java.lang.String |
SENDER
|
Method Summary | |
---|---|
void |
abortMessage()
this makes the message to be dropped inprotocol |
java.lang.String |
clearResponseBuffer()
Clears the response buffer, returning the String of characters in the buffer. |
void |
endSession()
this makes the session to close |
java.lang.String |
getCommandArgument()
Returns currently process command argument |
java.lang.String |
getCommandName()
Returns currently process command name |
SMTPHandlerConfigurationData |
getConfigurationData()
Returns SMTPHandler service wide configuration |
java.util.Map |
getConnectionState()
Returns Map that consists of the state of the SMTPSession per connection |
java.io.InputStream |
getInputStream()
Returns Inputstream for handling messages and commands |
org.apache.mailet.Mail |
getMail()
Returns Mail object for message handlers to process |
int |
getRcptCount()
Returns the recipient count |
java.lang.String |
getRemoteHost()
Returns host name of the client |
java.lang.String |
getRemoteIPAddress()
Returns host ip address of the client |
java.lang.StringBuffer |
getResponseBuffer()
Returns ResponseBuffer, this optimizes the unecessary creation of resources by each handler object |
java.lang.String |
getSessionID()
Returns the SMTP session id |
java.util.Map |
getState()
Returns Map that consists of the state of the SMTPSession per mail |
boolean |
getStopHandlerProcessing()
Return if handlerprocessing should be stopped |
java.lang.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 |
isRelayingAllowed()
Returns whether Relaying is allowed or not |
boolean |
isSessionEnded()
Returns the session status |
java.lang.String |
readCommandLine()
Reads a line of characters off the command line. |
void |
resetConnectionState()
Reset the Connection state |
void |
resetState()
Resets message-specific, but not authenticated user, state. |
void |
setMail(org.apache.mailet.Mail mail)
Sets the MailImpl object for further processing |
void |
setRelayingAllowed(boolean relayingAllowed)
Set if reallying is allowed |
void |
setStopHandlerProcessing(boolean b)
Set to true if the handlerprocessing should be stopped |
void |
setUser(java.lang.String user)
Sets the user name associated with this SMTP interaction. |
boolean |
useHeloEhloEnforcement()
Returns whether remote server needs to send HELO/EHLO |
void |
writeResponse(java.lang.String respString)
Writes response string to the client |
Field Detail |
---|
static final java.lang.String MESG_FAILED
static final java.lang.String SENDER
static final java.lang.String RCPT_LIST
static final java.lang.String CURRENT_HELO_MODE
static final java.lang.String CURRENT_HELO_NAME
static final java.lang.Object CURRENT_RECIPIENT
Method Detail |
---|
void writeResponse(java.lang.String respString)
respString
- String that needs to send to the clientjava.lang.String readCommandLine() throws java.io.IOException
java.io.IOException
- if an exception is generated reading in the input charactersjava.lang.StringBuffer getResponseBuffer()
java.lang.String clearResponseBuffer()
java.io.InputStream getInputStream()
java.lang.String getCommandName()
java.lang.String getCommandArgument()
org.apache.mailet.Mail getMail()
void setMail(org.apache.mailet.Mail mail)
mail
- MailImpl objectjava.lang.String getRemoteHost()
java.lang.String getRemoteIPAddress()
void abortMessage()
void endSession()
boolean isSessionEnded()
java.util.Map getState()
void resetState()
SMTPHandlerConfigurationData getConfigurationData()
boolean isRelayingAllowed()
void setRelayingAllowed(boolean relayingAllowed)
relayingAllowed
- boolean isAuthRequired()
boolean useHeloEhloEnforcement()
java.lang.String getUser()
void setUser(java.lang.String user)
user
- the user nameWatchdog getWatchdog()
java.lang.String getSessionID()
int getRcptCount()
void setStopHandlerProcessing(boolean b)
b
- true or falseboolean getStopHandlerProcessing()
void resetConnectionState()
java.util.Map getConnectionState()
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |