Filter mails with Sieve #1822

pierlon · 2019-06-22T06:10:42Z

This PR is intended to fix #44.

Todo:

Configure Sieve settings from account form
Add UI to add and edit filter rules
Add UI to use custom Sieve rule
Add UI to change the active Sieve script
Store Sieve rules in a script on the server
Retrieve Sieve rules from a script on the server
Parse Sieve rules from a script to send to frontend
Compile Sieve rules that are sent from the frontend

ChristophWurst · 2019-06-22T08:07:54Z

Looks great so far! Please coordinate with the others that wanted to work on #44. We should avoid conflicts and duplicate work.

lib/Service/SetupService.php

lib/Account.php

kesselb

I found a migration in my stash. Looks very similar to your migration. We might need a sieve_enable flag: $table->addColumn('sieve_enable', Type::BOOLEAN);

lib/Migration/Version0151Date20190622040212.php

Signed-off-by: Pierre Gordon <pierregordon@protonmail.com>

Co-Authored-By: Daniel Kesselberg <mail@danielkesselberg.de> Signed-off-by: Pierre Gordon <pierregordon@protonmail.com>

Signed-off-by: Pierre Gordon <pierregordon@protonmail.com>

lib/Account.php

lib/Command/CreateAccount.php

lib/Db/MailAccount.php

lib/Service/Sieve/Script.php

Co-Authored-By: Daniel Kesselberg <mail@danielkesselberg.de> Signed-off-by: Pierre Gordon <pierregordon@protonmail.com>

Signed-off-by: Pierre Gordon <pierregordon@protonmail.com>

…/feature/sieve-filters'

merge frontend

ChristophWurst

some early feedback :)

ChristophWurst · 2019-10-18T16:20:20Z

lib/Account.php

+	 * @return ManageSieve
+	 * @throws ManageSieve\Exception
+	 */
+	public function getSieveConnection()


getImapConnection is using an outdated coding style and we're int process of refactoring our code to get rid of the method. Please see the ImapClientFactory and create something similar for Sieve.

ChristophWurst · 2019-10-18T16:21:34Z

lib/Account.php

+	public function getSieveConnection()
+	{
+		if ($this->sieveClient === null) {
+			$host = $this->account->getSieveHost();


Handle accounts without Sieve settings

ChristophWurst · 2019-10-18T16:22:38Z

lib/Controller/SieveController.php

+	 * @param int $accountId
+	 * @return JSONResponse
+	 * @throws AccountException
+	 * @throws \Horde\ManageSieve\Exception


TODO: Catch

ChristophWurst · 2019-10-18T16:22:52Z

lib/Controller/SieveController.php

+	 * @param string $script
+	 * @param string $script_name
+	 * @return JSONResponse
+	 * @throws \Horde\ManageSieve\Exception


TODO: Catch

ChristophWurst · 2019-10-18T16:23:21Z

lib/Controller/SieveController.php

+	 */
+	private function getSieveService(int $accountId): SieveService
+	{
+		$account = $this->accountService->find($this->currentUser->getUID(), $accountId);


TODO: handle account not found error

ChristophWurst · 2019-10-18T16:33:56Z

lib/Service/SieveService.php

+			return $this->installRawScript($script);
+		}
+
+		return ['status' => 'error', 'message' => 'Not implemented'];


ChristophWurst · 2019-10-18T16:34:06Z

lib/Service/SieveService.php

+			$this->installScript($script);
+			return ['status' => 'success'];
+		} else {
+			return ['status' => 'error', 'message' => $script->getParseError()];


ChristophWurst · 2019-10-18T16:34:41Z

package.json

@@ -15,6 +15,8 @@
    "test:watch": "mochapack -w --webpack-config webpack.test.js --require src/tests/setup.js \"src/tests/**/*.spec.js\""
  },
  "dependencies": {
+    "@saeris/vue-spinners": "^1.0.8",


TODO: use Nextcloud's icon-loading/icon-loading-small instead

ChristophWurst · 2019-10-18T16:35:28Z

package.json

@@ -56,12 +58,15 @@
    "vue-autosize": "^1.0.2",
    "vue-click-outside": "^1.0.7",
    "vue-infinite-scroll": "^2.0.2",
+    "vue-m-message": "^2.0.0",


TODO: use OC.Notification.showTemporary(...) instead

ChristophWurst · 2019-10-18T16:35:49Z

package.json

    "vue-on-click-outside": "^1.0.3",
    "vue-router": "^3.1.3",
    "vue-scroll": "^2.1.12",
+    "vue-select": "^3.1.0",


TODO: use Multiselect from nextcloud/vue instead

LorbusChris · 2020-02-19T21:34:55Z

@pierlon any updates?

jancborchardt · 2020-03-24T15:17:02Z

@pierlon @mmittelb do you have any new developments here? :) Or @kesselb maybe you want to take this over?

Let me know when or if you need any design input.

jancborchardt · 2020-03-26T16:45:12Z

Currently there are some merge conflicts. @nextcloud/mail does anyone want to look into resolving them and/or taking this over? :)

