wiki:es:Documentation/ARexxAPI

En otros idiomas:

Referencia - Interfaz ARexx

Con la ayuda de scripts ARexx, puede añadir nuevas funciones a YAM, o bien hacerle realizar ciertas cosas de forma automática. YAM ofrece una serie de comandos (organizados en este manual por nombre y por función ) que puede invocar desde el puerto ARexx YAM. Estos comandos se explican detalladamente a lo largo de los siguientes capítulos siguiendo este formato:

NOMBRE
El nombre del comando, con una breve descripción de lo que hace, y la versión de YAM en la que fue implantado por primera vez en caso de no estar presente en YAM 1.0.
PLANTILLA
Argumentos y opciones aceptados por el comando. La plantilla utiliza una serie de caracteres especiales para indicar cada tipo particular de argumento que espera el comando, siguiendo el formato de plantillas comúnmente utilizado por el AmigaDOS:

/A El parámetro es imprescindible
/K El parámetro debe ir precedido de la palabra clave
/N Argumento o resultado numérico
/M El argumento o el resultado es una lista de cero o más elementos
/S El parámetro actúa como un interruptor; el interruptor está activado cuando se indica el parámetro.

FUNCIÓN
Describe con más detalle lo que hace el comando.
ENTRADAS
Describe detalladamente los parámetros que acepta el comando. Tenga cuidado al indicar argumentos que contengan espacios; por ejemplo,
asunto = 'Hola Mundo'
'WRITESUBJECT' asunto

no funcionará. Debe escribirse así:

'WRITESUBJECT "'asunto'"'

o también:

'WRITESUBJECT "Hola Mundo"'
RESULTADOS
Información que hay que esperar recibir del comando. Los comandos pueden devolver resultados de tres formas diferentes; veamos estos ejemplos que utilizan el comando FOLDERINFO:
FOLDERINFO
  -> RESULT = "0 Entrantes incoming 10 2 4 23030 1"
FOLDERINFO VAR fi
  -> fi = "0 Entrantes incoming 10 2 4 23030 1"
FOLDERINFO STEM fi.
  -> fi.number = 0
     fi.name = "Entrantes"
     fi.path = "incoming"
     fi.total = 10
     fi.new = 2
     fi.unread = 4
     fi.size = 23030
     fi.type = 1

Otro ejemplo que devuelve un resultado del tipo /M:

ADDRFIND STEM encontrado. "Marcel Beck" NAMEONLY
  -> encontrado.alias.count = 2
     encontrado.alias.0 = "Mars"
     encontrado.alias.1 = "mbe"
AVISO
Cualquier información importante de la que debe ser consciente al utilizar este comando.
NOTAS
Información de interés sobre el funcionamiento del comando.
EJEMPLO
Un fragmento de código ARexx que ilustra el uso correcto del comando.
FALLOS
Problemas que son conocidos o que ya han sido rectificados en el comando.
VÉASE TAMBIÉN
Enlaces a otros comandos relacionados.

Lista de todos los comandos ARexx ordenados por función

Comandos de MUI

HELP - Obtener una lista de los comandos ARexx soportados
HIDE - Iconificar YAM
INFO - Obtener información sobre el programa
QUIT - Salir de YAM
SCREENTOBACK - Situar la pantalla de YAM detrás de todas las demás
SCREENTOFRONT - Situar la pantalla de YAM en primer término
SHOW - Des-iconificar YAM

Control del listín de direcciones

ADDRDELETE - Borrar una ficha del listín de direcciones
ADDREDIT - Editar la ficha actual del listín
ADDRFIND - Buscar fichas en el listín
ADDRGOTO - Elegir ficha actual del listín
ADDRINFO - Obtener información sobre una ficha del listín
ADDRLOAD - Cargar un listín desde un fichero
ADDRNEW - Crear una nueva ficha en el listín
ADDRRESOLVE - Expandir un alias o un nombre
ADDRSAVE - Guardar el listín en un fichero

Control de carpetas

FOLDERINFO - Obtener información sobre una carpeta
GETFOLDERINFO - Obtener información sobre la carpeta actual
MAILFILTER - Filtrar los mensajes de la carpeta actual
MAILUPDATE - Actualizar el índice de la carpeta actual
NEWMAILFILE - Obtener un fichero de mensaje sin usar para una carpeta

