_sloodle---lib---mail.php.html 7.3 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198
  1. <?xml version="1.0" encoding="iso-8859-1"?>
  2. <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
  3. <html xmlns="http://www.w3.org/1999/xhtml">
  4. <head>
  5. <!-- template designed by Marco Von Ballmoos -->
  6. <title>Docs for page mail.php</title>
  7. <link rel="stylesheet" href="../media/stylesheet.css" />
  8. <script src="../media/lib/classTree.js"></script>
  9. <script language="javascript" type="text/javascript">
  10. var imgPlus = new Image();
  11. var imgMinus = new Image();
  12. imgPlus.src = "../media/images/plus.png";
  13. imgMinus.src = "../media/images/minus.png";
  14. function showNode(Node){
  15. switch(navigator.family){
  16. case 'nn4':
  17. // Nav 4.x code fork...
  18. var oTable = document.layers["span" + Node];
  19. var oImg = document.layers["img" + Node];
  20. break;
  21. case 'ie4':
  22. // IE 4/5 code fork...
  23. var oTable = document.all["span" + Node];
  24. var oImg = document.all["img" + Node];
  25. break;
  26. case 'gecko':
  27. // Standards Compliant code fork...
  28. var oTable = document.getElementById("span" + Node);
  29. var oImg = document.getElementById("img" + Node);
  30. break;
  31. }
  32. oImg.src = imgMinus.src;
  33. oTable.style.display = "block";
  34. }
  35. function hideNode(Node){
  36. switch(navigator.family){
  37. case 'nn4':
  38. // Nav 4.x code fork...
  39. var oTable = document.layers["span" + Node];
  40. var oImg = document.layers["img" + Node];
  41. break;
  42. case 'ie4':
  43. // IE 4/5 code fork...
  44. var oTable = document.all["span" + Node];
  45. var oImg = document.all["img" + Node];
  46. break;
  47. case 'gecko':
  48. // Standards Compliant code fork...
  49. var oTable = document.getElementById("span" + Node);
  50. var oImg = document.getElementById("img" + Node);
  51. break;
  52. }
  53. oImg.src = imgPlus.src;
  54. oTable.style.display = "none";
  55. }
  56. function nodeIsVisible(Node){
  57. switch(navigator.family){
  58. case 'nn4':
  59. // Nav 4.x code fork...
  60. var oTable = document.layers["span" + Node];
  61. break;
  62. case 'ie4':
  63. // IE 4/5 code fork...
  64. var oTable = document.all["span" + Node];
  65. break;
  66. case 'gecko':
  67. // Standards Compliant code fork...
  68. var oTable = document.getElementById("span" + Node);
  69. break;
  70. }
  71. return (oTable && oTable.style.display == "block");
  72. }
  73. function toggleNodeVisibility(Node){
  74. if (nodeIsVisible(Node)){
  75. hideNode(Node);
  76. }else{
  77. showNode(Node);
  78. }
  79. }
  80. </script>
  81. </head>
  82. <body>
  83. <div class="page-body">
  84. <h2 class="file-name"><img src="../media/images/Page_logo.png" alt="File" style="vertical-align: middle">/sloodle/lib/mail.php</h2>
  85. <a name="sec-description"></a>
  86. <div class="info-box">
  87. <div class="info-box-title">Description</div>
  88. <div class="nav-bar">
  89. <span class="disabled">Description</span> |
  90. <a href="#sec-functions">Functions</a>
  91. </div>
  92. <div class="info-box-body">
  93. <!-- ========== Info from phpDoc block ========= -->
  94. <ul class="tags">
  95. <li><span class="field">filesource:</span> <a href="../__filesource/fsource_sloodle__sloodlelibmail.php.html">Source Code for this file</a></li>
  96. </ul>
  97. </div>
  98. </div>
  99. <a name="sec-functions"></a>
  100. <div class="info-box">
  101. <div class="info-box-title">Functions</div>
  102. <div class="nav-bar">
  103. <a href="#sec-description">Description</a> |
  104. <span class="disabled">Functions</span>
  105. </div>
  106. <div class="info-box-body">
  107. <a name="functionsloodle_text_email" id="functionsloodle_text_email"><!-- --></a>
  108. <div class="evenrow">
  109. <div>
  110. <img src="../media/images/Function.png" />
  111. <span class="method-title">sloodle_text_email</span> (line <span class="line-number"><a href="../__filesource/fsource_sloodle__sloodlelibmail.php.html#a15">15</a></span>)
  112. </div>
  113. <!-- ========== Info from phpDoc block ========= -->
  114. <p class="short-description">Send an email to a specific address, using the Moodle system.</p>
  115. <p class="description"><p>This function is heavily based on &quot;email_to_user()&quot; from Moodle's libraries.</p></p>
  116. <ul class="tags">
  117. <li><span class="field">return:</span> Returns true if mail was sent OK, or false otherwise</li>
  118. <li><span class="field">uses:</span> $FULLME</li>
  119. <li><span class="field">uses:</span> $CFG</li>
  120. </ul>
  121. <div class="method-signature">
  122. <span class="method-result">bool</span>
  123. <span class="method-name">
  124. sloodle_text_email
  125. </span>
  126. (<span class="var-type">string</span>&nbsp;<span class="var-name">$to</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$subject</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$messagetext</span>)
  127. </div>
  128. <ul class="parameters">
  129. <li>
  130. <span class="var-type">string</span>
  131. <span class="var-name">$to</span><span class="var-description">: The address to send the email to</span> </li>
  132. <li>
  133. <span class="var-type">string</span>
  134. <span class="var-name">$subject</span><span class="var-description">: Plain text subject line of the email</span> </li>
  135. <li>
  136. <span class="var-type">string</span>
  137. <span class="var-name">$messagetext</span><span class="var-description">: Plain text of the message</span> </li>
  138. </ul>
  139. </div>
  140. <a name="functionsloodle_text_email_sl" id="functionsloodle_text_email_sl"><!-- --></a>
  141. <div class="oddrow">
  142. <div>
  143. <img src="../media/images/Function.png" />
  144. <span class="method-title">sloodle_text_email_sl</span> (line <span class="line-number"><a href="../__filesource/fsource_sloodle__sloodlelibmail.php.html#a97">97</a></span>)
  145. </div>
  146. <!-- ========== Info from phpDoc block ========= -->
  147. <p class="short-description">Send an email to an object in SL.</p>
  148. <ul class="tags">
  149. <li><span class="field">return:</span> Returns true if mail was sent OK, or false otherwise</li>
  150. </ul>
  151. <div class="method-signature">
  152. <span class="method-result">bool</span>
  153. <span class="method-name">
  154. sloodle_text_email_sl
  155. </span>
  156. (<span class="var-type">string</span>&nbsp;<span class="var-name">$uuid</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$subject</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$messagetext</span>)
  157. </div>
  158. <ul class="parameters">
  159. <li>
  160. <span class="var-type">string</span>
  161. <span class="var-name">$uuid</span><span class="var-description">: The UUID of the object to send the email to</span> </li>
  162. <li>
  163. <span class="var-type">string</span>
  164. <span class="var-name">$subject</span><span class="var-description">: Plain text subject line of the email</span> </li>
  165. <li>
  166. <span class="var-type">string</span>
  167. <span class="var-name">$messagetext</span><span class="var-description">: Plain text of the message</span> </li>
  168. </ul>
  169. </div>
  170. </div>
  171. </div>
  172. <p class="notes" id="credit">
  173. Documentation generated on Mon, 16 Jun 2008 15:56:42 +0100 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.0</a>
  174. </p>
  175. </div></body>
  176. </html>