Comentario¶

Una palabra que comience por # y el resto de los caracteres hasta el carácter de nueva línea se ignoran. Esto no se aplica a las líneas de condición, que no se pueden comentar.

Recetas¶

Una línea que comience por ':' indica el comienzo de una receta. Esto tiene el siguiente formato:

:0 [banderas] [ : [fichero_bloqueo_local] ]
<ninguna o más condiciones (una por línea)>
<exactamente una línea de acción>

Las condiciones comienzan con un `*' inicial, todo lo que viene tras este carácter se pasa al egrep interno literalmente, salvo los espacios en blanco iniciales y finales. Estas expresiones regulares son completamente compatibles con las expresiones regulares extendidas del egrep(1) normal. Véase también Expresiones regulares extendidas.

La condiciones se unen mediante Y (and); si no hay condiciones el resultado será verdadero por defecto.

Banderas pueden ser cualesquiera de las siguientes:

H

Hace egrep sobre la cabecera (por defecto).

B

Hace egrep sobre el cuerpo.

D

Indica al egrep interno que distinga entre mayúsculas y minúsculas (contrario al comportamiento por defecto que ignora esta distinción).

A

Esta receta no se ejecutará salvo que las condiciones de la última receta precedente (del nivel de bloque anidado actual) sin las banderas `A' o `a' se verificaron. Esto permite encadenar acciones que dependan de una condición común.

a

Tiene el mismo significado que la bandera `A', con la condición adicional que la receta inmediatamente precedente tiene que completarse correctamente antes de ejecutar esta receta.

E

Esta receta sólo se ejecuta si la receta inmediatamente precedente no se ejecutó. La ejecución de esta receta también desactiva cualquier receta inmediatamente posterior con la bandera 'E'. Esto le permite especificar acciones `else if'.

e

Esta receta sólo se ejecuta si falló la receta inmediatamente anterior (i.e. la acción se intentó, pero ocasionó un error).

h

Alimenta la cabecera a un tubería, fichero o destino de correo (por defecto).

b

Alimenta el cuerpo a un tubería, fichero o destino de correo (por defecto).

f

Considera la tubería como un filtro.

c

Genera una copia de carbón de este mensaje. Esto sólo tiene sentido en las recetas de entrega. En la única receta de no entrega que esta bandera tiene efecto es en un bloque anidado, para generar una copia de carbón esto duplica el proceso procmail en ejecución (los ficheros de bloqueo no se heredan), por lo cual el proceso duplicado actuará de forma normal y el padre saltará el bloque.

w

Espera que termine el filtro o programa y verifica su código se salida (normalmente ignorado); si el filtro no tiene éxito, el texto no será filtrado.

W

Tiene el mismo significado que la bandera `w', pero suprimirá cualquier mensaje `Fallo de Programa'.

i

Ignora cualquier error de escritura en esta receta (i.e. normalmente debido a una tubería cerrada prematuramente).

r

Modo de estado original (raw mode), no intenta asegurarse de que el mensaje termina en un línea vacía, lo escribe tal cual.

Hay algunas condiciones especiales que puede usar que no son expresiones regulares puras. Para seleccionarlas, la condición debe comenzar con:

!

Invierte la condición.

$

Evalúa el resto de esta condición según las reglas de sustitución de sh(1) dentro de las dobles comillas, salta los espacios iniciales y entonces la vuelve a analizar.

?

Usa el código de salida del programa especificado.

<

Verifica si la longitud total del correo es más corta que el número de octetos especificado (en decimal).

>

Análogo a '<'.

nombre_de_variable ??

Concuerda el resto de esta condición con el valor de esta variable de entorno (que no puede ser una pseudo variable). Un caso especial es si nombre_de_variable es igual a `B', `H', `HB' o `BH'; esto simplemente se sobrepone al área cabecera/cuerpo por defecto definida por la bandera inicial de esta receta.

\

Para entrecomillar algo de lo anterior al inicio de la línea.

Fichero de bloqueo local¶

Si pone unos segundos ':' (detrás) en la primera línea de receta, entonces procmail usará un fichero de bloqueo local (para esta receta sólo). Opcionalmente puede especificar el fichero de bloqueo local que quiere usar; si no lo hace procmail usará el nombre de fichero destino (o el nombre de fichero a continuación del primer '>>') y le añadirá $LOCKEXT.

Línea de acción de receta¶

La línea de acción puede comenzar con los siguientes caracteres:

!

Reenvía a todas las direcciones de correo especificadas.

|

Inicia el programa especificado, posiblemente en $SHELL si incluya alguno de los caracteres $SHELLMETAS. Opcionalmente puede incluir el símbolo de tubería en variable=, lo que hará que la salida estándar del programa sea capturado en la variable de entorno (procmail no termina el preprocesado del fichero de recursos en este punto). si especifica el símbolo de tubería, sin ningún programa, procmail dirige el correo a la salida estándar.

{

Seguido de al menos un espacio, tabulador o nueva línea, marcará el inicio de un bloque anidado. Todo lo que hay hasta la siguiente llave cerrada dependerá de la condición especificada para esta receta. Está permitido el anidamiento ilimitado La llave que cierra existe simplemente para delimitar el bloque, no hará que procmail termine de ninguna forma. Si se llega al final del bloque el procesamiento continuará de la forma habitual después del bloque. En los bloque anidados, las banderas `H' y `B' sólo afecta a las iniciales del bloque, las banderas `h' y `b' no tienen efecto.

