Variabless for Filter Scripts

Variable

Description

Example Statement

InterfaceFilter

This applies a filter to processed data. This allows the interfaces to apply the initial layer of data sorting and collection and then applies the filter to the result.

GetAscii

Standard polling: Filter is applied against temp file with recipient, sender and message

Advanced polling: Filter is applied against temp file with recipient, sender and message, and after lookup substitution

GetMail

Filter is applied against temp file with recipient, sender and message, after they have been extracted from the email, and decoding has taken place

GetSerial

Filter is applied against temp file with recipient, sender and message, and after lookup substitution

GetTap

Filter is applied against each message that is received. The file processed by PGFilter will have Id as first line, second line blank, and message on remaining lines.

GetWeb

Filter is applied against temp file with recipient, sender and message

This can be used on an interface or global level. If used in an interface, it applies the filter to that interface. If used on a global level, it applies the filter to all input from all interfaces.

InterfaceFilter = c:\092PageGateData\092Filters\092yourfilter.xml

RawInterfaceFilter

This applies a filter to raw, unprocessed data. This applies the filter before the interface has a chance to read the data. The specific behavior varies depending on the interface in question.
 
GetAscii

Standard polling: Filter is applied against the raw text file before GetAscii tries to process it

Advanced polling: Filter is applied against each record that is found, before it is processed any further (record pattern matching done first)

GetMail

Filter is applied against the raw file received from the PageGate mail server process. All headers are intact and no decoding has taken place yet. Envelope values for recipient and sender are not available for modification in the raw mail file (because they are read from the envelope).

GetSerial

Filter is applied against each record found before it is processed any further (record pattern matching is done first)

GetTap

Filter is applied against each message that is received.

GetWeb

Filter is applied against raw text file created by webgate.exe CGI program

This can be used on an interface or global level. If used in an interface, it applies the filter to that interface. If used on a global level, it applies the filter to all input from all interfaces.

RawInterfaceFilter = c:\092PageGateData\092Filters\092yourfilter.xml

Filter

This applies a filter to outbound messages.

This can be applied on a recipient, carrier, connector or global level.

If used in a recipient template, all messages delivered to that recipient will be processed through the filter.

If used in a carrier template, all messages delivered through that carrier will be processed through the filter.

If used in the program template, it applies to all output from the program.

ConnectorFilter = c:\092PageGateData\092Filters\092yourfilter.xml

ConnectorFilter

This applies a filter to the messages delivered by a connector. This filter can only modify the contents of a message and cannot modify the recipient or sender information.

This can be applied on a connector or global level.

If used in the program template, it applies to all connectors in the program.

Filter = c:\092PageGateData\092Filters\092yourfilter.xml

SubjectFilter

This applies a filter to the subject line of any outbound email. This value is only referenced by the SMTP protocol and is not referenced by other protocols.

This can be applied on a recipient, carrier, connector or global level.

If used in a recipient template, all SMTP/email messages delivered to that recipient will have their subject lines processed through the filter.

If used in a recipient template, all SMTP/email messages delivered to through that SMTP/email carrier will have their subject lines processed through the filter.  

If used in the program template, all SMTP/email traffic sent from the system will have its subject line processed through the filter.

SubjectFilter = c:\092PageGateData\092Filters\092yourfilter.xml