Changes between Version 3 and Version 4 of Documentation/ARexxAPI/MAILFILTER


Ignore:
Timestamp:
Feb 5, 2014 9:42:16 AM (6 months ago)
Author:
damato
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • Documentation/ARexxAPI/MAILFILTER

    v3 v4  
    1 [[TranslatedPages]]\\ 
    2 [[TOC(titleindex, heading=ARexx API, notitle, depth=2, Documentation/ARexx API/*)]] 
    3  
     1[[TranslatedPages]] 
     2[[TOC(sectionindex, heading=ARexx Function List, notitle, depth=1, Documentation/ARexxAPI/)]] 
    43== MAILFILTER 
    54 
    6 '''NAME''' 
     5 NAME:: 
    76     MailFilter -- Filter messages in the current folder.  (V1.3.3) 
    87 
    9 '''TEMPLATE''' 
     8 TEMPLATE:: 
    109     VAR/K,STEM/K,ALL/S 
    1110 
    12 '''FUNCTION''' 
     11 FUNCTION:: 
    1312     Filters all the messages in the current folder, or only those 
    1413     marked as "new". 
    1514 
    16 '''INPUTS''' 
    17      VAR/K    - alternative variable to put the results into instead of RESULT  (V2.0)\\ 
    18      STEM/K   - base name used for the stems where the returned data will be stored  (V2.0)\\ 
    19      ALL/S    - filter ALL the messages in the folder, instead of only those marked as "new"\\ 
     15 INPUTS:: 
     16     `VAR/K`    - alternative variable to put the results into instead of RESULT  (V2.0)\\ 
     17     `STEM/K`   - base name used for the stems where the returned data will be stored  (V2.0)\\ 
     18     `ALL/S`    - filter ALL the messages in the folder, instead of only those marked as "new"\\ 
    2019 
    21 '''RETURNS''' 
    22      VAR             - info returned by the query\\ 
    23      <STEM>CHECKED   - total number of messages checked\\ 
    24      <STEM>BOUNCED   - number of messages bounced\\ 
    25      <STEM>FORWARDED - number of messages forwarded\\ 
    26      <STEM>REPLIED   - number of messages auto-replied\\ 
    27      <STEM>EXECUTED  - number of messages that triggered a command execution\\ 
    28      <STEM>MOVED     - number of messages moved to another folder\\ 
    29      <STEM>DELETED   - number of messages deleted\\ 
     20 RETURNS:: 
     21     `VAR`             - info returned by the query\\ 
     22     `<STEM>CHECKED`   - total number of messages checked\\ 
     23     `<STEM>BOUNCED`   - number of messages bounced\\ 
     24     `<STEM>FORWARDED` - number of messages forwarded\\ 
     25     `<STEM>REPLIED`   - number of messages auto-replied\\ 
     26     `<STEM>EXECUTED`  - number of messages that triggered a command execution\\ 
     27     `<STEM>MOVED`     - number of messages moved to another folder\\ 
     28     `<STEM>DELETED`   - number of messages deleted\\ 
    3029 
    3130     Note that stems are initialized even for empty folders. 
    3231 
    33 '''WARNING''' 
     32 WARNING:: 
    3433     Due to a design flaw in YAM, filtering a large amount of mail 
    3534     where lots of folder indices need to be loaded is potentially 
     
    3837     to a crash.  Use with caution. 
    3938 
    40 '''NOTES''' 
     39 NOTES:: 
    4140     Contrary to what happens when using the GUI, the command doesn't 
    4241     put up any warning when working in a folder other than "Incoming". 
    4342 
    44 '''EXAMPLE''' 
    45          /* Enable result codes */ 
     43 EXAMPLE:: 
     44     {{{#!urbiscript 
     45     /* Enable result codes */ 
     46     OPTIONS RESULTS 
    4647 
    47          OPTIONS RESULTS 
     48     /* Filter all the messages in the current folder */ 
     49     MAILFILTER ALL STEM st. 
    4850 
    49          /* Filter all the messages in the current folder */ 
     51     /* Display results */ 
     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     }}} 
    5060 
    51          MAILFILTER ALL STEM st. 
     61 BUGS:: 
    5262 
    53          /* Display results */ 
    54  
    55          SAY 'Checked messages:   'st.checked\\ 
    56          SAY 'Bounced:            'st.bounced\\ 
    57          SAY 'Auto-forwarded:     'st.forwarded\\ 
    58          SAY 'Auto-replied:       'st.replied\\ 
    59          SAY 'Commands triggered: 'st.executed\\ 
    60          SAY 'Moved:              'st.moved\\ 
    61          SAY 'Deleted:            'st.deleted\\ 
    62  
    63 '''BUGS''' 
    64  
    65 '''SEE ALSO''' 
     63 SEE ALSO::