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


Ignore:
Timestamp:
Sep 22, 2013, 10:44:56 PM (15 months ago)
Author:
AmigaPhil
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • Documentation/ARexxAPI/MAILEDIT

    v1 v1  
     1== MAILEDIT
     2
     3'''NAME'''
     4     MailEdit -- Edit the current message in a new Write window.  (V2.0)
     5
     6'''TEMPLATE'''
     7     VAR/K,STEM/K,QUIET/S
     8
     9'''FUNCTION'''
     10     Opens a new Write window to edit the selected message.
     11
     12'''INPUTS'''
     13     VAR/K     - alternative variable to store the number of the created window instead of RESULT\\
     14     STEM/K    - base name used for the stem where the returned data will be stored\\
     15     QUIET/S   - force the window to stay invisible  (V2.1)\\
     16
     17'''RETURNS'''
     18     VAR          - info returned by the command\\
     19     <STEM>WINDOW - number of the created window, may be either 0 or 1 (or 2, if QUIET is enabled)\\
     20
     21     RC is set to 10 if the window cannot be opened, maybe because the
     22     limit of two Write windows has been reached.
     23
     24'''NOTES'''
     25     The command works even with email that is NOT intended as "outgoing",
     26     like email in the Incoming folder for instance, in which case the
     27     [Send now] and [Hold] buttons in the Write window are disabled.
     28     After being edited, the mail is marked as "ready to send" no matter
     29     in which folder it is located, and all the old headers are replaced
     30     except for "From:" and "To:", which must be manually edited.  Special
     31     care must be taken to ensure that these remain valid in the resulting
     32     message and no "undisclosed-recipients:;" or some such remains there
     33     by the time it is again saved.  Handle with caution.
     34
     35'''EXAMPLE'''
     36         /* Select the first message in the Outgoing folder */
     37
     38         SETFOLDER Outgoing\\
     39         SETMAIL 0\\
     40
     41         /* Edit this message */
     42
     43         MAILEDIT
     44
     45         /* Change the subject */
     46
     47         'WRITESUBJECT "Email address change"'
     48
     49         /* Put the message again in the queue */
     50
     51         WRITEQUEUE
     52
     53'''BUGS'''
     54
     55'''SEE ALSO'''