Main Page | Modules | Data Structures | File List | Data Fields

E-Mail Transport (mod_mail)
[Extension Modules]


Functions

sul_error_t * modmail_initialize (smd_module_system_t *modsys, sul_cfg_block_t *cfg, apr_pool_t *pool)
sul_error_t * modmail_destroy (apr_pool_t *pool)
sul_error_t * modmail_send (const char *to, const char *cc, const char *subj, const char *body, apr_pool_t *pool)

Function Documentation

sul_error_t* modmail_destroy (  apr_pool_t *  pool  ) 
 

Destroys this Modules runtime state and stops anything that the Module may be doing. Usually invoked when the Module is being unloaded and the server is being stopped.

Parameters:
pool Pool used to allocate the Module.
Returns:
An sul_error_t instance if an error occured and NULL otherwise.

sul_error_t* modmail_initialize (  smd_module_system_t *  modsys,
sul_cfg_block_t *  cfg,
apr_pool_t *  pool
) 
 

Called when the Module is being loaded and should create and initialize itself. All modules start here and this is where all of the work starts. This function MUST always return.

Parameters:
modsys Module system that is loading the Module
cfg Configuration details for the Module.
pool Pool to allocate module overhead from.
Returns:
An sul_error_t instance if an error occured and NULL otherwise.

sul_error_t* modmail_send (  const char *  to,
const char *  cc,
const char *  subj,
const char *  body,
apr_pool_t *  pool
) 
 

Sends an e-mail.

Parameters:
to Address of the person to send the e-mail to.
cc Addresses to CC the e-mail to.
subj Subject line of the e-mail.
body Body of the e-mail.
pool Pool to allocate memory overhead from.
Returns:
An sul_error_t instance if an error occured and NULL otherwise.


Generated on Wed Apr 28 09:38:37 2004 for State by doxygen 1.3.5