EditProperties()
Syntax: EditProperties( )
This function is called whenever the plug-in entry is double clicked in the WorkgroupMail administrator. This function takes no arguments and returns nothing back to the caller.
Ideally, this function should create a modal dialog box or property sheet, allowing the user to change any settings associated with the plug-in.
DefaultName()
Syntax: DefaultName( ) As String
This function is called by the WorkgroupMail Administrator in order to query the name of the plug-in. The plug-in name will be used to display the plug-in in the left hand window in the WorkgroupMail Administrator.
So, for example, you might return a typical DefaultName string as follows:
DefaultName = "Sample Plug-in"
GetProperties()
Syntax: GetProperties() As String
This function is used to display the properties (or settings) associated with the plug-in, in the right hand window of the WorkgroupMail Administrator when the user clicks on the plug-in entry in the left-hand window.
The string that you return from this function represents all the properties and values of the plug-in. The format of the string is as follows:
Property 1 & Value 1 & Property 2 & Value 2….
So, for example, you might return a typical property string as follows:
GetProperties = "Name&Sample Plug-in&Folder&" & "c:\temp" & "&Date&" & "12/4/01"
ProcessMessageFile()
Syntax: ProcessMessageFile(sFilename As String, bReceived As Integer, ByRef sDescription As String ) As Long
This function is called by the WorkgroupMail engine to determine whether or not a particular message should be quarantined.
The ProcessMessageFile() should do the following:
· Parse the file, sFilename, and look at whether the message is incoming or outgoing (bReceived) to determine whether this plug-in should quarantine or not.
· If the message is quarantined remember to assign a reason string to the sDescription parameter.
· Return one of the following values to determine how the message is treated by the engine:
| Return Value | Action |
| 1 | Do not quarantine the message. Don't pass this message to any further plug-ins and don't permit the message to be sent or received. |
| 2 | Quarantine the message. Don't pass this message to any further plug-ins and don't permit the message to be sent or received. |
| 3 | Do not quarantine the message. Pass this message to any further plug-ins for processing. Permit this message to be sent and received unless another plug-in throws a problem. |
| 4 | Log an event to indicate a problem with the plug-in. Pass this message to any further plug-ins for processing. Permit this message to be sent and received unless another plug-in throws a problem. |