From d8065e3f5a988e14b2b972b73ed0d5b06c1a2978 Mon Sep 17 00:00:00 2001
From: shamoon <4887959+shamoon@users.noreply.github.com>
Date: Mon, 18 Sep 2023 12:01:21 -0700
Subject: [PATCH] Allow mail rules to not set title or owner

---
 .../mail-rule-edit-dialog.component.html      |  1 +
 .../mail-rule-edit-dialog.component.spec.ts   |  2 ++
 .../mail-rule-edit-dialog.component.ts        |  5 +++
 src-ui/src/app/data/paperless-mail-rule.ts    |  3 ++
 .../services/rest/mail-rule.service.spec.ts   |  3 ++
 .../tests/test_consumption_templates.py       |  3 +-
 src/paperless_mail/mail.py                    |  7 +++-
 ...ailrule_assign_owner_from_rule_and_more.py | 34 +++++++++++++++++++
 src/paperless_mail/models.py                  |  6 ++++
 src/paperless_mail/serialisers.py             |  1 +
 src/paperless_mail/tests/test_api.py          |  5 +++
 src/paperless_mail/tests/test_mail.py         |  5 +++
 12 files changed, 73 insertions(+), 2 deletions(-)
 create mode 100644 src/paperless_mail/migrations/0022_mailrule_assign_owner_from_rule_and_more.py

diff --git a/src-ui/src/app/components/common/edit-dialog/mail-rule-edit-dialog/mail-rule-edit-dialog.component.html b/src-ui/src/app/components/common/edit-dialog/mail-rule-edit-dialog/mail-rule-edit-dialog.component.html
index b45035a4d..869ba12ec 100644
--- a/src-ui/src/app/components/common/edit-dialog/mail-rule-edit-dialog/mail-rule-edit-dialog.component.html
+++ b/src-ui/src/app/components/common/edit-dialog/mail-rule-edit-dialog/mail-rule-edit-dialog.component.html
@@ -32,6 +32,7 @@
         <pngx-input-select i18n-title title="Assign document type" [items]="documentTypes" [allowNull]="true" formControlName="assign_document_type"></pngx-input-select>
         <pngx-input-select i18n-title title="Assign correspondent from" [items]="metadataCorrespondentOptions" formControlName="assign_correspondent_from"></pngx-input-select>
         <pngx-input-select *ngIf="showCorrespondentField" i18n-title title="Assign correspondent" [items]="correspondents" [allowNull]="true" formControlName="assign_correspondent"></pngx-input-select>
+        <pngx-input-check i18n-title title="Assign owner from rule" formControlName="assign_owner_from_rule"></pngx-input-check>
       </div>
     </div>
   </div>
diff --git a/src-ui/src/app/components/common/edit-dialog/mail-rule-edit-dialog/mail-rule-edit-dialog.component.spec.ts b/src-ui/src/app/components/common/edit-dialog/mail-rule-edit-dialog/mail-rule-edit-dialog.component.spec.ts
index 5d089005b..b2876c6ad 100644
--- a/src-ui/src/app/components/common/edit-dialog/mail-rule-edit-dialog/mail-rule-edit-dialog.component.spec.ts
+++ b/src-ui/src/app/components/common/edit-dialog/mail-rule-edit-dialog/mail-rule-edit-dialog.component.spec.ts
@@ -21,6 +21,7 @@ import {
   MailAction,
   MailMetadataCorrespondentOption,
 } from 'src/app/data/paperless-mail-rule'
+import { CheckComponent } from '../../input/check/check.component'
 
 describe('MailRuleEditDialogComponent', () => {
   let component: MailRuleEditDialogComponent
@@ -41,6 +42,7 @@ describe('MailRuleEditDialogComponent', () => {
         NumberComponent,
         TagsComponent,
         SafeHtmlPipe,
+        CheckComponent,
       ],
       providers: [
         NgbActiveModal,
diff --git a/src-ui/src/app/components/common/edit-dialog/mail-rule-edit-dialog/mail-rule-edit-dialog.component.ts b/src-ui/src/app/components/common/edit-dialog/mail-rule-edit-dialog/mail-rule-edit-dialog.component.ts
index bddecf204..1de036847 100644
--- a/src-ui/src/app/components/common/edit-dialog/mail-rule-edit-dialog/mail-rule-edit-dialog.component.ts
+++ b/src-ui/src/app/components/common/edit-dialog/mail-rule-edit-dialog/mail-rule-edit-dialog.component.ts
@@ -79,6 +79,10 @@ const METADATA_TITLE_OPTIONS = [
     id: MailMetadataTitleOption.FromFilename,
     name: $localize`Use attachment filename as title`,
   },
+  {
+    id: MailMetadataTitleOption.None,
+    name: $localize`Do not assign title from this rule`,
+  },
 ]
 
 const METADATA_CORRESPONDENT_OPTIONS = [
@@ -168,6 +172,7 @@ export class MailRuleEditDialogComponent extends EditDialogComponent<PaperlessMa
         MailMetadataCorrespondentOption.FromNothing
       ),
       assign_correspondent: new FormControl(null),
+      assign_owner_from_rule: new FormControl(true),
     })
   }
 
