Tivoli Mail Gateway KB File Detail


dbgutils.kb

File Description

This module supplies debugging instrumentation to TMG.

File Structure Notes

Procedures

DbgCloseOutputWindow

DbgCommonWrite

DbgEventOutput

DbgWrite

DbgWriteLn

Functions

DbgEventName

DbgInitialize

DbgOpenOutputWindow

NextStrColor

Events

DbgEvent


ea_apis.kb

File Description

This module has been established to isolate TMG's communication with TPM functions or tables in one place. As such, it is the module most likely to be modified to accommodate customer-specific customizations to the base TPM product. It is suggested that, as you expand TMG's interaction with TPM, you continue to use this module to isolate TPM-related functions.

File Structure Notes

Procedures

None

Functions

EAAddProblemHistory

EACreateInquiryRecord

EACreateProblem

EAGetLists

EAGetProblemStatus

EALogin

EASelectAUser

EAUpdateContactRow

EAUpdateSolution

EAValidCallCode

EAValidEAUser

EAValidSeverityCode

EAValidSystem

SAIApplicationIsInstalled

SAIInitApplicationMask

SAIRegisterApplication

Events

UserSelectEventHandler


ee_apis.kb

File Description

Procedures

None

Functions

EEInitialize

Events

None


emamainr.kb

File Description

This module holds the definitions for all record types used in the EMA_MAIN module of Tivoli Mail Gateway.

File Structure Notes

Procedures

None

Functions

None

Events

None


ema_admn.kb

File Description

This module creates the TMG administration dialog box type and handles all interactions with that dialog box.

File Structure Notes

Procedures

None

Functions

AdminCreateDialog

AdminDBAddRow

AdminDBDeleteRow

AdminDBLoadTable

AdminDBUpdateRow

AdminDestroyDialog

AdminDlgRestoreData

AdminDlgSaveData

AdminEnableControls

AdminGetData

AdminGetListData

AdminInitData

AdminLBAddAction

AdminLBDeleteAction

AdminLBEnter2ndaryFieldAction

AdminLBEnterKeyFieldAction

AdminLBModifyAction

AdminLBMsgSelectHandler

AdminLBSelectAction

AdminSaveData

AdminSetData

AdminShutDown

RefreshListBoxFromData

TransferRowToGUIFields

Events

AdminEventHandler

ModuleTestEventHandler


ema_bind.kb

File Description

This module handles the various functions for list box handling.

File Structure Notes

Procedures

None

Functions

BindValidateEmailUser

Events

None


ema_cli.kb

File Description

This file contains source code that implements the end-user functional commands (representing a virtual command line interface (CLI) for the agent). This module's entry points have no GUI. The major functions take textual commands and perform the requested actions.

Procedures

AppendOriginalBodyToOutput

CleanupMessage

CLIBuildAlternateBody

CLITest

Functions

CleanupUserReply

CLIExecuteCommand

CLIInitialize

CLIParseCommand

CLIProcessBrowseProb

CLIProcessBrowseSoln

CLIProcessComment

CLIProcessDiagnoseProb

CLIProcessHelp

CLIProcessSubmitProb

CLIProcessUpdateProb

CLIProcessUseSoln

CLIProcessViewProb

CLIShutDown

ParseNextAsNoun

ParseNextAsVerb

ParseRemainder

RefreshTestFields

Events

ModuleTestEventHandler


ema_cnfg.kb

File Description

This module creates the TMG configuration dialog box type and handles all interactions with that dialog box.

File Structure Notes

Procedures

None

Functions

CleanupAttachmentPath

CloseCommentFile

CommaStringToList

ConfigADLRefreshRate

ConfigAdminDeleteConfirm

ConfigAdminModifyConfirm

ConfigAttachmentEnabled

ConfigCommentCommandEnabled

ConfigCommentWriteEntry

ConfigCommentWriteLn

ConfigCreateDialog

ConfigCutoffAccount

