lainwir3d/dolibarr
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Doxygen

Browse Source
This commit is contained in:
Laurent Destailleur 2022-04-03 12:24:03 +02:00
parent 45fca25408
commit 395758f213
1 changed files with 26 additions and 20 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

46
htdocs/emailcollector/lib/emailcollector.lib.php
View File

@ -87,9 +87,10 @@ function emailcollectorPrepareHead($object)
} }
/** /**
* Récupère les parties d'un message * Get parts of a message
* @param object $structure structure du message *
* @return object|boolean parties du message|false en cas d'erreur * @param object $structure Structure of message
* @return object|boolean Parties du message|false en cas d'erreur
*/ */
function getParts($structure) function getParts($structure)
{ {
@ -97,9 +98,10 @@ function getParts($structure)
} }
/** /**
* Tableau définissant la pièce jointe * Array with joined files
* @param object $part partie du message *
* @return object|boolean définition du message|false en cas d'erreur * @param object $part Part of message
* @return object|boolean Definition of message|false en cas d'erreur
*/ */
function getDParameters($part) function getDParameters($part)
{ {
@ -107,10 +109,11 @@ function getDParameters($part)
} }
/** /**
* Récupère les pièces d'un mail donné * Get attachments of a given mail
* @param integer $jk numéro du mail *
* @param object $mbox object connection imaap * @param integer $jk Number of email
* @return array type, filename, pos * @param object $mbox object connection imaap
* @return array type, filename, pos
*/ */
function getAttachments($jk, $mbox) function getAttachments($jk, $mbox)
{ {
@ -140,7 +143,8 @@ function getAttachments($jk, $mbox)
} }
/** /**
* Récupère la contenu de la pièce jointe par rapport a sa position dans un mail donné * Get content of a joined file from its position into a given email
*
* @param integer $jk numéro du mail * @param integer $jk numéro du mail
* @param integer $fpos position de la pièce jointe * @param integer $fpos position de la pièce jointe
* @param integer $type type de la pièce jointe * @param integer $type type de la pièce jointe
@ -156,11 +160,12 @@ function getFileData($jk, $fpos, $type, $mbox)
} }
/** /**
* Sauvegarde de la pièce jointe dans le dossier défini avec un nom unique * Save joined file into a directory with a given name
* @param string $path chemin de sauvegarde dui fichier *
* @param string $filename nom du fichier * @param string $path Path to file
* @param mixed $data contenu à sauvegarder * @param string $filename Name of file
* @return string emplacement du fichier * @param mixed $data contenu à sauvegarder
* @return string emplacement du fichier
**/ **/
function saveAttachment($path, $filename, $data) function saveAttachment($path, $filename, $data)
{ {
@ -186,10 +191,11 @@ function saveAttachment($path, $filename, $data)
} }
/** /**
* Décode le contenu du message * Decode content of a message
* @param string $message message *
* @param integer $coding type de contenu * @param string $message Message
* @return message décodé * @param integer $coding Type of content
* @return string Decoded message
**/ **/
function getDecodeValue($message, $coding) function getDecodeValue($message, $coding)
{ {