Package milter

A thin wrapper around libmilter. More...


Classes

class  milterContext
 Hold context for a milter connection. More...
class  error

Functions

def set_flags
def set_connect_callback
def set_helo_callback
def set_envfrom_callback
def set_envrcpt_callback
def set_header_callback
def set_eoh_callback
def set_body_callback
def set_abort_callback
def set_close_callback
def set_exception_policy
def register
def opensocket
def main
def setdbg
 Set the libmilter debugging level.
def settimeout
def setbacklog
def setconn
 Set the socket used to communicate with the MTA.
def stop
 Stop the milter gracefully.
def getdiag
 Retrieve diagnostic info.
def getversion
 Retrieve the runtime libmilter version.

Variables

int VERSION = 0x1000001
 The compile time libmilter version.


Detailed Description

A thin wrapper around libmilter.


Function Documentation

def milter.getdiag (  ) 

Retrieve diagnostic info.

Return a tuple with diagnostic info gathered by the milter module. The first two fields are counts of milterContext objects created and deleted. Additional fields may be added later.

Returns:
a tuple of diagnostic data

def milter.getversion (  ) 

Retrieve the runtime libmilter version.

Return the runtime libmilter version. This can be different from the compile time version when sendmail or libmilter is upgraded after pymilter is compiled.

Returns:
a tuple of (major,minor,patchlevel)

def milter.setconn (   s  ) 

Set the socket used to communicate with the MTA.

The MTA can communicate with the milter by means of a unix, inet, or inet6 socket. By default, a unix domain socket is used. It must not exist, and sendmail will throw warnings if, eg, the file is under a group or world writable directory.

 setconn('unix:/var/run/pythonfilter')
 setconn('inet:8800') 			# listen on ANY interface
 setconn('inet:7871@publichost')	# listen on a specific interface
 setconn('inet6:8020')
 

def milter.setdbg (   lev  ) 

Set the libmilter debugging level.

smfi_setdbg sets the milter library's internal debugging level to a new level so that code details may be traced. A level of zero turns off debugging. The greater (more positive) the level the more detailed the debugging. Six is the current, highest, useful value.

def milter.stop (  ) 

Stop the milter gracefully.


Variable Documentation

int milter.VERSION = 0x1000001

The compile time libmilter version.

Python code might need to deal with pymilter compiled against various versions of libmilter. This module constant contains the contents of the SMFI_VERSION macro when the milter module was compiled.


Generated on Tue Jul 28 18:31:38 2009 for pymilter by  doxygen 1.5.9