Changes between Version 5 and Version 6 of Documentation/Configuration


Ignore:
Timestamp:
Oct 28, 2012 11:53:15 AM (21 months ago)
Author:
damato
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • Documentation/Configuration

    v5 v6  
    196196 
    197197  Example: RX PROGDIR:rexx/Newmail.YAM 
     198 
     199== Filters == 
     200The purpose of a mail filter is to process mail according to criteria defined by the user.  Whenever a mail matches a specified pattern, it can 
     201trigger certain actions. Applications for the use of filters include 
     202 
     203- automatically moving mail from a mailing list to a specified folder 
     204 
     205- automatic processing of incoming inquiries by sending pre-defined 
     206  answers 
     207 
     208- automatic deletion of unwanted spam (advertising by e-mail, a real 
     209  pest nowadays) 
     210 
     211- automatic re-directing of mails to another recipient. 
     212 
     213You can define theoretically an unlimited number of filters. The list on the left shows the names of all the filters defined so far. Click on a name to bring up its details on the right, spread across three sheets -- Options, Comparison and Action. Click on [New] to create a new filter or use [Delete] to delete one. Filters are executed in top-to-bottom order, therefore you should place filters that delete or move messages at the bottom of the list. 
     214 
     215=== Options === 
     216`Name` 
     217  The filter's name is merely for recognition and not of any other use. 
     218 
     219`Remote filter` 
     220  With a remote filter, new email can be checked on the POP3 server without being downloaded completely. The POP3 server must support the TOP command to be able to process this kind of filter. 
     221  In contrast to 'normal' filters, only the contents of the e-mail headers can be searched for certain patterns. For obvious reasons, functions like forwarding or moving e-mails cannot be used with remote filters. In addition, if remote filters are activated they might slow down downloading e-mail, but they are handy and powerful if used with care. 
     222 
     223`Apply to new mail` 
     224  Activate this option to have all new mail processed by this filter. Processing will start automatically after receiving new mail. 
     225 
     226`Apply to sent mail` 
     227  Activate this option to have all sent mail processed by this filter. Processing will be initiated automatically after sending mail. 
     228 
     229`Apply on request` 
     230  If this option is activated, the filtering process will be started by clicking on the Filter button in the main window or by choosing 'Filter' from the 'Folder' menu. This way you can also process old messages which do not necessarily have to be in the Incoming folder. 
     231 
     232=== Comparison === 
     233`Search in` 
     234  Here you can define what part of the e-mail should be scanned for the search pattern. If you want a field of the message header to be searched, you can choose one from the list which appears when clicking on the cycle gadget, or select 'Other field' and insert the name of the header field into the text field on the right side of the cycle gadget. If 'Message body' is selected, the whole message -except for the headers- will be searched.  Please note that this type of full text search may take quite a long time when big mails are processed (YAM will have to decode mails in MIME format). 
     235 
     236  Example: 'Other field: X-Mailer' 
     237 
     238`Comparison` 
     239  The instruction comprises the comparison operator and the search pattern. 
     240 
     241  YAM supports the following comparison operators: 
     242 
     243  - //=//  the text which is compared must match the search pattern 
     244  - //<//  the text must be "less" than the search pattern 
     245  - //>//  the text must be "greater than" the search pattern 
     246  - //<>// the text must be different from the search pattern 
     247  - //IN// the text must match pattern contained in the file which is specified in the text field to the right side of the comparison cycle gadget.  Instead of a search pattern itself, the name of a file has to be inserted here, containing one or several lines of search patterns. In this way it is possible to create a so-called 'Killfile' containing a list of e-mail addresses. Click on the page icon to edit the file. 
     248 
     249  Note that the comparison operators '<' and '>' work differently according to the type of field.  YAM knows that a message size or date is numeric and sorts these in numerical order, but for fields such as "Subject:", alphanumeric order is used as in a telephone directory, so James < Jim and 12 < 2. 
     250 
     251  The search pattern may contain  AmigaDOS wildcards  such as ?, #?, (a|b) or [abc]. Please note that the search pattern [YAM]#? will filter all messages beginning with Y, A or M. For filtering mails coming from a mailing list (for example, a mailing list related to YAM), you'd better use the search pattern #?YAM#? or have the filter compare the Reply-To: field with the address of the mailing list. 
     252 
     253  Example: '= YAM 1.3.#?' 
     254 
     255`Address/Name` 
     256  If you make the filter search a header field containing an e-mail address, you can specify here whether the search pattern should be processed on the actual address (e.g. jdoe@example.com) or the author's name (e.g. 'John Doe'). 
     257 
     258`Case sensitive` 
     259  Activate this option if you want the filtering process to distinguish between normal and capital letters. 
     260 
     261`Substring search` 
     262  If the search pattern consists of only a part of the header field which is to be searched through, you must activate this option - YAM will then complete the search pattern with #? internally. 
     263 
     264  It is possible to combine two search criteria. The cycle gadget lets you select how this is to be done: 
     265 
     266  //none// don't use a second criterion 
     267  //and//  both criteria must be satisfied 
     268  //or//   at least one of the two criteria must be met 
     269  //exclusive or// either one or the other of the two criteria must apply, but not both 
     270 
     271=== Action === 
     272 
     273`Bounce` 
     274  Activate this option to have mail matching the search criteria bounced to another recipient -- for instance, you might use this to automatically resend certain email to your mailbox at work. 
     275 
     276  The new recipient's e-mail address must be inserted into the text field next to the option. 
     277 
     278  Example: jdoe@example.net 
     279 
     280`Forward` 
     281  Activate this option when you want e-mail matching the search criteria to be forwarded to another person.  The new recipient's e-mail address must be inserted into the text field next to the option. 
     282 
     283`Reply` 
     284  If this option is activated, YAM will send an automatic reply to any mail matching the search pattern. Enter the filename containing the auto-answer text into the text field next to this option. 
     285 
     286  Example: PROGDIR:Auto-Texts/Answer1.txt 
     287 
     288`Execute` 
     289  If this option is activated, an external program will be executed whenever an email matches the search criterion. YAM will send the path of the e-mail to the external program as a starting parameter. Insert the command line into the text field next to this option. 
     290 
     291  Please note that if you want an ARexx script to be executed, you will have to explicitely put the 'RX' command first. 
     292 
     293  Example: 'rx PROGDIR:Rexx/Subscribe.rexx' 
     294 
     295`Play sound` 
     296  Activate this option to have a sound played whenever a message matches the search pattern.  The sound file name is to be inserted into the text field next to this option.  YAM uses the datatypes library for playing the sound.  Click the small arrow (PLAY symbol) to test the sound. 
     297 
     298  Example: Data:Audio/Ihatespam.wav 
     299 
     300`Move` 
     301  If you activate this option, YAM will move any email matching the search pattern to another folder. You can select the folder with the pop-up button. 
     302 
     303 
     304`Delete` 
     305  If this option is activated, all messages matching the search pattern will be deleted. (You probably guessed that... ;) ) 
     306 
     307 
     308`Don't download` 
     309  If this option is activated, any message matching the search pattern will not be downloaded from the mail server. You can use a remote filter together with this option if several people share the same POP3 account.