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


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

--

Legend:

Unmodified
Added
Removed
Modified
  • Documentation/ARexxAPI/GETMAILINFO

    v1 v1  
     1== GETMAILINFO 
     2 
     3'''NAME''' 
     4     GetMailInfo -- Return information about the current message. 
     5 
     6'''TEMPLATE''' 
     7     VAR/K,STEM/K,ITEM/A 
     8 
     9'''FUNCTION''' 
     10     Returns information about the current message. 
     11 
     12'''INPUTS''' 
     13     VAR/K    - alternative variable to put the results into instead of RESULT  (V2.0)\\ 
     14     STEM/K   - base name used for the stems where the returned data will be stored  (V2.0)\\ 
     15     ITEM/A   - item to return info about, may be one of 
     16 
     17                   ACT(IVE)    - position (0 = first message in the folder)\\ 
     18                   STA(TUS)    - status of the message, possible values are\\ 
     19 
     20                                    N   - new\\ 
     21                                    O   - read\\ 
     22                                    U   - unread\\ 
     23                                    R   - replied\\ 
     24                                    F   - forwarded\\ 
     25                                    S   - sent\\ 
     26                                    W   - pending\\ 
     27                                    H   - hold\\ 
     28                                    E   - error sending\\ 
     29 
     30                   FRO(M)      - sender\\ 
     31                   TO          - primary recipient\\ 
     32                   REP(LY)     - return address; this will be either the first recipient in the "Reply-To:" header, or the first sender in the "From:" header if no "Reply-To:" header exists\\ 
     33                   SUB(JECT)   - subject\\ 
     34                   FIL(E)      - full path of the message file\\ 
     35 
     36'''RETURNS''' 
     37     VAR         - info returned by the query\\ 
     38     <STEM>VALUE - info returned by the query\\ 
     39 
     40'''NOTES''' 
     41     Superseded by [[rx_mailinfo| MAILINFO ]] in V2.0+.  Don't use it in new scripts. 
     42 
     43'''EXAMPLE''' 
     44         /* Enable result codes */ 
     45 
     46         OPTIONS RESULTS 
     47 
     48         /* Request info */ 
     49 
     50         GETMAILINFO ACTIVE VAR posi\\ 
     51         GETMAILINFO STATUS VAR status\\ 
     52         GETMAILINFO FROM VAR from\\ 
     53         GETMAILINFO TO VAR to\\ 
     54         GETMAILINFO REPLY VAR replyto\\ 
     55         GETMAILINFO SUBJECT VAR subj\\ 
     56         GETMAILINFO FILE VAR path\\ 
     57 
     58         /* Display results */ 
     59 
     60         SAY 'Position: 'posi\\ 
     61         SAY 'Status:   'status\\ 
     62         SAY 'From:     'from\\ 
     63         SAY 'To:       'to\\ 
     64         SAY 'Reply-To: 'replyto\\ 
     65         SAY 'Subject:  'subj\\ 
     66         SAY 'Path:     'path\\ 
     67 
     68'''BUGS''' 
     69 
     70'''SEE ALSO''' 
     71     [[rx_mailinfo| MAILINFO ]]