MDL-44257 Message: Update phpdocs for email_to_user function

moodle · Sep 16, 2014 · 35fa165 · 35fa165
1 parent 0bdbe84
commit 35fa165
Showing 1 changed file with 1 addition and 1 deletion.
diff --git a/lib/moodlelib.php b/lib/moodlelib.php
@@ -5712,7 +5712,7 @@ function get_mailer($action='get') {
  * @param string $subject plain text subject line of the email
  * @param string $messagetext plain text version of the message
  * @param string $messagehtml complete html version of the message (optional)
- * @param string $attachment a file on the filesystem, relative to $CFG->dataroot
+ * @param string $attachment a file on the filesystem, either relative to $CFG->dataroot or a full path to a file in $CFG->tempdir
  * @param string $attachname the name of the file (extension indicates MIME)
  * @param bool $usetrueaddress determines whether $from email address should
  *          be sent out. Will be overruled by user profile setting for maildisplay