Add a flag that indicates whether an inbox should be sync'ed

The cron background sync can be expensive with accounts that have many
mailboxes. As it turns out other clients like Thunderbird also don't
look into *all* mailboxes to check for new email. Instead they only do
that for INBOX by default and let the user pick more mailboxes if they
wish. We should do the same.

This adds a simple flag. Only the inbox and mailboxes that have this
flag set will get a sync in background.

Any other mailbox can still be used, but the sync only happens if the
user has the mailbox open.

This will bring down the load on instances with many accounts,
especially if those have many mailboxes.

Signed-off-by: Christoph Wurst <christoph@winzerhof-wurst.at>

1 files changed, 11 insertions, 0 deletions

diff --git a/lib/Contracts/IMailManager.php b/lib/Contracts/IMailManager.php
index cbe727933..d80a8bcc1 100644
--- a/lib/Contracts/IMailManager.php
+++ b/lib/Contracts/IMailManager.php
@@ -209,4 +209,15 @@ interface IMailManager {
 	public function updateSubscription(Account $account,
 									   Mailbox $mailbox,
 									   bool $subscribed): Mailbox;
+
+	/**
+	 * @param string $mailbox
+	 * @param bool $syncInBackground
+	 *
+	 * @return Mailbox
+	 * @throws ClientException
+	 * @throws ServiceException
+	 */
+	public function enableMailboxBackgroundSync(Mailbox $mailbox,
+												bool $syncInBackground): Mailbox;
 }