ChristophWurst · 2020-03-26T18:18:38Z

Whoever takes this over should first get in contact with the original authors so there is no conflict on who may eventually claim the bounty.

LorbusChris · 2020-05-06T01:57:12Z

friendly ping @pierlon @mmittelb
(as a little incentive I've increased the bounty a bit -- if you get this done within the next 3mo)

ChristophWurst · 2020-05-06T06:48:10Z

@nextcloud/mail at which point will we just assume that this incentive is dead? We want to have this feature eventually but since I've been wrongly accused of taking away bounties from community people I'm not willing to take this over unless the original authors can clarify #1822 (comment). @pierlon @mmittelb would you have a minute to comment?

ChristophWurst · 2020-05-06T06:49:29Z

@nextcloud/mail at which point will we just assume that this incentive is dead?

Currently it's been 165d since the latest commit.

pierlon · 2020-05-06T08:03:02Z

Much apologies for not replying as quickly as possible here, but unfortunately I won't be able to continue where I left off. I hope the work done so far will serve as a basis and guide for the additional code to be written, and I do wish all the best for my successor.

With that said, if I recall correctly I believe the "TODO" section in the description above is still accurate and those are still outstanding. I may have done some more work on the UI for adding and customizing filters that were not pushed; if I am able to find it I will update this PR with the changes.

dehnhardt · 2020-05-26T13:40:10Z

Sieve filters are a pretty important thing to me. I would try to move on here - even though I might need help for frontend things.
However, I do not know how to take over a pull request in a meaningful way.
Since there are many merge conflicts now, I tend to create a new pull request. Does that make sense?

hashworks · 2020-05-26T13:57:04Z

Does that make sense?

I think so. The only other option would be pull requests to pierlon:feature/sieve-filters that he would need to merge. But I guess it's better you fork from that branch.

ChristophWurst · 2020-05-26T16:43:54Z

I would try to move on here

@dehnhardt please coordinate with the original authors regarding #1822 (comment) and how you want to handle the bounty.

dehnhardt · 2020-05-26T20:21:18Z

Ups, haven't seen the bounty. Ok, I will get in touch with pierlon.
Thanks for reminding me!

dehnhardt · 2020-05-27T13:09:10Z

@pierlon : Dear Pierre, I want to try to finish this ManageSieve extension.
@ChristophWurst pointed out to me that there are bounties for it. I think you did a good part of the implementation, so you should decide what to do with the bounties;-)
Can you give some feedback?
Thanks Holger
@ChristophWurst is there a possibility to contact @pierlon directly?

ChristophWurst · 2020-05-27T13:11:02Z

@ChristophWurst is there a possibility to contact @pierlon directly?

You can try the email from the commit 6d7b0dc

pierlon · 2020-05-28T09:26:31Z

@ChristophWurst pointed out to me that there are bounties for it. I think you did a good part of the implementation, so you should decide what to do with the bounties;-)
Can you give some feedback?

Hey @dehnhardt, I'd leave that up to you. I did put a lot of hard work into this quite some time ago, but I believe the person who is able to bring this across the finish line deserves as much respect and praise as I would have received if I did.

dehnhardt · 2020-05-28T11:08:52Z

@pierlon, then we'll see if I get further than you and if this is the case we'll toss a coin;-)

ChristophWurst · 2021-02-26T13:26:14Z

Hi 👋,

we are about to merge #4472. This isn't the full sieve feature but merely the basics with sieve credentials, provisioning and so on and "just" a basic UI, but this will be the foundation for any other enhancements. Therefore I'm closing this PR and the other one.

Thanks a lot everyone who has helped move this forward. Even if this PR wasn't integrated it was a huge help for Daniel's implementation.

✌️

pierlon requested a review from ChristophWurst June 22, 2019 06:10