Modifier and Type | Field and Description |
---|---|
static int |
MAX_DEPTH
The maximum mechanismn which are allowed to use
|
Constructor and Description |
---|
SPFSession(String mailFrom,
String heloDomain,
String clientIP)
Build the SPFSession from the given parameters
|
Modifier and Type | Method and Description |
---|---|
Object |
getAttribute(String key)
Retrieve a stored attribute
|
String |
getClientDomain()
Get clientDomain (p)
|
String |
getCurrentDomain()
Get current-domain (d)
|
String |
getCurrentResult()
Get the current result
|
String |
getCurrentResultExpanded() |
String |
getCurrentSenderPart()
Get current-senderpart (l)
|
String |
getExplanation()
Get the explanation
|
String |
getHostName()
Get sender-domain (h)
|
String |
getInAddress()
Get inAddress (v)
|
String |
getIpAddress()
Get the ipAddress which was used to connect
|
String |
getMacroIpAddress()
Get sending-host (i)
|
String |
getMailFrom()
Get responsible-sender (s)
|
String |
getReadableIP()
Get readableIP (c)
|
String |
getReceivingDomain()
Get receivingDomain (r)
|
String |
getSenderDomain()
Get senderDomain (o)
|
long |
getTimeStamp()
Get timeStamp (t)
|
boolean |
ignoreExplanation()
Return true if the explanation should be ignored
|
void |
increaseCurrentDepth()
Increase the current depth:
if we reach maximum calls we must throw a PermErrorException.
|
SPFChecker |
popChecker()
Remove the SPFChecker on the top and return it.
|
void |
pushChecker(SPFChecker checker)
Add the given SPFChecker on top of the stack
|
Object |
removeAttribute(String key)
Remove the attribute stored under the given key
|
void |
setAttribute(String key,
Object value)
Sets a new attribute in the session
|
void |
setClientDomain(String clientDomain)
Sets the calculated clientDomain
|
void |
setCurrentDomain(String domain)
Set the currentDomain
|
void |
setCurrentResult(String result)
Set the current result
|
void |
setCurrentResultExpanded(String result) |
void |
setExplanation(String explanation)
Set the explanation which will returned when a fail match
|
void |
setIgnoreExplanation(boolean ignoreExplanation)
Get set to true if the explanation should be ignored
|
void |
setReceivingDomain(String receivingDomain)
Sets the new receiving domain
|
public static final int MAX_DEPTH
public String getCurrentSenderPart()
MacroData
getCurrentSenderPart
in interface MacroData
MacroData.getCurrentSenderPart()
public String getMailFrom()
MacroData
getMailFrom
in interface MacroData
MacroData.getMailFrom()
public String getHostName()
MacroData
getHostName
in interface MacroData
MacroData.getHostName()
public String getCurrentDomain()
MacroData
getCurrentDomain
in interface MacroData
MacroData.getCurrentDomain()
public String getInAddress()
MacroData
getInAddress
in interface MacroData
MacroData.getInAddress()
public String getClientDomain()
MacroData
getClientDomain
in interface MacroData
MacroData.getClientDomain()
public void setClientDomain(String clientDomain)
clientDomain
- the new clientDomainpublic String getSenderDomain()
MacroData
getSenderDomain
in interface MacroData
MacroData.getSenderDomain()
public String getIpAddress()
public String getMacroIpAddress()
MacroData
getMacroIpAddress
in interface MacroData
MacroData.getMacroIpAddress()
public long getTimeStamp()
MacroData
getTimeStamp
in interface MacroData
MacroData.getTimeStamp()
public String getReadableIP()
MacroData
getReadableIP
in interface MacroData
MacroData.getReadableIP()
public String getReceivingDomain()
MacroData
getReceivingDomain
in interface MacroData
MacroData.getReceivingDomain()
public void setReceivingDomain(String receivingDomain)
receivingDomain
- the new receiving domainpublic void increaseCurrentDepth() throws PermErrorException
PermErrorException
public void setCurrentDomain(String domain)
domain
- The current used domainpublic void setExplanation(String explanation)
explanation
- This String is set as explanationpublic String getExplanation()
public void setCurrentResult(String result)
result
- resultpublic String getCurrentResult()
public void setIgnoreExplanation(boolean ignoreExplanation)
ignoreExplanation
- true or falsepublic boolean ignoreExplanation()
public Object getAttribute(String key)
key
- the attribute keypublic void setAttribute(String key, Object value)
key
- attribute keyvalue
- the value for this attributepublic Object removeAttribute(String key)
key
- the key of the attributepublic void pushChecker(SPFChecker checker)
checker
- public SPFChecker popChecker()
public void setCurrentResultExpanded(String result)
result
- public String getCurrentResultExpanded()
Copyright © 2006–2016 The Apache Software Foundation. All rights reserved.