.TH "nm_spool" 3 "23 Oct 2003" "libnewmail" \" -*- nroff -*-
.ad l
.nh
.SH NAME
nm_spool \- A structure encapsulating information about a mail spool handle. 
.SH SYNOPSIS
.br
.PP
\fC#include <module.h>\fP
.PP
.SS "Data Fields"

.in +1c
.ti -1c
.RI "lt_dlhandle \fBdl\fP"
.br
.RI "\fIA libltdl handle to the plugin so.\fP"
.ti -1c
.RI "char * \fBdata\fP"
.br
.RI "\fISome plugin specific data.\fP"
.ti -1c
.RI "\fBconfig_t\fP * \fBconfig\fP"
.br
.RI "\fIA configuration context for the mail spool.\fP"
.ti -1c
.RI "char * \fBpath\fP"
.br
.RI "\fIThe path to the associated configuration file.\fP"
.ti -1c
.RI "int(* \fBquery\fP )(struct nm_spool *s, enum \fBnm_query\fP query, struct \fBnm_status\fP *status)"
.br
.RI "\fIA pointer to the real \fBquery()\fP function wrapped by \fBnm_query()\fP.\fP"
.ti -1c
.RI "int(* \fBquery_submit\fP )(struct nm_spool *s, enum \fBnm_query\fP \fBquery\fP, oop_source *oop, \fBnm_query_cb_t\fP cb, void *user)"
.br
.RI "\fIA pointer to the real \fBquery_submit()\fP function wrapped by \fBnm_query_submit()\fP.\fP"
.ti -1c
.RI "int(* \fBconfigure\fP )(struct nm_spool *s)"
.br
.RI "\fIA pointer to the real \fBconfigure()\fP function wrapped by nm_configuret().\fP"
.ti -1c
.RI "int(* \fBinfo\fP )(struct nm_spool *s, struct \fBnm_info\fP *i)"
.br
.RI "\fIA pointer to the real query_info() function wrapped by \fBnm_info()\fP.\fP"
.ti -1c
.RI "void(* \fBdone\fP )(struct nm_spool *s)"
.br
.RI "\fIA pointer to a function which will be called before this nm_spool is freed.\fP"
.in -1c
.SH "DETAILED DESCRIPTION"
.PP 
A structure encapsulating information about a mail spool handle.
.PP
It is opaque to the application 
.PP
\fBExamples: \fP
.in +1c
.PP
\fBeasy.c\fP, \fBnm-spoolhack.c\fP, \fBnmail-async.c\fP, and \fBnmail.c\fP.
.PP
Definition at line 37 of file module.h.
.SH "FIELD DOCUMENTATION"
.PP 
.SS "\fBconfig_t\fP* nm_spool::config"
.PP
A configuration context for the mail spool.
.PP
Definition at line 40 of file module.h.
.SS "int(* nm_spool::configure)(struct nm_spool *s)"
.PP
A pointer to the real \fBconfigure()\fP function wrapped by nm_configuret().
.PP
.SS "char* nm_spool::data"
.PP
Some plugin specific data.
.PP
Definition at line 39 of file module.h.
.SS "lt_dlhandle nm_spool::dl"
.PP
A libltdl handle to the plugin so.
.PP
Definition at line 38 of file module.h.
.SS "void(* nm_spool::done)(struct nm_spool *s)"
.PP
A pointer to a function which will be called before this nm_spool is freed.
.PP
.SS "int(* nm_spool::info)(struct nm_spool *s, struct \fBnm_info\fP *i)"
.PP
A pointer to the real query_info() function wrapped by \fBnm_info()\fP.
.PP
.SS "char* nm_spool::path"
.PP
The path to the associated configuration file.
.PP
Definition at line 41 of file module.h.
.SS "int(* nm_spool::query)(struct nm_spool *s, enum \fBnm_query\fP query, struct \fBnm_status\fP *status)"
.PP
A pointer to the real \fBquery()\fP function wrapped by \fBnm_query()\fP.
.PP
.SS "int(* nm_spool::query_submit)(struct nm_spool *s, enum \fBnm_query\fP \fBquery\fP, oop_source* oop, \fBnm_query_cb_t\fP cb, void *user)"
.PP
A pointer to the real \fBquery_submit()\fP function wrapped by \fBnm_query_submit()\fP.
.PP


.SH "AUTHOR"
.PP 
Generated automatically by Doxygen for libnewmail from the source code.