ConfigDestroyDialog

ConfigDiagnoseInquiryEnabled

ConfigDlgRestoreData

ConfigGetData

ConfigInitData

ConfigMaxMsgSize

ConfigMaxMsgSizeType

ConfigMaxSolsReturned

ConfigSaveAttachment

ConfigSetData

ConfigShutDown

ConfigStatsRefreshRate

NewAttachFileName

OpenCommentFile

PerformSelectAction

TransferAttribsToModuleRec

TransferModuleRecToAttribs

UpdateDialogFromData

Events

ConfigEventHandler


ema_db.kb

File Description

This module handles the writing of various items of information to the database tables for TMG. This module has no GUI of its own, and is a utility only.

File Structure Notes

Procedures

None

Functions

DBGetAttribList

DBSetAttribDefaults

DBSetAttribList

Events

None


ema_defs.kb

File Description

This module supplies various global definitions for all modules which make up the Tivoli Mail Gateway program. NOTE: All user-visible strings are now defined in the file ema_defs.df (although related constants and variables are defined in this module).

File Structure Notes

The various definitions tend to be grouped by relationship and module.

Procedures

None

Functions

None

Events

None


ema_eadf.kb

File Description

This module is a template for creating dialog box types and handling all interaction with that dialog box.

File Structure Notes

Procedures

TestThisModule

Functions

EADefaultsCreateDialog

EADefaultsDestroyDialog

EADefaultsDlgRestoreData

EADefaultsEnableControls

EADefaultsGetData

EADefaultsInitData

EADefaultsRefreshLists

EADefaultsSaveData

EADefaultsSetData

EADefaultsShutDown

EADefaultsValidateEntries

PerformSelectAction

TransferAttribsToModuleRec

TransferModuleRecToAttribs

Events

EADefaultsEventHandler

ModuleTestEventHandler


ema_eror.kb

File Description

This module creates the log dialog box type and handles all interactions with that dialog box.

File Structure Notes

Procedures

ErrLogTestDialog

Functions

CommonWrite

CreateLogFile

CreateLogWindow

DisplayLogFileInWindow

ErrLogCreateDialog

ErrLogDBErrorFatal

ErrLogDlgRestoreData

ErrLogEnableControls

ErrLogHideDialog

ErrLogInitData

ErrLogShutDown

ErrLogWrite

ErrLogWriteDBError

ErrLogWriteLn

ErrLogWriteSysError

PerformAction

TransferAttribsToModuleRec

TransferModuleRecToAttribs

Events

ErrLogEventHandler

ErrModuleTestEventHandler

PlaceholderEvent


ema_kwd.kb

File Description

This module encapsulates the data and associated functions for the EMA command keywords. Command keywords are "labels" which designate individual field entries on EMA's command input forms. The keywords are completely configurable by the EMA administrator. All configuration is performed through the EMA Command Configuration dialog (see ema_ccfg.kb).

File Structure Notes

The structure, methodology and coding guidelines used by the developers of this module, as well as the module development history, are located at the end of this file in a large comment.

Procedures

KeywordInitialize

Functions

None

Events

None


ema_log.kb

File Description

This module creates the log dialog box type and handles all interactions with that dialog box.

File Structure Notes

Procedures

LogTestDialog

Functions

CloseLogFile

CommonWrite

CreateLogFile

CreateLogWindow

LogCreateDialog

LogDestroyDialog

LogDlgRestoreData

LogGetData

LogHideDialog

LogInitData

LogSetData

LogShutDown

LogWinWrite

LogWrite

LogWriteIncoming

LogWriteLn

LogWriteOutgoing

PerformAction

TransferAttribsToModuleRec

TransferModuleRecToAttribs

UpdateDialogFromData

Events

LogEventHandler

PlaceholderEvent


ema_mail.kb

File Description

This module creates a generic dialog box type and handles all interactions with that dialog box.

File Structure Notes

Procedures

CleanUpMessageContent

EmailTest

