wiki:fr:Documentation/Reference

Version 3 (modified by AmigaPhil, 6 months ago) (diff)

--

Traduction partielle

Autres langues:

Référence

Structure de l'installation

Dans le répertoire du programme YAM se trouvent les répertoires et les fichiers suivants:

  • YAM Le programme lui-même
  • YAM.info L'icône du programme
  • Resources/
    • Themes/ Themes Utilisés par YAM pour son interface graphique
    • Gallery/ Photos des personnes figurant dans le carnet d'adresses
    • Certificates/
    • Spamfilters/
  • Folders
    • incoming/ le répertoire du courrier entrant
    • outgoing/ le répertoire du courrier sortant
    • sent/ le répertoire du courrier envoyé
    • trash/ le répertoire du courrier marqué pour effacement
    • drafts/
    • spam/
  • Rexx/ programmes ARexx pour YAM
  • .config le fichier de configuration
  • .folders une liste des dossiers
  • .addressbook le carnet d'adresses
  • .glossary le glossaire
  • .users une liste des utilisateurs YAM
  • .spamdata les données d'entraînement au spam de YAM
  • .updatestate information pour le méchanisme automatique de mise à jour
  • .signature votre signature personnelle
  • .altsignature1 première signature alternative
  • .altsignature2 seconde signature alternative
  • .taglines votre collection de taglines
  • .autosave?.txt copies de sauvegarde du contenu de l'éditeur
  • .uidl utilisé pour éviter les duplicata
  • .emailcache fichier cache utilisé pour la fonction de cache courrier feature

Stockage des messages

Chaque message est sauvegardé dans un fichier séparé dont le nom est construit en encodant certaines informations à propos du courriel (date, status, etc) avec l'encodage standard Base64. Le nom de fichier résultant est compatible avec n'importe quel système de fichier.

Exemple: QvZgMAAFe4M=.001,RA

QvZgMAAFe4M= Hash de 5 octets encodé en Base64.

Ce hash est basé sur l'info DATE du message.

. (dot) - Séparateur.

001 Valeur séquentielle. incrémentée de 1 si la base du nom de fichier, en incluant cette partie, existe déjà.

, (comma) - Séparateur.

RA Statut du message. Lettres possibles après la virgule:

R - Lu
A - Répondu
M - Marqué
Y -
J -

Chaque dossier contient un fichier ".index" avec les en-têtes de chaque message du répertoire. Il y a aussi un fichier de configuration appelé ".fconfig" qui contient les réglages pour ce dossier en particulier.

Gestion de thèmes

YAM utilise des icônes et des images dans /Themes/default pour son Interface Graphique Utilisateur (GUI). Il y a plusieurs sortes d'icônes:

config/config_#?, config_#?_big

Ces images sont celles que vous voyez quand vous ouvrez les Préférences pour configurer YAM.

folder/folder_#?, folder_#?_new

Ce sont les images utilisées devant les dossiers Reçus, Corbeille, En attente et Envoyés. Celles avec le suffixe "_new" sont utilisées automatiquement chaque fois qu'il y a un nouveau ou un courriel non-lu dans le répertoire.

Les images "folder_fold" et "folder_unfold" sont spéciales: elles sont utilisées comme icônes pour les groupes de dossiers.

Un fichier image ".fimage" dans le dossier surpasse l'image par défaut. C'est aussi la seule méthode supportée pour avoir des images affichées devant les dossiers custyomisés.

icon/check.info, empty.info, new.info, old.info

Icônes qui montrent le statut de la boîte de réception:

check.info YAM vérifie s'il y a de nouveaux courriels
empty.info la boîte mail est vide
new.info la boîte mail a au moins un nouveau message
old.info la boîte mail ne contient que des "vieux" courriels

status/status_#?

Ce sont les icônes statut ? affichées par YAM pour représenter le statut des messages

L'icône "status_mark", utilisée quand les messages sont marqués, est spéciale: si elle n'est pas présente, YAM marquera les messages en affichant l'expéditeur ou le destinataire en caractères gras.

toolbar/tb_#?, tb_#?_G, tb_#?_S

Ce sont les images utilisées pour construire la barre d'outils des fenêtres Principale, Lecture, Ecriture, et Carnet d'adresses. Celles nommées "tb_#?_G" sont la variété "fantôme", par ex. elles fournissent les images à utiliser lorsque les icônes doivent paraître grisées. "tb_#?_S" sont la variété "sélectionnées", par ex. lorsque vous cliquez sur un bouton.

.theme, logo, preview

.theme contient d'importantes variables textuelles qui sont nécessaire pour que le moteur de thème fonctionne.

