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


Ignore:
Timestamp:
Feb 5, 2014 5:20:37 PM (6 months ago)
Author:
damato
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • Documentation/ARexxAPI/WRITEOPTIONS

    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== WRITEOPTIONS 
    54 
    6 '''NAME''' 
     5 NAME:: 
    76     WriteOptions -- Set the options of a new message.  (V2.0) 
    87 
    9 '''TEMPLATE''' 
     8 TEMPLATE:: 
    109     DELETE/S,RECEIPT/S,NOTIF/S,ADDINFO/S,IMPORTANCE/N,SIG/N,SECURITY/N 
    1110 
    12 '''FUNCTION''' 
     11 FUNCTION:: 
    1312     Sets the options of a new message. 
    1413 
    15 '''INPUTS''' 
    16      DELETE/S       - discard the message completely after sending\\ 
    17      RECEIPT/S      - ask for a return receipt\\ 
    18      NOTIF/S        - enable message tracking (MDN)\\ 
    19      ADDINFO/S      - add personal information\\ 
    20      IMPORTANCE/N   - importance of the message, possible values are 
     14 INPUTS:: 
     15     `DELETE/S`       - discard the message completely after sending\\ 
     16     `RECEIPT/S`      - ask for a return receipt\\ 
     17     `NOTIF/S`        - enable message tracking (MDN)\\ 
     18     `ADDINFO/S`      - add personal information\\ 
     19     `IMPORTANCE/N`   - importance of the message, possible values are: 
     20       - `0` - high 
     21       - `1` - normal (default) 
     22       - `2` - low 
     23     `SIG/N`          - signature to use, possible values are: 
     24       - `0` - no signature 
     25       - `1` - default value taken from the Signature configuration 
     26       - `2` - alt. signature #1 
     27       - `3` - alt. signature #2 
     28     `SECURITY/N`     - security to use, possible values are: 
     29       - `0` - none 
     30       - `1` - PGP signed 
     31       - `2` - PGP encrypted 
     32       - `3` - PGP signed & encrypted 
     33       - `4` - send anonymously 
     34       - `5` - default value for this recipient (default) 
    2135 
    22                          0 - high\\ 
    23                          1 - normal (default)\\ 
    24                          2 - low\\ 
     36 RETURNS:: 
     37     `RC` is set to 10 if no Write window was previously specified as 
     38     "active" with [[MAILWRITE]]. 
    2539 
    26      SIG/N          - signature to use, possible values are 
    27  
    28                          0 - no signature\\ 
    29                          1 - default value taken from the Signature configuration\\ 
    30                          2 - alt. signature !#1\\ 
    31                          3 - alt. signature !#2\\ 
    32  
    33      SECURITY/N     - security to use, possible values are 
    34  
    35                          0 - none\\ 
    36                          1 - PGP signed\\ 
    37                          2 - PGP encrypted 
    38                          3 - PGP signed & encrypted\\ 
    39                          4 - send anonymously\\ 
    40                          5 - default value for this recipient (default)\\ 
    41  
    42 '''RETURNS''' 
    43      RC is set to 10 if no Write window was previously specified as 
    44      "active" with [[ARexx API/MAILWRITE| MAILWRITE ]]. 
    45  
    46 '''NOTES''' 
     40 NOTES:: 
    4741     Defaults are taken from the program configuration; the default 
    4842     signature may vary depending on whether mailing list support is 
     
    5044     specified, personal info and signatures are removed automatically. 
    5145 
    52 '''EXAMPLE''' 
    53          /* Set a message to be sent anonymously */ 
     46 EXAMPLE:: 
     47     {{{#!urbiscript 
     48     /* Set the active Write window */ 
     49     MAILWRITE WINDOW 0 
    5450 
    55          MAILWRITE WINDOW 0      /* Set the active Write window */\\ 
    56          WRITEOPTIONS SECURITY 4\\ 
     51     /* Set a message to be sent anonymously */ 
     52     WRITEOPTIONS SECURITY 4 
     53     }}} 
    5754 
    58 '''BUGS''' 
     55 BUGS:: 
    5956 
    60 '''SEE ALSO''' 
    61      [[ARexx API/MAILWRITE| MAILWRITE ]] 
     57 SEE ALSO:: 
     58     [[MAILWRITE]]