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


Ignore:
Timestamp:
Sep 23, 2013 9:27:57 PM (11 months ago)
Author:
AmigaPhil
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • Documentation/ARexxAPI/WRITEATTACH

    v1 v1  
     1== WRITEATTACH 
     2 
     3'''NAME''' 
     4     WriteAttach -- Attach a file to a new message. 
     5 
     6'''TEMPLATE''' 
     7     FILE/A,DESC,ENCMODE,CTYPE 
     8 
     9'''FUNCTION''' 
     10     Attaches a file to a new message. 
     11 
     12'''INPUTS''' 
     13     FILE/A    - filename to attach, with path\\ 
     14     DESC      - optional, string with a description for the file  (V1.3)\\ 
     15     ENCMODE   - optional, encoding type for the file; may be either "uu" or "b64"  (V1.3)\\ 
     16     CTYPE     - optional, content type of the file  (V1.3)\\ 
     17 
     18'''RETURNS''' 
     19     RC is set to 10 if no Write window was previously specified as 
     20     "active" with [[rx_mailwrite| MAILWRITE ]]. 
     21 
     22'''NOTES''' 
     23     By default, binary files are encoded as Base64 (MIME), whereas 
     24     text files are UUencoded. 
     25 
     26     The default content type is taken after scanning the built-in 
     27     list of MIME types and then looking at the MIME types defined 
     28     in the user configuration.  For instance, if the user has 
     29     defined "application/pgs" as MIME type for files using the 
     30     ".pgs" extension, all files attached bearing this extension 
     31     will default to "application/pgs" unless CTYPE overrides this. 
     32     If no suitable MIME type is found and no content type has been 
     33     specified, YAM will fallback to "application/octet-stream". 
     34 
     35'''EXAMPLE''' 
     36         /* Attach a file */ 
     37 
     38         MAILWRITE WINDOW 0      /* Set the active Write window */\\ 
     39         WRITEATTACH 'Docs:Mag.pgs' ENCMODE 'b64' CTYPE 'application/pgs'\\ 
     40 
     41'''BUGS''' 
     42     No error is returned if the specified file was found but couldn't 
     43     be opened. 
     44 
     45'''SEE ALSO''' 
     46     [[rx_mailwrite| MAILWRITE ]]