4.3.7.1. SMTP Functionalities (I)

A list of all events and all variables and methods that can be used by each event is presented below. The type (IN or OUT) and the access method (RO - read only, RW - read write, WO - write only) will be specified for each variable.

Important!

Certain variables are only interpreted within some events, while the remaining events ignore them. Therefore setting such a variable for an event that will ignore it will take no effect. This is also applicable to predefined methods.

Not all variables marked as RO or not presented for a certain event will generate an error if set. The reason is they can be marked as RW for other events of the same context. However, setting them will have no effect.

onConnect

Called when a new client is connected.

Variable	Type	Access Method	Explanation	Value set	Default
smtpPort	numeric	IN,RO	The local listener port the client used to connect	Range: 0 - 65535	Not Applicable
smtpIp	ip	IN,RO	The local interface IP the client used to connect	IP	Not Applicable
remoteSmtpPort	numeric	IN,RO	The remote port the connection was established through	Range: 0 - 65535	Not Applicable
remoteSmtpIp	ip	IN,RO	The remote IP the connection was established from	IP	Not Applicable
isSSLConnection	choice	IN,RO	'yes' if the connection is encrypted (socket ssl), no if it is not.	Choice: yes - the connection is encrypted (socket ssl) no - the connection is not encrypted	Not Applicable
DNSBLServer	text	OUT,WO	The DNSBL server name used by 'checkDNSBL' method.	Text string
DNSBLResult	ip	IN,RO	The result of a 'checkDNSBL' call; if the client ip is not found using 'DNSBLServer' the result is an empty string	IP
DNSBLExplanation	text	IN,RO	The explanation associated with the result returned by a 'checkDNSBL' call	Text string
smtpGreeting	text	OUT,WO	The initial message sent to the client (for the moment, it can be a static string only).	Text string	Axigen specific greeting text
smtpAction	choice	OUT,WO	Determine what action the smtp engine shoud take for the current command.	Choice: accept - the server accepts the current command reject - the server rejects the current command and returns a permanent error tmpreject - the server rejects the current command and returns a temporary error abort - the server aborts the connection	Takes an action conforming with the internal policies
smtpExplanation	text	OUT,WO	The message sent to the client in case of a reject or tmpreject action.	Text string	A default error message
RFCBreak	multival	OUT,WO	List of RFC violation permitted or requested.	Values: nofolding - Header lines longer than 78 characters are permitted and no folding is perfomed on those lines bodycrlfcorrection - SMTP IN service is allowed to modify the body of 7Bit mime messages in order to fix invalid line terminator sequences (the single CR, LF or LFCR and CRCRLF sequences found in mail's body are replaced with CRLF)
filterName	text	OUT,WO	The name of the extenral filter to be added	Text string	Not Applicable
filterType	choice	OUT,WO	The type of the external filter to be added	Choice: milter - The new external filter is of type MILTER	Not Applicable
filterAddress	text	OUT,WO	The address of the new external filter	Text string	Not Applicable
addFilterResult	choice	IN,RO		Choice: ok - The addFilter call was successfull error - The addFilter call failed	Not Applicable
addFilterExplanation	text	IN,RO		Text string	Not Applicable
filterNamePattern	text	OUT,WO	The pattern name of filters to be executed	Text string
'filterName'.result	choice	IN,RO	The execution result of an external smtp filter	Choice: pass - The filter was executed and returned a positive result fail - The filter was executed and returned a rejection result neutral - The filter was not selected for execution by the lass executeFilters call error - The filter was not executed because of system errors	Not Applicable
'filterName'.action	choice	IN/OUT,RW	The default action taken by the smtp engine as a result of executing an external smtp filter	Choice: accept - The engine accepts the current and the following commands continue - The engine accepts the current command discard - The engine ignores the current command tmpreject - The engine temporary rejects the current command reject - The engine permanently rejects the current command	Not Applicable
'filterName'.explanation	text	IN,RO	The explanation associated with the execution of an external smtp filter	Text string	Not Applicable
AllowedCountries	text	OUT,WO	List of allowed countries used by checkGeoIP method	Text string
BannedCountries	text	OUT,WO	List of banned countries used by checkGeoIP method	Text string
ActionGeoIPBan	choice	OUT,WO	The default action taken in case the country is banned	Choice: accept - the server accepts the current command reject - the server rejects the current command and returns a permanent error tmpreject - the server rejects the current command and returns a temporary error abort - the server aborts the connection	Reject
GeoIPResult	text	IN,RO	Country code associated with the client's ip	Text string	Not Applicable
IsGeoIPBanned	choice	IN,RO	Determine if client's country is banned	Choice: yes - the client's country is banned no - the client's country is not banned	Not Applicable

Methods

Name	Explanation	Input Parameters	Output Parameters
checkGeoIp	Determine the client's country code and check if is banned	AllowedCountries-List of allowed countries BannedCountries-List of banned countries ActionGeoIP-The default action taken by server in case the country is banned	GeoIpResult-The country code associated with client's ip IsGeoIPBanned-The result of checking the country code against allowed/banned countries lists
addFilter	Adds an external smtp filter	filterName-Specifies the name of the filter to be added filterType-Specifies the type of the filter to be added filterAddress-Specifies the address of the filter to be added	addFilterResult-Indicates if the add filter operation was successfull addFilterExplanation-Indicates the failure reason of the add filter operation
executeFilters	Execute onConnect method for selected filters	filterNamePattern-The selection name pattern of filters to be executed	'filterName'.result-The execution result of the filter named 'filterName' 'filterName'.action-The default smtp action taken as a result of executing the filter named 'filterName'
checkDNSBL	Checks if the clinent ip is black-listed in server 'DNSBLServer'	DNSBLServer-The DNS Black List server used to check the client ip	DNSBLResult-The ip associated with the client ip in server 'DNSBLServer' DNSBLExplanation-Explanation associated with the 'DNSBLResult'