Le "logo" est ce que vous voyez lorsque démarrez et quittez YAM, et aussi dans la fenêtre "A propos" de YAM. (Note: Seul le logo par défaut est affiché, qu'importe le thème choisi.)

Le "preview" est une petite prévisualisation qui montre à quoi ressemblera un thème dans Préférences/Apparence

Formats de fichiers divers

Le fichier .addressbook

This plain text file uses a hierarchical scheme following this general format:

    YAB4 - YAM Addressbook                          - Identifier
    @GROUP alias  ·································
    description                                   ·
    @USER alias     -------------.                ·
    e-mail address               |                ·
    real name                    |                ·
    description                  |                ·
    phone #                      |                ·
    street address               |                ·
    ZIP/City                      > Person        ·
    country                      |                ·
    PGP ID                       |                ·
    birth date                   |                ·
    portrait                     |                 · GROUP
    homepage                     |                ·
    default security             |                ·
    @ENDUSER        -------------'                ·
    @LIST alias     >>>>>>>>>>>>>>>>>>>>>>>>>>                 ·
    return address               v                ·
    list name                    v                ·
    description                  v                ·
    member #1                     >> LIST          ·
    member #2                    ^                ·
    ...                          ^                ·
    member #n                    ^                ·
                                 ^                ·
    @ENDLIST        >>>>>>>>>>>>>>>>>>>>>>>>>>                 ·
    @ENDGROUP     ·································

Groups, lists and people are started with @GROUP <alias>, @LIST <alias> and @USER <alias> and closed with @ENDGROUP, @ENDLIST and @ENDUSER, respectively. Groups may include lists, and lists may include members. Both lists and people may appear outside groups. List members may be either aliases, addresses or fully qualified "Real name <address>" pairs.

GUI-wise, a group may be dragged&dropped onto a distribution list and viceversa to get all its recipients added to the list. Recursive loops are watched and promptly avoided when appropriate - for instance, if a group contanining a list is dragged&dropped on that list, only the items available in the group other than the contents of the list itself are added to it.

Le fichier .emailcache

This plain text file contains a list of the last n used recipients who were not in the address book, in the format "Name <address>" (or just "<address>" if the name is not available) with one entry per line.

New entries get added at the top. If the limit of entries set in the configuration is exceeded, the oldest entry (i.e. the one at the bottom) is dropped.

If it is already in the cache when writing the mail, the entry is moved to the top -- this way, the next time, the most recently used recipient will be suggested first. Entries in the address book will still have priority over the cache, though.

Le fichier .fconfig

This plain text file exists in every folder and stores the settings used therein, using this format:

YFC1 - YAM Folder Configuration
Name = folder_name
MaxAge = age
Password = password
Type = folder_type
XPKType = type_number
Sort1 = primary_sort
Sort2 = secondary_sort
Stats = Y|N
MLSupport = Y|N
MLFromAddr = MLFrom_address
MLRepToAddr = MLRepTo_address
MLPattern = ML_pattern
MLAddress = ML_address
MLSignature = signature_number

where

  • Name is the name of the folder, as it appears in the folder list
  • MaxAge is the number of days the messages in the folder will be kept before removing them automatically, where 0 disables this feature (see Configuration/Start/Quit )
  • Password is the encoded counterpart of the password used to protect this folder, if any
  • Type is a number indicating which type this folder is (should be usually 0 for user folders - see the documentation for the FOLDERINFO ? command)
  • XPKType refers to the XPK mode used in the folder:

0 = none
1 = simple protection (password)
2 = compressed
3 = compressed with password

  • Sort1 refers to the primary sort criterion used in the folder, in negative form if the sort is reversed:

1 = Message date
2 = Date received
3 = Sender
4 = Recipient
5 = Subject
6 = Size
7 = Status

  • Sort2 is just the same as Sort1, but referred to the secondary sort criterion
  • Stats may be either Y or N depending on the status of the "AppIcon stats" flag
  • MLSupport may be either Y or N depending on the status of the "Mailing list support" flag
  • MLFromAddr shows the contents of the "From: address" field
  • MLRepToAddr shows the contents of the "Reply-To: address" field
  • MLPattern shows the contents of the "To: pattern" field
  • MLAddress shows the contents of the "To: address" field
  • MLSignature refers to the default signature to be used when posting messages to this mailing list:

0 = none
1 = default signature, i.e. PROGDIR:.signature
2 = alt. signature #1
3 = alt. signature #2

Le fichier .folders

This plain text file uses a hierarchical scheme following this general format:

    YFO1 - YAM Folders                              - Identifier
    @FOLDER name    ------------------.
    directory                          > Folder
    @ENDFOLDER      ------------------'
    @GROUP name              ································
    status                                                  ·
    @FOLDER name    ------------------.                     ·
    directory                          > Folder             ·
    @ENDFOLDER      ------------------'                     ·
    @GROUP name              ······················         ·
    status                                        ·         ·
    @FOLDER name    ------------------.           ·          · GROUP
    directory                          > Folder   ·         ·
    @ENDFOLDER      ------------------'            · GROUP  ·
    @FOLDER name    ------------------.           ·         ·
    directory                          > Folder   ·         ·
    @ENDFOLDER      ------------------'           ·         ·
    @ENDGROUP                ······················         ·
    @ENDGROUP                ································

where <status> may be either 0 or 1, the latter meaning that the group is unfolded, e.g. its contents are being displayed. Folders may live both inside and outside groups, and groups may be nested.

The order of the folder tree is saved on disk whenever the Folder/Order/Save menu item is called.

Le fichier .glossary

This file contains a list of the definitions made in the glossary using this format:

YDI1 - YAM Dictionary
@ENTRY abbreviation
contents
@ENDENTRY
@ENTRY abbreviation
contents
@ENDENTRY
...

Le fichier .uidl

If "Avoid duplicates" is enabled in Configuration/New mail , YAM will use the UIDL POP3 command when connecting to your POP3 server to request an Unique ID Listing of the messages in your mail account. The POP3 server is responsible for assigning an unique ID to every message and put it into a "X-UIDL:" header.

If the server doesn't support the UIDL POP3 command, YAM will fall back to the TOP command and try using the "Message-ID:" header instead; if this also fails, an error will be generated.

The Unique ID Listing received from the server is compared against the contents of the "PROGDIR:.uidl" file; if this file doesn't exist yet, it will be created. This is a plain text file with one ID per line using the format <ID>@<POP3 server>, e.g.

9685@…
9686@…
9687@…
9688@…
(k5"!N1!"!RkI"!YT4"!@pop.wanadoo.es
9689@…
9690@…
9691@…
9692@…

Whenever an ID is already found in the "PROGDIR:.uidl" file, the relevant message will be considered a duplicate, and thus it won't be downloaded. New IDs not yet in the "PROGDIR:.uidl" file will be added to it as the corresponding messages are successfully downloaded.

Le fichier .users

This file contains a list of the users that can log in and use YAM. YAM maintains this file by itself, so you shouldn't ever touch it, unless maybe you are moving YAM to another place in your hard disk.

The file uses the following format:

1st line: YUS2 - YAM Users
2nd line: @USER <username>
3rd line: mail directory of this user, e.g. Comm:YAM
4th line: number
5th line: encrypted password, if any
6th line: @ENDUSER

further lines: next user definition, upto 16 maximum.

where "number" is a value defining the status of this user combining the following set of elements:

No Supervisor privileges = 4
Share global address book = 2
Share global glossary = 1

Thus, "3" would mean the user has Supervisor privileges and is sharing the global address book and glossary. This is the default value in a single user setup.

Le fichier log

The log file used by YAM is an ASCII file storing one event per line. Each line is saved in this format:

DD-MMM-YY HH:MM [code] Event description

where code is a two digit number and "Event description" is obviously the event description, possibly localized. Therefore, any computer-assisted software meant to analyze the log file data should refer to the code of the event.

Events out of the 30<->49 range will only be printed if "Log all events" is enabled in the Security options .

List of possible events:

0 - YAM started
1 - Logged in as user 'user_name'
2 - Logged in as 'user_name', using configuration 'config_file' and mail directory 'folder_path'

10 - Wrote new message for 'recipient' about 'subject', including n attachment(s)
11 - Replied message from 'sender' about 'subject'
12 - Forwarded message from 'sender' about 'subject' to 'recipient'
13 - Bounced message from 'sender' about 'subject' to 'recipient'
14 - Edited message from 'sender' to 'recipient' about 'subject'
20 - Deleted n message(s) in folder 'folder'
21 - Deleted message from 'sender' about 'subject' in folder 'folder'
22 - Moved n message(s) from folder 'folder' to 'folder'
23 - Moved message from 'sender' about 'subject' from folder 'folder' to 'folder'
24 - Copied n message(s) from folder 'folder' to 'folder'
25 - Copied message from 'sender' about 'subject' from folder 'folder' to 'folder'
26 - Filtered n message(s) in folder 'folder': n match(es)
30 - Retrieved n message(s) from POP3 account 'user_id@host'
31 - Logged in on POP3 account 'user_id@host': n messages waiting
32 - Retrieved message from 'sender' about 'subject' (n bytes)
40 - Sent n message(s) using SMTP server 'host'
41 - Connected to SMTP server 'host'
42 - Sent message to 'recipient' about 'subject' (n bytes)
50 - Imported n message(s) from file 'filename' into folder 'folder'
51 - Exported n message(s) from folder 'folder' to file 'filename'
60 - Saved configuration file 'config_file'
62 - Saved user configuration
70 - Saved address book 'filename'
71 - Added address book entry 'alias'
80 - Saved attachment 'filename' of message 'mailfile' in folder 'folder'
81 - Cropped attachment(s) of message 'mailfile' in folder 'folder'
82 - Changed subject 'subject' of message 'mailfile' in folder 'folder' to 'subject'
99 - YAM terminated