; filter.txt
;
; This is the WaterGate help file
; This file is included by wtrgate.txt
;
; Contents: WtrConf Filter Definitions help
;

; quick reference:
;
; #topic(reference text)
; #subtopic(reference text)
; #end
; #title(text)
; Space at start of line or #linebreak
; Empty line or #break
; #link(reference)(text)
; #highlight(text) or #hl(text)


;---------------------------------------------------------------------------
; Filter SearchLimit
;
#topic(Filter SearchLimit)
#title(Filter search limitation)
Select which types of messages you want to limit this filter to.
#end


;---------------------------------------------------------------------------
; Filter SelectArea
;
#topic(Filter SelectArea)
#title(Filter area selection)
Select the area you want to use for the filter from this list.
#end


;---------------------------------------------------------------------------
; Filter SelectAction
;
#topic(Filter SelectAction)
#title(Filter action selection)
Select the action you want this filter to perform from this menu.
#end


;===========================================================================
; Filter Definition Editor
;
#topic(Filter Definition Editor)
#title(Filter Definition)
This help topic belongs to the fields of a Filter Definition in
WtrConf.

#subtopic(EditFilter Search)
#title(Search)
In this field you select in which types of messages you want to
search. You can select a combination of netmail, echomail, mail
and news.

Another way to see this is as a limitation. You can limit
what type of messages are searched.

#subtopic(EditFilter InOut)
#title(In/Out)
This option allows you to limit a filter to inbound or outbound
messages.

 Inbound  - Messages entering your system only
 Outbound - Messages leaving your system only
 Both     - Inbound or Outbound

#subtopic(EditFilter Parts)
#title(Parts)
This fields allows you to focus the search on a certain part of
a message. You can choose from the generic terms @All@, @Body@,
@Header@, @From@, @To@ and @Subject@.

@All@ searches every character in a message. @Body@ limits it to the
actual message text and @Header@ to the control part of a message
only. @From@, @To@ and @Subject@ select one of the three generic
blocks of the header.

For e-mail and news, the From includes the From:, Sender: and
Reply-To: headers and the To including the To:, Cc:, Bcc: and
Apparently-To: headers.

To match a certain header line in a RFC message, simply include
the header name itself as well. For example: "X-Dist: Some List".

#subtopic(EditFilter SearchFor)
#title(Search for)
Fill in the actual text you want to search for in this field.

You must fill in this field or the entire entry will be ignored by WtrGate.

#subtopic(EditFilter Action)
#title(Action)
When a match of the Text is found in the selected part(s) of
the selected message type(s), then you can tell WaterGate to
actually do something with the message. You can choose from

#hl(Move) Move the message to the area selected in the Area field.

#hl(Copy) As above, but makes a copy and delivers the message as well.

#hl(Delete) Send the message to a big black hole.

#hl(Forward) Forward to a specific FTN or RFC address,
optionally via a remote gateway.

#hl(Carbon Copy) Make a copy of this message and send it to another user.

#hl(Bounce) Bounce message back to sender with a 'why' filled in
in the Reason field.

#hl(Bounce To) As Bounce, but to a specific address, for example to
postmaster. See the manual for more details.

#hl(Save) Save to disk (message is not delivered) to the directoryt
selected in the Path field.

#subtopic(EditFilter AddNote)
#title(Add note)
When set to Yes, WaterGates adds a short note to the start of the
copied message to indicate where it was copied from and at what
date and time.

#subtopic(EditFilter AddressType)
#title(Address type)
This fields selects the type of address you want to send the
message to. You can send it to an FTN recipient (via netmail),
an RFC recipient (via e-mail) or a RFC recipient behind a
remote FTN->RFC gateway.

#subtopic(EditFilter Name)
#title(Name)
Enter the full name part of the FTN address here.

#subtopic(EditFilter AKA)
#title(AKA)
Enter the AKA of the FTN address here.

#subtopic(EditFilter Email)
#title(E-mail)
Enter the e-mail address here.

<special format for bounce-to to be added>

#subtopic(EditFilter AreaName)
#title(AreaName)
Enter the name of the area where you want to copy or move the
message to. An Area Definition with the same name has to exist.

#subtopic(EditFilter Reason)
#title(Reason)
When bouncing a message, WaterGate puts this 'why' text in the message.

#subtopic(EditFilter Path)
#title(Path)
When SAVE is selected, the message is saved to a file in the
directory you select here.

You press function key F3 and use the File Manager to select
the directory.
#end


;---------------------------------------------------------------------------
; Filter Definitions
;
#topic(Filter Definitions)
#title(Filter Definitions)
This list shows the Filters you have defined.
You can use the following keys:

  Escape - Return to the main menu
  Insert - Create a new Filter Definition
  Enter  - Edit the filter the cursor is on
  Delete - Delete the filter the cursor is on

#end

; end of file filter.txt
