Wavyzz/dolibarr-fork
2
0
Fork 0
forked from Wavyzz/dolibarr
Code Pull Requests Activity

Doc: Documentation doxygen

Browse Source
This commit is contained in:
Laurent Destailleur
2004-12-28 18:34:56 +00:00
parent 9e918bb301
commit da9a898752
1 changed files with 39 additions and 49 deletions
Download Patch File Download Diff File Expand all files Collapse all files

50
htdocs/lib/CMailFile.class.php
View File

@@ -28,6 +28,9 @@ to chunk_split
/** \class CMailFile /** \class CMailFile
\brief Classe d'envoi de mails et pi<70>ces jointes. Encapsule mail() avec d'<27>ventuel attachements. \brief Classe d'envoi de mails et pi<70>ces jointes. Encapsule mail() avec d'<27>ventuel attachements.
\remarks Usage:
\remarks $mailfile = new CMailFile($subject,$sendto,$replyto,$message,$filename,$mimetype);
\remarks $mailfile->sendfile();
*/ */
class CMailFile class CMailFile
@@ -69,13 +72,13 @@ class CMailFile
} }
} }
/**
/**
\brief permet d'attacher un fichier \brief permet d'attacher un fichier
\param filename_list \param filename_list
\param mimetype_list \param mimetype_list
\param mimefilename_list \param mimefilename_list
*/ */
function attach_file($filename_list,$mimetype_list,$mimefilename_list) function attach_file($filename_list,$mimetype_list,$mimefilename_list)
{ {
for ($i = 0; $i < count($filename_list); $i++) { for ($i = 0; $i < count($filename_list); $i++) {
@@ -93,11 +96,11 @@ class CMailFile
// 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
*/ */
function encode_file($sourcefile) function encode_file($sourcefile)
{ {
// print "<pre> on encode $sourcefile </pre>\n"; // print "<pre> on encode $sourcefile </pre>\n";
@@ -111,10 +114,9 @@ class CMailFile
return $encoded; return $encoded;
} }
/** /**
\brief permet d'envoyer un fichier \brief permet d'envoyer un fichier
*/ */
function sendfile() function sendfile()
{ {
$headers .= $this->smtp_headers . $this->mime_headers; $headers .= $this->smtp_headers . $this->mime_headers;
@@ -122,12 +124,11 @@ class CMailFile
return mail($this->addr_to,$this->subject,stripslashes($message),$headers); return mail($this->addr_to,$this->subject,stripslashes($message),$headers);
} }
/** /**
\brief permet d'ecrire le body d'un message \brief permet d'ecrire le body d'un message
\param msgtext \param msgtext
\param filename_list \param filename_list
*/ */
function write_body($msgtext, $filename_list) function write_body($msgtext, $filename_list)
{ {
if (count($filename_list)) if (count($filename_list))
@@ -140,12 +141,11 @@ class CMailFile
return $out; return $out;
} }
/** /**
\brief cr<63>ation des headers mime \brief cr<63>ation des headers mime
\param filename_list \param filename_list
\param mimefilename_list \param mimefilename_list
*/ */
function write_mimeheaders($filename_list, $mimefilename_list) { function write_mimeheaders($filename_list, $mimefilename_list) {
$out = "MIME-version: 1.0\n"; $out = "MIME-version: 1.0\n";
$out = $out . "Content-type: multipart/mixed; "; $out = $out . "Content-type: multipart/mixed; ";
@@ -158,13 +158,9 @@ class CMailFile
return $out; return $out;
} }
/** /**
\brief cr<63>ation des headers smtp \brief cr<63>ation des headers smtp
\param addr_from */
\param addr_cc
\param addr_bcc
*/
function write_smtpheaders() function write_smtpheaders()
{ {
$out = "From: ".$this->addr_from."\n"; $out = "From: ".$this->addr_from."\n";
@@ -177,22 +173,16 @@ class CMailFile
$out = $out . "Return-path: $addr_from\n"; $out = $out . "Return-path: $addr_from\n";
return $out; return $out;
} }
} }
/** /**
\brief permet de diviser une chaine (RFC2045) \brief permet de diviser une chaine (RFC2045)
\param str \param str
\remarks function chunk_split qui remplace celle de php si n<>c<EFBFBD>ssaire \remarks function chunk_split qui remplace celle de php si n<>c<EFBFBD>ssaire
\remarks 76 caract<63>res par ligne, termin<69> par "\r\n" \remarks 76 caract<63>res par ligne, termin<69> par "\r\n"
*/ */
// usage - mimetype example "image/gif"
// $mailfile = new CMailFile($subject,$sendto,$replyto,$message,$filename,$mimetype);
// $mailfile->sendfile();
// Splits a string by RFC2045 semantics (76 chars per line, end with \r\n).
// This is not in all PHP versions so I define one here manuall.
function my_chunk_split($str) function my_chunk_split($str)
{ {
$stmp = $str; $stmp = $str;
@@ -212,5 +202,5 @@ function my_chunk_split($str)
return $out; return $out;
} }
// end script
?> ?>