Control del interfaz gráfico

APPBUSY - Pasar YAM al estado "ocupado"
APPNOBUSY - Poner fin al estado "ocupado"
LISTFREEZE -
LISTUNFREEZE -
READCLOSE - Cerrar la ventana de lectura activa
RESTART -

Selección de mensajes y carpetas

FINDMAIL -
GETSELECTED - Obtener las posiciones de los mensajes seleccionados
LISTSELECT - Seleccionar mensajes en la carpeta actual
SETFOLDER - Cambiar la carpeta actual
SETMAIL - Elegir mensaje actual por posición en la carpeta
SETMAILFILE - Elegir mensaje actual por nombre de fichero

Manipulación de mensajes

GETMAILINFO - Obtener información sobre el mensaje actual
MAILARCHIVE - Mover los mensajes seleccionados a otra carpeta
MAILBOUNCE - Desviar el mensaje actual
MAILCHANGESUBJECT - Cambiar el asunto de los mensajes seleccionados
MAILCOPY - Duplicar los mensajes seleccionados
MAILDELETE - Borrar los mensajes seleccionados
MAILEDIT - Editar el mensaje actual
MAILEXPORT - Exportar los mensajes seleccionados a un fichero
MAILIMPORT - Importar mensajes de un fichero a la carpeta actual
MAILINFO - Obtener información sobre un mensaje
MAILMOVE - Mover los mensajes seleccionados a otra carpeta
MAILREAD - Leer el mensaje actual
MAILREPLY - Responder a los mensajes seleccionados
MAILSTATUS - Cambiar el estado de los mensajes seleccionados
READINFO - Obtener información sobre los anexos del mensaje abierto
READPRINT - Imprimir un anexo
READSAVE - Guardar un anexo
SETFLAG - Definir las banderas PERmanente o VOLátil de un mensaje

Control de la red

GETURL - Descargar un fichero de la web
ISONLINE - Detectar si YAM está recibiendo o enviando correo
MAILCHECK - Recoger el correo nuevo
MAILSEND - Enviar los mensajes de la carpeta "Salientes"
MAILSENDALL - Enviar todos los mensajes de la carpeta "Salientes"

Información sobre el usuario

GETCONFIGINFO - Obtener información sobre el usuario actual
REQUEST - Pedir una decisión al usuario
REQUESTFILE -
REQUESTFOLDER - Pedir al usuario que elija una carpeta
REQUESTSTRING - Pedir al usuario que teclee una cadena
USERINFO - Obtener información sobre el usuario actual

Nuevo mensaje

MAILFORWARD - Reenviar los mensajes seleccionados
MAILWRITE - Escribir un nuevo mensaje
WRITEATTACH - Añadir un fichero a un nuevo mensaje
WRITEBCC - Editar la cabecera "BCC:" de un nuevo mensaje
WRITECC - Editar la cabecera "CC:" de un nuevo mensaje
WRITEEDITOR - Pasar un comando ARexx al editor interno
WRITEFROM - Editar la cabecera "From:" de un nuevo mensaje
WRITEIDENTITY -
WRITELETTER - Cargar un fichero de texto en el editor interno
WRITEMAILTO - Editar la cabecera "To:" de un nuevo mensaje
WRITEOPTIONS - Definir las opciones de un nuevo mensaje
WRITEQUEUE - Colocar el nuevo mensaje en la cola de mensajes salientes
WRITEREPLYTO - Editar la cabecera "Reply-To:" de un nuevo mensaje
WRITESEND - Enviar el nuevo mensaje
WRITESUBJECT - Editar el asunto del nuevo mensaje
WRITETO - Editar la cabecera "To:" de un nuevo mensaje

Lista alfabética de todos los comandos ARexx

