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

Doc: Documentation doxygen

Browse Source
This commit is contained in:
Laurent Destailleur 2005-01-02 17:41:30 +00:00
parent 1870650bfb
commit d3b8edfb15
1 changed files with 20 additions and 24 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

44
htdocs/lib/dolibarrmail.class.php
View File

@ -25,26 +25,22 @@
*/ */
/*! \file htdocs/lib/CMailFile.class.php /**
\brief Classe permettant d'envoyer des mail avec attachements, recriture de CMailFile \file htdocs/lib/dolibarrmail.class.php
\author Dan Potter. \brief Classe permettant d'envoyer des mail avec attachements, recriture de CMailFile
\author Eric Seigne \author Dan Potter.
\author Rodolphe Quiedeville \author Eric Seigne
\author Laurent Destailleur. \author Rodolphe Quiedeville
\version $Revision$ \author Laurent Destailleur.
\version $Revision$
*/ */
/*! \class CMailFile /**
\brief Classe permettant d'envoyer des attachements par mail \class DolibarrMail
\remarks Eric Seigne <eric.seigne@ryxeo.com> 2004.01.08 \brief Classe permettant d'envoyer des attachements par mail
\remarks ajout de la gestion des cc: \todo Classe en double avec CMAilFile.class.php
\remarks ajout de l'expedition de plusieurs fichiers
\remarks Laurent Destailleur 2004.02.10
\remarks correction d'un disfonctionnement à la gestion des attachements multiples
*/ */
// simple class that encapsulates mail() with addition of mime file attachment.
class DolibarrMail class DolibarrMail
{ {
var $subject; var $subject;
@ -57,7 +53,7 @@ class DolibarrMail
var $boundary; var $boundary;
var $smtp_headers; var $smtp_headers;
/*! /**
\brief DolibarrMail \brief DolibarrMail
\param subject \param subject
\param to \param to
@ -93,7 +89,7 @@ class DolibarrMail
dolibarr_syslog("DolibarrMail::DolibarrMail from : ".$this->from); dolibarr_syslog("DolibarrMail::DolibarrMail from : ".$this->from);
} }
/*! /**
\brief PrepareFile \brief PrepareFile
\param filename_list \param filename_list
\param mimetype_list \param mimetype_list
@ -118,7 +114,7 @@ class DolibarrMail
} }
} }
/*! /**
\brief permet d'attacher un fichier \brief permet d'attacher un fichier
\param filename_list \param filename_list
\param mimetype_list \param mimetype_list
@ -155,7 +151,7 @@ class DolibarrMail
// added -- to notify email client attachment is done // added -- to notify email client attachment is done
} }
/*! /**
\brief permet d'encoder un fichier \brief permet d'encoder un fichier
\param sourcefile \param sourcefile
*/ */
@ -176,7 +172,7 @@ class DolibarrMail
return $encoded; return $encoded;
} }
/*! /**
\brief permet d'envoyer un fichier \brief permet d'envoyer un fichier
*/ */
@ -215,7 +211,7 @@ class DolibarrMail
fputs($fp, $message_comp); fputs($fp, $message_comp);
fclose($fp); fclose($fp);
} }
/*! /**
\brief permet d'ecrire le corps du message \brief permet d'ecrire le corps du message
\param msgtext \param msgtext
\param filename_list \param filename_list
@ -239,7 +235,7 @@ class DolibarrMail
return $out; return $out;
} }
/*! /**
\brief création des headers mime \brief création des headers mime
\param filename_list \param filename_list
\param mimefilename_list \param mimefilename_list
@ -264,7 +260,7 @@ class DolibarrMail
return $out; return $out;
} }
/*! /**
\brief création des headers smtp \brief création des headers smtp
\param addr_from \param addr_from
\param addr_cc \param addr_cc