From f97a4124826900b3a263cb9bd1b94ca717d1f757 Mon Sep 17 00:00:00 2001 From: pdontthink Date: Wed, 13 Sep 2017 01:26:14 +0000 Subject: [PATCH] Add docs for function git-svn-id: https://svn.code.sf.net/p/squirrelmail/code/trunk/squirrelmail@14719 7612ce4b-ef26-0410-bec9-ea0150e637f0 --- src/view_header.php | 16 +++++++++++++++- 1 file changed, 15 insertions(+), 1 deletion(-) diff --git a/src/view_header.php b/src/view_header.php index e4978034..2d215608 100644 --- a/src/view_header.php +++ b/src/view_header.php @@ -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(); -- 2.25.1