Changes between Version 3 and Version 8 of Documentation/ARexxAPI/MAILCHECK


Ignore:
Timestamp:
(multiple changes)
Author:
(multiple changes)
Comment:
(multiple changes)

Legend:

Unmodified
Added
Removed
Modified
  • Documentation/ARexxAPI/MAILCHECK

    v3 v8  
    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== MAILCHECK 
    54 
    6 '''NAME''' 
     5 NAME:: 
    76     MailCheck -- Download new mail. 
    87 
    9 '''TEMPLATE''' 
     8 TEMPLATE:: 
    109     VAR/K,STEM/K,POP/K/N,MANUAL/S 
    1110 
    12 '''FUNCTION''' 
     11 FUNCTION:: 
    1312     Downloads new email from the specified POP3 account, or from all 
    1413     of them if none is specified. 
    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      POP/K/N    - POP3 mail account to check, specified as the position in the list of POP3 accounts in Configuration ->TCP/IP; the account at the top is account 0  (V2.0)\\ 
    20      MANUAL/S   - open the transfer window to enable user interaction, i.e. message preselection  (V2.0)\\ 
     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     `POP/K/N`    - POP3 mail account to check, specified as the position in the list of POP3 accounts in Configuration ->TCP/IP; the account at the top is account 0  (V2.0)\\ 
     19     `MANUAL/S`   - open the transfer window to enable user interaction, i.e. message preselection  (V2.0)\\ 
    2120 
    22 '''RETURNS''' 
    23      VAR              - info returned by the query\\ 
    24      <STEM>DOWNLOADED - total number of downloaded emails\\ 
    25      <STEM>ONSERVER   - total number of emails remaining on the server\\ 
    26      <STEM>DUPSKIPPED - total number of duplicates skipped\\ 
    27      <STEM>DELETED    - total number of emails deleted from the server\\ 
     21 RETURNS:: 
     22     `VAR`              - info returned by the query\\ 
     23     `<STEM>DOWNLOADED` - total number of downloaded emails\\ 
     24     `<STEM>ONSERVER`  - total number of emails remaining on the server\\ 
     25     `<STEM>DUPSKIPPED` - total number of duplicates skipped\\ 
     26     `<STEM>DELETED`    - total number of emails deleted from the server\\ 
    2827 
    29      In V1.x, RC was always set to 0.  As of V2.0 however, RC is set to 
     28     In V1.x, `RC` was always set to 0.  As of V2.0 however, `RC` is set to 
    3029     5 if the TCP/IP stack is not online. 
    3130 
    32      Likewise, in V1.x RESULT was set to the number of downloaded emails, 
     31     Likewise, in V1.x `RESULT` was set to the number of downloaded emails, 
    3332     or -1 if the connection to the mail server failed. 
    3433 
    35 '''NOTES''' 
    36      The command returns immediately if MANUAL is used. 
     34 NOTES:: 
     35     The command returns immediately if `MANUAL` is used. 
    3736 
    3837     If no account is specified, the command will only check those 
     
    4039     if the "Get" button was pressed in the toolbar. 
    4140 
    42 '''EXAMPLE''' 
    43          /* Enable result codes */ 
     41 EXAMPLE:: 
     42     {{{#!arexx 
     43     /* Enable result codes */ 
     44     OPTIONS RESULTS 
    4445 
    45          OPTIONS RESULTS 
     46     /* Download email from a mail account */ 
     47     MAILCHECK POP 2 STEM st. 
    4648 
    47          /* Download email from a mail account */ 
     49     /* Display results */ 
     50     IF RC = 0 THEN DO 
     51       SAY 'Downloaded emails:  'st.downloaded 
     52       SAY 'Left on server:     'st.onserver 
     53       SAY 'Duplicates skipped: 'st.dupskipped 
     54       SAY 'Deleted on server:  'st.deleted 
     55     END 
     56     ELSE 
     57       SAY 'Error during mail download.' 
     58     EXIT 
     59     }}} 
    4860 
    49          MAILCHECK POP 2 STEM st. 
    50  
    51          /* Display results */ 
    52  
    53          SAY 'Downloaded emails:  'st.downloaded\\ 
    54          SAY 'Left on server:     'st.onserver\\ 
    55          SAY 'Duplicates skipped: 'st.dupskipped\\ 
    56          SAY 'Deleted on server:  'st.deleted\\ 
    57  
    58 '''BUGS''' 
    59      RC was set to 5 if no mail was found on the server, and 
    60      <STEM>ONSERVER simply returned the number of messages found. 
     61 BUGS:: 
     62     `RC` was set to 5 if no mail was found on the server, and 
     63     `<STEM>ONSERVER` simply returned the number of messages found. 
    6164     Both were fixed in V2.4. 
    6265 
    63 '''SEE ALSO''' 
     66 SEE ALSO::