.TH "module.h" 3 "23 Oct 2003" "libnewmail" \" -*- nroff -*-
.ad l
.nh
.SH NAME
module.h \- The plugin interface of libnewmail. 
.SH SYNOPSIS
.br
.PP
\fC#include <ltdl.h>\fP
.br
\fC#include 'newmail.h'\fP
.br
\fC#include 'config.h'\fP
.br
.SS "Data Structures"

.in +1c
.ti -1c
.RI "struct \fBnm_spool\fP"
.br
.RI "\fIA structure encapsulating information about a mail spool handle.\fP"
.in -1c
.SS "Typedefs"

.in +1c
.ti -1c
.RI "typedef int(* \fBnm_init_t\fP )(struct \fBnm_spool\fP *s)"
.br
.RI "\fIThe prototype of the only function which needs to be exported by a plugin.\fP"
.in -1c
.SH "DETAILED DESCRIPTION"
.PP 
The plugin interface of libnewmail.
.PP
Mail checking modules should use these functions and those declared in \fBconfig.h\fP and \fButil.h\fP
.PP
.PP
Definition in file \fBmodule.h\fP.
.SH "TYPEDEF DOCUMENTATION"
.PP 
.SS "typedef int(* nm_init_t)(struct \fBnm_spool\fP *s)"
.PP
The prototype of the only function which needs to be exported by a plugin.
.PP
It is called when new \fBnm_spool\fP of the plugin is instantiated. 
.PP
\fBParameters: \fP
.in +1c
.TP
\fB\fIs\fP\fP
The virgin \fBnm_spool\fP structure. The plugin should fill in the pointers to functions contained in the structure.\\c dl, \fCconfig\fP and \fCpath\fP are already filled in, \fCdata\fP may be used for arbitrary spool handle specific data, 
.PP
\fBReturns: \fP
.in +1c
zero on success, nonzero on failure. 
.PP
Definition at line 68 of file module.h.
.SH "AUTHOR"
.PP 
Generated automatically by Doxygen for libnewmail from the source code.