type of stream
typedef void * ServerStream;
SMTPReqCallback
type for callback function that will call for each request, after request received, before server do anything other.
typedef int (*
SMTPReqCallback)(ServerStream *
stream, char *
reqname, int
action, ...);
Parameters:
The
stream may be used by host program for next request.
The
reqname it is name of requested file.
The
action defined there:
ACTION_POP_LOGIN ACTION_POP_GETMSG ACTION_POP_DELMSG ACTION_SMTP_CONNECT ACTION_SMTP_SENDMSG
Return value:
If this callback return zero, the server will still work the request.
If this callback return subzero the server understand that host program
If this callback return value above zero, the server return it to client as error code and return error page.
ALL_ACTIONS
MsgCallback
type for callback function that will call for each change state in send msg request.
typedef void (*
MsgCallback)(ServerStream *
stream, void *
usr_par, int
state, int
sent);
Parameters:
The
stream -- may be used by host program for next request.
The
usr_par' -- . user s param
The
state defined there:
STATE_SMTP_FINDHOST STATE_SMTP_CONNECTING STATE_SMTP_DIALOG STATE_SMTP_SENDING STATE_SMTP_DONE
sent -- number of bytes that already sent.
SRVInitSendMsgImidiatly
To begin send message directly and immediate, to SMTP server of receptor use:
ServerStream
SRVInitSendMsgImidiatly(char *
from, int *
to,
MsgCallback callback=NULL, void *
callback_param);
Parameters:
From -- sender e-mail
To -- Reception e-mail
callback -- callback function that will call for each change of state.
Return value:
If success return the pointer to Stream
NULL if error.
SRVInitSendMsgSMTP
To begin send message through an external SMTP server use:
ServerStream
SRVInitSendMsgSMTP(char *
from, int *
to, char *
smtp_host, int
port=25 ,
MsgCallback callback=NULL, void *
callback_param=NULL);
Parameters:
From -- sender e-mail
To -- Reception e-mail
smtp_host -- the host of remote SMTP server to connect
port -- port of remote.
callback -- callback function that will call for each change of state.
Return value:
If success return the pointer to Stream
NULL if error.
SRVInitSendMsgBackgaund
To begin send message directly but through background queue use:
ServerStream
SRVInitSendMsgBackgaund(char *
from, int *
to,
MsgCallback callback=NULL, void *
callback_param=NULL);
Parameters:
From -- sender e-mail
To -- Reception e-mail
callback -- callback function that will call for each change of state.
Return value:
If success return the pointer to Stream
NULL if error.
SRVEndOfMsg
After init sending you may put message date with
SRVSend' or 'SRVprintf' and after it use 'SRVEndOfMsg to close the stream.
void
SRVEndOfMsg(ServerStream *
stream);
Parameters:
The
stream -- pointer to stream that was transfer to callback function or return by SRVInitSendMsg*
SetSMTPServer
The host program must only call
SetSMTPServerServer function, that create SMTP server thread
int
SetSMTPServer(SMTPReqCallback
callback=NULL, int
port=0, int
mask=ALL_ACTIONS);
Parameters:
The
callback -- callback function that will call for each request, after request received, before server do anything other
by default NULL -- int this case the server will just work with request.
The
port -- TCP/IP port. If used default value zero, the server use value from config, by default 21.
mask -- the mask for action for that the server call callback
Return value:
Zero if success.
Subzero if fail
SetPOP3Server
The host program must only call
SetPOP3Server function, that create server thread
int
SetPOP3Server(SMTPReqCallback
callback=NULL, int
port=0, int
mask=ALL_ACTIONS);
Parameters:
The
callback -- callback function that will call for each request, after request received, before server do anything other
by default NULL -- int this case the server will just work with request.
The
port -- TCP/IP port. If used default value zero, the server use value from config, by default 21.
mask -- the mask for action for that the server call callback
Return value:
Zero if success.
Subzero if fail
SRVSend
The host program may send data to the client with next functions:
int
SRVSend(ServerStream *
stream, void *
bufer, int
size);
Parameters:
The
stream -- pointer to stream that was transfer to callback function.or return by SRVInitSendMsg*
The
buffer -- buffer to send
The
size -- size of buffer
Return value:
Number of bytes that has been send.
Zero if error
SRVprintf
int
SRVprintf(ServerStream *
stream, char *
format, ...);
Parameters:
The
stream -- pointer to stream that was transfer to callback function or return by SRVInitSendMsg*.
The
format -- format like in stdio printf
... params by format
Return value:
Number of bytes that has been send.
Zero if error
SRVRecv
If you would like reveive the data st you may use
SRVRecv:
int
SRVRecv(ServerStream *
stream, void *
bufer, int
l);
Parameters:
The
stream -- pointer to stream that was transfer to callback function.
The
buffer -- buffer to receive
The
size -- size of buffer
Return value:
Number of bytes that has been receive.
Zero if error
GetAUTHName
To get info about POP3 authorization use next functions:
char *
GetAUTHName(ServerStream *
stream);
Parameters:
The
stream -- pointer to stream that was transfer to callback function.
Return value:
pointer to user name.
GetAUTHPassw
The NULL pointer if no control present.
char *
GetAUTHPassw(ServerStream *
stream);
Parameters:
The
stream -- pointer to stream that was transfer to callback function.
Return value:
pointer to password.
The NULL pointer if no control present.
GetRemoteIP
Advanced info about connection you may get with next functions.
ulong
GetRemoteIP(ServerStream *
stream);
Parameters:
The
stream -- pointer to stream that was transfer to callback function.
Return value:
IP address of remote.
GetRemoteAddr
int
GetRemoteAddr(ServerStream *
stream, void *
addr, int
buflen);
Parameters:
The
stream -- pointer to stream that was transfer to callback function.
Return value:
address of remote in sockaddr struct
GetSocket
int
GetSocket(ServerStream *
stream);
Parameters:
The
stream -- pointer to stream that was transfer to callback function.
Return value:
socket
If you would like find MX records for domain use
FindMX function:
struct MailHostInfo
{
char name[64]; The hostname of MX
int prior; MX priority
ulong ip[12]; Array of IP if it was present in reply.
FindMX
};
int
FindMX(char *
domain, MailHostInfo *
ret, int
size);
Parameters:
domain -- the domain name
ret -- array of MailHostInfo where module will store data
size -- size of array
Return value:
number of MX that has been found If Ok
zero, if not found
The host program may load all params for module from separate file,
LoadConfig
or my set required params directly, or use default values.
int
LoadConfig(char *
filename="ftp.cfg");
Parameters:
The
filename -- name of configuration file.
Return value:
Zero if success.
Subzero if fail
SetConfigParam
You may set all params directly:
void
SetConfigParam(char *
param, int
val);
Parameters:
The
param -- name of param
val -- value.
SetConfigParam
void
SetConfigParam(char *
param, char *
val);
Parameters:
The
param -- name of param
val -- value.
To get current values of configuration params you may use next functions:
GetConfigParamInt
For integer params:
int
GetConfigParamInt(char *
param);
Parameters:
The
param -- name of param
SetConfigParamStr
For string params:
char *SetConfigParamStr(char *
param);
Parameters:
The
param -- name of param