Changes between Initial Version and Version 1 of fr:Documentation/Reference


Ignore:
Timestamp:
Apr 24, 2014, 3:59:26 PM (8 months ago)
Author:
AmigaPhil
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • fr:Documentation/Reference

    v1 v1  
     1[[TranslatedPages(revision=9,outdated=Traduction partielle]]
     2[[TOC]]
     3
     4= Référence =
     5
     6== Structure de l'installation ==
     7
     8Dans le répertoire du programme YAM se trouvent les répertoires et les fichiers suivants:
     9
     10
     11 * '''YAM'''               Le programme lui-même
     12 * '''YAM.info'''          L'icône du programme
     13
     14 * '''Resources/'''
     15   * '''Themes/'''            [[#FixTheme| Themes ]] Utilisés par YAM pour son interface graphique
     16   * '''Gallery/'''               Photos des personnes figurant dans le carnet d'adresses
     17   * '''Certificates/'''
     18   * '''Spamfilters/'''
     19
     20* '''Folders'''
     21   * '''incoming/'''         le répertoire du courrier entrant
     22   * '''outgoing/'''         le répertoire du courrier sortant
     23   * '''sent/'''             le répertoire du courrier envoyé
     24   * '''trash/'''          le répertoire du courrier marqué pour effacement
     25   * '''drafts/'''
     26   * '''spam/'''
     27
     28 * '''Rexx/'''             programmes ARexx pour YAM
     29
     30 * '''.config'''           le fichier de [[Configuration| configuration ]]
     31 * '''.folders'''          une liste des [[#FixFolders| dossiers ]]
     32 * '''.addressbook'''      le [[#FixAddressbook| carnet d'adresses ]]
     33 * '''.glossary'''         le [[#FixGlossary| glossaire ]]
     34 * '''.users'''            une liste des [[#FixUsers| utilisateurs YAM ]]
     35 * '''.spamdata'''         les données d'entraînement au spam de YAM
     36 * '''.updatestate'''      information pour le méchanisme automatique de mise à jour
     37 * '''.signature'''        votre signature personnelle
     38 * '''.altsignature1'''    première signature alternative
     39 * '''.altsignature2'''    seconde signature alternative
     40 * '''.taglines'''         votre collection de taglines
     41 * '''.autosave?.txt'''    copies de sauvegarde du contenu de l'éditeur
     42 * '''.uidl'''             utilisé pour [[#FixUidl| éviter les duplicata ]]
     43 * '''.emailcache'''       fichier cache utilisé pour la fonction de [[#FixEmailcache| cache courrier ]] feature
     44
     45 * '''YAM.log'''           [[#FixLog| fichier log ]] (si la [[Configuration#FixLogfiles| fonction log ]] a été activée)
     46
     47 
     48== Stockage des messages ==
     49
     50
     51Each message is saved as a separate file of which the filename is constructed
     52by encoding certain information about the mail (date, status, etc) using the Base64
     53standard encoding. The resulting name is compatible to any filesystem.
     54
     55Example: QvZgMAAFe4M=.001,RA
     56
     57   `QvZgMAAFe4M=`      Base64 encoded 5 bytes hash.
     58                                    This hash is based on the DATE info from the message.
     59
     60   `.` (dot)                       - Separator.
     61
     62   `001`                           Sequential value.  Incremented by 1 if the base filename, including this part, already exists.
     63
     64   `,` (comma)                - Separator.
     65
     66   `RA`                             Status of the message.  Possible letters after the comma:
     67                                    R - Read\\
     68                                    A - Answered\\
     69                                    M - Marked\\
     70                                    Y - \\
     71                                    J - \\
     72
     73
     74Every folder contains an '''.index''' file with the headers of every message
     75in the directory. There is also a configuration file called '''.fconfig''' which
     76holds the settings for that particular folder.
     77
     78[[=#FixTheme]]
     79== Gestion de thèmes ==
     80
     81YAM will use the icons and pictures in /Themes/default along its
     82Graphical User Interface.  There are several kinds of icons:
     83
     84
     85'''config/config_#?, config_#?_big'''
     86     These images are what you see when you open Settings to
     87     configure YAM.
     88
     89
     90'''folder/folder_#?, folder_#?_new'''
     91     These are the images used in front of the basic Incoming, Deleted,
     92     Outgoing and Sent folders.  Those with the "_new" suffix are used
     93     automatically whenever there is new or unread mail in the folder.
     94
     95     The "folder_fold" and "folder_unfold" images are special: they are
     96     used as the icon for folder groups.
     97
     98     A ".fimage" picture file in a folder overrides the default image.
     99     This is also the only method supported to have images displayed
     100     in front of custom folders.
     101
     102
     103'''icon/check.info, empty.info, new.info, old.info'''
     104     Icons which show the status of the "Incoming" mailbox:
     105
     106     check.info     YAM is checking for new mail\\
     107     empty.info     the mailbox is empty\\
     108     new.info       the mailbox has at least one new message\\
     109     old.info       the mailbox only holds "old" mail\\
     110
     111
     112'''status/status_#?'''
     113     These are the [[Window main#FixStatus| status icons ]] displayed by YAM to show the status
     114     of the messages.
     115
     116     The "status_mark" icon used when messages are set to "marked"
     117     is special: if it is not present, YAM will mark the messages by
     118     displaying the sender/recipient data in bold letters.
     119
     120
     121'''toolbar/tb_#?, tb_#?_G, tb_#?_S'''
     122     These are the images used to build the toolbars in the Main, Read,
     123     Write and Address book windows.  Those named "tb_#?_G" are the
     124     "ghosted" variety, i.e. they provide the images to be used when the
     125     icons must look ghosted.
     126     "tb_#?_S" are the "selected" variety, i.e. when you press a button.
     127
     128
     129'''.theme, logo, preview'''
     130     .theme contains various important text variables that are needed
     131     for the theme engine to work.
     132
     133     The "logo" is what you see when you start and quit YAM and also
     134     in the "about" window in YAM. (Note: only the default logo is
     135     displayed, no matter what theme you have selected.)
     136
     137     The "preview" is a small preview that shows what that icon theme
     138     looks like in Settings/Look & Feel.
     139
     140
     141== Formats de fichiers divers==
     142
     143[[=#FixAddressbook]]
     144=== Le fichier .addressbook ===
     145
     146This plain text file uses a hierarchical scheme following this general format:
     147
     148{{{
     149    YAB4 - YAM Addressbook                          - Identifier
     150    @GROUP alias  ·································
     151    description                                   ·
     152    @USER alias     -------------.                ·
     153    e-mail address               |                ·
     154    real name                    |                ·
     155    description                  |                ·
     156    phone #                      |                ·
     157    street address               |                ·
     158    ZIP/City                      > Person        ·
     159    country                      |                ·
     160    PGP ID                       |                ·
     161    birth date                   |                ·
     162    portrait                     |                 · GROUP
     163    homepage                     |                ·
     164    default security             |                ·
     165    @ENDUSER        -------------'                ·
     166    @LIST alias     >>>>>>>>>>>>>>>>>>>>>>>>>>                 ·
     167    return address               v                ·
     168    list name                    v                ·
     169    description                  v                ·
     170    member #1                     >> LIST          ·
     171    member #2                    ^                ·
     172    ...                          ^                ·
     173    member #n                    ^                ·
     174                                 ^                ·
     175    @ENDLIST        >>>>>>>>>>>>>>>>>>>>>>>>>>                 ·
     176    @ENDGROUP     ·································
     177}}}
     178
     179Groups, lists and people are started with @GROUP <alias>, @LIST <alias>
     180and @USER <alias> and closed with @ENDGROUP, @ENDLIST and @ENDUSER,
     181respectively.  Groups may include lists, and lists may include members.
     182Both lists and people may appear outside groups.  List members may be
     183either aliases, addresses or fully qualified "Real name <address>" pairs.
     184
     185GUI-wise, a group may be dragged&dropped onto a distribution list and
     186viceversa to get all its recipients added to the list.  Recursive loops
     187are watched and promptly avoided when appropriate - for instance, if a
     188group contanining a list is dragged&dropped on that list, only the items
     189available in the group other than the contents of the list itself are
     190added to it.
     191
     192[[=#FixEmailcache]]
     193=== Le fichier .emailcache ===
     194
     195This plain text file contains a list of the last n used recipients
     196who were not in the address book, in the format "Name <address>" (or
     197just "<address>" if the name is not available) with one entry per line.
     198
     199New entries get added at the top.  If the limit of entries set in the
     200configuration is exceeded, the oldest entry (i.e. the one at the bottom)
     201is dropped.
     202
     203If it is already in the cache when writing the mail, the entry is
     204moved to the top -- this way, the next time, the most recently used
     205recipient will be suggested first.  Entries in the address book will
     206still have priority over the cache, though.
     207
     208[[=#FixFconfig]]
     209=== Le fichier .fconfig ===
     210
     211This plain text file exists in every folder and stores the settings
     212used therein, using this format:
     213
     214
     215    YFC1 - YAM Folder Configuration\\
     216    Name        = folder_name\\
     217    MaxAge      = age\\
     218    Password    = password\\
     219    Type        = folder_type\\
     220    XPKType     = type_number\\
     221    Sort1       = primary_sort\\
     222    Sort2       = secondary_sort\\
     223    Stats       = Y|N\\
     224    MLSupport   = Y|N\\
     225    MLFromAddr  = MLFrom_address\\
     226    MLRepToAddr = MLRepTo_address\\
     227    MLPattern   = ML_pattern\\
     228    MLAddress   = ML_address\\
     229    MLSignature = signature_number\\
     230
     231
     232where
     233
     234   - '''Name''' is the name of the folder, as it appears in the folder list
     235
     236   - '''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#FixStartQuit| Configuration/Start/Quit ]])
     237
     238   - '''Password''' is the encoded counterpart of the password used to protect this folder, if any
     239
     240   - '''Type''' is a number indicating which type this folder is (should be usually 0 for user folders - see the documentation for the [[ARexx API/FOLDERINFO| FOLDERINFO ]] command)
     241
     242   - '''XPKType''' refers to the XPK mode used in the folder:
     243
     244        0 = none\\
     245        1 = simple protection (password)\\
     246        2 = compressed\\
     247        3 = compressed with password\\
     248
     249   - '''Sort1''' refers to the primary sort criterion used in the folder, in negative form if the sort is reversed:
     250
     251        1 = Message date\\
     252        2 = Date received\\
     253        3 = Sender\\
     254        4 = Recipient\\
     255        5 = Subject\\
     256        6 = Size\\
     257        7 = Status\\
     258
     259   - '''Sort2''' is just the same as Sort1, but referred to the secondary sort criterion
     260
     261   - '''Stats''' may be either Y or N depending on the status of the "AppIcon stats" flag
     262
     263   - '''MLSupport''' may be either Y or N depending on the status of the "Mailing list support" flag
     264
     265   - '''MLFromAddr''' shows the contents of the "From: address" field
     266
     267   - '''MLRepToAddr''' shows the contents of the "Reply-To: address" field
     268
     269   - '''MLPattern''' shows the contents of the "To: pattern" field
     270
     271   - '''MLAddress''' shows the contents of the "To: address" field
     272
     273   - '''MLSignature''' refers to the default signature to be used when posting messages to this mailing list:
     274
     275        0 = none\\
     276        1 = default signature, i.e. PROGDIR:.signature\\
     277        2 = alt. signature !#1\\
     278        3 = alt. signature !#2\\
     279
     280[[=#FixFolders]]
     281=== Le fichier .folders ===
     282
     283This plain text file uses a hierarchical scheme following this general format:
     284
     285{{{
     286    YFO1 - YAM Folders                              - Identifier
     287    @FOLDER name    ------------------.
     288    directory                          > Folder
     289    @ENDFOLDER      ------------------'
     290    @GROUP name              ································
     291    status                                                  ·
     292    @FOLDER name    ------------------.                     ·
     293    directory                          > Folder             ·
     294    @ENDFOLDER      ------------------'                     ·
     295    @GROUP name              ······················         ·
     296    status                                        ·         ·
     297    @FOLDER name    ------------------.           ·          · GROUP
     298    directory                          > Folder   ·         ·
     299    @ENDFOLDER      ------------------'            · GROUP  ·
     300    @FOLDER name    ------------------.           ·         ·
     301    directory                          > Folder   ·         ·
     302    @ENDFOLDER      ------------------'           ·         ·
     303    @ENDGROUP                ······················         ·
     304    @ENDGROUP                ································
     305}}}
     306
     307where <status> may be either 0 or 1, the latter meaning that the
     308group is unfolded, e.g. its contents are being displayed.  Folders
     309may live both inside and outside groups, and groups may be nested.
     310
     311The order of the folder tree is saved on disk whenever the
     312Folder/Order/Save menu item is called.
     313
     314[[=#FixGlossary]]
     315=== Le fichier .glossary ===
     316
     317This file contains a list of the definitions made in the glossary using this format:
     318
     319
     320    YDI1 - YAM Dictionary\\
     321    @ENTRY abbreviation\\
     322    contents\\
     323    @ENDENTRY\\
     324    @ENTRY abbreviation\\
     325    contents\\
     326    @ENDENTRY\\
     327    ...\\
     328
     329[[=#FixUidl]]
     330=== Le fichier .uidl ===
     331
     332If "Avoid duplicates" is enabled in [[Configuration#FixNewmail| Configuration/New mail ]], YAM
     333will use the UIDL POP3 command when connecting to your POP3 server to
     334request an '''U'''nique '''ID''' '''L'''isting of the messages in your mail account.
     335The POP3 server is responsible for assigning an unique ID to every
     336message and put it into a "X-UIDL:" header.
     337
     338If the server doesn't support the UIDL POP3 command, YAM will fall
     339back to the TOP command and try using the "Message-ID:" header instead;
     340if this also fails, an error will be generated.
     341
     342The Unique ID Listing received from the server is compared against
     343the contents of the "PROGDIR:.uidl" file; if this file doesn't exist
     344yet, it will be created.  This is a plain text file with one ID per
     345line using the format <ID>@<POP3 server>, e.g.
     346
     347
     348    9685@mail.saug.org\\
     349    9686@mail.saug.org\\
     350    9687@mail.saug.org\\
     351    9688@mail.saug.org\\
     352    (k5"!N1!"!RkI"!YT4"!@pop.wanadoo.es\\
     353    9689@mail.saug.org\\
     354    9690@mail.saug.org\\
     355    9691@mail.saug.org\\
     356    9692@mail.saug.org\\
     357
     358
     359Whenever an ID is already found in the "PROGDIR:.uidl" file, the
     360relevant message will be considered a duplicate, and thus it won't be
     361downloaded.  New IDs not yet in the "PROGDIR:.uidl" file will be added
     362to it as the corresponding messages are successfully downloaded.
     363
     364[[=#FixUsers]]
     365=== Le fichier .users ===
     366
     367This file contains a list of the users that can log in and use YAM.
     368YAM maintains this file by itself, so you shouldn't ever touch it,
     369unless maybe you are [[Tips & tricks#FixMoving| moving YAM ]] to another place in your hard disk.
     370
     371The file uses the following format:
     372
     373
     374        1st line:   YUS2 - YAM Users\\
     375        2nd line:   @USER <username>\\
     376        3rd line:   mail directory of this user, e.g.  Comm:YAM\\
     377        4th line:   number\\
     378        5th line:   encrypted password, if any\\
     379        6th line:   @ENDUSER\\
     380   further lines:   next user definition, upto 16 maximum.\\
     381
     382
     383where "number" is a value defining the status of this user combining
     384the following set of elements:
     385
     386
     387        No Supervisor privileges  = 4\\
     388        Share global address book = 2\\
     389        Share global glossary     = 1\\
     390
     391
     392Thus, "3" would mean the user has Supervisor privileges and is sharing
     393the global address book and glossary.  This is the default value in a
     394single user setup.
     395
     396[[=#FixLog]]
     397=== Le fichier log ===
     398
     399The log file used by YAM is an ASCII file storing one event per line.
     400Each line is saved in this format:
     401
     402   DD-MMM-YY HH:MM [code] Event description
     403
     404where '''code''' is a two digit number and "Event description" is obviously
     405the event description, possibly localized.  Therefore, any computer-assisted
     406software meant to analyze the log file data should refer to the code of the
     407event.
     408
     409Events out of the 30<->49 range will only be printed if "Log all events"
     410is enabled in the [[Configuration#FixLogfiles| Security options ]].
     411
     412   List of possible events:
     413
     414
     415 0 - YAM started\\
     416 1 - Logged in as user 'user_name'\\
     417 2 - Logged in as 'user_name', using configuration 'config_file' and mail directory 'folder_path'\\
     41810 - Wrote new message for 'recipient' about 'subject', including n attachment(s)\\
     41911 - Replied message from 'sender' about 'subject'\\
     42012 - Forwarded message from 'sender' about 'subject' to 'recipient'\\
     42113 - Bounced message from 'sender' about 'subject' to 'recipient'\\
     42214 - Edited message from 'sender' to 'recipient' about 'subject'\\
     42320 - Deleted n message(s) in folder 'folder'\\
     42421 - Deleted message from 'sender' about 'subject' in folder 'folder'\\
     42522 - Moved n message(s) from folder 'folder' to 'folder'\\
     42623 - Moved message from 'sender' about 'subject' from folder 'folder' to 'folder'\\
     42724 - Copied n message(s) from folder 'folder' to 'folder'\\
     42825 - Copied message from 'sender' about 'subject' from folder 'folder' to 'folder'\\
     42926 - Filtered n message(s) in folder 'folder': n match(es)\\
     43030 - Retrieved n message(s) from POP3 account 'user_id@host'\\
     43131 - Logged in on POP3 account 'user_id@host': n messages waiting\\
     43232 - Retrieved message from 'sender' about 'subject' (n bytes)\\
     43340 - Sent n message(s) using SMTP server 'host'\\
     43441 - Connected to SMTP server 'host'\\
     43542 - Sent message to 'recipient' about 'subject' (n bytes)\\
     43650 - Imported n message(s) from file 'filename' into folder 'folder'\\
     43751 - Exported n message(s) from folder 'folder' to file 'filename'\\
     43860 - Saved configuration file 'config_file'\\
     43962 - Saved user configuration\\
     44070 - Saved address book 'filename'\\
     44171 - Added address book entry 'alias'\\
     44280 - Saved attachment 'filename' of message 'mailfile' in folder 'folder'\\
     44381 - Cropped attachment(s) of message 'mailfile' in folder 'folder'\\
     44482 - Changed subject 'subject' of message 'mailfile' in folder 'folder' to 'subject'\\
     44599 - YAM terminated\\