X-Git-Url: https://vcs.fsf.org/?p=squirrelmail.git;a=blobdiff_plain;f=src%2Fview_header.php;h=3d6652f31f272f995f773cc1554117d10e54e4c8;hp=7535210502986965b298e96e4d24ae12993d9f14;hb=c4faef335b2362c81b8ebf026d4066c12d70536c;hpb=f197ec8835b64975ff47dc6cd86dae75605baebf

diff --git a/src/view_header.php b/src/view_header.php
index 75352105..3d6652f3 100644
--- a/src/view_header.php
+++ b/src/view_header.php
@@ -5,7 +5,7 @@
  *
  * This is the code to view the message header.
  *
- * @copyright 1999-2016 The SquirrelMail Project Team
+ * @copyright 1999-2020 The SquirrelMail Project Team
  * @license http://opensource.org/licenses/gpl-license.php GNU Public License
  * @version $Id$
  * @package squirrelmail
@@ -23,7 +23,21 @@ require('../include/init.php');
 require_once(SM_PATH . 'functions/imap.php');
 require_once(SM_PATH . 'functions/url_parser.php');
 
-function parse_viewheader($imapConnection,$id, $passed_ent_id) {
+/**
+  * Extract message headers
+  *
+  * @param resource $imapConnection
+  * @param string $id Message ID
+  * @param string $passed_ent_id Nested/attached/embedded message ID (if any)
+  *
+  * @return array List of all message headers, where each
+  *               element is a sub-array that contains two
+  *               elements: header name and header value
+  *               (in that order) where the header value is
+  *               HTML-formatted, ready for display in browser
+  *
+  */
+function parse_viewheader($imapConnection, $id, $passed_ent_id) {
 
     $header_output = array();
     $second = array();