Permalink
Browse files

MDL-31739 mod_forum: added phpdocs for forum_get_email_message_id()

  • Loading branch information...
1 parent c4a12af commit 8260050dbd25673eebb47f25ee50df4a71fb56fd @andyjdavis andyjdavis committed Feb 24, 2012
Showing with 10 additions and 0 deletions.
  1. +10 −0 mod/forum/lib.php
View
@@ -365,6 +365,16 @@ function forum_get_completion_state($course,$cm,$userid,$type) {
return $result;
}
+/**
+ * Create a message-id string to use in the custom headers of forum notification emails
+ *
+ * message-id is used by email clients to identify emails and to nest conversations
+ *
+ * @param int $postid The ID of the forum post we are notifying the user about
+ * @param int $usertoid The ID of the user being notified
+ * @param string $hostname The server's hostname
+ * @return string A unique message-id
+ */
function forum_get_email_message_id($postid, $usertoid, $hostname) {
return '<'.hash('sha256',$postid.'to'.$usertoid.'@'.$hostname).'>';
}

0 comments on commit 8260050

Please sign in to comment.