Filter mails with Sieve

appinfo/routes.php

@@ -113,6 +113,11 @@
 			'url' => '/proxy',
 			'verb' => 'GET'
 		],
+		[
+			'name' => 'sieve#setActiveScript',
+			'url' => '/api/accounts/{accountId}/scripts/active',
+			'verb' => 'POST'
+		],
 	],
 	'resources' => [
 		'accounts' => ['url' => '/api/accounts'],
@@ -122,5 +127,6 @@
 		'localAttachments' => ['url' => '/api/attachments'],
 		'messages' => ['url' => '/api/accounts/{accountId}/folders/{folderId}/messages'],
 		'preferences' => ['url' => '/api/preferences'],
+		'sieve' => ['url' => '/api/accounts/{accountId}/scripts'],
 	]
 ];

composer.json

@@ -29,11 +29,13 @@
 		"pear-pear.horde.org/horde_text_flowed": "^2.0.3@stable",
 		"pear-pear.horde.org/horde_util": "^2.5.8@stable",
 		"pear-pear.horde.org/horde_smtp": "^1.9.5@stable",
+		"pear-pear.horde.org/horde_managesieve": "^1.0.2@stable",
 		"cerdic/css-tidy": "v1.7.1",
 		"ezyang/htmlpurifier": "4.11.0",
 		"kwi/urllinker": "dev-bleeding",
 		"gravatarphp/gravatar": "^2.0",
-		"arthurhoaro/favicon": "^1.2"
+		"arthurhoaro/favicon": "^1.2",
+		"protonlabs/libsieve-php": "^2.0"
 	},
 	"require-dev": {
 		"christophwurst/nextcloud": "v17.0.0-beta3",

lib/Account.php

@@ -33,6 +33,7 @@
 
 namespace OCA\Mail;
 
+use Horde\ManageSieve;
 use Horde_Imap_Client_Mailbox;
 use Horde_Imap_Client_Socket;
 use Horde_Mail_Rfc822_List;
@@ -55,7 +56,10 @@ class Account implements JsonSerializable {
 	private $account;
 
 	/** @var Horde_Imap_Client_Socket */
-	private $client;
+	private $imapClient;
+
+	/** @var ManageSieve */
+	private $sieveClient;
 
 	/** @var ICrypto */
 	private $crypto;
@@ -114,9 +118,10 @@ public function getEMailAddress() {
 
 	/**
 	 * @return Horde_Imap_Client_Socket
+	 * @throws \Horde_Imap_Client_Exception
 	 */
 	public function getImapConnection() {
-		if (is_null($this->client)) {
+		if (is_null($this->imapClient)) {
 			$host = $this->account->getInboundHost();
 			$user = $this->account->getInboundUser();
 			$password = $this->account->getInboundPassword();
@@ -144,10 +149,44 @@ public function getImapConnection() {
 						))];
 				}
 			}
-			$this->client = new \Horde_Imap_Client_Socket($params);
-			$this->client->login();
+			$this->imapClient = new \Horde_Imap_Client_Socket($params);
+			$this->imapClient->login();
 		}
-		return $this->client;
+		return $this->imapClient;
+	}
+
+	/**
+	 * @return ManageSieve
+	 * @throws ManageSieve\Exception
+	 */
+	public function getSieveConnection()
+	{
+		if ($this->sieveClient === null) {
+			$host = $this->account->getSieveHost();
+			$user = $this->account->getSieveUser();
+			$password = $this->account->getSievePassword();
+			$password = $this->crypto->decrypt($password);
+			$port = $this->account->getSievePort();
+			$ssl_mode = $this->convertSslMode($this->account->getSieveSslMode());
+
+			$params = [
+				'host' => $host,
+				'port' => $port,
+				'user' => $user,
+				'password' => $password,
+				'secure' => $ssl_mode,
+			];
+
+			// TODO: configure sieve logging
+			/*if ($this->config->getSystemValue('debug', false)) {
+				$params['logger'] = $this->config->getSystemValue('datadirectory') . '/horde_sieve.log';
+			}*/
+
+			$this->sieveClient = new ManageSieve($params);
+
+		}
+
+		return $this->sieveClient;
 	}
 
 	/**
@@ -201,6 +240,11 @@ public function testConnectivity(Horde_Mail_Transport $transport) {
 		if ($transport instanceof Horde_Mail_Transport_Smtphorde) {
 			$transport->getSMTPObject();
 		}
+
+		// connect to sieve
+		if ($this->account->getSieveHost() !== null) {
+			$this->getSieveConnection();
+		}
 	}
 
 	/**

lib/Command/CreateAccount.php

@@ -46,6 +46,11 @@ class CreateAccount extends Command {
 	const ARGUMENT_SMTP_SSL_MODE = 'smtp-ssl-mode';
 	const ARGUMENT_SMTP_USER = 'smtp-user';
 	const ARGUMENT_SMTP_PASSWORD = 'smtp-password';
+	const ARGUMENT_SIEVE_HOST = 'sieve-host';
+	const ARGUMENT_SIEVE_PORT = 'sieve-port';
+	const ARGUMENT_SIEVE_SSL_MODE = 'sieve-ssl-mode';
+	const ARGUMENT_SIEVE_USER = 'sieve-user';
+	const ARGUMENT_SIEVE_PASSWORD = 'sieve-password';
 
 	/** @var AccountService */
 	private $accountService;