Cualquier otra cosa se tomará como un nombre de buzón (bien un nombre de fichero o bien un directorio, absoluto o relativo al directorio actual (véase MAILDIR)). Si es un nombre de fichero (posiblemente inexistente), el correo se añade a él.

Si es un directorio, el correo se entregará a un fichero creado nuevo con un nombre que se garantiza único llamado $MSGPREFIX* en el directorio especificado. Si el nombre del directorio directorio termina en "/.", entonces se presupone que es una carpeta MH; i.e. procmail usará el siguiente número que encuentre disponible. Cuando procmail está entregando a directorios, puede especificar múltiples directorios para entregar (procmail la hará usando enlaces duros).

Variables de entoro por defecto¶

LOGNAME, HOME y SHELL

Sus valores (del recipiente) por defecto

SHELLMETAS

& |<>~;?*[

SHELLFLAGS

-c

ORGMAIL

/var/spool/mail/$LOGNAME
(Salvo que se haya especificado -m, en cuyo caso no tiene valor)

MAILDIR

$HOME/
(Salvo que el nombre del primer fichero de recursos abierto correctamente empiece con Unless the name of the first successfully opened rcfile starts with `./' o si se ha especificado -m, ne cuyo caso se pone por defecto a `.')

DEFAULT

$ORGMAIL

MSGPREFIX

msg.

SENDMAIL

/usr/sbin/sendmail

SENDMAILFLAGS

-oi

HOST

El nombre actual del host

COMSAT

no
(Si se ha especificado un fichero de recursos en la línea de comando)

PROCMAIL_VERSION

3.13.1

LOCKEXT

.lock

Otras variables limpiadas o prefijadas son IFS, ENV, PWD and PATH=$HOME/bin :/bin :/usr/bin :/sbin :/usr/sbin :/usr/local/bin :/usr/local/sbin :/usr/bin/X11.

Entorno¶

Antes de que se pierda en la multitud de varables de entorno, tenga en cuenta que todas ellas tienen valores por defecto razonables.

MAILDIR

Directorio actual mientras procmail está en ejecución (que significa que todas las rutas son relativas a $MAILDIR).

DEFAULT

Fichero buzón por defecto (si no se ha dicho otra cosa, procmail volcará el correo en este buzón). Procmail usará automáticamente $DEFAULT$LOCKEXT como fichero de bloqueo antes de escribir en este buzón. No necesita fijar esta variable, ya que apunta al buzón estándar del sistema.

LOGFILE

Este fichero también contendrá cualquier mensaje de error o diagnóstico de procmail (normalmente ninguno :-) o cualquier otro programa iniciado por procmail. Si no se especifica este fichero, cualquier mensaje de diagnóstico o error se devolverá por correo al remitente. Véase también LOGABSTRACT.

VERBOSE

Puede activar diagnósticos extendidos fijando esta variable a `yes' u `on', para desactivarlos de nuevo póngala a `no' u `off'.

LOGABSTRACT

Justo antes de que procmail termine registra una descripción del mensaje entregado en $LOGFILE mostrando los campos `From ' y `Subject:' de la cabecera, a qué carpeta se entregó finalmente y qué tamaño tenía (en octetos). Fijando esta variable a `no', se suprime la generación de estos mensajes. Si le asigna el valor `all', procmail registrará una descripción para cada receta de entrega procesada con éxito.

LOG

Cualquier cosa asignada a esta variable se añade a $LOGFILE.

ORGMAIL

Normalmente el buzón del sistema (ORiGinal MAILbox). Si por alguna oscura razón (como `sistema de ficheros lleno') el correo no pudiera entregarse, entonces este buzón es el último recurso. Si procmail falla para guardar el correo aquí (gran, gran problema :-), entonces el correo vuelve al remitente.

LOCKFILE

Fichero semáforo global. Si este fichero existe ya, procmail esperará hasta que se haya ido antes de proceder, y lo creará él mismo (eliminándolo cuando esté listo, desde luego). Si se especifica más de un fichero de bloqueo , entonces el previo sólo se eliminará antes de intentar crear el nuevo. El uso de un fichero de bloqueo global es desaconsejable, cuando sea posible use en su lugar ficheros de bloqueo locales (uno por receta base).

LOCKEXT

Extensión por defecto que se añade al fichero destino para determinar que fichero de bloqueo local usar (sólo si se activa, activo por receta base).

LOCKSLEEP

Número de segundos que procmail dormirá antes de reintentar sobre un fichero de bloqueo (si ya existe); si no se especifica, el valor por defecto es 8 segundos.

LOCKTIMEOUT

Número de segundos que tienen que pasar desde que un fichero de bloqueo fue modificado/creado antes de que procmail decida que este deber ser fichero de bloqueo erróneamente dejado y que puede ser eliminado ahora a la fuerza. Si es cero el fichero de bloqueo se elimina, si no se especifica, toma un valor por defecto de 1024 segundos. Esta variable es útil para prevenir cuelgues infinitos de sendmail/procmail. Procmail es inmune a las desviaciones de reloj a través de máquinas.

TIMEOUT

Número de segundos que tienen que haber transcurrido antes de que procmail decida que algún proceso hijo que él inició tiene que terminarlo. El programa en cuestión recibirá una señal TERMINATE de procmail, y el procesamiento del fichero de recursos continuará. Si vale cero, no se usa temporizador y procmail esperará indefinidamente hasta que el hijo termine; si no se especifica, el valor por defecto es 960 segundos.

MSGPREFIX

El prefijo de nombre de fichero que se usa cuando se entrega a un directorio (no se usa cuando se entrega a un directorio MH).

HOST

Si esto no es el nombre de host de la máquina, el procesado del fichero de recursos actual cesa inmediatamente. Si otro fichero de recursos fuera especificado en la línea de comando, el procesamiento continuará con el siguiente. Si se agotan todos los ficheros de recursos, el programa terminará, pero no generará un error (i.e. para el programa de correo parecerá que el correo ha sido entregado).

UMASK

El nombre lo dice todo (si no, olvide esto :-). Cualquier cosa asignada a UMASK se toma como un número octal. Si no se especifica, el valor por defecto de umask será 077. Si umask permite o+x, todos los buzones a los que entrega procmail directamente sufrirán un cambio de modo a o+x. Esto se puede usar para verificar si ha llegado nuevo correo.

SHELLMETAS

Si cualesquiera de los caracteres de SHELLMETAS aparece en la línea que especifica un filtro o programa, la línea se pasará a $SHELL en lugar de ser ejecutada directamente.

SHELLFLAGS

Cualquier llamada a $SHELL será como:
"$SHELL" "$SHELLFLAGS" "$*";

SENDMAIL

Si no usa la facilidad forwarding no se preocupe por esto. Especifica el programa que se llama para reenviar cualquier correo.
Se llama como: "$SENDMAIL" "$SENDMAILFLAGS" "$@";

NORESRETRY

Número de reintentos que se llevan a cabo si sucede alguno de los errores `tabla de procesos llena', `tabla de ficheros llena', `memoria agotada(out of memory)' o `espacio swap agotado (out of swap space)'. Si este número es negativo, entonces procmail reintentará indefinidamente; si no se especifica su valor por defecto es 4 veces. Los reintentos se producen con un intervalo de $SUSPEND segundos. La idea que hay detrás de esto es, que si v.g. el espacio swap se ha agotado o la tabla de procesos está llena, normalmente muchos otros programas lo detectarán también y abortarán o fallarán 8-), en relación con esto, libere los recursos que puedan se valiosos para procmail.

SUSPEND

Número de segundos que procmail estará en pausa si tiene que esperar algo que actualmente no está dispoible (memoria, fork, etc.); si no se especifica tomará un valor por defecto de 16 segundos. Véase también: LOCKSLEEP.

LINEBUF

Longitud de las líneas de buffer internas, no pueden ser menores de 128. Todas las líneas leídas del fichero de recursos Si no se especifica toma el valor por defecto de 2048. Este límite, desde luego, no se aplica al propio mensaje, que puede tener una longitud de líneas arbitrario, o podría ser un fichero binario. Véase también PROCMAIL_OVERFLOW.

DELIVERED

Si está con un valor `yes' procmail parecerá (al agente de correo) que el correo ha sido entregado. Si el correo o se puede entregar tras haberse encontrado con esta asignación (puesta a `yes'), el correo se perderá (i.e. el correo no rebota).

TRAP

Cuando procmail termina ejecutará el contenido de esta variable. Se puede leer una copia del correo de la entrada estándar. Cualquuier salida producida por este comando se añadirá a $LOGFILE. Los posibles usos de TRAP son: eliminación de ficheros temporales, registrar incidencias personalizadas, etc. Véase también EXITCODE y LOGABSTRACT.

EXITCODE

Cuando procmail termina y a esta variable se le ha asignado un valor numérico positivo, procmail los usará como código de salida. Si esta variable está definida pero vacía, procmail asignará el código de salida con cualquier cosa que devuelva el programa TRAP devuelva. Si esta variable no se ha fijado, procmail la fijará antes de llamar al programa TRAP program.

LASTFOLDER

Procmail asigna esta variable cuando está entregando a una carpeta o programa. Siempre contiene el nombre de la última carpeta (o programa) al que entregó procmail.

MATCH

Procmail asigna esta variable cuando se le dice que extraiga el texto que concuerda con una expresión regular. Contendrá todo el texto que concuerda con la expresión regular pasado el `\/'.

SHIFT

La asignación de un valor positivo a esta variable tiene el mismo efecto que el mandato `shift' en sh(1). Este comando es más útil para extraer argumentos extra pasados a procmail cuando actúa como filtro de correo genérico.

INCLUDERC

Nombres de ficheros de recursos (relativos al directorio actual) se se incluirán aquí como si fueran parte del fichero de recursos actual. Se permite el anidamiento ilimitado. Como no se realizan verificaciones sobre los permisos o la propiedad del fichero de recursos, los usuarios de INCLUDERC deberían estar seguros de que sólo los usuarios con confianza tienen permiso de escritura en el fichero de recurso incluido o el directorio en el que está.

PROCMAIL_VERSION

El número de versión del binario procmail en ejecución.

PROCMAIL_OVERFLOW

Esta variable se fijará a un valor no vacío si procmail detecta un desbordamiento del buffer. Véase también la sección fallos de abajo para otros detalles de operación cuando ocurren los desbordamientos.

COMSAT

La notificación Comsat(8)/biff(1) está activa por defecto, se puede desactivar fijando esta variable a `no'. De forma alternativa, el servicio biff se puede personalizar poniéndolo como `service@', `@hostname', o `service@hostname'. Cuando no se especifica por defecto to biff@localhost.

DROPPRIVS

Si está a `yes' procmail anulará todos los privilegios que pudiera tener (suid o sgid). Esto sólo es útil si quiere garantizar que la última mitad del fichero /etc/procmailrc se ejecuta en nombre del recipiente.

Expresiones regulares extendidas¶

Los siguientes elementos se conocen por el egrep interno de procmail y el egrep(1) estándar (tenga cuidado que algunos desarrollos de egrep incluyen otras extensiones no estándar):

^

Inicio de línea.

$

Fin de línea.

.

Cualquier carácter salvo nueva línea.

a*

Cualquier secuencia de ninguna o más aes.

a+

Cualquier secuencia de una o más aes.

a?

Ninguna o una a.

[^-a-d]

Cualquier carácter que no sea un guion, a, b, c, d o nueva línea.

de|abc

Las secuencias `de' o `abc'.

(abc)*

Ninguna o más veces la secuencia `abc'.

\.

Concuerda con un simple punto; use \ para proteger cualquiera de los caracteres mágicos para suprimir su significado especial. Véase también la sustitción de variables $\ .

Esto eran sólo ejemplos, desde luego, cualquier combinación más compleja es válida también.

Los significados de los siguientes elementos son extensiones especiales de procmail:

^ or $

Concuerda con una nueva línea(para concordancia multilínea).

^^

Asocia la expresión al comienzo del área de búsqueda, o si se encuentra al final de la expresión, lo asocia al final de área de búsqueda.

\< o \>

Concuerda con el carácter anterio o posterior a una palabra. Simplemente son abreviaturas de `[^a-zA-Z0-9_]', pero también puede concordar con nuevas líneas. Como concuerdan con los caracteres actuales, sólo sirven para delimitar palabras, no para delimitar espacio entre palabras.

\/

Divide la expresión en dos partes. Todo lo que cocuerda con la parte derecha se asignará a la variable de entorno MATCH.