Changes between Version 16 and Version 17 of Documentation/ARexxAPI


Ignore:
Timestamp:
Feb 4, 2014, 3:05:35 PM (11 months ago)
Author:
damato
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • Documentation/ARexxAPI

    v16 v17  
    1 [[TranslatedPages]][[TOC(sectionindex, heading=ARexx Function List, notitle, depth=1, Documentation/ARexxAPI/)]]
     1[[TranslatedPages]][[TOC(depth=1)]][[TOC(sectionindex, heading=ARexx Function List, notitle, depth=1, Documentation/ARexxAPI/)]]
    22== Reference - ARexx interface
    33
     
    7575   FOLDERINFO STEM fi.
    7676   -> fi.number = 0
    77         fi.name = "Incoming"
    78         fi.path = "incoming"
    79         fi.total = 10
    80         fi.new = 2
    81         fi.unread = 4
    82         fi.size = 23030
    83         fi.type = 1
     77      fi.name = "Incoming"
     78      fi.path = "incoming"
     79      fi.total = 10
     80      fi.new = 2
     81      fi.unread = 4
     82      fi.size = 23030
     83      fi.type = 1
    8484   }}}
    8585
     
    8888   {{{#!urbiscript
    8989   ADDRFIND STEM found. "Marcel Beck" NAMEONLY
    90     -> found.alias.count = 2
    91          found.alias.0 = "Mars"
    92          found.alias.1 = "mbe"
     90   -> found.alias.count = 2
     91      found.alias.0 = "Mars"
     92      found.alias.1 = "mbe"
    9393    }}}
    9494
     
    109109
    110110----
    111  * [[ARexxAPI/List by Name|Alphabetical list of all ARexx commands]]
    112  * [[ARexxAPI/List by Function|List of all the ARexx commands sorted by function]]
     111
     112== List of all the ARexx commands sorted by function
     113
     114=== Commands supplied by MUI
     115 [[ARexxAPI/HELP|HELP]] - Return a list of all the supported ARexx commands\\
     116 [[ARexxAPI/HIDE|HIDE]]  - Iconify YAM\\
     117 [[ARexxAPI/INFO| INFO]]  - Return information about the program\\
     118 [[ARexxAPI/QUIT| QUIT]]  - Terminate YAM\\
     119 [[ARexxAPI/SCREENTOBACK| SCREENTOBACK]]  - Bring the YAM screen to the background\\
     120 [[ARexxAPI/SCREENTOFRONT| SCREENTOFRONT]]  - Bring the YAM screen to the foreground\\
     121 [[ARexxAPI/SHOW| SHOW]]  - Uniconify YAM\\
     122
     123=== Address book handling
     124 [[ARexxAPI/ADDRDELETE| ADDRDELETE]]  - Remove an entry from the address book\\
     125 [[ARexxAPI/ADDREDIT|ADDREDIT]]  - Fill the fields of the current address book entry\\
     126 [[ARexxAPI/ADDRFIND|ADDRFIND]]  - Search the address book for one or more entries\\
     127 [[ARexxAPI/ADDRGOTO|ADDRGOTO]]  - Select an address book entry by alias\\
     128 [[ARexxAPI/ADDRINFO|ADDRINFO]]  - Return information about an entry referred by alias\\
     129 [[ARexxAPI/ADDRLOAD|ADDRLOAD]]  - Load an address book by filename\\
     130 [[ARexxAPI/ADDRNEW|ADDRNEW]]  - Create a new entry in the address book\\
     131 [[ARexxAPI/ADDRRESOLVE|ADDRRESOLVE]]  - Resolve an alias or name\\
     132 [[ARexxAPI/ADDRSAVE|ADDRSAVE]]  - Save the address book under a given filename\\
     133
     134=== Folder wide operations
     135 [[ARexxAPI/FLUSHINDEXES|FLUSHINDEXES]]  - Flush the index of all folders\\
     136 [[ARexxAPI/FOLDERINFO|FOLDERINFO]]  - Return information about a given folder\\
     137 [[ARexxAPI/GETFOLDERINFO|GETFOLDERINFO]]  - Return information about the current folder\\
     138 [[ARexxAPI/MAILFILTER|MAILFILTER]]  - Filter messages in the current folder\\
     139 [[ARexxAPI/MAILUPDATE|MAILUPDATE]]  - Update the index of the current folder\\
     140 [[ARexxAPI/NEWMAILFILE|NEWMAILFILE]]  - Return a free message slot for a given folder\\
     141
     142=== GUI handling
     143 [[ARexxAPI/APPBUSY|APPBUSY]]  - Switch YAM to busy mode\\
     144 [[ARexxAPI/APPNOBUSY|APPNOBUSY]]  - Bring YAM out of busy mode\\
     145 [[ARexxAPI/LISTFREEZE|LISTFREEZE]]  - Forbid graphical updates to a list\\
     146 [[ARexxAPI/LISTUNFREEZE|LISTUNFREEZE]]  - Permit graphical updates to a list\\
     147 [[ARexxAPI/READCLOSE|READCLOSE]]  - Close the active Read window\\
     148 [[ARexxAPI/RESTART|RESTART]]  - Restart YAM\\
     149
     150=== Message/Folder selection
     151 [[ARexxAPI/FINDMAIL|FINDMAIL]] - Find a mail in all folders given a MessageID\\
     152 [[ARexxAPI/GETSELECTED|GETSELECTED]]  - Get the position of the messages selected in the current folder\\
     153 [[ARexxAPI/LISTSELECT|LISTSELECT]]  - Select messages in the current folder\\
     154 [[ARexxAPI/SETFOLDER|SETFOLDER]]  - Select the current folder\\
     155 [[ARexxAPI/SETMAIL|SETMAIL]]  - Select the current message in the current folder by number\\
     156 [[ARexxAPI/SETMAILFILE|SETMAILFILE]]  - Select the current message in the current folder by filename\\
     157
     158=== Message manipulation
     159 [[ARexxAPI/GETMAILINFO|GETMAILINFO]]  - Return information about the active message\\
     160 [[ARexxAPI/MAILARCHIVE|MAILARCHIVE]]  - Move the selected messages to another folder\\
     161 [[ARexxAPI/MAILBOUNCE|MAILBOUNCE]]  - Bounce the current message\\
     162 [[ARexxAPI/MAILCHANGESUBJECT|MAILCHANGESUBJECT]]  - Change the subject of the selected message(s)\\
     163 [[ARexxAPI/MAILCOPY|MAILCOPY]]  - Duplicate the selected message(s)\\
     164 [[ARexxAPI/MAILDELETE|MAILDELETE]]  - Delete the selected message(s)\\
     165 [[ARexxAPI/MAILEDIT|MAILEDIT]]  - Edit the current message\\
     166 [[ARexxAPI/MAILEXPORT|MAILEXPORT]]  - Export the selected message(s) into a file\\
     167 [[ARexxAPI/MAILIMPORT|MAILIMPORT]]  - Import messages from a file into the current folder\\
     168 [[ARexxAPI/MAILINFO|MAILINFO]]  - Return information about a given message\\
     169 [[ARexxAPI/MAILMOVE|MAILMOVE]]  - Move the selected messages to another folder\\
     170 [[ARexxAPI/MAILREAD|MAILREAD]]  - Read the current message\\
     171 [[ARexxAPI/MAILREPLY|MAILREPLY]]  - Reply the currently selected messages\\
     172 [[ARexxAPI/MAILSTATUS|MAILSTATUS]]  - Change the status of the selected message(s)\\
     173 [[ARexxAPI/READINFO|READINFO]]  - Get info about the attachments in the message being read\\
     174 [[ARexxAPI/READPRINT|READPRINT]]  - Print an attachment\\
     175 [[ARexxAPI/READSAVE|READSAVE]]  - Save an attachment\\
     176 [[ARexxAPI/SETFLAG|SETFLAG]]  - Set the PERmanent or VOLatile flag of a message\\
     177
     178=== Network related
     179 [[ARexxAPI/GETURL|GETURL]]  - Download a file from the WWW based on a given URL\\
     180 [[ARexxAPI/ISONLINE|ISONLINE]]  - Detect whether YAM is currently transfering email\\
     181 [[ARexxAPI/MAILCHECK|MAILCHECK]]  - Download new email\\
     182 [[ARexxAPI/MAILSEND|MAILSEND]]  - Send the messages in the '''Outgoing''' folder\\
     183 [[ARexxAPI/MAILSENDALL|MAILSENDALL]]  - Send all the messages in the '''Outgoing''' folder\\
     184
     185=== Request info from user
     186 [[ARexxAPI/GETCONFIGINFO|GETCONFIGINFO]]  - Return information about the current user\\
     187 [[ARexxAPI/REQUEST|REQUEST]]  - Request a choice from the user\\
     188 [[ARexxAPI/REQUESTFILE|REQUESTFILE]]  - Request the user to select a file\\
     189 [[ARexxAPI/REQUESTFOLDER|REQUESTFOLDER]]  - Request the user to select a folder\\
     190 [[ARexxAPI/REQUESTSTRING|REQUESTSTRING]]  - Request the user for a string\\
     191 [[ARexxAPI/USERINFO|USERINFO]]  - Return information about the current user\\
     192
     193=== Writing new email
     194 [[ARexxAPI/MAILFORWARD| MAILFORWARD]]  - Forward the selected messages\\
     195 [[ARexxAPI/MAILWRITE|MAILWRITE]]  - Open a new Write window to compose a new mail\\
     196 [[ARexxAPI/WRITEATTACH|WRITEATTACH]]  - Attach a file to a new message\\
     197 [[ARexxAPI/WRITEBCC|WRITEBCC]]  - Fill the BCC: header of a new message\\
     198 [[ARexxAPI/WRITECC|WRITECC]]  - Fill the CC: header of a new message\\
     199 [[ARexxAPI/WRITEEDITOR|WRITEEDITOR]]  - Pass an ARexx command to the internal editor\\
     200 [[ARexxAPI/WRITEFROM|WRITEFROM]]  - Fill the FROM: header of a new message\\
     201 [[ARexxAPI/WRITEIDENTITY|WRITEIDENTITY]] - Choose the user identity to be used when composing a new mail\\
     202 [[ARexxAPI/WRITELETTER|WRITELETTER]]  - Load a file into the internal text editor\\
     203 [[ARexxAPI/WRITEMAILTO|WRITEMAILTO]]  - Fill the TO: header of a new message\\
     204 [[ARexxAPI/WRITEOPTIONS|WRITEOPTIONS]]  - Set the options of a new message\\
     205 [[ARexxAPI/WRITEQUEUE|WRITEQUEUE]]  - Move a new message to the '''Outgoing''' queue\\
     206 [[ARexxAPI/WRITEREPLYTO|WRITEREPLYTO]]  - Fill the REPLY-TO: header of a new message\\
     207 [[ARexxAPI/WRITESEND|WRITESEND]]  - Send a new message\\
     208 [[ARexxAPI/WRITESUBJECT|WRITESUBJECT]]  - Fill the SUBJECT: header of a new message\\
     209 [[ARexxAPI/WRITETO|WRITETO]]  - Fill the TO: header of a new message\\