| 123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122 |
- <?xml version="1.0" encoding="iso-8859-1"?>
- <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
- <html xmlns="http://www.w3.org/1999/xhtml">
- <head>
- <!-- template designed by Marco Von Ballmoos -->
- <title>File Source for mail.php</title>
- <link rel="stylesheet" href="../media/stylesheet.css" />
- </head>
- <body>
-
<h1>Source for file mail.php</h1>
- <p>Documentation is available at <a href="../sloodle/_sloodle---lib---mail.php.html">mail.php</a></p>
- <div class="src-code">
- <div class="src-code"><ol><li><div class="src-line"><a name="a1"></a><span class="src-php"><?php</span></div></li>
- <li><div class="src-line"><a name="a2"></a> </div></li>
- <li><div class="src-line"><a name="a3"></a> </div></li>
- <li><div class="src-line"><a name="a4"></a><span class="src-doc">/**</span></div></li>
- <li><div class="src-line"><a name="a5"></a><span class="src-doc">* Send an email to a specific address, using the Moodle system.</span></div></li>
- <li><div class="src-line"><a name="a6"></a><span class="src-doc">* This function is heavily based on "email_to_user()" from Moodle's libraries.</span></div></li>
- <li><div class="src-line"><a name="a7"></a><span class="src-doc">*</span></div></li>
- <li><div class="src-line"><a name="a8"></a><span class="src-doc">* </span><span class="src-doc-coretag">@uses</span><span class="src-doc"> $CFG</span></div></li>
- <li><div class="src-line"><a name="a9"></a><span class="src-doc">* </span><span class="src-doc-coretag">@uses</span><span class="src-doc"> $FULLME</span></div></li>
- <li><div class="src-line"><a name="a10"></a><span class="src-doc">* </span><span class="src-doc-coretag">@param </span><span class="src-doc-type">string </span><span class="src-doc-var">$to </span><span class="src-doc">The address to send the email to</span></div></li>
- <li><div class="src-line"><a name="a11"></a><span class="src-doc">* </span><span class="src-doc-coretag">@param </span><span class="src-doc-type">string </span><span class="src-doc-var">$subject </span><span class="src-doc">Plain text subject line of the email</span></div></li>
- <li><div class="src-line"><a name="a12"></a><span class="src-doc">* </span><span class="src-doc-coretag">@param </span><span class="src-doc-type">string </span><span class="src-doc-var">$messagetext </span><span class="src-doc">Plain text of the message</span></div></li>
- <li><div class="src-line"><a name="a13"></a><span class="src-doc">* </span><span class="src-doc-coretag">@return </span><span class="src-doc-type">bool </span><span class="src-doc">Returns true if mail was sent OK, or false otherwise</span></div></li>
- <li><div class="src-line"><a name="a14"></a><span class="src-doc">*/</span></div></li>
- <li><div class="src-line"><a name="a15"></a><span class="src-key">function </span><a href="../sloodle/_sloodle---lib---mail.php.html#functionsloodle_text_email">sloodle_text_email</a><span class="src-sym">(</span><span class="src-var">$to</span><span class="src-sym">, </span><span class="src-var">$subject</span><span class="src-sym">, </span><span class="src-var">$messagetext</span><span class="src-sym">)</span></div></li>
- <li><div class="src-line"><a name="a16"></a><span class="src-sym">{</span></div></li>
- <li><div class="src-line"><a name="a17"></a> <span class="src-key">global </span><span class="src-var">$CFG</span><span class="src-sym">, </span><span class="src-var">$FULLME</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a18"></a> </div></li>
- <li><div class="src-line"><a name="a19"></a> <span class="src-comm">// Fetch the PHP mailing functionality</span></div></li>
- <li><div class="src-line"><a name="a20"></a> <span class="src-inc">include_once</span><span class="src-sym">(</span><span class="src-var">$CFG</span><span class="src-sym">-></span><span class="src-id">libdir </span>.<span class="src-str">'/phpmailer/class.phpmailer.php'</span><span class="src-sym">)</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a21"></a> </div></li>
- <li><div class="src-line"><a name="a22"></a> <span class="src-comm">// We are going to use textlib services here</span></div></li>
- <li><div class="src-line"><a name="a23"></a> <span class="src-var">$textlib </span>= <span class="src-id">textlib_get_instance</span><span class="src-sym">(</span><span class="src-sym">)</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a24"></a> </div></li>
- <li><div class="src-line"><a name="a25"></a> <span class="src-comm">// Construct a new PHP mailer</span></div></li>
- <li><div class="src-line"><a name="a26"></a> <span class="src-var">$mail </span>= <span class="src-key">new </span><span class="src-id">phpmailer</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a27"></a> <span class="src-var">$mail</span><span class="src-sym">-></span><span class="src-id">Version </span>= <span class="src-str">'Moodle '</span>. <span class="src-var">$CFG</span><span class="src-sym">-></span><span class="src-id">version</span><span class="src-sym">; </span><span class="src-comm">// mailer version</span></div></li>
- <li><div class="src-line"><a name="a28"></a> <span class="src-var">$mail</span><span class="src-sym">-></span><span class="src-id">PluginDir </span>= <span class="src-var">$CFG</span><span class="src-sym">-></span><span class="src-id">libdir </span>.<span class="src-str">'/phpmailer/'</span><span class="src-sym">; </span><span class="src-comm">// plugin directory (eg smtp plugin)</span></div></li>
- <li><div class="src-line"><a name="a29"></a> <span class="src-comm">// We will use Unicode UTF8</span></div></li>
- <li><div class="src-line"><a name="a30"></a> <span class="src-var">$mail</span><span class="src-sym">-></span><span class="src-id">CharSet </span>= <span class="src-str">'UTF-8'</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a31"></a> </div></li>
- <li><div class="src-line"><a name="a32"></a> <span class="src-comm">// Determine which mail system to use</span></div></li>
- <li><div class="src-line"><a name="a33"></a> <span class="src-key">if </span><span class="src-sym">(</span><span class="src-var">$CFG</span><span class="src-sym">-></span><span class="src-id">smtphosts </span>== <span class="src-str">'qmail'</span><span class="src-sym">) </span><span class="src-sym">{</span></div></li>
- <li><div class="src-line"><a name="a34"></a> <span class="src-var">$mail</span><span class="src-sym">-></span><span class="src-id">IsQmail</span><span class="src-sym">(</span><span class="src-sym">)</span><span class="src-sym">; </span><span class="src-comm">// use Qmail system</span></div></li>
- <li><div class="src-line"><a name="a35"></a> </div></li>
- <li><div class="src-line"><a name="a36"></a> <span class="src-sym">} </span><span class="src-key">else </span><span class="src-key">if </span><span class="src-sym">(</span><span class="src-key">empty</span><span class="src-sym">(</span><span class="src-var">$CFG</span><span class="src-sym">-></span><span class="src-id">smtphosts</span><span class="src-sym">)) </span><span class="src-sym">{</span></div></li>
- <li><div class="src-line"><a name="a37"></a> <span class="src-var">$mail</span><span class="src-sym">-></span><span class="src-id">IsMail</span><span class="src-sym">(</span><span class="src-sym">)</span><span class="src-sym">; </span><span class="src-comm">// use PHP mail() = sendmail</span></div></li>
- <li><div class="src-line"><a name="a38"></a> </div></li>
- <li><div class="src-line"><a name="a39"></a> <span class="src-sym">} </span><span class="src-key">else </span><span class="src-sym">{</span></div></li>
- <li><div class="src-line"><a name="a40"></a> <span class="src-var">$mail</span><span class="src-sym">-></span><span class="src-id">IsSMTP</span><span class="src-sym">(</span><span class="src-sym">)</span><span class="src-sym">; </span><span class="src-comm">// use SMTP directly</span></div></li>
- <li><div class="src-line"><a name="a41"></a> <span class="src-key">if </span><span class="src-sym">(</span><span class="src-sym">!</span><span class="src-key">empty</span><span class="src-sym">(</span><span class="src-var">$CFG</span><span class="src-sym">-></span><span class="src-id">debugsmtp</span><span class="src-sym">)) </span><span class="src-sym">{</span></div></li>
- <li><div class="src-line"><a name="a42"></a> echo <span class="src-str">'<pre>' </span>. <span class="src-str">"\n"</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a43"></a> <span class="src-var">$mail</span><span class="src-sym">-></span><span class="src-id">SMTPDebug </span>= <span class="src-id">true</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a44"></a> <span class="src-sym">}</span></div></li>
- <li><div class="src-line"><a name="a45"></a> <span class="src-var">$mail</span><span class="src-sym">-></span><span class="src-id">Host </span>= <span class="src-var">$CFG</span><span class="src-sym">-></span><span class="src-id">smtphosts</span><span class="src-sym">; </span><span class="src-comm">// specify main and backup servers</span></div></li>
- <li><div class="src-line"><a name="a46"></a> </div></li>
- <li><div class="src-line"><a name="a47"></a> <span class="src-key">if </span><span class="src-sym">(</span><span class="src-var">$CFG</span><span class="src-sym">-></span><span class="src-id">smtpuser</span><span class="src-sym">) </span><span class="src-sym">{ </span><span class="src-comm">// Use SMTP authentication</span></div></li>
- <li><div class="src-line"><a name="a48"></a> <span class="src-var">$mail</span><span class="src-sym">-></span><span class="src-id">SMTPAuth </span>= <span class="src-id">true</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a49"></a> <span class="src-var">$mail</span><span class="src-sym">-></span><span class="src-id">Username </span>= <span class="src-var">$CFG</span><span class="src-sym">-></span><span class="src-id">smtpuser</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a50"></a> <span class="src-var">$mail</span><span class="src-sym">-></span><span class="src-id">Password </span>= <span class="src-var">$CFG</span><span class="src-sym">-></span><span class="src-id">smtppass</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a51"></a> <span class="src-sym">}</span></div></li>
- <li><div class="src-line"><a name="a52"></a> <span class="src-sym">}</span></div></li>
- <li><div class="src-line"><a name="a53"></a> </div></li>
- <li><div class="src-line"><a name="a54"></a> <span class="src-comm">// Use the admin's address for the Sender field</span></div></li>
- <li><div class="src-line"><a name="a55"></a> <span class="src-var">$adminuser </span>= <span class="src-id">get_admin</span><span class="src-sym">(</span><span class="src-sym">)</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a56"></a> <span class="src-var">$mail</span><span class="src-sym">-></span><span class="src-id">Sender </span>= <span class="src-var">$adminuser</span><span class="src-sym">-></span><span class="src-id">email</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a57"></a> <span class="src-comm">// Use the 'noreply' address </span></div></li>
- <li><div class="src-line"><a name="a58"></a> <span class="src-var">$mail</span><span class="src-sym">-></span><span class="src-id">From </span>= <span class="src-var">$CFG</span><span class="src-sym">-></span><span class="src-id">noreplyaddress</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a59"></a> <span class="src-var">$mail</span><span class="src-sym">-></span><span class="src-id">FromName </span>= <span class="src-var">$CFG</span><span class="src-sym">-></span><span class="src-id">wwwroot</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a60"></a> </div></li>
- <li><div class="src-line"><a name="a61"></a> <span class="src-comm">// Setup the other headers</span></div></li>
- <li><div class="src-line"><a name="a62"></a> <span class="src-var">$mail</span><span class="src-sym">-></span><span class="src-id">Subject </span>= <a href="http://www.php.net/substr">substr</a><span class="src-sym">(</span><a href="http://www.php.net/stripslashes">stripslashes</a><span class="src-sym">(</span><span class="src-var">$subject</span><span class="src-sym">)</span><span class="src-sym">, </span><span class="src-num">0</span><span class="src-sym">, </span><span class="src-num">900</span><span class="src-sym">)</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a63"></a> <span class="src-var">$mail</span><span class="src-sym">-></span><span class="src-id">AddAddress</span><span class="src-sym">(</span><a href="http://www.php.net/stripslashes">stripslashes</a><span class="src-sym">(</span><span class="src-var">$to</span><span class="src-sym">)</span><span class="src-sym">, </span><span class="src-str">'Sloodle' </span><span class="src-sym">)</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a64"></a> <span class="src-comm">//$mail->WordWrap = 79; // We don't want to do a wordwrap</span></div></li>
- <li><div class="src-line"><a name="a65"></a> </div></li>
- <li><div class="src-line"><a name="a66"></a> <span class="src-comm">// Add our message text</span></div></li>
- <li><div class="src-line"><a name="a67"></a> <span class="src-var">$mail</span><span class="src-sym">-></span><span class="src-id">IsHTML</span><span class="src-sym">(</span><span class="src-id">false</span><span class="src-sym">)</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a68"></a> <span class="src-var">$mail</span><span class="src-sym">-></span><span class="src-id">Body </span>= <span class="src-var">$messagetext</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a69"></a> </div></li>
- <li><div class="src-line"><a name="a70"></a> <span class="src-comm">// Attempt to send the email</span></div></li>
- <li><div class="src-line"><a name="a71"></a> <span class="src-key">if </span><span class="src-sym">(</span><span class="src-var">$mail</span><span class="src-sym">-></span><span class="src-id">Send</span><span class="src-sym">(</span><span class="src-sym">)) </span><span class="src-sym">{</span></div></li>
- <li><div class="src-line"><a name="a72"></a> <span class="src-var">$mail</span><span class="src-sym">-></span><span class="src-id">IsSMTP</span><span class="src-sym">(</span><span class="src-sym">)</span><span class="src-sym">; </span><span class="src-comm">// use SMTP directly</span></div></li>
- <li><div class="src-line"><a name="a73"></a> <span class="src-key">if </span><span class="src-sym">(</span><span class="src-sym">!</span><span class="src-key">empty</span><span class="src-sym">(</span><span class="src-var">$CFG</span><span class="src-sym">-></span><span class="src-id">debugsmtp</span><span class="src-sym">)) </span><span class="src-sym">{</span></div></li>
- <li><div class="src-line"><a name="a74"></a> echo <span class="src-str">'</pre>'</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a75"></a> <span class="src-sym">}</span></div></li>
- <li><div class="src-line"><a name="a76"></a> <span class="src-key">return </span><span class="src-id">true</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a77"></a> </div></li>
- <li><div class="src-line"><a name="a78"></a> <span class="src-sym">} </span><span class="src-key">else </span><span class="src-sym">{</span></div></li>
- <li><div class="src-line"><a name="a79"></a> <span class="src-id">mtrace</span><span class="src-sym">(</span><span class="src-str">'ERROR: '</span>. <span class="src-var">$mail</span><span class="src-sym">-></span><span class="src-id">ErrorInfo</span><span class="src-sym">)</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a80"></a> <span class="src-id">add_to_log</span><span class="src-sym">(</span><span class="src-id">SITEID</span><span class="src-sym">, </span><span class="src-str">'library'</span><span class="src-sym">, </span><span class="src-str">'mailer'</span><span class="src-sym">, </span><span class="src-var">$FULLME</span><span class="src-sym">, </span><span class="src-str">'ERROR: '</span>. <span class="src-var">$mail</span><span class="src-sym">-></span><span class="src-id">ErrorInfo</span><span class="src-sym">)</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a81"></a> <span class="src-key">if </span><span class="src-sym">(</span><span class="src-sym">!</span><span class="src-key">empty</span><span class="src-sym">(</span><span class="src-var">$CFG</span><span class="src-sym">-></span><span class="src-id">debugsmtp</span><span class="src-sym">)) </span><span class="src-sym">{</span></div></li>
- <li><div class="src-line"><a name="a82"></a> echo <span class="src-str">'</pre>'</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a83"></a> <span class="src-sym">}</span></div></li>
- <li><div class="src-line"><a name="a84"></a> <span class="src-key">return </span><span class="src-id">false</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a85"></a> <span class="src-sym">}</span></div></li>
- <li><div class="src-line"><a name="a86"></a><span class="src-sym">}</span></div></li>
- <li><div class="src-line"><a name="a87"></a> </div></li>
- <li><div class="src-line"><a name="a88"></a> </div></li>
- <li><div class="src-line"><a name="a89"></a><span class="src-doc">/**</span></div></li>
- <li><div class="src-line"><a name="a90"></a><span class="src-doc">* Send an email to an object in SL.</span></div></li>
- <li><div class="src-line"><a name="a91"></a><span class="src-doc">*</span></div></li>
- <li><div class="src-line"><a name="a92"></a><span class="src-doc">* </span><span class="src-doc-coretag">@param </span><span class="src-doc-type">string </span><span class="src-doc-var">$uuid </span><span class="src-doc">The UUID of the object to send the email to</span></div></li>
- <li><div class="src-line"><a name="a93"></a><span class="src-doc">* </span><span class="src-doc-coretag">@param </span><span class="src-doc-type">string </span><span class="src-doc-var">$subject </span><span class="src-doc">Plain text subject line of the email</span></div></li>
- <li><div class="src-line"><a name="a94"></a><span class="src-doc">* </span><span class="src-doc-coretag">@param </span><span class="src-doc-type">string </span><span class="src-doc-var">$messagetext </span><span class="src-doc">Plain text of the message</span></div></li>
- <li><div class="src-line"><a name="a95"></a><span class="src-doc">* </span><span class="src-doc-coretag">@return </span><span class="src-doc-type">bool </span><span class="src-doc">Returns true if mail was sent OK, or false otherwise</span></div></li>
- <li><div class="src-line"><a name="a96"></a><span class="src-doc">*/</span></div></li>
- <li><div class="src-line"><a name="a97"></a><span class="src-key">function </span><a href="../sloodle/_sloodle---lib---mail.php.html#functionsloodle_text_email_sl">sloodle_text_email_sl</a><span class="src-sym">(</span><span class="src-var">$uuid</span><span class="src-sym">, </span><span class="src-var">$subject</span><span class="src-sym">, </span><span class="src-var">$messagetext</span><span class="src-sym">)</span></div></li>
- <li><div class="src-line"><a name="a98"></a><span class="src-sym">{</span></div></li>
- <li><div class="src-line"><a name="a99"></a> <span class="src-key">return </span><a href="../sloodle/_sloodle---lib---mail.php.html#functionsloodle_text_email">sloodle_text_email</a><span class="src-sym">(</span><span class="src-var">$uuid</span>.<span class="src-str">'@lsl.secondlife.com'</span><span class="src-sym">, </span><span class="src-var">$subject</span><span class="src-sym">, </span><span class="src-var">$messagetext</span><span class="src-sym">)</span><span class="src-sym">;</span></div></li>
- <li><div class="src-line"><a name="a100"></a><span class="src-sym">}</span></div></li>
- <li><div class="src-line"><a name="a101"></a> </div></li>
- <li><div class="src-line"><a name="a102"></a> </div></li>
- <li><div class="src-line"><a name="a103"></a><span class="src-php">?></span></div></li>
- </ol></div>
- </div>
- <p class="notes" id="credit">
- 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>
- </p>
- </body>
- </html>
|