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

Timestamp:

Sep 22, 2013, 10:32:19 PM (17 months ago)

Author:

AmigaPhil

Comment:

--

Documentation/ARexxAPI/MAILBOUNCE

@@ +1 @@
+== MAILBOUNCE
+
+'''NAME'''
+     MailBounce -- Open a new Write window to bounce the current message. (V2.0)
+
+'''TEMPLATE'''
+     VAR/K,STEM/K,QUIET/S
+
+'''FUNCTION'''
+     Opens a cut-down Write window to bounce the current message to
+     another recipient.
+
+'''INPUTS'''
+     VAR/K     - alternative variable to store the number of the created window instead of RESULT\\
+     STEM/K    - base name used for the stem where the returned data will be stored\\
+     QUIET/S   - force the window to stay invisible  (V2.1)\\
+
+'''RETURNS'''
+     <STEM>WINDOW - number of the created window if the command had success; may be 0 or 1 (or 2, if QUIET is enabled)
+
+     RC is set to 10 if the window cannot be opened, maybe because the
+     limit of two Write windows has been reached.
+
+'''NOTES'''
+     In the outgoing message, only the "To:" field can be edited.
+
+'''EXAMPLE'''
+         /* Silently bounce the current message */
+
+         MAILBOUNCE QUIET\\
+         WRITETO 'joe@example.com' 'mars'\\
+         WRITESEND\\
+
+'''BUGS'''
+
+'''SEE ALSO'''