2
0
forked from Wavyzz/dolibarr
Files
dolibarr-fork/doc/dev/php/html/classCMailFile.html
2004-07-16 06:41:58 +00:00

401 lines
17 KiB
HTML

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
<title>dolibarr: CMailFile class Reference</title>
<link href="doxygen.css" rel="stylesheet" type="text/css">
</head><body>
<!-- Généré par Doxygen 1.3.7 -->
<div class="qindex"><a class="qindex" href="index.html">Page&nbsp;principale</a> | <a class="qindex" href="classes.html">Liste&nbsp;alphabétique</a> | <a class="qindex" href="annotated.html">Liste&nbsp;des&nbsp;classes</a> | <a class="qindex" href="files.html">Liste&nbsp;des&nbsp;fichiers</a> | <a class="qindex" href="functions.html">Membres&nbsp;de&nbsp;classe</a> | <a class="qindex" href="globals.html">Membres&nbsp;de&nbsp;fichier</a></div>
<h1>Référence de la classe CMailFile</h1>Classe permettant d'envoyer des attachements par mail.
<a href="#_details">Plus de détails...</a>
<p>
<a href="classCMailFile-members.html">Liste de tous les membres</a><table border=0 cellpadding=0 cellspacing=0>
<tr><td></td></tr>
<tr><td colspan=2><br><h2>Fonctions membres publiques</h2></td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top>&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classCMailFile.html#a0">CMailFile</a> ($subject, $to, $from, $msg, $filename_list, $mimetype_list, $mimefilename_list, $addr_cc="")</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">CMailFile. <a href="#a0"></a><br><br></td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top>&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classCMailFile.html#a1">attach_file</a> ($filename_list, $mimetype_list, $mimefilename_list)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">permet d'attacher un fichier <a href="#a1"></a><br><br></td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top>&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classCMailFile.html#a2">encode_file</a> ($sourcefile)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">permet d'encoder un fichier <a href="#a2"></a><br><br></td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top><a class="anchor" name="a3" doxytag="CMailFile::sendfile" ></a>
&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classCMailFile.html#a3">sendfile</a> ()</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">permet d'envoyer un fichier <br><br></td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top>&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classCMailFile.html#a4">write_body</a> ($msgtext, $filename_list)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">permet d'ecrire le body d'un message <a href="#a4"></a><br><br></td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top>&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classCMailFile.html#a5">write_mimeheaders</a> ($filename_list, $mimefilename_list)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">création des headers mime <a href="#a5"></a><br><br></td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top>&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classCMailFile.html#a6">write_smtpheaders</a> ($addr_from, $addr_cc)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">création des headers smtp <a href="#a6"></a><br><br></td></tr>
</table>
<hr><a name="_details"></a><h2>Description détaillée</h2>
Classe permettant d'envoyer des attachements par mail.
<p>
<dl compact><dt><b>Remarques:</b></dt><dd>Eric Seigne &lt;<a href="mailto:eric.seigne@ryxeo.com">eric.seigne@ryxeo.com</a>&gt; 2004.01.08 <p>
ajout de la gestion des cc: <p>
ajout de l'expedition de plusieurs fichiers<p>
Laurent Destailleur 2004.02.10 <p>
correction d'un disfonctionnement à la gestion des attachements multiples </dd></dl>
<p>
<p>
Définition à la ligne <a class="el" href="CMailFile_8class_8php-source.html#l00040">40</a> du fichier <a class="el" href="CMailFile_8class_8php-source.html">CMailFile.class.php</a>.<hr><h2>Documentation des contructeurs et destructeur</h2>
<a class="anchor" name="a0" doxytag="CMailFile::CMailFile" ></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> CMailFile::CMailFile </td>
<td class="md" valign="top">(&nbsp;</td>
<td class="md" nowrap valign="top">$&nbsp;</td>
<td class="mdname" nowrap> <em>subject</em>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td></td>
<td class="md" nowrap>$&nbsp;</td>
<td class="mdname" nowrap> <em>to</em>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td></td>
<td class="md" nowrap>$&nbsp;</td>
<td class="mdname" nowrap> <em>from</em>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td></td>
<td class="md" nowrap>$&nbsp;</td>
<td class="mdname" nowrap> <em>msg</em>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td></td>
<td class="md" nowrap>$&nbsp;</td>
<td class="mdname" nowrap> <em>filename_list</em>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td></td>
<td class="md" nowrap>$&nbsp;</td>
<td class="mdname" nowrap> <em>mimetype_list</em>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td></td>
<td class="md" nowrap>$&nbsp;</td>
<td class="mdname" nowrap> <em>mimefilename_list</em>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td></td>
<td class="md" nowrap>$&nbsp;</td>
<td class="mdname" nowrap> <em>addr_cc</em> = <code>""</code></td>
</tr>
<tr>
<td></td>
<td class="md">)&nbsp;</td>
<td class="md" colspan="2"></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
CMailFile.
<p>
<dl compact><dt><b>Paramètres:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td></td><td valign=top><em>subject</em>&nbsp;</td><td></td></tr>
<tr><td></td><td valign=top><em>to</em>&nbsp;</td><td></td></tr>
<tr><td></td><td valign=top><em>from</em>&nbsp;</td><td></td></tr>
<tr><td></td><td valign=top><em>msg</em>&nbsp;</td><td></td></tr>
<tr><td></td><td valign=top><em>filename_list</em>&nbsp;</td><td></td></tr>
<tr><td></td><td valign=top><em>mimetype_list</em>&nbsp;</td><td></td></tr>
<tr><td></td><td valign=top><em>mimefilename_list</em>&nbsp;</td><td></td></tr>
<tr><td></td><td valign=top><em>addr_cc</em>&nbsp;</td><td></td></tr>
</table>
</dl>
<p>
Définition à la ligne <a class="el" href="CMailFile_8class_8php-source.html#l00064">64</a> du fichier <a class="el" href="CMailFile_8class_8php-source.html">CMailFile.class.php</a>.
<p>
Références <a class="el" href="CMailFile_8class_8php-source.html#l00083">attach_file()</a>, <a class="el" href="CMailFile_8class_8php-source.html#l00135">write_body()</a>, <a class="el" href="CMailFile_8class_8php-source.html#l00153">write_mimeheaders()</a>, et <a class="el" href="CMailFile_8class_8php-source.html#l00171">write_smtpheaders()</a>. </td>
</tr>
</table>
<hr><h2>Documentation des fonctions membres</h2>
<a class="anchor" name="a1" doxytag="CMailFile::attach_file" ></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> CMailFile::attach_file </td>
<td class="md" valign="top">(&nbsp;</td>
<td class="md" nowrap valign="top">$&nbsp;</td>
<td class="mdname" nowrap> <em>filename_list</em>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td></td>
<td class="md" nowrap>$&nbsp;</td>
<td class="mdname" nowrap> <em>mimetype_list</em>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td></td>
<td class="md" nowrap>$&nbsp;</td>
<td class="mdname" nowrap> <em>mimefilename_list</em></td>
</tr>
<tr>
<td></td>
<td class="md">)&nbsp;</td>
<td class="md" colspan="2"></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
permet d'attacher un fichier
<p>
<dl compact><dt><b>Paramètres:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td></td><td valign=top><em>filename_list</em>&nbsp;</td><td></td></tr>
<tr><td></td><td valign=top><em>mimetype_list</em>&nbsp;</td><td></td></tr>
<tr><td></td><td valign=top><em>mimefilename_list</em>&nbsp;</td><td></td></tr>
</table>
</dl>
<p>
Définition à la ligne <a class="el" href="CMailFile_8class_8php-source.html#l00083">83</a> du fichier <a class="el" href="CMailFile_8class_8php-source.html">CMailFile.class.php</a>.
<p>
Références <a class="el" href="CMailFile_8class_8php-source.html#l00083">attach_file()</a>, et <a class="el" href="CMailFile_8class_8php-source.html#l00105">encode_file()</a>.
<p>
Référencé par <a class="el" href="CMailFile_8class_8php-source.html#l00083">attach_file()</a>, et <a class="el" href="CMailFile_8class_8php-source.html#l00064">CMailFile()</a>. </td>
</tr>
</table>
<a class="anchor" name="a2" doxytag="CMailFile::encode_file" ></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> CMailFile::encode_file </td>
<td class="md" valign="top">(&nbsp;</td>
<td class="md" nowrap valign="top">$&nbsp;</td>
<td class="mdname1" valign="top" nowrap> <em>sourcefile</em> </td>
<td class="md" valign="top">&nbsp;)&nbsp;</td>
<td class="md" nowrap></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
permet d'encoder un fichier
<p>
<dl compact><dt><b>Paramètres:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td></td><td valign=top><em>sourcefile</em>&nbsp;</td><td></td></tr>
</table>
</dl>
<p>
Définition à la ligne <a class="el" href="CMailFile_8class_8php-source.html#l00105">105</a> du fichier <a class="el" href="CMailFile_8class_8php-source.html">CMailFile.class.php</a>.
<p>
Références <a class="el" href="CMailFile_8class_8php-source.html#l00105">encode_file()</a>, et <a class="el" href="CMailFile_8class_8php-source.html#l00197">my_chunk_split()</a>.
<p>
Référencé par <a class="el" href="CMailFile_8class_8php-source.html#l00083">attach_file()</a>, et <a class="el" href="CMailFile_8class_8php-source.html#l00105">encode_file()</a>. </td>
</tr>
</table>
<a class="anchor" name="a4" doxytag="CMailFile::write_body" ></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> CMailFile::write_body </td>
<td class="md" valign="top">(&nbsp;</td>
<td class="md" nowrap valign="top">$&nbsp;</td>
<td class="mdname" nowrap> <em>msgtext</em>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td></td>
<td class="md" nowrap>$&nbsp;</td>
<td class="mdname" nowrap> <em>filename_list</em></td>
</tr>
<tr>
<td></td>
<td class="md">)&nbsp;</td>
<td class="md" colspan="2"></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
permet d'ecrire le body d'un message
<p>
<dl compact><dt><b>Paramètres:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td></td><td valign=top><em>msgtext</em>&nbsp;</td><td></td></tr>
<tr><td></td><td valign=top><em>filename_list</em>&nbsp;</td><td></td></tr>
</table>
</dl>
<p>
Définition à la ligne <a class="el" href="CMailFile_8class_8php-source.html#l00135">135</a> du fichier <a class="el" href="CMailFile_8class_8php-source.html">CMailFile.class.php</a>.
<p>
Références <a class="el" href="CMailFile_8class_8php-source.html#l00135">write_body()</a>.
<p>
Référencé par <a class="el" href="CMailFile_8class_8php-source.html#l00064">CMailFile()</a>, et <a class="el" href="CMailFile_8class_8php-source.html#l00135">write_body()</a>. </td>
</tr>
</table>
<a class="anchor" name="a5" doxytag="CMailFile::write_mimeheaders" ></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> CMailFile::write_mimeheaders </td>
<td class="md" valign="top">(&nbsp;</td>
<td class="md" nowrap valign="top">$&nbsp;</td>
<td class="mdname" nowrap> <em>filename_list</em>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td></td>
<td class="md" nowrap>$&nbsp;</td>
<td class="mdname" nowrap> <em>mimefilename_list</em></td>
</tr>
<tr>
<td></td>
<td class="md">)&nbsp;</td>
<td class="md" colspan="2"></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
création des headers mime
<p>
<dl compact><dt><b>Paramètres:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td></td><td valign=top><em>filename_list</em>&nbsp;</td><td></td></tr>
<tr><td></td><td valign=top><em>mimefilename_list</em>&nbsp;</td><td></td></tr>
</table>
</dl>
<p>
Définition à la ligne <a class="el" href="CMailFile_8class_8php-source.html#l00153">153</a> du fichier <a class="el" href="CMailFile_8class_8php-source.html">CMailFile.class.php</a>.
<p>
Références <a class="el" href="CMailFile_8class_8php-source.html#l00153">write_mimeheaders()</a>.
<p>
Référencé par <a class="el" href="CMailFile_8class_8php-source.html#l00064">CMailFile()</a>, et <a class="el" href="CMailFile_8class_8php-source.html#l00153">write_mimeheaders()</a>. </td>
</tr>
</table>
<a class="anchor" name="a6" doxytag="CMailFile::write_smtpheaders" ></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> CMailFile::write_smtpheaders </td>
<td class="md" valign="top">(&nbsp;</td>
<td class="md" nowrap valign="top">$&nbsp;</td>
<td class="mdname" nowrap> <em>addr_from</em>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td></td>
<td class="md" nowrap>$&nbsp;</td>
<td class="mdname" nowrap> <em>addr_cc</em></td>
</tr>
<tr>
<td></td>
<td class="md">)&nbsp;</td>
<td class="md" colspan="2"></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
création des headers smtp
<p>
<dl compact><dt><b>Paramètres:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td></td><td valign=top><em>addr_from</em>&nbsp;</td><td></td></tr>
<tr><td></td><td valign=top><em>addr_cc</em>&nbsp;</td><td></td></tr>
</table>
</dl>
<p>
Définition à la ligne <a class="el" href="CMailFile_8class_8php-source.html#l00171">171</a> du fichier <a class="el" href="CMailFile_8class_8php-source.html">CMailFile.class.php</a>.
<p>
Références <a class="el" href="CMailFile_8class_8php-source.html#l00171">write_smtpheaders()</a>.
<p>
Référencé par <a class="el" href="CMailFile_8class_8php-source.html#l00064">CMailFile()</a>, et <a class="el" href="CMailFile_8class_8php-source.html#l00171">write_smtpheaders()</a>. </td>
</tr>
</table>
<hr>La documentation de cette classe a été générée à partir du fichier suivant:<ul>
<li>htdocs/lib/<a class="el" href="CMailFile_8class_8php-source.html">CMailFile.class.php</a></ul>
<hr size="1"><address style="align: right;"><small>Généré le Fri Jul 16 08:51:52 2004 pour dolibarr par
<a href="http://www.doxygen.org/index.html">
<img src="doxygen.png" alt="doxygen" align="middle" border=0 ></a> 1.3.7 </small></address>
</body>
</html>