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


Ignore:
Timestamp:
Feb 4, 2014 9:26:19 PM (6 months ago)
Author:
damato
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • Documentation/ARexxAPI/GETMAILINFO

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