From e01956b6cef0db5e82e2637fe5e565f4560f9fd5 Mon Sep 17 00:00:00 2001
From: Eric Wong <e@80x24.org>
Date: Tue, 2 Mar 2021 09:13:07 +0000
Subject: inbox: ->mailboxid accessor

This will be necessary for "mailboxIds" as described in RFCs 8620 and
8621 (for JMAP).  We may implement "MAILBOXID" in RFC 8474 for IMAP,
as well.
---
 lib/PublicInbox/Inbox.pm | 12 ++++++++++++
 1 file changed, 12 insertions(+)

(limited to 'lib/PublicInbox')

diff --git a/lib/PublicInbox/Inbox.pm b/lib/PublicInbox/Inbox.pm
index a1e34797..da7ea75f 100644
--- a/lib/PublicInbox/Inbox.pm
+++ b/lib/PublicInbox/Inbox.pm
@@ -421,4 +421,16 @@ sub uidvalidity { $_[0]->{uidvalidity} //= eval { $_[0]->mm->created_at } }
 
 sub eidx_key { $_[0]->{newsgroup} // $_[0]->{inboxdir} }
 
+sub mailboxid { # rfc 8474, 8620, 8621
+	my ($self, $imap_slice) = @_;
+	my $pfx = defined($imap_slice) ? $self->{newsgroup} : $self->{name};
+	utf8::encode($pfx); # to octets
+	# RFC 8620, 1.2 recommends not starting with dash or digits
+	# "A good solution to these issues is to prefix every id with a single
+	#  alphabetical character."
+	'M'.join('', map { sprintf('%02x', ord) } split(//, $pfx)) .
+		(defined($imap_slice) ? sprintf('-%x', $imap_slice) : '') .
+		sprintf('-%x', uidvalidity($self) // 0)
+}
+
 1;
-- 
cgit v1.2.3-24-ge0c7