-
-
Notifications
You must be signed in to change notification settings - Fork 18
es:Documentation ARexxAPI
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 #FixListByName y #FixListByFunction) 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,
{{{#!arexx
asunto = 'Hola Mundo'
'WRITESUBJECT' asunto
}}}
no funcionará. Debe escribirse así:
{{{#!arexx
'WRITESUBJECT "'asunto'"'
}}}
o también:
{{{#!arexx
'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:
{{{#!arexx
FOLDERINFO
-> RESULT = "0 Entrantes incoming 10 2 4 23030 1"
}}}
{{{#!arexx
FOLDERINFO VAR fi
-> fi = "0 Entrantes incoming 10 2 4 23030 1"
}}}
{{{#!arexx
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`:
{{{#!arexx
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.
ARexxAPI/HELP - Obtener una lista de los comandos ARexx soportados\ ARexxAPI/HIDE - Iconificar YAM\ ARexxAPI/INFO - Obtener información sobre el programa\ ARexxAPI/QUIT - Salir de YAM\ ARexxAPI/SCREENTOBACK - Situar la pantalla de YAM detrás de todas las demás\ ARexxAPI/SCREENTOFRONT - Situar la pantalla de YAM en primer término\ ARexxAPI/SHOW - Des-iconificar YAM\
ARexxAPI/ADDRDELETE - Borrar una ficha del listín de direcciones\ ARexxAPI/ADDREDIT - Editar la ficha actual del listín\ ARexxAPI/ADDRFIND - Buscar fichas en el listín\ ARexxAPI/ADDRGOTO - Elegir ficha actual del listín\ ARexxAPI/ADDRINFO - Obtener información sobre una ficha del listín\ ARexxAPI/ADDRLOAD - Cargar un listín desde un fichero\ ARexxAPI/ADDRNEW - Crear una nueva ficha en el listín\ ARexxAPI/ADDRRESOLVE - Expandir un alias o un nombre\ ARexxAPI/ADDRSAVE - Guardar el listín en un fichero\
ARexxAPI/FOLDERINFO - Obtener información sobre una carpeta\ ARexxAPI/GETFOLDERINFO - Obtener información sobre la carpeta actual\ ARexxAPI/MAILFILTER - Filtrar los mensajes de la carpeta actual\ ARexxAPI/MAILUPDATE - Actualizar el índice de la carpeta actual\ ARexxAPI/NEWMAILFILE - Obtener un fichero de mensaje sin usar para una carpeta\
ARexxAPI/APPBUSY - Pasar YAM al estado "ocupado"\ ARexxAPI/APPNOBUSY - Poner fin al estado "ocupado"\ ARexxAPI/LISTFREEZE - \ ARexxAPI/LISTUNFREEZE - \ ARexxAPI/READCLOSE - Cerrar la ventana de lectura activa\ ARexxAPI/RESTART - \
ARexxAPI/FINDMAIL - \ ARexxAPI/GETSELECTED - Obtener las posiciones de los mensajes seleccionados\ ARexxAPI/LISTSELECT - Seleccionar mensajes en la carpeta actual\ ARexxAPI/SETFOLDER - Cambiar la carpeta actual\ ARexxAPI/SETMAIL - Elegir mensaje actual por posición en la carpeta\ ARexxAPI/SETMAILFILE - Elegir mensaje actual por nombre de fichero\
ARexxAPI/GETMAILINFO - Obtener información sobre el mensaje actual\ ARexxAPI/MAILARCHIVE - Mover los mensajes seleccionados a otra carpeta\ ARexxAPI/MAILBOUNCE - Desviar el mensaje actual\ ARexxAPI/MAILCHANGESUBJECT - Cambiar el asunto de los mensajes seleccionados\ ARexxAPI/MAILCOPY - Duplicar los mensajes seleccionados\ ARexxAPI/MAILDELETE - Borrar los mensajes seleccionados\ ARexxAPI/MAILEDIT - Editar el mensaje actual\ ARexxAPI/MAILEXPORT - Exportar los mensajes seleccionados a un fichero\ ARexxAPI/MAILIMPORT - Importar mensajes de un fichero a la carpeta actual\ ARexxAPI/MAILINFO - Obtener información sobre un mensaje\ ARexxAPI/MAILMOVE - Mover los mensajes seleccionados a otra carpeta\ ARexxAPI/MAILREAD - Leer el mensaje actual\ ARexxAPI/MAILREPLY - Responder a los mensajes seleccionados\ ARexxAPI/MAILSTATUS - Cambiar el estado de los mensajes seleccionados\ ARexxAPI/READINFO - Obtener información sobre los anexos del mensaje abierto\ ARexxAPI/READPRINT - Imprimir un anexo\ ARexxAPI/READSAVE - Guardar un anexo\ ARexxAPI/SETFLAG - Definir las banderas PERmanente o VOLátil de un mensaje\
ARexxAPI/GETURL - Descargar un fichero de la web\ ARexxAPI/ISONLINE - Detectar si YAM está recibiendo o enviando correo\ ARexxAPI/MAILCHECK - Recoger el correo nuevo\ ARexxAPI/MAILSEND - Enviar los mensajes de la carpeta "Salientes"\ ARexxAPI/MAILSENDALL - Enviar todos los mensajes de la carpeta "Salientes"\
ARexxAPI/GETCONFIGINFO - Obtener información sobre el usuario actual\ ARexxAPI/REQUEST - Pedir una decisión al usuario\ ARexxAPI/REQUESTFILE - \ ARexxAPI/REQUESTFOLDER - Pedir al usuario que elija una carpeta\ ARexxAPI/REQUESTSTRING - Pedir al usuario que teclee una cadena\ ARexxAPI/USERINFO - Obtener información sobre el usuario actual\
ARexxAPI/MAILFORWARD - Reenviar los mensajes seleccionados\ ARexxAPI/MAILWRITE - Escribir un nuevo mensaje\ ARexxAPI/WRITEATTACH - Añadir un fichero a un nuevo mensaje\ ARexxAPI/WRITEBCC - Editar la cabecera "BCC:" de un nuevo mensaje\ ARexxAPI/WRITECC - Editar la cabecera "CC:" de un nuevo mensaje\ ARexxAPI/WRITEEDITOR - Pasar un comando ARexx al editor interno\ ARexxAPI/WRITEFROM - Editar la cabecera "From:" de un nuevo mensaje\ ARexxAPI/WRITEIDENTITY - \ ARexxAPI/WRITELETTER - Cargar un fichero de texto en el editor interno\ ARexxAPI/WRITEMAILTO - Editar la cabecera "To:" de un nuevo mensaje\ ARexxAPI/WRITEOPTIONS - Definir las opciones de un nuevo mensaje\ ARexxAPI/WRITEQUEUE - Colocar el nuevo mensaje en la cola de mensajes salientes\ ARexxAPI/WRITEREPLYTO - Editar la cabecera "Reply-To:" de un nuevo mensaje\ ARexxAPI/WRITESEND - Enviar el nuevo mensaje\ ARexxAPI/WRITESUBJECT - Editar el asunto del nuevo mensaje\ ARexxAPI/WRITETO - Editar la cabecera "To:" de un nuevo mensaje\
ARexxAPI/ADDRDELETE - Borrar una ficha del listín de direcciones\ ARexxAPI/ADDREDIT - Editar la ficha actual del listín\ ARexxAPI/ADDRFIND - Buscar fichas en el listín\ ARexxAPI/ADDRGOTO - Elegir ficha actual del listín\ ARexxAPI/ADDRINFO - Obtener información sobre una ficha del listín\ ARexxAPI/ADDRLOAD - Cargar un listín desde un fichero\ ARexxAPI/ADDRNEW - Crear una nueva ficha en el listín\ ARexxAPI/ADDRRESOLVE - Expandir un alias o un nombre\ ARexxAPI/ADDRSAVE - Guardar el listín en un fichero\ ARexxAPI/APPBUSY - Pasar YAM al estado "ocupado"\ ARexxAPI/APPNOBUSY - Poner fin al estado "ocupado"\ ARexxAPI/FINDMAIL - \ ARexxAPI/FLUSHINDEXES - \ ARexxAPI/FOLDERINFO - Obtener información sobre una carpeta\ ARexxAPI/GETCONFIGINFO - Obtener información sobre el usuario actual\ ARexxAPI/GETFOLDERINFO - Obtener información sobre la carpeta actual\ ARexxAPI/GETMAILINFO - Obtener información sobre el mensaje actual\ ARexxAPI/GETSELECTED - Obtener las posiciones de los mensajes seleccionados\ ARexxAPI/GETURL - Descargar un fichero de la web\ ARexxAPI/HELP - Obtener una lista de los comandos ARexx soportados\ ARexxAPI/HIDE - Iconificar YAM\ ARexxAPI/INFO - Obtener información sobre el programa\ ARexxAPI/ISONLINE - Detectar si YAM está recibiendo o enviando correo\ ARexxAPI/LISTFREEZE - \ ARexxAPI/LISTSELECT - Seleccionar mensajes en la carpeta actual\ ARexxAPI/LISTUNFREEZE - \ ARexxAPI/MAILARCHIVE - Mover los mensajes seleccionados a otra carpeta\ ARexxAPI/MAILBOUNCE - Desviar el mensaje actual\ ARexxAPI/MAILCHANGESUBJECT - Cambiar el asunto de los mensajes seleccionados\ ARexxAPI/MAILCHECK - Recoger el correo nuevo\ ARexxAPI/MAILCOPY - Duplicar los mensajes seleccionados\ ARexxAPI/MAILDELETE - Borrar los mensajes seleccionados\ ARexxAPI/MAILEDIT - Editar el mensaje actual\ ARexxAPI/MAILEXPORT - Exportar los mensajes seleccionados a un fichero\ ARexxAPI/MAILFILTER - Filtrar los mensajes de la carpeta actual\ ARexxAPI/MAILFORWARD - Reenviar los mensajes seleccionados\ ARexxAPI/MAILIMPORT - Importar mensajes de un fichero a la carpeta actual\ ARexxAPI/MAILINFO - Obtener información sobre un mensaje\ ARexxAPI/MAILMOVE - Mover los mensajes seleccionados a otra carpeta\ ARexxAPI/MAILREAD - Leer el mensaje actual\ ARexxAPI/MAILREPLY - Responder a los mensajes seleccionados\ ARexxAPI/MAILSEND - Enviar los mensajes de la carpeta "Salientes"\ ARexxAPI/MAILSENDALL - Enviar todos los mensajes de la carpeta "Salientes"\ ARexxAPI/MAILSTATUS - Cambiar el estado de los mensajes seleccionados\ ARexxAPI/MAILUPDATE - Actualizar el índice de la carpeta actual\ ARexxAPI/MAILWRITE - Escribir un nuevo mensaje\ ARexxAPI/NEWMAILFILE - Obtener un fichero de mensaje sin usar para una carpeta\ ARexxAPI/QUIT - Salir de YAM\ ARexxAPI/READCLOSE - Cerrar la ventana de lectura activa\ ARexxAPI/READINFO - Obtener información sobre los anexos del mensaje abierto\ ARexxAPI/READPRINT - Imprimir un anexo\ ARexxAPI/READSAVE - Guardar un anexo\ ARexxAPI/REQUEST - Pedir una decisión al usuario\ ARexxAPI/REQUESTFILE - \ ARexxAPI/REQUESTFOLDER - Pedir al usuario que elija una carpeta\ ARexxAPI/REQUESTSTRING - Pedir al usuario que teclee una cadena\ ARexxAPI/RESTART - \ ARexxAPI/SCREENTOBACK - Situar la pantalla de YAM detrás de todas las demás\ ARexxAPI/SCREENTOFRONT - Situar la pantalla de YAM en primer término\ ARexxAPI/SETFLAG - Definir las banderas PERmanente o VOLátil de un mensaje\ ARexxAPI/SETFOLDER - Cambiar la carpeta actual\ ARexxAPI/SETMAIL - Elegir mensaje actual por posición en la carpeta\ ARexxAPI/SETMAILFILE - Elegir mensaje actual por nombre de fichero\ ARexxAPI/SHOW - Des-iconificar YAM\ ARexxAPI/USERINFO - Obtener información sobre el usuario actual\ ARexxAPI/WRITEATTACH - Añadir un fichero a un nuevo mensaje\ ARexxAPI/WRITEBCC - Editar la cabecera "BCC:" de un nuevo mensaje\ ARexxAPI/WRITECC - Editar la cabecera "CC:" de un nuevo mensaje\ ARexxAPI/WRITEEDITOR - Pasar un comando ARexx al editor interno\ ARexxAPI/WRITEFROM - Editar la cabecera "From:" de un nuevo mensaje\ ARexxAPI/WRITEIDENTITY - \ ARexxAPI/WRITELETTER - Cargar un fichero de texto en el editor interno\ ARexxAPI/WRITEMAILTO - Editar la cabecera "To:" de un nuevo mensaje\ ARexxAPI/WRITEOPTIONS - Definir las opciones de un nuevo mensaje\ ARexxAPI/WRITEQUEUE - Colocar el nuevo mensaje en la cola de mensajes salientes\ ARexxAPI/WRITEREPLYTO - Editar la cabecera "Reply-To:" de un nuevo mensaje\ ARexxAPI/WRITESEND - Enviar el nuevo mensaje\ ARexxAPI/WRITESUBJECT - Editar el asunto del nuevo mensaje\ ARexxAPI/WRITETO - Editar la cabecera "To:" de un nuevo mensaje\