---

module.h File Reference

The plugin interface of libnewmail. More...

#include <ltdl.h>
#include "newmail.h"
#include "config.h"

Go to the source code of this file.

Data Structures
struct	nm_spool
	A structure encapsulating information about a mail spool handle. More...
Typedefs
typedef int(*	nm_init_t )(struct nm_spool *s)
	The prototype of the only function which needs to be exported by a plugin.

---

Detailed Description

The plugin interface of libnewmail.

Mail checking modules should use these functions and those declared in config.h and util.h

Definition in file module.h.

---

Typedef Documentation

typedef int(* nm_init_t)(struct nm_spool *s)

The prototype of the only function which needs to be exported by a plugin. It is called when new nm_spool of the plugin is instantiated. Parameters: s  The virgin nm_spool structure. The plugin should fill in the pointers to functions contained in the structure.\c dl, config and path are already filled in, data may be used for arbitrary spool handle specific data, Returns: zero on success, nonzero on failure. Definition at line 68 of file module.h.

---