Zend_Mail_Read.xml 31 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813
  1. <?xml version="1.0" encoding="utf-8"?>
  2. <!-- EN-Revision: 13593 -->
  3. <!-- Reviewed: no -->
  4. <sect1 id="zend.mail.read">
  5. <title>Lire des émail</title>
  6. <para><classname>Zend_Mail</classname> peut lire des émail provenant de différents stockages locaux ou distants. Tous
  7. bénéficient de la même API pour compter et extraire les messages, certains implémentent des interfaces
  8. additionnelles pour des fonctionnalités moins communes. Pour une vue d'ensemble des fonctionnalités des stockages
  9. implémentés voir la table suivante.</para>
  10. <table id="zend.mail.read.table-1">
  11. <title>Vue d'ensemble des fonctionnalités de lecture d'émail</title>
  12. <tgroup cols="5">
  13. <thead>
  14. <row>
  15. <entry>Fonctionnalité</entry>
  16. <entry>Mbox</entry>
  17. <entry>Maildir</entry>
  18. <entry>Pop3</entry>
  19. <entry>IMAP</entry>
  20. </row>
  21. </thead>
  22. <tbody>
  23. <row>
  24. <entry>Type de stockage</entry>
  25. <entry>local</entry>
  26. <entry>local</entry>
  27. <entry>distant</entry>
  28. <entry>distant</entry>
  29. </row>
  30. <row>
  31. <entry>Extraction des messages</entry>
  32. <entry>Oui</entry>
  33. <entry>Oui</entry>
  34. <entry>Oui</entry>
  35. <entry>Oui</entry>
  36. </row>
  37. <row>
  38. <entry>Extraction des parties mimes</entry>
  39. <entry>émulé</entry>
  40. <entry>émulé</entry>
  41. <entry>émulé</entry>
  42. <entry>émulé</entry>
  43. </row>
  44. <row>
  45. <entry>Dossiers</entry>
  46. <entry>Oui</entry>
  47. <entry>Oui</entry>
  48. <entry>Non</entry>
  49. <entry>Oui</entry>
  50. </row>
  51. <row>
  52. <entry>Créer des messages/dossiers</entry>
  53. <entry>Non</entry>
  54. <entry>A faire</entry>
  55. <entry>Non</entry>
  56. <entry>A faire</entry>
  57. </row>
  58. <row>
  59. <entry>Flags</entry>
  60. <entry>Non</entry>
  61. <entry>Oui</entry>
  62. <entry>Non</entry>
  63. <entry>Oui</entry>
  64. </row>
  65. <row>
  66. <entry>Quota</entry>
  67. <entry>Non</entry>
  68. <entry>Oui</entry>
  69. <entry>Non</entry>
  70. <entry>Non</entry>
  71. </row>
  72. </tbody>
  73. </tgroup>
  74. </table>
  75. <sect2 id="zend.mail.read-example">
  76. <title>Exemple simple avec Pop3</title>
  77. <programlisting role="php"><![CDATA[
  78. $mail = new Zend_Mail_Storage_Pop3(array('host' => 'localhost',
  79. 'user' => 'test',
  80. 'password' => 'test'));
  81. echo $mail->countMessages() . " messages trouvés\n";
  82. foreach ($mail as $message) {
  83. echo "Mail from '{$message->from}': {$message->subject}\n";
  84. }
  85. ]]></programlisting>
  86. </sect2>
  87. <sect2 id="zend.mail.read-open-local">
  88. <title>Ouvrir un stockage local</title>
  89. <para>Mbox et Maildir sont les deux formats supportés pour le stockage local des émail, tous les deux dans leurs
  90. formats le plus simple.</para>
  91. <para>Si vous voulez lire un fichier Mbox, vous devez juste donner le nom du fichier au constructeur de
  92. <classname>Zend_Mail_Storage_Mbox</classname>:</para>
  93. <programlisting role="php"><![CDATA[
  94. $mail =
  95. new Zend_Mail_Storage_Mbox(array('filename' => '/home/test/mail/inbox'));
  96. ]]></programlisting>
  97. <para>Maildir est très similaire mais nécessite un nom de dossier :</para>
  98. <programlisting role="php"><![CDATA[
  99. $mail =
  100. new Zend_Mail_Storage_Maildir(array('dirname' => '/home/test/mail/'));
  101. ]]></programlisting>
  102. <para>Ces deux constructeurs lèvent une exception <classname>Zend_Mail_Exception</classname> si le stockage ne peut pas
  103. être lu.</para>
  104. </sect2>
  105. <sect2 id="zend.mail.read-open-remote">
  106. <title>Ouvrir un stockage distant</title>
  107. <para>Pour les stockages distants les deux protocoles les plus populaires sont supportés : Pop3 et Imap. Les
  108. deux nécessitent au moins un hôte et un utilisateur pour se connecter et s'identifier. Le mot de passe par
  109. défaut est une chaîne vide et le port par défaut celui donné dans la RFC du protocole.</para>
  110. <programlisting role="php"><![CDATA[
  111. // connexion à Pop3
  112. $mail = new Zend_Mail_Storage_Pop3(array('host' => 'exemple.com'
  113. 'user' => 'test',
  114. 'password' => 'test'));
  115. // connexion à Imap
  116. $mail = new Zend_Mail_Storage_Imap(array('host' => 'exemple.com'
  117. 'user' => 'test',
  118. 'password' => 'test'));
  119. // exemple à un port non standard
  120. $mail = new Zend_Mail_Storage_Pop3(array('host' => 'exemple.com',
  121. 'port' => 1120
  122. 'user' => 'test',
  123. 'password' => 'test'));
  124. ]]></programlisting>
  125. <para>Pour ces deux stockages SSL et TLS sont supportés. Si vous utilisez SSL le port par défaut change comme
  126. indiqué dans la RFC.</para>
  127. <programlisting role="php"><![CDATA[
  128. // exemples pour Zend_Mail_Storage_Pop3,
  129. // identique à Zend_Mail_Storage_Imap
  130. // utiliser SSL avec un port différent
  131. // (par défaut 995 pour Pop3 et 993 pour Imap)
  132. $mail = new Zend_Mail_Storage_Pop3(array('host' => 'exemple.com'
  133. 'user' => 'test',
  134. 'password' => 'test',
  135. 'ssl' => 'SSL'));
  136. // utiliser TLS
  137. $mail = new Zend_Mail_Storage_Pop3(array('host' => 'exemple.com'
  138. 'user' => 'test',
  139. 'password' => 'test',
  140. 'ssl' => 'TLS'));
  141. ]]></programlisting>
  142. <para>Les deux constructeurs peuvent lever une exception <classname>Zend_Mail_Exception</classname> ou
  143. <classname>Zend_Mail_Protocol_Exception</classname>(étendant <classname>Zend_Mail_Exception</classname>), en fonction du type de
  144. l'erreur.</para>
  145. </sect2>
  146. <sect2 id="zend.mail.read-fetching">
  147. <title>Extraire des messages et autres méthodes simples</title>
  148. <para>Dès que vous avez ouvert l'accès, les messages peuvent être extraits. Vous devez fournir un numéro de
  149. message, qui est un compteur qui démarre à 1 pour le premier message. Pour extraire le message vous utilisez la
  150. méthode <code>getMessage()</code> :</para>
  151. <programlisting role="php"><![CDATA[
  152. $message = $mail->getMessage($numeroDeMessage);
  153. ]]></programlisting>
  154. <para>L'accès sous forme de tableau est aussi supporté, mais cet méthode d'accès ne supporte pas les paramètres additionnels qui
  155. aurait pu être ajouté à <code>getMessage()</code>. Tant que vous n'en n'avez pas besoin et que vous pouvez vivre
  156. avec les valeurs par défaut, vous pouvez utiliser :</para>
  157. <programlisting role="php"><![CDATA[
  158. $message = $mail[$numeroDeMessage];
  159. ]]></programlisting>
  160. <para>Pour itérer tous les messages, l'interface <code>Iterator</code> est implémentée :</para>
  161. <programlisting role="php"><![CDATA[
  162. foreach ($mail as $numeroDeMessage => $message) {
  163. // faire qqch ...
  164. }
  165. ]]></programlisting>
  166. <para>Pour compter les messages dans le stockage, vous pouvez soit utiliser la méthode
  167. <code>countMessages()</code> ou utiliser l'accès de type tableau :</para>
  168. <programlisting role="php"><![CDATA[
  169. // par méthode
  170. $maxMessage = $mail->countMessages();
  171. // type tableau
  172. $maxMessage = count($mail);
  173. ]]></programlisting>
  174. <para>Pour supprimer un mail vous pouvez utiliser la méthode <code>removeMessage()</code> ou l'accès de type
  175. tableau :</para>
  176. <programlisting role="php"><![CDATA[
  177. // méthode
  178. $mail->removeMessage($numeroDeMessage);
  179. // type tableau
  180. unset($mail[$messageNum]);
  181. ]]></programlisting>
  182. </sect2>
  183. <sect2 id="zend.mail.read-message">
  184. <title>Travailler avec les messages</title>
  185. <para>Après avoir extrait les messages avec <code>getMessage()</code> vous voulez extraire les en-têtes, le
  186. contenu ou une partie d'un message multipart. Tous les en-têtes peuvent être accédés via les propriétés ou la
  187. méthode <code>getHeader()</code> si vous voulez plus de contrôle ou avoir accès à des en-têtes peu communs. Les
  188. noms des en-têtes gérés en interne avec une casse minuscule, ainsi la casse du nom de l'en-tête importe peu. En
  189. outre les en-têtes avec un tiret-bas peuvent être écrit avec la <ulink
  190. url="http://en.wikipedia.org/wiki/CamelCase">notation Camel</ulink>. Si aucun en-tête n'est trouvé pour les deux
  191. notations, une exception est levée. Pour éviter ceci, la méthode <code>headerExists()</code> peut être utilisée
  192. pour vérifier l'existence d'un en-tête.</para>
  193. <programlisting role="php"><![CDATA[
  194. // récupérer l'objet message
  195. $message = $mail->getMessage(1);
  196. // afficher le sujet du message
  197. echo $message->subject . "\n";
  198. // récupérer l'en-tête content-type
  199. $type = $message->contentType;
  200. // vérifier si CC est spécifié :
  201. if( isset($message->cc) ) { // ou $message->headerExists('cc');
  202. $cc = $message->cc;
  203. }
  204. ]]></programlisting>
  205. <para>Si vous avez plusieurs en-têtes avec le même nom, par exemple les en-têtes "Received", vous pourriez les
  206. vouloir sous la forme d'un tableau plutôt qu'en tant que chaîne. Ceci est possible avec la méthode
  207. <code>getHeader()</code>.</para>
  208. <programlisting role="php"><![CDATA[
  209. // récupérer l'en-tête comme une propriété - le résultat est toujours
  210. // une chaîne, avec de nouvelles lignes entre chaque occurence
  211. // dans le message
  212. $received = $message->received;
  213. // la même chose avec la méthode getHeader()
  214. $received = $message->getHeader('received', 'string');
  215. // ou mieux un tableau avec une entrée pour chaque occurence
  216. $received = $message->getHeader('received', 'array');
  217. foreach ($received as $line) {
  218. // faire qqch
  219. }
  220. // si vous ne définissez pas de format vous récupérerez la représentation
  221. // interne (chaîne pour en-têtes uniques, tableau pour en-têtes multiples
  222. $received = $message->getHeader('received');
  223. if (is_string($received)) {
  224. // seulement un en-tête received trouvé dans le message
  225. }
  226. ]]></programlisting>
  227. <para>La méthode <code>getHeaders()</code> retourne tous les headers sous forme de tableau avec des clés en
  228. minuscules et des valeurs en tant que tableau pour des en-têtes multiples ou une chaîne pour des en-têtes
  229. uniques.</para>
  230. <programlisting role="php"><![CDATA[
  231. // récupère tous les en-têtes
  232. foreach ($message->getHeaders() as $name => $value) {
  233. if (is_string($value)) {
  234. echo "$name: $value\n";
  235. continue;
  236. }
  237. foreach ($value as $entry) {
  238. echo "$name: $entry\n";
  239. }
  240. }
  241. ]]></programlisting>
  242. <para>Si vous n'avez pas de message de type multipart, extraire le contenu est facilité avec
  243. <code>getContent()</code>. A la différence des en-têtes, le contenu est seulement extrait en cas de besoin (alias
  244. late-fetch).</para>
  245. <programlisting role="php"><![CDATA[
  246. // affiche le contenu du message
  247. echo '<pre>';
  248. echo $message->getContent();
  249. echo '</pre>';
  250. ]]></programlisting>
  251. <para>Vérifier si un message est de type multipart est réalisé avec la méthode <code>isMultipart()</code>. Si
  252. vous avez un message de type multipart vous pouvez récupérer une instance de <classname>Zend_Mail_Part</classname> avec la
  253. méthode <code>getPart()</code>. <classname>Zend_Mail_Part</classname> est la classe de base de
  254. <classname>Zend_Mail_Message</classname>, donc vous avez les mêmes méthodes : <code>getHeader()</code>,
  255. <code>getHeaders()</code>, <code>getContent()</code>, <code>getPart()</code>, <code>isMultipart</code> et les
  256. propriétés pour les en-têtes.</para>
  257. <programlisting role="php"><![CDATA[
  258. // récupérer la première partie non-multipart
  259. $part = $message;
  260. while ($part->isMultipart()) {
  261. $part = $message->getPart(1);
  262. }
  263. echo 'Le type de cette partie est '
  264. . strtok($part->contentType, ';')
  265. . "\n";
  266. echo "Contenu :\n";
  267. echo $part->getContent();
  268. ]]></programlisting>
  269. <para><classname>Zend_Mail_Part</classname> implémente aussi <code>RecursiveIterator</code>, qui rend facile le scan de
  270. toutes les parties. Et pour un affichage facile, il implémente de plus la méthode magique
  271. <code>__toString()</code> qui retourne le contenu.</para>
  272. <programlisting role="php"><![CDATA[
  273. // affiche la première partie de type text/plain=
  274. $foundPart = null;
  275. foreach (new RecursiveIteratorIterator($mail->getMessage(1)) as $part) {
  276. try {
  277. if (strtok($part->contentType, ';') == 'text/plain') {
  278. $foundPart = $part;
  279. break;
  280. }
  281. } catch (Zend_Mail_Exception $e) {
  282. // ignore
  283. }
  284. }
  285. if (!$foundPart) {
  286. echo 'Aucune partie "plain text" trouvés';
  287. } else {
  288. echo "Partie \"plain text\" : \n" . $foundPart;
  289. }
  290. ]]></programlisting>
  291. </sect2>
  292. <sect2 id="zend.mail.read-flags">
  293. <title>Vérifier les drapeaux ("flags")</title>
  294. <para>Maildir et IMAP supporte l'enregistrement de drapeaux. La classe <classname>Zend_Mail_Storage</classname> possède
  295. des constantes pour tous les drapeaux maildir et IMAP connus, nommés
  296. <classname>Zend_Mail_Storage::FLAG_&lt;nomdudrapeau&gt;</classname>. Pour vérifier les drapeaux
  297. <classname>Zend_Mail_Message</classname> possède une méthode <code>hasFlag()</code>. Avec <code>getFlags()</code> vous
  298. récupérez tous les drapeaux existants.</para>
  299. <programlisting role="php"><![CDATA[
  300. // trouvé les messages non lus
  301. echo "Emails non lus :\n";
  302. foreach ($mail as $message) {
  303. if ($message->hasFlag(Zend_Mail_Storage::FLAG_SEEN)) {
  304. continue;
  305. }
  306. // marque les emails récents/nouveaux
  307. if ($message->hasFlag(Zend_Mail_Storage::FLAG_RECENT)) {
  308. echo '! ';
  309. } else {
  310. echo ' ';
  311. }
  312. echo $message->subject . "\n";
  313. }
  314. // vérifie les drapeaux connus
  315. $flags = $message->getFlags();
  316. echo "Le message est marqué comme : ";
  317. foreach ($flags as $flag) {
  318. switch ($flag) {
  319. case Zend_Mail_Storage::FLAG_ANSWERED:
  320. echo 'Réponse ';
  321. break;
  322. case Zend_Mail_Storage::FLAG_FLAGGED:
  323. echo 'Marqués ';
  324. break;
  325. // ...
  326. // vérifie d'autres drapeaux
  327. // ...
  328. default:
  329. echo $flag . '(drapeau inconnu) ';
  330. }
  331. }
  332. ]]></programlisting>
  333. <para>Comme IMAP autorise les drapeaux définis par client ou l'utilisateur, vous pouvez obtenir ces drapeaux
  334. même s'ils n'ont pas de constante dans <classname>Zend_Mail_Storage</classname>. Au lieu de cela ils sont retournés comme
  335. une chaîne et peuvent être vérifiés de la même manière avec <code>hasFlag()</code>.</para>
  336. <programlisting role="php"><![CDATA[
  337. // Vérifie le message avec les drapeaux $EstUnSpam, $SpamTeste
  338. if (!$message->hasFlag('$SpamTeste')) {
  339. echo 'ce message n\'est pas considéré comme un spam';
  340. } else if ($message->hasFlag('$EstUnSpam')) {
  341. echo 'ce message est un spam';
  342. } else {
  343. echo 'ce message est sûr';
  344. }
  345. ]]></programlisting>
  346. </sect2>
  347. <sect2 id="zend.mail.read-folders">
  348. <title>Utiliser les dossiers</title>
  349. <para>Tous les stockages, excepté Pop3, supportent les dossiers, également appelés boîtes aux lettres.
  350. L'interface implémentée par tous les stockages supportant les dossiers s'appelle
  351. <classname>Zend_Mail_Storage_Folder_Interface</classname>. En outre toutes ces classes ont un paramètre facultatif
  352. additionnel appelé <code>folder</code>, qui est le dossier choisi après ouverture, dans le constructeur.</para>
  353. <para>Pour les stockages locaux vous devez employer les classes séparées appelées
  354. <classname>Zend_Mail_Storage_Folder_Mbox</classname> ou <classname>Zend_Mail_Storage_Folder_Maildir</classname>. Tous les deux ont
  355. besoin d'un paramètre nommé <code>dirname</code> avec le nom du dossier de base. Le format pour le maildir est
  356. comme définie dans maildir++ (avec un point comme délimiteur par défaut), Mbox est une hiérarchie de dossiers
  357. avec des fichiers Mbox. Si vous n'avez pas un dossier de Mbox appelé INBOX dans votre dossier de base Mbox vous
  358. devez placer un autre dossier dans le constructeur.</para>
  359. <para><classname>Zend_Mail_Storage_Imap</classname> supporte déjà des dossiers par défaut. Exemples pour ouvrir ces
  360. stockages :</para>
  361. <programlisting role="php"><![CDATA[
  362. // mbox avec dossiers
  363. $mail = new Zend_Mail_Storage_Folder_Mbox(
  364. array('dirname' => '/home/test/mail/')
  365. );
  366. // mbox avec un dossier par défaut nommé INBOX, fontionne aussi
  367. // avec Zend_Mail_Storage_Folder_Maildir et Zend_Mail_Storage_Imap
  368. $mail = new Zend_Mail_Storage_Folder_Mbox(
  369. array('dirname' => '/home/test/mail/', 'folder' => 'Archive')
  370. );
  371. // maildir avec dossiers
  372. $mail = new Zend_Mail_Storage_Folder_Maildir(
  373. array('dirname' => '/home/test/mail/')
  374. );
  375. // maildir avec deux-points comme délimiteur,
  376. // comme suggéré dans Maildir++
  377. $mail = new Zend_Mail_Storage_Folder_Maildir(
  378. array('dirname' => '/home/test/mail/', 'delim' => ':')
  379. );
  380. // imap est le même avec ou sans dossier
  381. $mail = new Zend_Mail_Storage_Imap(array('host' => 'example.com',
  382. 'user' => 'test',
  383. 'password' => 'test'));
  384. ]]></programlisting>
  385. <para>Avec la méthode <code>getFolders($root = null)</code> vous pouvez obtenir la hiérarchie des dossiers en
  386. commençant par le dossier racine ou le dossier fourni. Elle est retournée comme instance de
  387. <classname>Zend_Mail_Storage_Folder</classname>, qui implémente <code>RecursiveIterator</code> et tous ses enfants sont
  388. également des instances de <classname>Zend_Mail_Storage_Folder</classname>. Chacune de ces instances à des noms locaux et
  389. globaux retournés par les méthodes <code>getLocalName()</code> et <code>getGlobalName()</code>. Le nom global
  390. est le nom absolu du dossier racine (délimiteurs y compris), le nom local est le nom dans le dossier
  391. parent.</para>
  392. <table id="zend.mail.read-folders.table-1">
  393. <title>Noms de dossiers</title>
  394. <tgroup cols="2">
  395. <thead>
  396. <row>
  397. <entry>Nom global</entry>
  398. <entry>Nom local</entry>
  399. </row>
  400. </thead>
  401. <tbody>
  402. <row>
  403. <entry>/INBOX</entry>
  404. <entry>INBOX</entry>
  405. </row>
  406. <row>
  407. <entry>/Archive/2005</entry>
  408. <entry>2005</entry>
  409. </row>
  410. <row>
  411. <entry>List.ZF.General</entry>
  412. <entry>General</entry>
  413. </row>
  414. </tbody>
  415. </tgroup>
  416. </table>
  417. <para>Si vous employez l'itérateur, la clé de l'élément courant est le nom local. Le nom global est également
  418. retourné par la méthode magique <code>__toString()</code>. Quelques dossiers peuvent ne pas être
  419. sélectionnables, ce qui veut dire qu'ils ne peuvent pas stocker des messages et les choisir entraînerait une
  420. erreur. Ceci peut être vérifié avec la méthode <code>isSelectable()</code>. Ainsi il est très facile de produire
  421. l'arbre entier dans une vue :</para>
  422. <programlisting role="php"><![CDATA[
  423. $folders = new RecursiveIteratorIterator(
  424. $this->mail->getFolders(),
  425. RecursiveIteratorIterator::SELF_FIRST
  426. );
  427. echo '<select name="folder">';
  428. foreach ($folders as $localName => $folder) {
  429. $localName = str_pad('', $folders->getDepth(), '-', STR_PAD_LEFT)
  430. . $localName;
  431. echo '<option';
  432. if (!$folder->isSelectable()) {
  433. echo ' disabled="disabled"';
  434. }
  435. echo ' value="' . htmlspecialchars($folder) . '">'
  436. . htmlspecialchars($localName) . '</option>';
  437. }
  438. echo '</select>';
  439. ]]></programlisting>
  440. <para>Les dossiers choisis courants sont retournés par la méthode <code>getSelectedFolder()</code>. Changer de
  441. dossier est fait avec la méthode <code>selectFolder()</code>, qui a besoin du nom global comme paramètre. Si
  442. vous voulez éviter d'écrire des délimiteurs vous pouvez également employer les propriétés d'une instance de
  443. <classname>Zend_Mail_Storage_Folder</classname> :</para>
  444. <programlisting role="php"><![CDATA[
  445. // selon votre stockage et ses réglages $rootFolder->Archive->2005
  446. // est la même chose que :
  447. // /Archive/2005
  448. // Archive:2005
  449. // INBOX.Archive.2005
  450. // ...
  451. $folder = $mail->getFolders()->Archive->2005;
  452. echo 'Le précédent dossier était '
  453. . $mail->getSelectedFolder()
  454. . "Le nouveau dossier est $folder\n";
  455. $mail->selectFolder($folder);
  456. ]]></programlisting>
  457. </sect2>
  458. <sect2 id="zend.mail.read-advanced">
  459. <title>Utilisation avancée</title>
  460. <sect3 id="zend.mail.read-advanced.noop">
  461. <title>Utiliser NOOP</title>
  462. <para>Si vous employez un stockage distant et avez une longue tâche vous pourriez devoir maintenir la
  463. connexion persistante par l'intermédiaire du noop :</para>
  464. <programlisting role="php"><![CDATA[
  465. foreach ($mail as $message) {
  466. // faire qqch...
  467. $mail->noop(); // maintient la connexion
  468. // faire autre chose...
  469. $mail->noop(); // maintient la connexion
  470. }
  471. ]]></programlisting>
  472. </sect3>
  473. <sect3 id="zend.mail.read-advanced.extending">
  474. <title>Mettre en cache des instances</title>
  475. <para><classname>Zend_Mail_Storage_Mbox</classname>, <classname>Zend_Mail_Storage_Folder_Mbox</classname>,
  476. <classname>Zend_Mail_Storage_Maildir</classname> et <classname>Zend_Mail_Storage_Folder_Maildir</classname> implémentant les
  477. méthodes magiques <code>__sleep()</code> et <code>__wakeup()</code>, ce qui veut dire qu'ils sont
  478. sérialisable. Ceci évite d'analyser les dossiers ou l'arbre des dossiers plus d'une fois. L'inconvénient est
  479. que votre stockage de Mbox ou de Maildir ne doit pas changer. Quelques contrôles faciles sont faits, comme
  480. ré-analyser le dossier courant de Mbox si le temps de modification change ou ré-analysé la structure du
  481. dossier si un dossier a disparu (ce qui a toujours comme conséquence une erreur, mais vous pouvez rechercher
  482. un autre dossier après). Il est meilleur si vous avez quelque chose comme un fichier de signal pour des
  483. changements et la vérifiez avant d'employer l'instance caché.</para>
  484. <programlisting role="php"><![CDATA[
  485. // il n'y a pas de gestionnaire spécifique de cache utilisé ici,
  486. // changer le code pour utiliser votre gestionnaire de cache
  487. $signal_file = '/home/test/.mail.last_change';
  488. $mbox_basedir = '/home/test/mail/';
  489. $cache_id = 'exemple de mail en cache ' . $mbox_basedir . $signal_file;
  490. $cache = new Your_Cache_Class();
  491. if (!$cache->isCached($cache_id) ||
  492. filemtime($signal_file) > $cache->getMTime($cache_id)) {
  493. $mail = new Zend_Mail_Storage_Folder_Pop3(
  494. array('dirname' => $mbox_basedir)
  495. );
  496. } else {
  497. $mail = $cache->get($cache_id);
  498. }
  499. // faire qqch ...
  500. $cache->set($cache_id, $mail);
  501. ]]></programlisting>
  502. </sect3>
  503. <sect3>
  504. <title>Étendre les classes de protocoles</title>
  505. <para>Les stockages distants utilisent deux classes : <classname>Zend_Mail_Storage_&lt;NOM&gt;</classname> et
  506. <classname>Zend_Mail_Protocol_&lt;NOM&gt;</classname>. La classe de protocole traduit les commandes et les réponses de
  507. protocole et issu de ou pour PHP, comme des méthodes pour les commandes ou les variables avec différentes
  508. structures pour les données. L'autre/classe principale met en application l'interface commune.</para>
  509. <para>Si vous avez besoin de fonctionnalités additionnelles de protocole vous pouvez étendre la classe de
  510. protocole et l'employer dans le constructeur de la classe principale. Supposer par exemple que nous devons
  511. joindre différents ports avant que nous puissions nous relier à POP3.</para>
  512. <programlisting role="php"><![CDATA[
  513. Zend_Loader::loadClass('Zend_Mail_Storage_Pop3');
  514. class Example_Mail_Exception extends Zend_Mail_Exception
  515. {}
  516. class Example_Mail_Protocol_Exception extends Zend_Mail_Protocol_Exception
  517. {}
  518. class Example_Mail_Protocol_Pop3_Knock extends Zend_Mail_Protocol_Pop3
  519. {
  520. private $host, $port;
  521. public function __construct($host, $port = null)
  522. {
  523. // pas d'auto-connexion dans cette classe
  524. $this->host = $host;
  525. $this->port = $port;
  526. }
  527. public function knock($port)
  528. {
  529. $sock = @fsockopen($this->host, $port);
  530. if ($sock) {
  531. fclose($sock);
  532. }
  533. }
  534. public function connect($host = null, $port = null, $ssl = false)
  535. {
  536. if ($host === null) {
  537. $host = $this->host;
  538. }
  539. if ($port === null) {
  540. $port = $this->port;
  541. }
  542. parent::connect($host, $port);
  543. }
  544. }
  545. class Example_Mail_Pop3_Knock extends Zend_Mail_Storage_Pop3
  546. {
  547. public function __construct(array $params)
  548. {
  549. // ... vérifier les $params ici ! ...
  550. $protocol =
  551. new Example_Mail_Protocol_Pop3_Knock($params['host']);
  552. // faire votre fonction "spéciale"
  553. foreach ((array)$params['knock_ports'] as $port) {
  554. $protocol->knock($port);
  555. }
  556. // récupérer l'état coorect
  557. $protocol->connect($params['host'], $params['port']);
  558. $protocol->login($params['user'], $params['password']);
  559. // initialise le parent
  560. parent::__construct($protocol);
  561. }
  562. }
  563. $mail = new Example_Mail_Pop3_Knock(
  564. array('host' => 'localhost',
  565. 'user' => 'test',
  566. 'password' => 'test',
  567. 'knock_ports' => array(1101,
  568. 1105,
  569. 1111))
  570. );
  571. ]]></programlisting>
  572. <para>Comme vous voyez nous supposons toujours que nous sommes reliés, identifiés et, si supporté, un
  573. dossier est choisi dans le constructeur de la classe principale. Ainsi si vous assignez votre propre classe
  574. de protocole vous devez toujours vous assurer que c'est fait ou la prochaine méthode échouera si le serveur
  575. ne la permet pas dans l'état actuel.</para>
  576. </sect3>
  577. <sect3 id="zend.mail.read-advanced.quota">
  578. <title>Utilisation des Quotas (avant 1.5)</title>
  579. <para><classname>Zend_Mail_Storage_Writable_Maildir</classname> supporte les quotas Maildir++. Ceci est désactivé par
  580. défaut, mais il est possible de l'utiliser manuellement, si la vérification automatique n'est pas souhaitée
  581. (ce qui veut dire que <code>appendMessage()</code>, <code>removeMessage()</code> et
  582. <code>copyMessage()</code> ne vérifie pas et n'ajoute pas d'entrée dans le fichier de contrôle de la taille
  583. du dossier de mails). Si vous l'activez une exception sera levée si vous tentez d'écrire dans le dossier de
  584. mails et qu'il a déjà atteint son quota.</para>
  585. <para>Il existe trois méthodes pour les quotas : <code>getQuota()</code>, <code>setQuota()</code> et
  586. <code>checkQuota()</code>:</para>
  587. <programlisting role="php"><![CDATA[
  588. $mail = new Zend_Mail_Storage_Writable_Maildir(
  589. array('dirname' => '/home/test/mail/')
  590. );
  591. $mail->setQuota(true); // true pour activer, false pour désactiver
  592. echo 'La vérification du quota est maintenant ',
  593. $mail->getQuota() ? 'active' : 'inactive',
  594. "\n";
  595. // la vérification du quota peut être utilisée
  596. // si celle-ci est désactivée
  597. echo 'Vous êtes ',
  598. $mail->checkQuota() ? 'hors quota' : 'dans le quota',
  599. "\n";
  600. ]]></programlisting>
  601. <para><code>checkQuota()</code> peut aussi retournée une réponse plus détaillée :</para>
  602. <programlisting role="php"><![CDATA[
  603. $quota = $mail->checkQuota(true);
  604. echo 'Vous êtes ',
  605. $quota['over_quota'] ? 'hors quota' : 'dans le quota',
  606. "\n";
  607. echo 'Vous avez ',
  608. $quota['count'],
  609. ' de ',
  610. $quota['quota']['count'],
  611. ' messages et vous utilisez ';
  612. echo $quota['size'], ' de ', $quota['quota']['size'], ' octets';
  613. ]]></programlisting>
  614. <para>Si vous voulez spécifier votre propre quota plutôt que d'utiliser celui spécifié dans le fichier de
  615. contrôle de la taille du dossier de mails, vous pouvez le faire avec <code>setQuota()</code> :</para>
  616. <programlisting role="php"><![CDATA[
  617. // le nombre de messages et la taille en octet sont supportés,
  618. // l'ordre est important
  619. $quota = $mail->setQuota(array('size' => 10000, 'count' => 100));
  620. ]]></programlisting>
  621. <para>Pour ajouter vos propres vérifications de quota, utilisez des caractères uniques en tant que clé et
  622. ils seront préservés (mais évidemment non vérifié). Il est aussi possible d'étendre
  623. <classname>Zend_Mail_Storage_Writable_Maildir</classname> pour définir votre propre quota seulement si le fichier de
  624. contrôle de la taille du dossier de mails est absent (qui peut se produire dans Maildir++) :</para>
  625. <programlisting role="php"><![CDATA[
  626. class Exemple_Mail_Storage_Maildir extends Zend_Mail_Storage_Writable_Maildir {
  627. // getQuota est appelé avec $fromStorage = true
  628. // par la vérification de quota
  629. public function getQuota($fromStorage = false) {
  630. try {
  631. return parent::getQuota($fromStorage);
  632. } catch (Zend_Mail_Storage_Exception $e) {
  633. if (!$fromStorage) {
  634. // Erreur inconnue
  635. throw $e;
  636. }
  637. // le fichier de contrôle de la taille du dossier de mails
  638. // doit être absent
  639. list($count, $size) = get_un_autre_quota();
  640. return array('count' => $count, 'size' => $size);
  641. }
  642. }
  643. }
  644. ]]></programlisting>
  645. </sect3>
  646. </sect2>
  647. </sect1>