GODT-1740: Opt-out All Mail visibility in settings file.

internal/bridge/bridge.go

@@ -57,8 +57,9 @@ type Bridge struct {
 	// Bridge's global errors list.
 	errors []error
 
-	isFirstStart bool
-	lastVersion  string
+	isAllMailVisible bool
+	isFirstStart     bool
+	lastVersion      string
 }
 
 func New(
@@ -92,15 +93,16 @@ func New(
 	)
 
 	b := &Bridge{
-		Users:         u,
-		locations:     locations,
-		settings:      setting,
-		clientManager: clientManager,
-		updater:       updater,
-		versioner:     versioner,
-		cacheProvider: cacheProvider,
-		autostart:     autostart,
-		isFirstStart:  false,
+		Users:            u,
+		locations:        locations,
+		settings:         setting,
+		clientManager:    clientManager,
+		updater:          updater,
+		versioner:        versioner,
+		cacheProvider:    cacheProvider,
+		autostart:        autostart,
+		isFirstStart:     false,
+		isAllMailVisible: setting.GetBool(settings.IsAllMailVisible),
 	}
 
 	if setting.GetBool(settings.FirstStartKey) {
@@ -302,3 +304,14 @@ func (b *Bridge) GetLastVersion() string {
 func (b *Bridge) IsFirstStart() bool {
 	return b.isFirstStart
 }
+
+// IsAllMailVisible can be called extensively by IMAP. Therefore, it is better
+// to cache the value instead of reading from settings file.
+func (b *Bridge) IsAllMailVisible() bool {
+	return b.isAllMailVisible
+}
+
+func (b *Bridge) SetIsAllMailVisible(isVisible bool) {
+	b.settings.SetBool(settings.IsAllMailVisible, isVisible)
+	b.isAllMailVisible = isVisible
+}

internal/config/settings/settings.go

@@ -55,6 +55,7 @@ const (
 	AttachmentWorkers      = "attachment_workers"
 	ColorScheme            = "color_scheme"
 	RebrandingMigrationKey = "rebranding_migrated"
+	IsAllMailVisible       = "is_all_mail_visible"
 )
 
 type Settings struct {
@@ -110,4 +111,6 @@ func (s *Settings) setDefaultValues() {
 
 	// By default, stick to STARTTLS. If the user uses catalina+applemail they'll have to change to SSL.
 	s.setDefault(SMTPSSLKey, "false")
+
+	s.setDefault(IsAllMailVisible, "true")
 }

internal/imap/bridge.go

@@ -31,6 +31,7 @@ type cacheProvider interface {
 type bridger interface {
 	GetUser(query string) (bridgeUser, error)
 	HasError(err error) bool
+	IsAllMailVisible() bool
 }
 
 type bridgeUser interface {

internal/imap/user.go

@@ -128,6 +128,10 @@ func (iu *imapUser) ListMailboxes(showOnlySubcribed bool) ([]goIMAPBackend.Mailb
 
 	mailboxes := []goIMAPBackend.Mailbox{}
 	for _, storeMailbox := range iu.storeAddress.ListMailboxes() {
+		if storeMailbox.LabelID() == pmapi.AllMailLabel && !iu.backend.bridge.IsAllMailVisible() {
+			continue
+		}
+
 		if showOnlySubcribed && !iu.isSubscribed(storeMailbox.LabelID()) {
 			continue
 		}