Changes between Version 17 and Version 18 of Documentation/ARexxAPI


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

--

Legend:

Unmodified
Added
Removed
Modified
  • Documentation/ARexxAPI

    v17 v18  
    11[[TranslatedPages]][[TOC(depth=1)]][[TOC(sectionindex, heading=ARexx Function List, notitle, depth=1, Documentation/ARexxAPI/)]]
    2 == Reference - ARexx interface
     2= Reference - ARexx interface
    33
    44With the help of ARexx scripts, you can add new functions to YAM or let it do things automatically.\\
     
    108108     Links to other related commands.
    109109
    110 ----
    111 
    112 == List of all the ARexx commands sorted by function
     110== Grouped Function List
    113111
    114112=== Commands supplied by MUI
     
    208206 [[ARexxAPI/WRITESUBJECT|WRITESUBJECT]]  - Fill the SUBJECT: header of a new message\\
    209207 [[ARexxAPI/WRITETO|WRITETO]]  - Fill the TO: header of a new message\\
     208
     209== Alphabetical Function List
     210 [[ARexxAPI/ADDRDELETE|ADDRDELETE]]  - Remove an entry from the address book\\
     211 [[ARexxAPI/ADDREDIT|ADDREDIT]]  - Fill the fields of the current address book entry\\
     212 [[ARexxAPI/ADDRFIND|ADDRFIND]]  - Search the address book for one or more entries\\
     213 [[ARexxAPI/ADDRGOTO|ADDRGOTO]]  - Select an address book entry by alias\\
     214 [[ARexxAPI/ADDRINFO|ADDRINFO]]  - Return information about an entry referred by alias\\
     215 [[ARexxAPI/ADDRLOAD|ADDRLOAD]]  - Load an address book by filename\\
     216 [[ARexxAPI/ADDRNEW|ADDRNEW]]  - Create a new entry in the address book\\
     217 [[ARexxAPI/ADDRRESOLVE|ADDRRESOLVE]]  - Resolve an alias or name\\
     218 [[ARexxAPI/ADDRSAVE|ADDRSAVE]]  - Save the address book under a given filename\\
     219 [[ARexxAPI/APPBUSY|APPBUSY]]  - Switch YAM to busy mode\\
     220 [[ARexxAPI/APPNOBUSY|APPNOBUSY]]  - Bring YAM out of busy mode\\
     221 [[ARexxAPI/FINDMAIL|FINDMAIL]] -  Find a mail in all folders given a MessageID\\
     222 [[ARexxAPI/FLUSHINDEXES|FLUSHINDEXES]]  - Flush the index of all folders\\
     223 [[ARexxAPI/FOLDERINFO|FOLDERINFO]]  - Return information about a given folder\\
     224 [[ARexxAPI/GETCONFIGINFO|GETCONFIGINFO]]  - Return information about the current user\\
     225 [[ARexxAPI/GETFOLDERINFO|GETFOLDERINFO]]  - Return information about the current folder\\
     226 [[ARexxAPI/GETMAILINFO|GETMAILINFO]]  - Return information about the active message\\
     227 [[ARexxAPI/GETSELECTED|GETSELECTED]]  - Get the position of the messages selected in the current folder\\
     228 [[ARexxAPI/GETURL|GETURL]]  - Download a file from the WWW based on a given URL\\
     229 [[ARexxAPI/HELP|HELP]]  - Return a list of all the supported ARexx commands\\
     230 [[ARexxAPI/HIDE|HIDE]]  - Iconify YAM\\
     231 [[ARexxAPI/INFO|INFO]]  - Return information about the program\\
     232 [[ARexxAPI/ISONLINE|ISONLINE]]  - Detect whether YAM is currently transfering email\\
     233 [[ARexxAPI/LISTFREEZE|LISTFREEZE]]  - Forbid graphical updates to a list\\
     234 [[ARexxAPI/LISTSELECT|LISTSELECT]]  - Select messages in the current folder\\
     235 [[ARexxAPI/LISTUNFREEZE|LISTUNFREEZE]]  - Permit graphical updates to a list\\
     236 [[ARexxAPI/MAILARCHIVE|MAILARCHIVE]]  - Move the selected messages to another folder\\
     237 [[ARexxAPI/MAILBOUNCE|MAILBOUNCE]]  - Bounce the current message\\
     238 [[ARexxAPI/MAILCHANGESUBJECT|MAILCHANGESUBJECT]]  - Change the subject of the selected message(s)\\
     239 [[ARexxAPI/MAILCHECK|MAILCHECK]]  - Download new email\\
     240 [[ARexxAPI/MAILCOPY|MAILCOPY]]  - Duplicate the selected message(s)\\
     241 [[ARexxAPI/MAILDELETE|MAILDELETE]]  - Delete the selected message(s)\\
     242 [[ARexxAPI/MAILEDIT|MAILEDIT]]  - Edit the current message\\
     243 [[ARexxAPI/MAILEXPORT|MAILEXPORT]]  - Export the selected message(s) into a file\\
     244 [[ARexxAPI/MAILFILTER|MAILFILTER]]  - Filter messages in the current folder\\
     245 [[ARexxAPI/MAILFORWARD|MAILFORWARD]]  - Forward the selected messages\\
     246 [[ARexxAPI/MAILIMPORT|MAILIMPORT]]  - Import messages from a file into the current folder\\
     247 [[ARexxAPI/MAILINFO|MAILINFO]]  - Return information about a given message\\
     248 [[ARexxAPI/MAILMOVE|MAILMOVE]]  - Move the selected messages to another folder\\
     249 [[ARexxAPI/MAILREAD|MAILREAD]]  - Read the current message\\
     250 [[ARexxAPI/MAILREPLY|MAILREPLY]]  - Reply the currently selected messages\\
     251 [[ARexxAPI/MAILSEND|MAILSEND]]  - Send the messages in the '''Outgoing''' folder\\
     252 [[ARexxAPI/MAILSENDALL|MAILSENDALL]]  - Send all the messages in the '''Outgoing''' folder\\
     253 [[ARexxAPI/MAILSTATUS|MAILSTATUS]]  - Change the status of the selected message(s)\\
     254 [[ARexxAPI/MAILUPDATE|MAILUPDATE]]  - Update the index of the current folder\\
     255 [[ARexxAPI/MAILWRITE|MAILWRITE]]  - Open a new Write window to compose a new mail\\
     256 [[ARexxAPI/NEWMAILFILE|NEWMAILFILE]]  - Return a free message slot for a given folder\\
     257 [[ARexxAPI/QUIT|QUIT]]  - Terminate YAM\\
     258 [[ARexxAPI/READCLOSE|READCLOSE]]  - Close the active Read window\\
     259 [[ARexxAPI/READINFO|READINFO]] - Get info about the attachments in the message being read\\
     260 [[ARexxAPI/READPRINT|READPRINT]]  - Print an attachment\\
     261 [[ARexxAPI/READSAVE|READSAVE]]  - Save an attachment\\
     262 [[ARexxAPI/REQUEST|REQUEST]]  - Request a choice from the user\\
     263 [[ARexxAPI/REQUESTFILE|REQUESTFILE]]  - Request the user to select a file\\
     264 [[ARexxAPI/REQUESTFOLDER|REQUESTFOLDER]]  - Request the user to select a folder\\
     265 [[ARexxAPI/REQUESTSTRING|REQUESTSTRING]]  - Request the user for a string\\
     266 [[ARexxAPI/RESTART|RESTART]]  - Restart YAM\\
     267 [[ARexxAPI/SCREENTOBACK|SCREENTOBACK]]  - Bring the YAM screen to the background\\
     268 [[ARexxAPI/SCREENTOFRONT|SCREENTOFRONT]]  - Bring the YAM screen to the foreground\\
     269 [[ARexxAPI/SETFLAG|SETFLAG]]  - Set the PERmanent or VOLatile flag of a message\\
     270 [[ARexxAPI/SETFOLDER|SETFOLDER]]  - Select the current folder\\
     271 [[ARexxAPI/SETMAIL|SETMAIL]]  - Select the current message in the current folder by number\\
     272 [[ARexxAPI/SETMAILFILE|SETMAILFILE]]  - Select the current message in the current folder by filename\\
     273 [[ARexxAPI/SHOW|SHOW]]  - Uniconify YAM\\
     274 [[ARexxAPI/USERINFO|USERINFO]]  - Return information about the current user\\
     275 [[ARexxAPI/WRITEATTACH|WRITEATTACH]]  - Attach a file to a new message\\
     276 [[ARexxAPI/WRITEBCC|WRITEBCC]]  - Fill the BCC: header of a new message\\
     277 [[ARexxAPI/WRITECC|WRITECC]]  - Fill the CC: header of a new message\\
     278 [[ARexxAPI/WRITEEDITOR|WRITEEDITOR]]  - Pass an ARexx command to the internal editor\\
     279 [[ARexxAPI/WRITEFROM|WRITEFROM]]  - Fill the FROM: header of a new message\\
     280 [[ARexxAPI/WRITEIDENTITY|WRITEIDENTITY]] - Choose the user identity to be used when composing a new mail \\
     281 [[ARexxAPI/WRITELETTER|WRITELETTER]]  - Load a file into the internal text editor\\
     282 [[ARexxAPI/WRITEMAILTO|WRITEMAILTO]] - Fill the TO: header of a new message\\
     283 [[ARexxAPI/WRITEOPTIONS|WRITEOPTIONS]]  - Set the options of a new message\\
     284 [[ARexxAPI/WRITEQUEUE|WRITEQUEUE]]  - Move a new message to the '''Outgoing''' queue\\
     285 [[ARexxAPI/WRITEREPLYTO|WRITEREPLYTO]]  - Fill the REPLY-TO: header of a new message\\
     286 [[ARexxAPI/WRITESEND|WRITESEND]]  - Send a new message\\
     287 [[ARexxAPI/WRITESUBJECT|WRITESUBJECT]]  - Fill the SUBJECT: header of a new message\\
     288 [[ARexxAPI/WRITETO|WRITETO]]  - Fill the TO: header of a new message\\