Document _mask message field

docs/source/Explanation/SarraPluginDev.rst

@@ -894,6 +894,20 @@ reaches the number given by the  **batch**  option (default 100).
 All download (upload) operations use a buffer. The size, in bytes,
 of the buffer used is given by the **bufsize** option (default 8192).
 
+Accessing accept/reject "masks"
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+When a message is accepted or rejected, the "mask" that was used to accept/reject it will be stored in the value of the message's ``_mask`` key. The ``_mask`` is a tuple that contains the regex from the accept/reject statement, the corresponding ``directory`` path, the value of the ``mirror`` and ``filename`` options. The last item in the tuple is a list containing any additional text, split by whitespace, that was included at the end of the accept/reject line in the config file. This additional text can be used to pass additional information to plugins.
+
+For example, with an accept statement in a config file like this::
+    
+    accept .*abc.*  your_text=here from_accept_abc
+
+The last item in ``msg['_mask']`` would be:
+
+.. code-block:: python
+
+    msg['_mask'][-1] # == [ 'your_text=here', 'from_accept_abc' ]
 
 Why v3 API should be used whenever possible
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

docs/source/fr/Explication/SarraPluginDev.rst

@@ -773,6 +773,21 @@ atteint le nombre donné par l’option **batch** (100 par défaut).
 Toutes les opérations de téléchargement (upload) utilisent un buffer. La taille, en octets,
 du buffer utilisé est donné par l’option **bufsize** (8192 par défaut).
 
+Accéder aux « masques » d'accept/reject
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+Lorsqu'un message est accepté ou rejeté, le « masque » qui a été utilisé pour l'accept/reject sera stocké dans la valeur de la clé ``_mask`` du message. Le ``_mask`` est un tuple qui contient l'expression régulière de l'instruction d'accept/reject, le chemin du ``directory`` correspondant, la valeur des options ``mirror`` et ``filename`` . Le dernier élément de le tuple est une liste contenant tout texte supplémentaire, divisé par espaces, inclus à la fin de la ligne d'accept/reject dans le fichier de configuration. Ce texte supplémentaire peut être utilisé pour transmettre des informations supplémentaires aux plugins.
+
+Par exemple, avec une instruction accept dans un fichier de configuration comme ceci :
+
+    accept .*abc.* votre_texte=ici from_accept_abc
+
+Le dernier élément de ``msg['_mask']`` serait :
+
+.. code-block:: python
+
+    msg['_mask'][-1] # == [ 'votre_text=ici', 'from_accept_abc' ]
+
 Pourquoi l’API v3 doit être utilisée dans la mesure du possible
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~