diff --git a/src-ui/src/app/data/paperless-mail-rule.ts b/src-ui/src/app/data/paperless-mail-rule.ts
index 63351fe3e..cc1bea0e7 100644
--- a/src-ui/src/app/data/paperless-mail-rule.ts
+++ b/src-ui/src/app/data/paperless-mail-rule.ts
@@ -22,6 +22,7 @@ export enum MailAction {
 export enum MailMetadataTitleOption {
   FromSubject = 1,
   FromFilename = 2,
+  None = 3,
 }
 
 export enum MailMetadataCorrespondentOption {
@@ -67,4 +68,6 @@ export interface PaperlessMailRule extends ObjectWithPermissions {
   assign_correspondent_from?: MailMetadataCorrespondentOption
 
   assign_correspondent?: number // PaperlessCorrespondent.id
+
+  assign_owner_from_rule: boolean
 }
diff --git a/src-ui/src/app/services/rest/mail-rule.service.spec.ts b/src-ui/src/app/services/rest/mail-rule.service.spec.ts
index daff57341..a83827182 100644
--- a/src-ui/src/app/services/rest/mail-rule.service.spec.ts
+++ b/src-ui/src/app/services/rest/mail-rule.service.spec.ts
@@ -28,6 +28,7 @@ const mail_rules = [
     attachment_type: MailFilterAttachmentType.Everything,
     action: MailAction.MarkRead,
     assign_title_from: MailMetadataTitleOption.FromSubject,
+    assign_owner_from_rule: true,
   },
   {
     name: 'Mail Rule 2',
@@ -44,6 +45,7 @@ const mail_rules = [
     attachment_type: MailFilterAttachmentType.Everything,
     action: MailAction.Delete,
     assign_title_from: MailMetadataTitleOption.FromSubject,
+    assign_owner_from_rule: true,
   },
   {
     name: 'Mail Rule 3',
@@ -60,6 +62,7 @@ const mail_rules = [
     attachment_type: MailFilterAttachmentType.Everything,
     action: MailAction.Flag,
     assign_title_from: MailMetadataTitleOption.FromSubject,
+    assign_owner_from_rule: false,
   },
 ]
 
diff --git a/src/documents/tests/test_consumption_templates.py b/src/documents/tests/test_consumption_templates.py
index 1f61c90a3..7e1bb3d6e 100644
--- a/src/documents/tests/test_consumption_templates.py
+++ b/src/documents/tests/test_consumption_templates.py
@@ -128,10 +128,11 @@ class TestConsumptionTemplates(DirectoriesMixin, FileSystemAssertsMixin, TestCas
             filter_attachment_filename="file.pdf",
             maximum_age=30,
             action=MailRule.MailAction.MARK_READ,
-            assign_title_from=MailRule.TitleSource.FROM_SUBJECT,
+            assign_title_from=MailRule.TitleSource.NONE,
             assign_correspondent_from=MailRule.CorrespondentSource.FROM_NOTHING,
             order=0,
             attachment_type=MailRule.AttachmentProcessing.ATTACHMENTS_ONLY,
+            assign_owner_from_rule=False,
         )
         ct = ConsumptionTemplate.objects.create(
             name="Template 1",
diff --git a/src/paperless_mail/mail.py b/src/paperless_mail/mail.py
index a22bc2df9..0157ea773 100644
--- a/src/paperless_mail/mail.py
+++ b/src/paperless_mail/mail.py
@@ -436,6 +436,9 @@ class MailAccountHandler(LoggingMixin):
         elif rule.assign_title_from == MailRule.TitleSource.FROM_FILENAME:
             return os.path.splitext(os.path.basename(att.filename))[0]
 
+        elif rule.assign_title_from == MailRule.TitleSource.NONE:
+            return None
+
         else:
             raise NotImplementedError(
                 "Unknown title selector.",
@@ -698,7 +701,9 @@ class MailAccountHandler(LoggingMixin):
                     correspondent_id=correspondent.id if correspondent else None,
                     document_type_id=doc_type.id if doc_type else None,
                     tag_ids=tag_ids,
-                    owner_id=rule.owner.id if rule.owner else None,
+                    owner_id=rule.owner.id
+                    if (rule.assign_owner_from_rule and rule.owner)
+                    else None,
                 )
 
                 consume_task = consume_file.s(
diff --git a/src/paperless_mail/migrations/0022_mailrule_assign_owner_from_rule_and_more.py b/src/paperless_mail/migrations/0022_mailrule_assign_owner_from_rule_and_more.py
new file mode 100644
index 000000000..f2c59a5bf
--- /dev/null
+++ b/src/paperless_mail/migrations/0022_mailrule_assign_owner_from_rule_and_more.py
@@ -0,0 +1,34 @@
+# Generated by Django 4.1.11 on 2023-09-18 18:50
+
+from django.db import migrations
+from django.db import models
+
+
+class Migration(migrations.Migration):
+    dependencies = [
+        ("paperless_mail", "0021_alter_mailaccount_password"),
+    ]
+
+    operations = [
+        migrations.AddField(
+            model_name="mailrule",
+            name="assign_owner_from_rule",
+            field=models.BooleanField(
+                default=True,
+                verbose_name="Assign the rule owner to documents",
+            ),
+        ),
+        migrations.AlterField(
+            model_name="mailrule",
+            name="assign_title_from",
+            field=models.PositiveIntegerField(
+                choices=[
+                    (1, "Use subject as title"),
+                    (2, "Use attachment filename as title"),
+                    (3, "Do not assign title from rule"),
+                ],
+                default=1,
+                verbose_name="assign title from",
+            ),
+        ),
+    ]
diff --git a/src/paperless_mail/models.py b/src/paperless_mail/models.py
index 3ea0619d9..6f1896f1f 100644
--- a/src/paperless_mail/models.py
+++ b/src/paperless_mail/models.py
@@ -82,6 +82,7 @@ class MailRule(document_models.ModelWithOwner):
     class TitleSource(models.IntegerChoices):
         FROM_SUBJECT = 1, _("Use subject as title")
         FROM_FILENAME = 2, _("Use attachment filename as title")
+        NONE = 3, _("Do not assign title from rule")
 
     class CorrespondentSource(models.IntegerChoices):
         FROM_NOTHING = 1, _("Do not assign a correspondent")
@@ -225,6 +226,11 @@ class MailRule(document_models.ModelWithOwner):
         verbose_name=_("assign this correspondent"),
     )
 
+    assign_owner_from_rule = models.BooleanField(
+        _("Assign the rule owner to documents"),
+        default=True,
+    )
+
     def __str__(self):
         return f"{self.account.name}.{self.name}"
 
diff --git a/src/paperless_mail/serialisers.py b/src/paperless_mail/serialisers.py
index bdecff11e..e5da4a7da 100644
--- a/src/paperless_mail/serialisers.py
+++ b/src/paperless_mail/serialisers.py
@@ -88,6 +88,7 @@ class MailRuleSerializer(OwnedObjectSerializer):
             "assign_correspondent_from",
             "assign_correspondent",
             "assign_document_type",
+            "assign_owner_from_rule",
             "order",
             "attachment_type",
             "consumption_scope",
diff --git a/src/paperless_mail/tests/test_api.py b/src/paperless_mail/tests/test_api.py
index a9e88e4ad..a02057114 100644
--- a/src/paperless_mail/tests/test_api.py
+++ b/src/paperless_mail/tests/test_api.py
@@ -464,6 +464,7 @@ class TestAPIMailRules(DirectoriesMixin, APITestCase):
             "assign_tags": [tag.pk],
             "assign_correspondent": correspondent.pk,
             "assign_document_type": document_type.pk,
+            "assign_owner_from_rule": True,
         }
 
         response = self.client.post(
@@ -512,6 +513,10 @@ class TestAPIMailRules(DirectoriesMixin, APITestCase):
             rule1["assign_document_type"],
         )
         self.assertEqual(returned_rule1["assign_tags"], rule1["assign_tags"])
+        self.assertEqual(
+            returned_rule1["assign_owner_from_rule"],
+            rule1["assign_owner_from_rule"],
+        )
 
     def test_delete_mail_rule(self):
         """
diff --git a/src/paperless_mail/tests/test_mail.py b/src/paperless_mail/tests/test_mail.py
index 38585d9f2..48b1e1a7a 100644
--- a/src/paperless_mail/tests/test_mail.py
+++ b/src/paperless_mail/tests/test_mail.py
@@ -392,6 +392,11 @@ class TestMail(
             assign_title_from=MailRule.TitleSource.FROM_SUBJECT,
         )
         self.assertEqual(handler._get_title(message, att, rule), "the message title")
+        rule = MailRule(
+            name="b",
+            assign_title_from=MailRule.TitleSource.NONE,
+        )
+        self.assertEqual(handler._get_title(message, att, rule), None)
 
     def test_handle_message(self):
         message = self.create_message(