@@ -78,6 +83,12 @@ protected function configure() {
 		$this->addArgument(self::ARGUMENT_SMTP_SSL_MODE, InputArgument::REQUIRED);
 		$this->addArgument(self::ARGUMENT_SMTP_USER, InputArgument::REQUIRED);
 		$this->addArgument(self::ARGUMENT_SMTP_PASSWORD, InputArgument::REQUIRED);
+
+		$this->addArgument(self::ARGUMENT_SIEVE_HOST, InputArgument::OPTIONAL);
+		$this->addArgument(self::ARGUMENT_SIEVE_PORT, InputArgument::OPTIONAL);
+		$this->addArgument(self::ARGUMENT_SIEVE_SSL_MODE, InputArgument::OPTIONAL);
+		$this->addArgument(self::ARGUMENT_SIEVE_USER, InputArgument::OPTIONAL);
+		$this->addArgument(self::ARGUMENT_SIEVE_PASSWORD, InputArgument::OPTIONAL);
 	}
 
 	protected function execute(InputInterface $input, OutputInterface $output) {
@@ -97,6 +108,12 @@ protected function execute(InputInterface $input, OutputInterface $output) {
 		$smtpUser = $input->getArgument(self::ARGUMENT_SMTP_USER);
 		$smtpPassword = $input->getArgument(self::ARGUMENT_SMTP_PASSWORD);
 
+		$sieveHost = $input->getArgument(self::ARGUMENT_SIEVE_HOST);
+		$sievePort = $input->getArgument(self::ARGUMENT_SIEVE_PORT);
+		$sieveSslMode = $input->getArgument(self::ARGUMENT_SIEVE_SSL_MODE);
+		$sieveUser = $input->getArgument(self::ARGUMENT_SIEVE_USER);
+		$sievePassword = $input->getArgument(self::ARGUMENT_SIEVE_PASSWORD);
+
 		$account = new MailAccount();
 		$account->setUserId($userId);
 		$account->setName($name);
@@ -114,6 +131,14 @@ protected function execute(InputInterface $input, OutputInterface $output) {
 		$account->setOutboundUser($smtpUser);
 		$account->setOutboundPassword($this->crypto->encrypt($smtpPassword));
 
+		if ($sieveHost !== null) {
+			$account->setSieveHost($sieveHost);
+			$account->setSievePort($sievePort);
+			$account->setSieveSslMode($sieveSslMode);
+			$account->setSieveUser($sieveUser);
+			$account->setSievePassword($this->crypto->encrypt($sievePassword));
+		}
+
 		$this->accountService->save($account);
 
 		$output->writeln("<info>Account $email created</info>");

lib/Command/ExportAccount.php

@@ -64,6 +64,11 @@ protected function execute(InputInterface $input, OutputInterface $output) {
 			$output->writeln("- IMAP host: " . $account->getMailAccount()->getInboundHost() . ":" . $account->getMailAccount()->getInboundPort() . ", security: " . $account->getMailAccount()->getInboundSslMode());
 			$output->writeln("- SMTP user: " . $account->getMailAccount()->getOutboundUser());
 			$output->writeln("- SMTP host: " . $account->getMailAccount()->getOutboundHost() . ":" . $account->getMailAccount()->getOutboundPort() . ", security: " . $account->getMailAccount()->getOutboundSslMode());
+
+			if ($account->getMailAccount()->getSieveHost()) {
+				$output->writeln("- Sieve user: " . $account->getMailAccount()->getSieveUser());
+				$output->writeln("- Sieve host: " . $account->getMailAccount()->getSieveHost() . ":" . $account->getMailAccount()->getSievePort() . ", security: " . $account->getMailAccount()->getSieveSslMode());
+			}
 		}
 	}
 

lib/Controller/AccountsController.php

@@ -135,6 +135,7 @@ public function show($accountId): JSONResponse {
 	 * @param string $smtpSslMode
 	 * @param string $smtpUser
 	 * @param string $smtpPassword
+	 * @param array|null $sieveConfig
 	 * @param bool $autoDetect
 	 *
 	 * @return JSONResponse
@@ -154,14 +155,22 @@ public function update(int $id,
 						   int $smtpPort = null,
 						   string $smtpSslMode = null,
 						   string $smtpUser = null,
-						   string $smtpPassword = null): JSONResponse {
+						   string $smtpPassword = null,
+						   array $sieveConfig = null): JSONResponse {
 		$account = null;
 		$errorMessage = null;
 		try {
 			if ($autoDetect) {
 				$account = $this->setup->createNewAutoConfiguredAccount($accountName, $emailAddress, $password);
 			} else {
-				$account = $this->setup->createNewAccount($accountName, $emailAddress, $imapHost, $imapPort, $imapSslMode, $imapUser, $imapPassword, $smtpHost, $smtpPort, $smtpSslMode, $smtpUser, $smtpPassword, $this->currentUserId, $id);
+
+				$account = $this->setup->createNewAccount(
+					$accountName, $emailAddress,
+					$imapHost, $imapPort, $imapSslMode, $imapUser, $imapPassword,
+					$smtpHost,$smtpPort, $smtpSslMode, $smtpUser, $smtpPassword,
+					$sieveConfig,
+					$this->currentUserId, $id
+				);
 			}
 		} catch (Exception $ex) {
 			$errorMessage = $ex->getMessage();
@@ -249,19 +258,40 @@ public function destroy($id): JSONResponse {
 	 * @param string $smtpSslMode
 	 * @param string $smtpUser
 	 * @param string $smtpPassword
+	 * @param array|null $sieveConfig
 	 * @param bool $autoDetect
 	 *
 	 * @return JSONResponse
 	 * @throws ClientException
 	 */
-	public function create(string $accountName, string $emailAddress, string $password = null, string $imapHost = null, int $imapPort = null, string $imapSslMode = null, string $imapUser = null, string $imapPassword = null, string $smtpHost = null, int $smtpPort = null, string $smtpSslMode = null, string $smtpUser = null, string $smtpPassword = null, bool $autoDetect = true): JSONResponse {
+	public function create(string $accountName,
+						   string $emailAddress,
+						   string $password = null,
+						   string $imapHost = null,
+						   int $imapPort = null,
+						   string $imapSslMode = null,
+						   string $imapUser = null,
+						   string $imapPassword = null,
+						   string $smtpHost = null,
+						   int $smtpPort = null,
+						   string $smtpSslMode = null,
+						   string $smtpUser = null,
+						   string $smtpPassword = null,
+						   array $sieveConfig = null,
+						   bool $autoDetect = true): JSONResponse {
 		$account = null;
 		$errorMessage = null;
 		try {
 			if ($autoDetect) {
 				$account = $this->setup->createNewAutoConfiguredAccount($accountName, $emailAddress, $password);
 			} else {
-				$account = $this->setup->createNewAccount($accountName, $emailAddress, $imapHost, $imapPort, $imapSslMode, $imapUser, $imapPassword, $smtpHost, $smtpPort, $smtpSslMode, $smtpUser, $smtpPassword, $this->currentUserId);
+				$account = $this->setup->createNewAccount(
+					$accountName, $emailAddress,
+					$imapHost, $imapPort, $imapSslMode, $imapUser, $imapPassword,
+					$smtpHost, $smtpPort, $smtpSslMode, $smtpUser, $smtpPassword,
+					$sieveConfig,
+					$this->currentUserId
+				);
 			}
 		} catch (Exception $ex) {
 			$errorMessage = $ex->getMessage();