Changes between Initial Version and Version 1 of Documentation/ARexxAPI/MAILFILTER


Ignore:
Timestamp:
Sep 23, 2013 7:43:52 PM (14 months ago)
Author:
AmigaPhil
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • Documentation/ARexxAPI/MAILFILTER

    v1 v1  
     1== MAILFILTER 
     2 
     3'''NAME''' 
     4     MailFilter -- Filter messages in the current folder.  (V1.3.3) 
     5 
     6'''TEMPLATE''' 
     7     VAR/K,STEM/K,ALL/S 
     8 
     9'''FUNCTION''' 
     10     Filters all the messages in the current folder, or only those 
     11     marked as "new". 
     12 
     13'''INPUTS''' 
     14     VAR/K    - alternative variable to put the results into instead of RESULT  (V2.0)\\ 
     15     STEM/K   - base name used for the stems where the returned data will be stored  (V2.0)\\ 
     16     ALL/S    - filter ALL the messages in the folder, instead of only those marked as "new"\\ 
     17 
     18'''RETURNS''' 
     19     VAR             - info returned by the query\\ 
     20     <STEM>CHECKED   - total number of messages checked\\ 
     21     <STEM>BOUNCED   - number of messages bounced\\ 
     22     <STEM>FORWARDED - number of messages forwarded\\ 
     23     <STEM>REPLIED   - number of messages auto-replied\\ 
     24     <STEM>EXECUTED  - number of messages that triggered a command execution\\ 
     25     <STEM>MOVED     - number of messages moved to another folder\\ 
     26     <STEM>DELETED   - number of messages deleted\\ 
     27 
     28     Note that stems are initialized even for empty folders. 
     29 
     30'''WARNING''' 
     31     Due to a design flaw in YAM, filtering a large amount of mail 
     32     where lots of folder indices need to be loaded is potentially 
     33     dangerous on Amigas with few memory, as the system might run 
     34     out of memory while the filtering is being done, thus leading 
     35     to a crash.  Use with caution. 
     36 
     37'''NOTES''' 
     38     Contrary to what happens when using the GUI, the command doesn't 
     39     put up any warning when working in a folder other than "Incoming". 
     40 
     41'''EXAMPLE''' 
     42         /* Enable result codes */ 
     43 
     44         OPTIONS RESULTS 
     45 
     46         /* Filter all the messages in the current folder */ 
     47 
     48         MAILFILTER ALL STEM st. 
     49 
     50         /* Display results */ 
     51 
     52         SAY 'Checked messages:   'st.checked\\ 
     53         SAY 'Bounced:            'st.bounced\\ 
     54         SAY 'Auto-forwarded:     'st.forwarded\\ 
     55         SAY 'Auto-replied:       'st.replied\\ 
     56         SAY 'Commands triggered: 'st.executed\\ 
     57         SAY 'Moved:              'st.moved\\ 
     58         SAY 'Deleted:            'st.deleted\\ 
     59 
     60'''BUGS''' 
     61 
     62'''SEE ALSO'''