UpdateLoginDialog

WriteMsgLns

Functions

EMailDeleteCurrentMessage

EMailGetReadMessageCount

EMailGetUnreadMessageCount

EMailInitData

EMailLogin

EMailLogout

EMailOpenContainer

EMailPrepareOutgoingMessage

EMailReadNextNewMessage

EMailScanUnreadMessages

EMailSendMessage

EMailShutDown

EmailStartup

EMailSystemTypeNum

HandleDeleteBtn

HandleDumpBtn

HandleGetReadBtn

HandleGetUnreadBtn

HandleListSelect

HandleLoginBtn

HandleLogoutBtn

HandleReadBtn

HandleSendBtn

PerformAction

PerformSelectAction

StatusOfKMLMailCall

UpdateLoginFields

Events

DumpStructEvent

EMailLoginEventHandler

EMailTestEventHandler


ema_main.kb

File Description

This module is the main driver for the Tivoli Mail Gateway program. It contains all of the interaction software for the TMG Administrator GUI, and references routines in the TMG Command Line Interface module, which implements the e-mail user-level routines.

File Structure Notes

Procedures

EMAStartup

MungeEMailStatus

Functions

ChangeState

ContinueMessageProcessing

DisconnectFromEA

DisconnectFromEMail

EF

EMAInitialize

HandleEMailError

HandleMenuSelection

HandleRIFailure

InitializeState

PerformSelectAction

ProcessAMessage

ReconnectToEA

ReconnectToEMail

SendReplyAsAttachment

SendUserReply

ShutDownAndCloseWindow

StartEmailTimer

StartIntraMessageTimer

StartMessageProcessing

StopEmailTimer

StopIntraMessageTimer

TransferAttribsToModuleRec

TransferModuleRecToAttribs

UpdateCurrentProcessGUI

UpdateMainGUI

UpdateMainGUIState

UpdateServerStateGUI

UpdateSummaryGUI

Events

EMAMainEvent

PlaceholderEvent


ema_user.kb

File Description

This module handles the various functions for list box and dialog box handling for the User Activity box.

File Structure Notes

Procedures

UserActTestThisModule

Functions

DBGetStatsInfo

DBSetStatsInfo

ExportUserActivityData

RefreshListBoxFromData

TransferRowToGUIFields

UpdateSingleStatistic

UserActCreateDialog

UserActDBLoadTable

UserActDestroyDialog

UserActDlgRestoreData

UserActDlgSaveData

UserActEnableControls

UserActGetData

UserActInitData

UserActLBEnter2ndaryFieldAction

UserActLBModifyAction

UserActLBMsgSelectHandler

UserActLBSelectAction

UserActNewMessage

UserActSaveData

UserActSetData

UserActShutDown

Events

ModuleTestEventHandler

UserActEventHandler


eq_apis.kb

File Description

This file contains source code which implements the "hiding" API to Tivoli Quality Management. TMG has independence from current TQM implementation.

File Structure Notes

The structure, methodology and coding guidelines used by the developers of this module, as well as the module development history, are located at the end of this file in a large comment.

Procedures

None

Functions

EQInitialize

Events

None


gnc_defs.kb

File Description

This module supplies generic definitions for Tivoli Mail Gateway.

File Structure Notes

Procedures

None

Functions

None

Events

None


m_string.kb

File Description

Contains the resources of the string tables for Tivoli Mail Gateway.

File Structure Notes

None

Procedures

None

Functions

None

Events

None


nettest.kb

File Description

This file contains the functions that use the application server to complete the necessary e-mail requests.

Procedures

None

Functions

AddProblemHist

GetADL

SubmitProblem

UseSolution

ViewProblem

ViewProbNoID

WithHist

Events

None


tstmsgen.kb

File Description

This module has been established for testing purposes.

File Structure Notes

Procedures

TestGenMain

Functions

ReadEmailSysData

ReadMessageScriptFile

Events

ModuleTestEventHandler