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


Ignore:
Timestamp:
Sep 22, 2013 10:37:24 PM (14 months ago)
Author:
AmigaPhil
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • Documentation/ARexxAPI/MAILCHECK

    v1 v1  
     1== MAILCHECK 
     2 
     3'''NAME''' 
     4     MailCheck -- Download new mail. 
     5 
     6'''TEMPLATE''' 
     7     VAR/K,STEM/K,POP/K/N,MANUAL/S 
     8 
     9'''FUNCTION''' 
     10     Downloads new email from the specified POP3 account, or from all 
     11     of them if none is specified. 
     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     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)\\ 
     17     MANUAL/S   - open the transfer window to enable user interaction, i.e. message preselection  (V2.0)\\ 
     18 
     19'''RETURNS''' 
     20     VAR              - info returned by the query\\ 
     21     <STEM>DOWNLOADED - total number of downloaded emails\\ 
     22     <STEM>ONSERVER   - total number of emails remaining on the server\\ 
     23     <STEM>DUPSKIPPED - total number of duplicates skipped\\ 
     24     <STEM>DELETED    - total number of emails deleted from the server\\ 
     25 
     26     In V1.x, RC was always set to 0.  As of V2.0 however, RC is set to 
     27     5 if the TCP/IP stack is not online. 
     28 
     29     Likewise, in V1.x RESULT was set to the number of downloaded emails, 
     30     or -1 if the connection to the mail server failed. 
     31 
     32'''NOTES''' 
     33     The command returns immediately if MANUAL is used. 
     34 
     35     If no account is specified, the command will only check those 
     36     mail accounts marked as "active" in the configuration, just like 
     37     if the "Get" button was pressed in the toolbar. 
     38 
     39'''EXAMPLE''' 
     40         /* Enable result codes */ 
     41 
     42         OPTIONS RESULTS 
     43 
     44         /* Download email from a mail account */ 
     45 
     46         MAILCHECK POP 2 STEM st. 
     47 
     48         /* Display results */ 
     49 
     50         SAY 'Downloaded emails:  'st.downloaded\\ 
     51         SAY 'Left on server:     'st.onserver\\ 
     52         SAY 'Duplicates skipped: 'st.dupskipped\\ 
     53         SAY 'Deleted on server:  'st.deleted\\ 
     54 
     55'''BUGS''' 
     56     RC was set to 5 if no mail was found on the server, and 
     57     <STEM>ONSERVER simply returned the number of messages found. 
     58     Both were fixed in V2.4. 
     59 
     60'''SEE ALSO'''