From mboxrd@z Thu Jan  1 00:00:00 1970
Return-Path: <d.csapak@proxmox.com>
Received: from firstgate.proxmox.com (firstgate.proxmox.com [212.224.123.68])
 (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits)
 key-exchange X25519 server-signature RSA-PSS (2048 bits))
 (No client certificate requested)
 by lists.proxmox.com (Postfix) with ESMTPS id 718D060B46
 for <pmg-devel@lists.proxmox.com>; Thu,  3 Feb 2022 09:29:26 +0100 (CET)
Received: from firstgate.proxmox.com (localhost [127.0.0.1])
 by firstgate.proxmox.com (Proxmox) with ESMTP id 67DAB23BAD
 for <pmg-devel@lists.proxmox.com>; Thu,  3 Feb 2022 09:29:26 +0100 (CET)
Received: from proxmox-new.maurer-it.com (proxmox-new.maurer-it.com
 [94.136.29.106])
 (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits)
 key-exchange X25519 server-signature RSA-PSS (2048 bits))
 (No client certificate requested)
 by firstgate.proxmox.com (Proxmox) with ESMTPS id D2F1E23B9B
 for <pmg-devel@lists.proxmox.com>; Thu,  3 Feb 2022 09:29:25 +0100 (CET)
Received: from proxmox-new.maurer-it.com (localhost.localdomain [127.0.0.1])
 by proxmox-new.maurer-it.com (Proxmox) with ESMTP id A3E4940B94
 for <pmg-devel@lists.proxmox.com>; Thu,  3 Feb 2022 09:29:25 +0100 (CET)
From: Dominik Csapak <d.csapak@proxmox.com>
To: pmg-devel@lists.proxmox.com
Date: Thu,  3 Feb 2022 09:29:23 +0100
Message-Id: <20220203082925.1780071-1-d.csapak@proxmox.com>
X-Mailer: git-send-email 2.30.2
MIME-Version: 1.0
Content-Transfer-Encoding: 8bit
X-SPAM-LEVEL: Spam detection results:  0
 AWL 0.161 Adjusted score from AWL reputation of From: address
 BAYES_00                 -1.9 Bayes spam probability is 0 to 1%
 KAM_DMARC_STATUS 0.01 Test Rule for DKIM or SPF Failure with Strict Alignment
 SPF_HELO_NONE           0.001 SPF: HELO does not publish an SPF Record
 SPF_PASS               -0.001 SPF: sender matches SPF record
 T_SCC_BODY_TEXT_LINE    -0.01 -
 URIBL_BLOCKED 0.001 ADMINISTRATOR NOTICE: The query to URIBL was blocked. See
 http://wiki.apache.org/spamassassin/DnsBlocklists#dnsbl-block for more
 information. [postfix.pm]
Subject: [pmg-devel] [PATCH pmg-api] api/postfix: add 'decode-headers' to
 postfix queue read
X-BeenThere: pmg-devel@lists.proxmox.com
X-Mailman-Version: 2.1.29
Precedence: list
List-Id: Proxmox Mail Gateway development discussion
 <pmg-devel.lists.proxmox.com>
List-Unsubscribe: <https://lists.proxmox.com/cgi-bin/mailman/options/pmg-devel>, 
 <mailto:pmg-devel-request@lists.proxmox.com?subject=unsubscribe>
List-Archive: <http://lists.proxmox.com/pipermail/pmg-devel/>
List-Post: <mailto:pmg-devel@lists.proxmox.com>
List-Help: <mailto:pmg-devel-request@lists.proxmox.com?subject=help>
List-Subscribe: <https://lists.proxmox.com/cgi-bin/mailman/listinfo/pmg-devel>, 
 <mailto:pmg-devel-request@lists.proxmox.com?subject=subscribe>
X-List-Received-Date: Thu, 03 Feb 2022 08:29:26 -0000

often, the users want to show the *decoded* header, iow. they want
to see the readable subject,from,to, etc. not the quoted-printable
versions.

so add a new parameter that decodes the header lines as we read them
using MIME::WordDecoder's 'mime_to_perl_string'.

for backwards compatibility, this is not the default in the api

Signed-off-by: Dominik Csapak <d.csapak@proxmox.com>
---
 src/PMG/API2/Postfix.pm | 8 +++++++-
 src/PMG/Postfix.pm      | 6 +++++-
 2 files changed, 12 insertions(+), 2 deletions(-)

diff --git a/src/PMG/API2/Postfix.pm b/src/PMG/API2/Postfix.pm
index ba22637..2dfcc11 100644
--- a/src/PMG/API2/Postfix.pm
+++ b/src/PMG/API2/Postfix.pm
@@ -239,6 +239,12 @@ __PACKAGE__->register_method ({
 		default => 0,
 		optional => 1,
 	    },
+	    'decode-header' => {
+		description => "Decodes the header fields.",
+		type => 'boolean',
+		default => 0,
+		optional => 1,
+	    },
 	},
     },
     returns => { type => 'string' },
@@ -247,7 +253,7 @@ __PACKAGE__->register_method ({
 
 	$param->{header} //= 1;
 
-	return PMG::Postfix::postcat($param->{queue_id}, $param->{header}, $param->{body});
+	return PMG::Postfix::postcat($param->{queue_id}, $param->{header}, $param->{body}, $param->{'decode-header'});
     }});
 
 __PACKAGE__->register_method ({
diff --git a/src/PMG/Postfix.pm b/src/PMG/Postfix.pm
index d6ad9d7..20f980e 100644
--- a/src/PMG/Postfix.pm
+++ b/src/PMG/Postfix.pm
@@ -5,6 +5,7 @@ use warnings;
 use Data::Dumper;
 use File::Find;
 use JSON;
+use MIME::WordDecoder qw(mime_to_perl_string);
 
 use PVE::Tools;
 
@@ -162,7 +163,7 @@ sub mailq {
 }
 
 sub postcat {
-    my ($queue_id, $header, $body) = @_;
+    my ($queue_id, $header, $body, $decode) = @_;
 
     die "no option specified (select header or body or both)"
 	if !($header || $body);
@@ -178,6 +179,9 @@ sub postcat {
 
     my $res = '';
     while (defined(my $line = <$fh>)) {
+	if ($decode) {
+	    $line = mime_to_perl_string($line);
+	}
 	$res .= $line;
     }
 
-- 
2.30.2