MAIN processing library

the file lib/libBID.tcl is the main processing library of the BID server. More...

Modules
	logging and debugging procedures
	mime header related procedures
	body formatting procedures
	mime context management procedures
Functions
string	Exit (optional num=0)
	finish the plugin processing and send out eMail
string	Main ()
	this is the Main processing procedure
Variables
string	TOK = UNKNOWN
	the tcl object mime handle of the eMail, use mime for additional information
array	HEADER = {To "" Cc "" Bcc "" From ""}
	the array of all mime header tokens available like To, Cc, Bcc, From, Subject
string	ID = UNKNOWN
	the name of the plugin used to handle this business case
string	LSUB = [list]
	the list of all parts of the Subject split with @ including the ID on the first position
string	SUB = UNKNOWN
	the original subject of the eMail (everything after the first @)
string	HOST = [string tolower [info hostname]]
	the current local hostname
string	USER = [exec /usr/bin/whoami]
	the current local user-name
string	_GLOBAL_VARS = [list TOK ID LSUB SUB HOST SEND DEBUG SYSMAIL SYSADMIN SYSGROUP SYSGROUPNAME sendType APPMAILRELAY APPMAILHOST SPAM_INTERVALL SPAM_ID DEV_HOST]
	!private! all global variables used
string	_GLOBALLIST = [list]
	!private! used to store stack data

---

Detailed Description

the file lib/libBID.tcl is the main processing library of the BID server.

Attention:

The doxygen documentation builder was primary developted for the C, C++, JAVA, ... language documentation and does not support the Tcl syntax.
The following translation rules have to be applied:

variable	string NAME = DEFAULT	set NAME DEFAULT
variable	array NAME = DEFAULT	array set NAME DEFAULT
procedure	string NAME ( type ARG1, ... )	proc NAME {ARG1 ...}
procedure	string NAME ( optional ARG1=DEF1, ... )	proc NAME {{ARG1 DEF1} ...}

---

Function Documentation

string Exit

(

optional

num = 0

)

finish the plugin processing and send out eMail

Parameters:

num

the exit number (default 0)

Attention:

it is safe to call this proc even from inside a plugin

The global boolean variable SEND is used to control if send-out (yes) or not send-out (no) the eMail defined in the mime object TOK.

string Main

(

)

this is the Main processing procedure

---

Variable Documentation

string TOK = UNKNOWN

the tcl object mime handle of the eMail, use mime for additional information

array HEADER = {To "" Cc "" Bcc "" From ""}

the array of all mime header tokens available like To, Cc, Bcc, From, Subject

string ID = UNKNOWN

the name of the plugin used to handle this business case

string LSUB = [list]

the list of all parts of the Subject split with @ including the ID on the first position

string SUB = UNKNOWN

the original subject of the eMail (everything after the first @)

string HOST = [string tolower [info hostname]]

the current local hostname

string USER = [exec /usr/bin/whoami]

the current local user-name

the executable /usr/bin/whoami because it is not garanteed the the tcl variable tcl_platform(user) works

Attention:

if your OS does not support /usr/bin/whoami please change the code to your needs

string _GLOBAL_VARS = [list TOK ID LSUB SUB HOST SEND DEBUG SYSMAIL SYSADMIN SYSGROUP SYSGROUPNAME sendType APPMAILRELAY APPMAILHOST SPAM_INTERVALL SPAM_ID DEV_HOST]

!private! all global variables used

The procedures Initialize and Finalize are using _GLOBAL_VARS to push the current environment to the stack

string _GLOBALLIST = [list]

!private! used to store stack data

---