ADDRDELETE - Borrar una ficha del listín de direcciones
ADDREDIT - Editar la ficha actual del listín
ADDRFIND - Buscar fichas en el listín
ADDRGOTO - Elegir ficha actual del listín
ADDRINFO - Obtener información sobre una ficha del listín
ADDRLOAD - Cargar un listín desde un fichero
ADDRNEW - Crear una nueva ficha en el listín
ADDRRESOLVE - Expandir un alias o un nombre
ADDRSAVE - Guardar el listín en un fichero
APPBUSY - Pasar YAM al estado "ocupado"
APPNOBUSY - Poner fin al estado "ocupado"
FINDMAIL -
FLUSHINDEXES -
FOLDERINFO - Obtener información sobre una carpeta
GETCONFIGINFO - Obtener información sobre el usuario actual
GETFOLDERINFO - Obtener información sobre la carpeta actual
GETMAILINFO - Obtener información sobre el mensaje actual
GETSELECTED - Obtener las posiciones de los mensajes seleccionados
GETURL - Descargar un fichero de la web
HELP - Obtener una lista de los comandos ARexx soportados
HIDE - Iconificar YAM
INFO - Obtener información sobre el programa
ISONLINE - Detectar si YAM está recibiendo o enviando correo
LISTFREEZE -
LISTSELECT - Seleccionar mensajes en la carpeta actual
LISTUNFREEZE -
MAILARCHIVE - Mover los mensajes seleccionados a otra carpeta
MAILBOUNCE - Desviar el mensaje actual
MAILCHANGESUBJECT - Cambiar el asunto de los mensajes seleccionados
MAILCHECK - Recoger el correo nuevo
MAILCOPY - Duplicar los mensajes seleccionados
MAILDELETE - Borrar los mensajes seleccionados
MAILEDIT - Editar el mensaje actual
MAILEXPORT - Exportar los mensajes seleccionados a un fichero
MAILFILTER - Filtrar los mensajes de la carpeta actual
MAILFORWARD - Reenviar los mensajes seleccionados
MAILIMPORT - Importar mensajes de un fichero a la carpeta actual
MAILINFO - Obtener información sobre un mensaje
MAILMOVE - Mover los mensajes seleccionados a otra carpeta
MAILREAD - Leer el mensaje actual
MAILREPLY - Responder a los mensajes seleccionados
MAILSEND - Enviar los mensajes de la carpeta "Salientes"
MAILSENDALL - Enviar todos los mensajes de la carpeta "Salientes"
MAILSTATUS - Cambiar el estado de los mensajes seleccionados
MAILUPDATE - Actualizar el índice de la carpeta actual
MAILWRITE - Escribir un nuevo mensaje
NEWMAILFILE - Obtener un fichero de mensaje sin usar para una carpeta
QUIT - Salir de YAM
READCLOSE - Cerrar la ventana de lectura activa
READINFO - Obtener información sobre los anexos del mensaje abierto
READPRINT - Imprimir un anexo
READSAVE - Guardar un anexo
REQUEST - Pedir una decisión al usuario
REQUESTFILE -
REQUESTFOLDER - Pedir al usuario que elija una carpeta
REQUESTSTRING - Pedir al usuario que teclee una cadena
RESTART -
SCREENTOBACK - Situar la pantalla de YAM detrás de todas las demás
SCREENTOFRONT - Situar la pantalla de YAM en primer término
SETFLAG - Definir las banderas PERmanente o VOLátil de un mensaje
SETFOLDER - Cambiar la carpeta actual
SETMAIL - Elegir mensaje actual por posición en la carpeta
SETMAILFILE - Elegir mensaje actual por nombre de fichero
SHOW - Des-iconificar YAM
USERINFO - Obtener información sobre el usuario actual
WRITEATTACH - Añadir un fichero a un nuevo mensaje
WRITEBCC - Editar la cabecera "BCC:" de un nuevo mensaje
WRITECC - Editar la cabecera "CC:" de un nuevo mensaje
WRITEEDITOR - Pasar un comando ARexx al editor interno
WRITEFROM - Editar la cabecera "From:" de un nuevo mensaje
WRITEIDENTITY -
WRITELETTER - Cargar un fichero de texto en el editor interno
WRITEMAILTO - Editar la cabecera "To:" de un nuevo mensaje
WRITEOPTIONS - Definir las opciones de un nuevo mensaje
WRITEQUEUE - Colocar el nuevo mensaje en la cola de mensajes salientes
WRITEREPLYTO - Editar la cabecera "Reply-To:" de un nuevo mensaje
WRITESEND - Enviar el nuevo mensaje
WRITESUBJECT - Editar el asunto del nuevo mensaje
WRITETO - Editar la cabecera "To:" de un nuevo mensaje

Last modified 2 months ago Last modified on Sep 27, 2014 3:51:04 PM