diff --git a/src-ui/cypress/e2e/settings/settings.cy.ts b/src-ui/cypress/e2e/settings/settings.cy.ts index 0480e39ce..aa59997d4 100644 --- a/src-ui/cypress/e2e/settings/settings.cy.ts +++ b/src-ui/cypress/e2e/settings/settings.cy.ts @@ -35,6 +35,16 @@ describe('settings', () => { req.reply(response) } ).as('savedViews') + + cy.intercept('http://localhost:8000/api/mail_accounts/*', { + fixture: 'mail_accounts/mail_accounts.json', + }) + cy.intercept('http://localhost:8000/api/mail_rules/*', { + fixture: 'mail_rules/mail_rules.json', + }).as('mailRules') + cy.intercept('http://localhost:8000/api/tasks/', { + fixture: 'tasks/tasks.json', + }) }) cy.fixture('documents/documents.json').then((documentsJson) => { @@ -48,7 +58,6 @@ describe('settings', () => { cy.viewport(1024, 1600) cy.visit('/settings') - cy.wait('@savedViews') }) it('should activate / deactivate save button when settings change and are saved', () => { @@ -64,7 +73,7 @@ describe('settings', () => { cy.contains('a', 'Dashboard').click() cy.contains('You have unsaved changes') cy.contains('button', 'Cancel').click() - cy.contains('button', 'Save').click().wait('@savedViews') + cy.contains('button', 'Save').click().wait('@savedViews').wait(2000) cy.contains('a', 'Dashboard').click() cy.contains('You have unsaved changes').should('not.exist') }) @@ -77,16 +86,16 @@ describe('settings', () => { }) it('should remove saved view from sidebar when unset', () => { - cy.contains('a', 'Saved views').click() + cy.contains('a', 'Saved views').click().wait(2000) cy.get('#show_in_sidebar_1').click() - cy.contains('button', 'Save').click().wait('@savedViews') + cy.contains('button', 'Save').click().wait('@savedViews').wait(2000) cy.contains('li', 'Inbox').should('not.exist') }) it('should remove saved view from dashboard when unset', () => { cy.contains('a', 'Saved views').click() cy.get('#show_on_dashboard_1').click() - cy.contains('button', 'Save').click().wait('@savedViews') + cy.contains('button', 'Save').click().wait('@savedViews').wait(2000) cy.visit('/dashboard') cy.get('app-saved-view-widget').contains('Inbox').should('not.exist') }) diff --git a/src-ui/cypress/fixtures/mail_accounts/mail_accounts.json b/src-ui/cypress/fixtures/mail_accounts/mail_accounts.json new file mode 100644 index 000000000..19c45b15a --- /dev/null +++ b/src-ui/cypress/fixtures/mail_accounts/mail_accounts.json @@ -0,0 +1,27 @@ +{ + "count": 2, + "next": null, + "previous": null, + "results": [ + { + "id": 1, + "name": "IMAP Server", + "imap_server": "imap.example.com", + "imap_port": 993, + "imap_security": 2, + "username": "inbox@example.com", + "password": "pass", + "character_set": "UTF-8" + }, + { + "id": 2, + "name": "Gmail", + "imap_server": "imap.gmail.com", + "imap_port": 993, + "imap_security": 2, + "username": "user@gmail.com", + "password": "pass", + "character_set": "UTF-8" + } + ] +} diff --git a/src-ui/cypress/fixtures/mail_rules/mail_rules.json b/src-ui/cypress/fixtures/mail_rules/mail_rules.json new file mode 100644 index 000000000..a2c59c5c6 --- /dev/null +++ b/src-ui/cypress/fixtures/mail_rules/mail_rules.json @@ -0,0 +1,29 @@ +{ + "count": 1, + "next": null, + "previous": null, + "results": [ + { + "id": 1, + "name": "Gmail", + "account": 2, + "folder": "INBOX", + "filter_from": null, + "filter_subject": "[paperless]", + "filter_body": null, + "filter_attachment_filename": null, + "maximum_age": 30, + "action": 3, + "action_parameter": null, + "assign_title_from": 1, + "assign_tags": [ + 9 + ], + "assign_correspondent_from": 1, + "assign_correspondent": 2, + "assign_document_type": null, + "order": 0, + "attachment_type": 2 + } + ] +} diff --git a/src-ui/cypress/fixtures/saved_views/savedviews.json b/src-ui/cypress/fixtures/saved_views/savedviews.json index 003bd900a..64afcf3dc 100644 --- a/src-ui/cypress/fixtures/saved_views/savedviews.json +++ b/src-ui/cypress/fixtures/saved_views/savedviews.json @@ -1 +1,44 @@ -{"count":3,"next":null,"previous":null,"results":[{"id":1,"name":"Inbox","show_on_dashboard":true,"show_in_sidebar":true,"sort_field":"created","sort_reverse":true,"filter_rules":[{"rule_type":6,"value":"18"}]},{"id":2,"name":"Recently Added","show_on_dashboard":true,"show_in_sidebar":false,"sort_field":"created","sort_reverse":true,"filter_rules":[]},{"id":11,"name":"Taxes","show_on_dashboard":false,"show_in_sidebar":true,"sort_field":"created","sort_reverse":true,"filter_rules":[{"rule_type":6,"value":"39"}]}]} +{ + "count": 3, + "next": null, + "previous": null, + "results": [ + { + "id": 1, + "name": "Inbox", + "show_on_dashboard": true, + "show_in_sidebar": true, + "sort_field": "created", + "sort_reverse": true, + "filter_rules": [ + { + "rule_type": 6, + "value": "18" + } + ] + }, + { + "id": 2, + "name": "Recently Added", + "show_on_dashboard": true, + "show_in_sidebar": false, + "sort_field": "created", + "sort_reverse": true, + "filter_rules": [] + }, + { + "id": 11, + "name": "Taxes", + "show_on_dashboard": false, + "show_in_sidebar": true, + "sort_field": "created", + "sort_reverse": true, + "filter_rules": [ + { + "rule_type": 6, + "value": "39" + } + ] + } + ] +} diff --git a/src-ui/messages.xlf b/src-ui/messages.xlf index 5e451935a..da0fb042c 100644 --- a/src-ui/messages.xlf +++ b/src-ui/messages.xlf @@ -370,46 +370,39 @@ 185 - - Check out the settings for various tweaks to the web app or to toggle settings for saved views. + + Check out the settings for various tweaks to the web app, toggle settings for saved views or setup e-mail checking. src/app/app.component.ts 194 - - The Admin area contains more advanced controls as well as the settings for automatic e-mail fetching. - - src/app/app.component.ts - 203 - - Thank you! 🙏 src/app/app.component.ts - 211 + 203 There are <em>tons</em> more features and info we didn't cover here, but this should get you started. Check out the documentation or visit the project on GitHub to learn more or to report issues. src/app/app.component.ts - 213 + 205 Lastly, on behalf of every contributor to this community-supported project, thank you for using Paperless-ngx! src/app/app.component.ts - 215 + 207 Initiating upload... src/app/app.component.ts - 264 + 256 @@ -514,7 +507,7 @@ src/app/components/manage/settings/settings.component.html - 184 + 189 @@ -631,22 +624,11 @@ 1 - - Admin - - src/app/components/app-frame/app-frame.component.html - 178 - - - src/app/components/app-frame/app-frame.component.html - 181 - - Info src/app/components/app-frame/app-frame.component.html - 187 + 180 src/app/components/manage/tasks/tasks.component.html @@ -657,68 +639,68 @@ Documentation src/app/components/app-frame/app-frame.component.html - 191 + 184 src/app/components/app-frame/app-frame.component.html - 194 + 187 GitHub src/app/components/app-frame/app-frame.component.html - 199 + 192 src/app/components/app-frame/app-frame.component.html - 202 + 195 Suggest an idea src/app/components/app-frame/app-frame.component.html - 204 + 197 src/app/components/app-frame/app-frame.component.html - 208 + 201 is available. src/app/components/app-frame/app-frame.component.html - 217 + 210 Click to view. src/app/components/app-frame/app-frame.component.html - 217 + 210 Paperless-ngx can automatically check for updates src/app/components/app-frame/app-frame.component.html - 221 + 214 How does this work? src/app/components/app-frame/app-frame.component.html - 228,230 + 221,223 Update available src/app/components/app-frame/app-frame.component.html - 239 + 232 @@ -729,7 +711,7 @@ src/app/components/manage/settings/settings.component.ts - 326 + 476 @@ -843,6 +825,14 @@ src/app/components/common/edit-dialog/document-type-edit-dialog/document-type-edit-dialog.component.html 9 + + src/app/components/common/edit-dialog/mail-account-edit-dialog/mail-account-edit-dialog.component.html + 10 + + + src/app/components/common/edit-dialog/mail-rule-edit-dialog/mail-rule-edit-dialog.component.html + 10 + src/app/components/common/edit-dialog/storage-path-edit-dialog/storage-path-edit-dialog.component.html 13 @@ -889,7 +879,15 @@ src/app/components/manage/settings/settings.component.html - 191 + 196 + + + src/app/components/manage/settings/settings.component.html + 248 + + + src/app/components/manage/settings/settings.component.html + 283 src/app/components/manage/tasks/tasks.component.html @@ -963,6 +961,14 @@ src/app/components/common/edit-dialog/document-type-edit-dialog/document-type-edit-dialog.component.html 16 + + src/app/components/common/edit-dialog/mail-account-edit-dialog/mail-account-edit-dialog.component.html + 23 + + + src/app/components/common/edit-dialog/mail-rule-edit-dialog/mail-rule-edit-dialog.component.html + 35 + src/app/components/common/edit-dialog/storage-path-edit-dialog/storage-path-edit-dialog.component.html 21 @@ -994,6 +1000,14 @@ src/app/components/common/edit-dialog/document-type-edit-dialog/document-type-edit-dialog.component.html 17 + + src/app/components/common/edit-dialog/mail-account-edit-dialog/mail-account-edit-dialog.component.html + 24 + + + src/app/components/common/edit-dialog/mail-rule-edit-dialog/mail-rule-edit-dialog.component.html + 36 + src/app/components/common/edit-dialog/storage-path-edit-dialog/storage-path-edit-dialog.component.html 22 @@ -1012,56 +1026,424 @@ src/app/components/manage/settings/settings.component.html - 223 + 317 Create new correspondent src/app/components/common/edit-dialog/correspondent-edit-dialog/correspondent-edit-dialog.component.ts - 25 + 20 Edit correspondent src/app/components/common/edit-dialog/correspondent-edit-dialog/correspondent-edit-dialog.component.ts - 29 + 24 Create new document type src/app/components/common/edit-dialog/document-type-edit-dialog/document-type-edit-dialog.component.ts - 25 + 20 Edit document type src/app/components/common/edit-dialog/document-type-edit-dialog/document-type-edit-dialog.component.ts - 29 + 24 Create new item src/app/components/common/edit-dialog/edit-dialog.component.ts - 52 + 49 Edit item src/app/components/common/edit-dialog/edit-dialog.component.ts - 56 + 53 Could not save element: src/app/components/common/edit-dialog/edit-dialog.component.ts - 60 + 57 + + + + IMAP Server + + src/app/components/common/edit-dialog/mail-account-edit-dialog/mail-account-edit-dialog.component.html + 11 + + + + IMAP Port + + src/app/components/common/edit-dialog/mail-account-edit-dialog/mail-account-edit-dialog.component.html + 12 + + + + IMAP Security + + src/app/components/common/edit-dialog/mail-account-edit-dialog/mail-account-edit-dialog.component.html + 13 + + + + Username + + src/app/components/common/edit-dialog/mail-account-edit-dialog/mail-account-edit-dialog.component.html + 16 + + + + Password + + src/app/components/common/edit-dialog/mail-account-edit-dialog/mail-account-edit-dialog.component.html + 17 + + + + Character Set + + src/app/components/common/edit-dialog/mail-account-edit-dialog/mail-account-edit-dialog.component.html + 18 + + + + Create new mail account + + src/app/components/common/edit-dialog/mail-account-edit-dialog/mail-account-edit-dialog.component.ts + 22 + + + + Edit mail account + + src/app/components/common/edit-dialog/mail-account-edit-dialog/mail-account-edit-dialog.component.ts + 26 + + + + No encryption + + src/app/components/common/edit-dialog/mail-account-edit-dialog/mail-account-edit-dialog.component.ts + 43 + + + + SSL + + src/app/components/common/edit-dialog/mail-account-edit-dialog/mail-account-edit-dialog.component.ts + 44 + + + + STARTTLS + + src/app/components/common/edit-dialog/mail-account-edit-dialog/mail-account-edit-dialog.component.ts + 45 + + + + Account + + src/app/components/common/edit-dialog/mail-rule-edit-dialog/mail-rule-edit-dialog.component.html + 11 + + + src/app/components/manage/settings/settings.component.html + 284 + + + + Folder + + src/app/components/common/edit-dialog/mail-rule-edit-dialog/mail-rule-edit-dialog.component.html + 12 + + + + Subfolders must be separated by a delimiter, often a dot ('.') or slash ('/'), but it varies by mail server. + + src/app/components/common/edit-dialog/mail-rule-edit-dialog/mail-rule-edit-dialog.component.html + 12 + + + + Maximum age (days) + + src/app/components/common/edit-dialog/mail-rule-edit-dialog/mail-rule-edit-dialog.component.html + 13 + + + + Attachment type + + src/app/components/common/edit-dialog/mail-rule-edit-dialog/mail-rule-edit-dialog.component.html + 14 + + + + Paperless will only process mails that match all of the filters specified below. + + src/app/components/common/edit-dialog/mail-rule-edit-dialog/mail-rule-edit-dialog.component.html + 17 + + + + Filter from + + src/app/components/common/edit-dialog/mail-rule-edit-dialog/mail-rule-edit-dialog.component.html + 18 + + + + Filter subject + + src/app/components/common/edit-dialog/mail-rule-edit-dialog/mail-rule-edit-dialog.component.html + 19 + + + + Filter body + + src/app/components/common/edit-dialog/mail-rule-edit-dialog/mail-rule-edit-dialog.component.html + 20 + + + + Filter attachment filename + + src/app/components/common/edit-dialog/mail-rule-edit-dialog/mail-rule-edit-dialog.component.html + 21 + + + + Only consume documents which entirely match this filename if specified. Wildcards such as *.pdf or *invoice* are allowed. Case insensitive. + + src/app/components/common/edit-dialog/mail-rule-edit-dialog/mail-rule-edit-dialog.component.html + 21 + + + + Action + + src/app/components/common/edit-dialog/mail-rule-edit-dialog/mail-rule-edit-dialog.component.html + 24 + + + + Action is only performed when documents are consumed from the mail. Mails without attachments remain entirely untouched. + + src/app/components/common/edit-dialog/mail-rule-edit-dialog/mail-rule-edit-dialog.component.html + 24 + + + + Action parameter + + src/app/components/common/edit-dialog/mail-rule-edit-dialog/mail-rule-edit-dialog.component.html + 25 + + + + Assign title from + + src/app/components/common/edit-dialog/mail-rule-edit-dialog/mail-rule-edit-dialog.component.html + 26 + + + + Assign document type + + src/app/components/common/edit-dialog/mail-rule-edit-dialog/mail-rule-edit-dialog.component.html + 28 + + + + Assign correspondent from + + src/app/components/common/edit-dialog/mail-rule-edit-dialog/mail-rule-edit-dialog.component.html + 29 + + + + Assign correspondent + + src/app/components/common/edit-dialog/mail-rule-edit-dialog/mail-rule-edit-dialog.component.html + 30 + + + + Create new mail rule + + src/app/components/common/edit-dialog/mail-rule-edit-dialog/mail-rule-edit-dialog.component.ts + 57 + + + + Edit mail rule + + src/app/components/common/edit-dialog/mail-rule-edit-dialog/mail-rule-edit-dialog.component.ts + 61 + + + + Only process attachments. + + src/app/components/common/edit-dialog/mail-rule-edit-dialog/mail-rule-edit-dialog.component.ts + 98 + + + + Process all files, including 'inline' attachments. + + src/app/components/common/edit-dialog/mail-rule-edit-dialog/mail-rule-edit-dialog.component.ts + 102 + + + + Delete + + src/app/components/common/edit-dialog/mail-rule-edit-dialog/mail-rule-edit-dialog.component.ts + 111 + + + src/app/components/document-detail/document-detail.component.html + 11 + + + src/app/components/document-list/bulk-editor/bulk-editor.component.html + 97 + + + src/app/components/manage/management-list/management-list.component.html + 46 + + + src/app/components/manage/management-list/management-list.component.html + 46 + + + src/app/components/manage/management-list/management-list.component.html + 46 + + + src/app/components/manage/management-list/management-list.component.html + 46 + + + src/app/components/manage/management-list/management-list.component.html + 65 + + + src/app/components/manage/management-list/management-list.component.html + 65 + + + src/app/components/manage/management-list/management-list.component.html + 65 + + + src/app/components/manage/management-list/management-list.component.html + 65 + + + src/app/components/manage/management-list/management-list.component.ts + 181 + + + src/app/components/manage/settings/settings.component.html + 214 + + + src/app/components/manage/settings/settings.component.html + 261 + + + src/app/components/manage/settings/settings.component.html + 296 + + + + Move to specified folder + + src/app/components/common/edit-dialog/mail-rule-edit-dialog/mail-rule-edit-dialog.component.ts + 115 + + + + Mark as read, don't process read mails + + src/app/components/common/edit-dialog/mail-rule-edit-dialog/mail-rule-edit-dialog.component.ts + 119 + + + + Flag the mail, don't process flagged mails + + src/app/components/common/edit-dialog/mail-rule-edit-dialog/mail-rule-edit-dialog.component.ts + 123 + + + + Tag the mail with specified tag, don't process tagged mails + + src/app/components/common/edit-dialog/mail-rule-edit-dialog/mail-rule-edit-dialog.component.ts + 127 + + + + Use subject as title + + src/app/components/common/edit-dialog/mail-rule-edit-dialog/mail-rule-edit-dialog.component.ts + 136 + + + + Use attachment filename as title + + src/app/components/common/edit-dialog/mail-rule-edit-dialog/mail-rule-edit-dialog.component.ts + 140 + + + + Do not assign a correspondent + + src/app/components/common/edit-dialog/mail-rule-edit-dialog/mail-rule-edit-dialog.component.ts + 149 + + + + Use mail address + + src/app/components/common/edit-dialog/mail-rule-edit-dialog/mail-rule-edit-dialog.component.ts + 153 + + + + Use name (or mail address if not available) + + src/app/components/common/edit-dialog/mail-rule-edit-dialog/mail-rule-edit-dialog.component.ts + 157 + + + + Use correspondent selected below + + src/app/components/common/edit-dialog/mail-rule-edit-dialog/mail-rule-edit-dialog.component.ts + 161 @@ -1086,35 +1468,35 @@ e.g. src/app/components/common/edit-dialog/storage-path-edit-dialog/storage-path-edit-dialog.component.ts - 26 + 21 or use slashes to add directories e.g. src/app/components/common/edit-dialog/storage-path-edit-dialog/storage-path-edit-dialog.component.ts - 28 + 23 See <a target="_blank" href="https://docs.paperless-ngx.com/advanced_usage/#file-name-handling">documentation</a> for full list. src/app/components/common/edit-dialog/storage-path-edit-dialog/storage-path-edit-dialog.component.ts - 30 + 25 Create new storage path src/app/components/common/edit-dialog/storage-path-edit-dialog/storage-path-edit-dialog.component.ts - 35 + 30 Edit storage path src/app/components/common/edit-dialog/storage-path-edit-dialog/storage-path-edit-dialog.component.ts - 39 + 34 @@ -1146,14 +1528,14 @@ Create new tag src/app/components/common/edit-dialog/tag-edit-dialog/tag-edit-dialog.component.ts - 26 + 21 Edit tag src/app/components/common/edit-dialog/tag-edit-dialog/tag-edit-dialog.component.ts - 30 + 25 @@ -1269,6 +1651,14 @@ src/app/components/document-list/document-list.component.html 93 + + src/app/components/manage/settings/settings.component.html + 222 + + + src/app/components/manage/settings/settings.component.html + 308 + src/app/components/manage/tasks/tasks.component.html 19 @@ -1535,57 +1925,6 @@ 5 - - Delete - - src/app/components/document-detail/document-detail.component.html - 11 - - - src/app/components/document-list/bulk-editor/bulk-editor.component.html - 97 - - - src/app/components/manage/management-list/management-list.component.html - 46 - - - src/app/components/manage/management-list/management-list.component.html - 46 - - - src/app/components/manage/management-list/management-list.component.html - 46 - - - src/app/components/manage/management-list/management-list.component.html - 46 - - - src/app/components/manage/management-list/management-list.component.html - 65 - - - src/app/components/manage/management-list/management-list.component.html - 65 - - - src/app/components/manage/management-list/management-list.component.html - 65 - - - src/app/components/manage/management-list/management-list.component.html - 65 - - - src/app/components/manage/management-list/management-list.component.ts - 157 - - - src/app/components/manage/settings/settings.component.html - 209 - - Download @@ -1855,7 +2194,7 @@ src/app/components/manage/settings/settings.component.html - 154 + 159 @@ -1880,7 +2219,7 @@ src/app/components/manage/management-list/management-list.component.ts - 153 + 177 @@ -1943,6 +2282,14 @@ src/app/components/document-list/bulk-editor/bulk-editor.component.ts 389 + + src/app/components/manage/settings/settings.component.ts + 560 + + + src/app/components/manage/settings/settings.component.ts + 619 + Proceed @@ -1954,6 +2301,14 @@ src/app/components/document-list/bulk-editor/bulk-editor.component.ts 391 + + src/app/components/manage/settings/settings.component.ts + 562 + + + src/app/components/manage/settings/settings.component.ts + 621 + Redo OCR operation will begin in the background. Close and re-open or reload this document after the operation has completed to see new content. @@ -2053,7 +2408,15 @@ src/app/components/manage/settings/settings.component.html - 208 + 213 + + + src/app/components/manage/settings/settings.component.html + 250 + + + src/app/components/manage/settings/settings.component.html + 285 src/app/components/manage/tasks/tasks.component.html @@ -2315,6 +2678,14 @@ src/app/components/manage/management-list/management-list.component.html 59 + + src/app/components/manage/settings/settings.component.html + 260 + + + src/app/components/manage/settings/settings.component.html + 295 + View @@ -2675,7 +3046,7 @@ src/app/components/manage/settings/settings.component.html - 203 + 208 @@ -2686,7 +3057,7 @@ src/app/components/manage/settings/settings.component.html - 199 + 204 @@ -2877,18 +3248,46 @@ 39 + + Successfully created . + + src/app/components/manage/management-list/management-list.component.ts + 127 + + + + Error occurred while creating : . + + src/app/components/manage/management-list/management-list.component.ts + 132,134 + + + + Successfully updated . + + src/app/components/manage/management-list/management-list.component.ts + 150 + + + + Error occurred while saving : . + + src/app/components/manage/management-list/management-list.component.ts + 155,157 + + Do you really want to delete the ? src/app/components/manage/management-list/management-list.component.ts - 140 + 164 Associated documents will not be deleted. src/app/components/manage/management-list/management-list.component.ts - 155 + 179 @@ -2897,7 +3296,7 @@ )"/> src/app/components/manage/management-list/management-list.component.ts - 168,170 + 192,194 @@ -2907,333 +3306,396 @@ 2 + + Open Django Admin + + src/app/components/manage/settings/settings.component.html + 4 + + General src/app/components/manage/settings/settings.component.html - 10 + 15 Appearance src/app/components/manage/settings/settings.component.html - 13 + 18 Display language src/app/components/manage/settings/settings.component.html - 17 + 22 You need to reload the page after applying a new language. src/app/components/manage/settings/settings.component.html - 25 + 30 Date display src/app/components/manage/settings/settings.component.html - 32 + 37 Date format src/app/components/manage/settings/settings.component.html - 45 + 50 Short: src/app/components/manage/settings/settings.component.html - 51 + 56 Medium: src/app/components/manage/settings/settings.component.html - 55 + 60 Long: src/app/components/manage/settings/settings.component.html - 59 + 64 Items per page src/app/components/manage/settings/settings.component.html - 67 + 72 Document editor src/app/components/manage/settings/settings.component.html - 83 + 88 Use PDF viewer provided by the browser src/app/components/manage/settings/settings.component.html - 87 + 92 This is usually faster for displaying large PDF documents, but it might not work on some browsers. src/app/components/manage/settings/settings.component.html - 87 + 92 Sidebar src/app/components/manage/settings/settings.component.html - 94 + 99 Use 'slim' sidebar (icons only) src/app/components/manage/settings/settings.component.html - 98 + 103 Dark mode src/app/components/manage/settings/settings.component.html - 105 + 110 Use system settings src/app/components/manage/settings/settings.component.html - 108 + 113 Enable dark mode src/app/components/manage/settings/settings.component.html - 109 + 114 Invert thumbnails in dark mode src/app/components/manage/settings/settings.component.html - 110 + 115 Theme Color src/app/components/manage/settings/settings.component.html - 116 + 121 Reset src/app/components/manage/settings/settings.component.html - 125 + 130 Update checking src/app/components/manage/settings/settings.component.html - 130 + 135 Update checking works by pinging the the public Github API for the latest release to determine whether a new version is available. Actual updating of the app must still be performed manually. src/app/components/manage/settings/settings.component.html - 134,137 + 139,142 No tracking data is collected by the app in any way. src/app/components/manage/settings/settings.component.html - 139 + 144 Enable update checking src/app/components/manage/settings/settings.component.html - 141 + 146 Note that for users of thirdy-party containers e.g. linuxserver.io this notification may be 'ahead' of the current third-party release. src/app/components/manage/settings/settings.component.html - 141 + 146 Bulk editing src/app/components/manage/settings/settings.component.html - 145 + 150 Show confirmation dialogs src/app/components/manage/settings/settings.component.html - 149 + 154 Deleting documents will always ask for confirmation. src/app/components/manage/settings/settings.component.html - 149 + 154 Apply on close src/app/components/manage/settings/settings.component.html - 150 + 155 Enable comments src/app/components/manage/settings/settings.component.html - 158 + 163 Notifications src/app/components/manage/settings/settings.component.html - 166 + 171 Document processing src/app/components/manage/settings/settings.component.html - 169 + 174 Show notifications when new documents are detected src/app/components/manage/settings/settings.component.html - 173 + 178 Show notifications when document processing completes successfully src/app/components/manage/settings/settings.component.html - 174 + 179 Show notifications when document processing fails src/app/components/manage/settings/settings.component.html - 175 + 180 Suppress notifications on dashboard src/app/components/manage/settings/settings.component.html - 176 + 181 This will suppress all messages about document processing status on the dashboard. src/app/components/manage/settings/settings.component.html - 176 + 181 Appears on src/app/components/manage/settings/settings.component.html - 196 + 201 No saved views defined. src/app/components/manage/settings/settings.component.html - 213 + 218 + + + + Mail + + src/app/components/manage/settings/settings.component.html + 231 + + + + Mail accounts + + src/app/components/manage/settings/settings.component.html + 236 + + + + Add Account + + src/app/components/manage/settings/settings.component.html + 241 + + + + Server + + src/app/components/manage/settings/settings.component.html + 249 + + + + No mail accounts defined. + + src/app/components/manage/settings/settings.component.html + 267 + + + + Mail rules + + src/app/components/manage/settings/settings.component.html + 271 + + + + Add Rule + + src/app/components/manage/settings/settings.component.html + 276 + + + + No mail rules defined. + + src/app/components/manage/settings/settings.component.html + 302 Saved view "" deleted. src/app/components/manage/settings/settings.component.ts - 217 + 367 Settings saved src/app/components/manage/settings/settings.component.ts - 310 + 460 Settings were saved successfully. src/app/components/manage/settings/settings.component.ts - 311 + 461 Settings were saved successfully. Reload is required to apply some changes. src/app/components/manage/settings/settings.component.ts - 315 + 465 Reload now src/app/components/manage/settings/settings.component.ts - 316 + 466 Use system language src/app/components/manage/settings/settings.component.ts - 334 + 484 Use date format of display language src/app/components/manage/settings/settings.component.ts - 341 + 491 @@ -3242,7 +3704,91 @@ )"/> src/app/components/manage/settings/settings.component.ts - 361,363 + 511,513 + + + + Saved account "". + + src/app/components/manage/settings/settings.component.ts + 538 + + + + Error saving account: . + + src/app/components/manage/settings/settings.component.ts + 548 + + + + Confirm delete mail account + + src/app/components/manage/settings/settings.component.ts + 558 + + + + This operation will permanently this mail account. + + src/app/components/manage/settings/settings.component.ts + 559 + + + + Deleted mail account + + src/app/components/manage/settings/settings.component.ts + 568 + + + + Error deleting mail account: . + + src/app/components/manage/settings/settings.component.ts + 577 + + + + Saved rule "". + + src/app/components/manage/settings/settings.component.ts + 596 + + + + Error saving rule: . + + src/app/components/manage/settings/settings.component.ts + 607 + + + + Confirm delete mail rule + + src/app/components/manage/settings/settings.component.ts + 617 + + + + This operation will permanently this mail rule. + + src/app/components/manage/settings/settings.component.ts + 618 + + + + Deleted mail rule + + src/app/components/manage/settings/settings.component.ts + 627 + + + + Error deleting mail rule: . + + src/app/components/manage/settings/settings.component.ts + 636 diff --git a/src-ui/src/app/app-routing.module.ts b/src-ui/src/app/app-routing.module.ts index 4dad24c51..084bc4a0b 100644 --- a/src-ui/src/app/app-routing.module.ts +++ b/src-ui/src/app/app-routing.module.ts @@ -47,6 +47,11 @@ const routes: Routes = [ component: SettingsComponent, canDeactivate: [DirtyFormGuard], }, + { + path: 'settings/:section', + component: SettingsComponent, + canDeactivate: [DirtyFormGuard], + }, { path: 'tasks', component: TasksComponent }, ], }, diff --git a/src-ui/src/app/app.component.ts b/src-ui/src/app/app.component.ts index b385498fb..9a6962ccf 100644 --- a/src-ui/src/app/app.component.ts +++ b/src-ui/src/app/app.component.ts @@ -191,21 +191,13 @@ export class AppComponent implements OnInit, OnDestroy { }, { anchorId: 'tour.settings', - content: $localize`Check out the settings for various tweaks to the web app or to toggle settings for saved views.`, + content: $localize`Check out the settings for various tweaks to the web app, toggle settings for saved views or setup e-mail checking.`, route: '/settings', enableBackdrop: true, prevBtnTitle, nextBtnTitle, endBtnTitle, }, - { - anchorId: 'tour.admin', - content: $localize`The Admin area contains more advanced controls as well as the settings for automatic e-mail fetching.`, - enableBackdrop: true, - prevBtnTitle, - nextBtnTitle, - endBtnTitle, - }, { anchorId: 'tour.outro', title: $localize`Thank you! 🙏`, diff --git a/src-ui/src/app/app.module.ts b/src-ui/src/app/app.module.ts index 3d0a7e3c7..ea366b968 100644 --- a/src-ui/src/app/app.module.ts +++ b/src-ui/src/app/app.module.ts @@ -39,6 +39,7 @@ import { NgxFileDropModule } from 'ngx-file-drop' import { TextComponent } from './components/common/input/text/text.component' import { SelectComponent } from './components/common/input/select/select.component' import { CheckComponent } from './components/common/input/check/check.component' +import { PasswordComponent } from './components/common/input/password/password.component' import { SaveViewConfigDialogComponent } from './components/document-list/save-view-config-dialog/save-view-config-dialog.component' import { TagsComponent } from './components/common/input/tags/tags.component' import { SortableDirective } from './directives/sortable.directive' @@ -76,6 +77,8 @@ import { StoragePathEditDialogComponent } from './components/common/edit-dialog/ import { SettingsService } from './services/settings.service' import { TasksComponent } from './components/manage/tasks/tasks.component' import { TourNgBootstrapModule } from 'ngx-ui-tour-ng-bootstrap' +import { MailAccountEditDialogComponent } from './components/common/edit-dialog/mail-account-edit-dialog/mail-account-edit-dialog.component' +import { MailRuleEditDialogComponent } from './components/common/edit-dialog/mail-rule-edit-dialog/mail-rule-edit-dialog.component' import localeBe from '@angular/common/locales/be' import localeCs from '@angular/common/locales/cs' @@ -157,6 +160,7 @@ function initializeApp(settings: SettingsService) { TextComponent, SelectComponent, CheckComponent, + PasswordComponent, SaveViewConfigDialogComponent, TagsComponent, SortableDirective, @@ -180,6 +184,8 @@ function initializeApp(settings: SettingsService) { DocumentAsnComponent, DocumentCommentsComponent, TasksComponent, + MailAccountEditDialogComponent, + MailRuleEditDialogComponent, ], imports: [ BrowserModule, diff --git a/src-ui/src/app/components/app-frame/app-frame.component.html b/src-ui/src/app/components/app-frame/app-frame.component.html index 589b95f4f..5115303d7 100644 --- a/src-ui/src/app/components/app-frame/app-frame.component.html +++ b/src-ui/src/app/components/app-frame/app-frame.component.html @@ -174,13 +174,6 @@  Settings -
  • - - - -  Admin - -
    • diff --git a/src-ui/src/app/components/common/edit-dialog/correspondent-edit-dialog/correspondent-edit-dialog.component.ts b/src-ui/src/app/components/common/edit-dialog/correspondent-edit-dialog/correspondent-edit-dialog.component.ts index 86be7414d..7361e5e4b 100644 --- a/src-ui/src/app/components/common/edit-dialog/correspondent-edit-dialog/correspondent-edit-dialog.component.ts +++ b/src-ui/src/app/components/common/edit-dialog/correspondent-edit-dialog/correspondent-edit-dialog.component.ts @@ -5,7 +5,6 @@ import { EditDialogComponent } from 'src/app/components/common/edit-dialog/edit- import { DEFAULT_MATCHING_ALGORITHM } from 'src/app/data/matching-model' import { PaperlessCorrespondent } from 'src/app/data/paperless-correspondent' import { CorrespondentService } from 'src/app/services/rest/correspondent.service' -import { ToastService } from 'src/app/services/toast.service' @Component({ selector: 'app-correspondent-edit-dialog', @@ -13,12 +12,8 @@ import { ToastService } from 'src/app/services/toast.service' styleUrls: ['./correspondent-edit-dialog.component.scss'], }) export class CorrespondentEditDialogComponent extends EditDialogComponent { - constructor( - service: CorrespondentService, - activeModal: NgbActiveModal, - toastService: ToastService - ) { - super(service, activeModal, toastService) + constructor(service: CorrespondentService, activeModal: NgbActiveModal) { + super(service, activeModal) } getCreateTitle() { diff --git a/src-ui/src/app/components/common/edit-dialog/document-type-edit-dialog/document-type-edit-dialog.component.ts b/src-ui/src/app/components/common/edit-dialog/document-type-edit-dialog/document-type-edit-dialog.component.ts index bcd2363fd..d565e66e1 100644 --- a/src-ui/src/app/components/common/edit-dialog/document-type-edit-dialog/document-type-edit-dialog.component.ts +++ b/src-ui/src/app/components/common/edit-dialog/document-type-edit-dialog/document-type-edit-dialog.component.ts @@ -5,7 +5,6 @@ import { EditDialogComponent } from 'src/app/components/common/edit-dialog/edit- import { DEFAULT_MATCHING_ALGORITHM } from 'src/app/data/matching-model' import { PaperlessDocumentType } from 'src/app/data/paperless-document-type' import { DocumentTypeService } from 'src/app/services/rest/document-type.service' -import { ToastService } from 'src/app/services/toast.service' @Component({ selector: 'app-document-type-edit-dialog', @@ -13,12 +12,8 @@ import { ToastService } from 'src/app/services/toast.service' styleUrls: ['./document-type-edit-dialog.component.scss'], }) export class DocumentTypeEditDialogComponent extends EditDialogComponent { - constructor( - service: DocumentTypeService, - activeModal: NgbActiveModal, - toastService: ToastService - ) { - super(service, activeModal, toastService) + constructor(service: DocumentTypeService, activeModal: NgbActiveModal) { + super(service, activeModal) } getCreateTitle() { diff --git a/src-ui/src/app/components/common/edit-dialog/edit-dialog.component.ts b/src-ui/src/app/components/common/edit-dialog/edit-dialog.component.ts index 92b16a93d..9bf141e78 100644 --- a/src-ui/src/app/components/common/edit-dialog/edit-dialog.component.ts +++ b/src-ui/src/app/components/common/edit-dialog/edit-dialog.component.ts @@ -2,11 +2,9 @@ import { Directive, EventEmitter, Input, OnInit, Output } from '@angular/core' import { FormGroup } from '@angular/forms' import { NgbActiveModal } from '@ng-bootstrap/ng-bootstrap' import { Observable } from 'rxjs' -import { map } from 'rxjs/operators' import { MATCHING_ALGORITHMS, MATCH_AUTO } from 'src/app/data/matching-model' import { ObjectWithId } from 'src/app/data/object-with-id' import { AbstractPaperlessService } from 'src/app/services/rest/abstract-paperless-service' -import { ToastService } from 'src/app/services/toast.service' @Directive() export abstract class EditDialogComponent @@ -14,8 +12,7 @@ export abstract class EditDialogComponent { constructor( private service: AbstractPaperlessService, - private activeModal: NgbActiveModal, - private toastService: ToastService + private activeModal: NgbActiveModal ) {} @Input() @@ -95,16 +92,16 @@ export abstract class EditDialogComponent break } this.networkActive = true - serverResponse.subscribe( - (result) => { + serverResponse.subscribe({ + next: (result) => { this.activeModal.close() this.success.emit(result) }, - (error) => { + error: (error) => { this.error = error.error this.networkActive = false - } - ) + }, + }) } cancel() { diff --git a/src-ui/src/app/components/common/edit-dialog/mail-account-edit-dialog/mail-account-edit-dialog.component.html b/src-ui/src/app/components/common/edit-dialog/mail-account-edit-dialog/mail-account-edit-dialog.component.html new file mode 100644 index 000000000..8164fca9a --- /dev/null +++ b/src-ui/src/app/components/common/edit-dialog/mail-account-edit-dialog/mail-account-edit-dialog.component.html @@ -0,0 +1,26 @@ +
    +
    + + +
    +
    +
    +
    + + + + +
    +
    + + + +
    +
    +
    +
    + + +
    +
    diff --git a/src-ui/src/app/components/common/edit-dialog/mail-account-edit-dialog/mail-account-edit-dialog.component.scss b/src-ui/src/app/components/common/edit-dialog/mail-account-edit-dialog/mail-account-edit-dialog.component.scss new file mode 100644 index 000000000..e69de29bb diff --git a/src-ui/src/app/components/common/edit-dialog/mail-account-edit-dialog/mail-account-edit-dialog.component.ts b/src-ui/src/app/components/common/edit-dialog/mail-account-edit-dialog/mail-account-edit-dialog.component.ts new file mode 100644 index 000000000..b2edb9219 --- /dev/null +++ b/src-ui/src/app/components/common/edit-dialog/mail-account-edit-dialog/mail-account-edit-dialog.component.ts @@ -0,0 +1,50 @@ +import { Component } from '@angular/core' +import { FormControl, FormGroup } from '@angular/forms' +import { NgbActiveModal } from '@ng-bootstrap/ng-bootstrap' +import { EditDialogComponent } from 'src/app/components/common/edit-dialog/edit-dialog.component' +import { + IMAPSecurity, + PaperlessMailAccount, +} from 'src/app/data/paperless-mail-account' +import { MailAccountService } from 'src/app/services/rest/mail-account.service' + +const IMAP_SECURITY_OPTIONS = [ + { id: IMAPSecurity.None, name: $localize`No encryption` }, + { id: IMAPSecurity.SSL, name: $localize`SSL` }, + { id: IMAPSecurity.STARTTLS, name: $localize`STARTTLS` }, +] + +@Component({ + selector: 'app-mail-account-edit-dialog', + templateUrl: './mail-account-edit-dialog.component.html', + styleUrls: ['./mail-account-edit-dialog.component.scss'], +}) +export class MailAccountEditDialogComponent extends EditDialogComponent { + constructor(service: MailAccountService, activeModal: NgbActiveModal) { + super(service, activeModal) + } + + getCreateTitle() { + return $localize`Create new mail account` + } + + getEditTitle() { + return $localize`Edit mail account` + } + + getForm(): FormGroup { + return new FormGroup({ + name: new FormControl(null), + imap_server: new FormControl(null), + imap_port: new FormControl(null), + imap_security: new FormControl(IMAPSecurity.SSL), + username: new FormControl(null), + password: new FormControl(null), + character_set: new FormControl('UTF-8'), + }) + } + + get imapSecurityOptions() { + return IMAP_SECURITY_OPTIONS + } +} 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 new file mode 100644 index 000000000..a8a476c28 --- /dev/null +++ b/src-ui/src/app/components/common/edit-dialog/mail-rule-edit-dialog/mail-rule-edit-dialog.component.html @@ -0,0 +1,39 @@ +
    +
    + + +
    +
    +
    +
    + + + + + +
    +
    +

    Paperless will only process mails that match all of the filters specified below.

    + + + + +
    +
    + + + + + + + +
    +
    +
    +
    + Error: {{error.non_field_errors}} + + +
    +
    diff --git a/src-ui/src/app/components/common/edit-dialog/mail-rule-edit-dialog/mail-rule-edit-dialog.component.scss b/src-ui/src/app/components/common/edit-dialog/mail-rule-edit-dialog/mail-rule-edit-dialog.component.scss new file mode 100644 index 000000000..e69de29bb 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 new file mode 100644 index 000000000..126c4968f --- /dev/null +++ b/src-ui/src/app/components/common/edit-dialog/mail-rule-edit-dialog/mail-rule-edit-dialog.component.ts @@ -0,0 +1,180 @@ +import { Component } from '@angular/core' +import { FormControl, FormGroup } from '@angular/forms' +import { NgbActiveModal } from '@ng-bootstrap/ng-bootstrap' +import { first } from 'rxjs' +import { EditDialogComponent } from 'src/app/components/common/edit-dialog/edit-dialog.component' +import { PaperlessCorrespondent } from 'src/app/data/paperless-correspondent' +import { PaperlessDocumentType } from 'src/app/data/paperless-document-type' +import { PaperlessMailAccount } from 'src/app/data/paperless-mail-account' +import { + MailAction, + MailFilterAttachmentType, + MailMetadataCorrespondentOption, + MailMetadataTitleOption, + PaperlessMailRule, +} from 'src/app/data/paperless-mail-rule' +import { CorrespondentService } from 'src/app/services/rest/correspondent.service' +import { DocumentTypeService } from 'src/app/services/rest/document-type.service' +import { MailAccountService } from 'src/app/services/rest/mail-account.service' +import { MailRuleService } from 'src/app/services/rest/mail-rule.service' + +const ATTACHMENT_TYPE_OPTIONS = [ + { + id: MailFilterAttachmentType.Attachments, + name: $localize`Only process attachments.`, + }, + { + id: MailFilterAttachmentType.Everything, + name: $localize`Process all files, including 'inline' attachments.`, + }, +] + +const ACTION_OPTIONS = [ + { + id: MailAction.Delete, + name: $localize`Delete`, + }, + { + id: MailAction.Move, + name: $localize`Move to specified folder`, + }, + { + id: MailAction.MarkRead, + name: $localize`Mark as read, don't process read mails`, + }, + { + id: MailAction.Flag, + name: $localize`Flag the mail, don't process flagged mails`, + }, + { + id: MailAction.Tag, + name: $localize`Tag the mail with specified tag, don't process tagged mails`, + }, +] + +const METADATA_TITLE_OPTIONS = [ + { + id: MailMetadataTitleOption.FromSubject, + name: $localize`Use subject as title`, + }, + { + id: MailMetadataTitleOption.FromFilename, + name: $localize`Use attachment filename as title`, + }, +] + +const METADATA_CORRESPONDENT_OPTIONS = [ + { + id: MailMetadataCorrespondentOption.FromNothing, + name: $localize`Do not assign a correspondent`, + }, + { + id: MailMetadataCorrespondentOption.FromEmail, + name: $localize`Use mail address`, + }, + { + id: MailMetadataCorrespondentOption.FromName, + name: $localize`Use name (or mail address if not available)`, + }, + { + id: MailMetadataCorrespondentOption.FromCustom, + name: $localize`Use correspondent selected below`, + }, +] + +@Component({ + selector: 'app-mail-rule-edit-dialog', + templateUrl: './mail-rule-edit-dialog.component.html', + styleUrls: ['./mail-rule-edit-dialog.component.scss'], +}) +export class MailRuleEditDialogComponent extends EditDialogComponent { + accounts: PaperlessMailAccount[] + correspondents: PaperlessCorrespondent[] + documentTypes: PaperlessDocumentType[] + + constructor( + service: MailRuleService, + activeModal: NgbActiveModal, + accountService: MailAccountService, + correspondentService: CorrespondentService, + documentTypeService: DocumentTypeService + ) { + super(service, activeModal) + + accountService + .listAll() + .pipe(first()) + .subscribe((result) => (this.accounts = result.results)) + + correspondentService + .listAll() + .pipe(first()) + .subscribe((result) => (this.correspondents = result.results)) + + documentTypeService + .listAll() + .pipe(first()) + .subscribe((result) => (this.documentTypes = result.results)) + } + + getCreateTitle() { + return $localize`Create new mail rule` + } + + getEditTitle() { + return $localize`Edit mail rule` + } + + getForm(): FormGroup { + return new FormGroup({ + name: new FormControl(null), + account: new FormControl(null), + folder: new FormControl('INBOX'), + filter_from: new FormControl(null), + filter_subject: new FormControl(null), + filter_body: new FormControl(null), + filter_attachment_filename: new FormControl(null), + maximum_age: new FormControl(null), + attachment_type: new FormControl(MailFilterAttachmentType.Attachments), + action: new FormControl(MailAction.MarkRead), + action_parameter: new FormControl(null), + assign_title_from: new FormControl(MailMetadataTitleOption.FromSubject), + assign_tags: new FormControl([]), + assign_document_type: new FormControl(null), + assign_correspondent_from: new FormControl( + MailMetadataCorrespondentOption.FromNothing + ), + assign_correspondent: new FormControl(null), + }) + } + + get showCorrespondentField(): boolean { + return ( + this.objectForm?.get('assign_correspondent_from')?.value == + MailMetadataCorrespondentOption.FromCustom + ) + } + + get showActionParamField(): boolean { + return ( + this.objectForm?.get('action')?.value == MailAction.Move || + this.objectForm?.get('action')?.value == MailAction.Tag + ) + } + + get attachmentTypeOptions() { + return ATTACHMENT_TYPE_OPTIONS + } + + get actionOptions() { + return ACTION_OPTIONS + } + + get metadataTitleOptions() { + return METADATA_TITLE_OPTIONS + } + + get metadataCorrespondentOptions() { + return METADATA_CORRESPONDENT_OPTIONS + } +} diff --git a/src-ui/src/app/components/common/edit-dialog/storage-path-edit-dialog/storage-path-edit-dialog.component.ts b/src-ui/src/app/components/common/edit-dialog/storage-path-edit-dialog/storage-path-edit-dialog.component.ts index 011c15e73..1dfef00c5 100644 --- a/src-ui/src/app/components/common/edit-dialog/storage-path-edit-dialog/storage-path-edit-dialog.component.ts +++ b/src-ui/src/app/components/common/edit-dialog/storage-path-edit-dialog/storage-path-edit-dialog.component.ts @@ -5,7 +5,6 @@ import { EditDialogComponent } from 'src/app/components/common/edit-dialog/edit- import { DEFAULT_MATCHING_ALGORITHM } from 'src/app/data/matching-model' import { PaperlessStoragePath } from 'src/app/data/paperless-storage-path' import { StoragePathService } from 'src/app/services/rest/storage-path.service' -import { ToastService } from 'src/app/services/toast.service' @Component({ selector: 'app-storage-path-edit-dialog', @@ -13,12 +12,8 @@ import { ToastService } from 'src/app/services/toast.service' styleUrls: ['./storage-path-edit-dialog.component.scss'], }) export class StoragePathEditDialogComponent extends EditDialogComponent { - constructor( - service: StoragePathService, - activeModal: NgbActiveModal, - toastService: ToastService - ) { - super(service, activeModal, toastService) + constructor(service: StoragePathService, activeModal: NgbActiveModal) { + super(service, activeModal) } get pathHint() { diff --git a/src-ui/src/app/components/common/edit-dialog/tag-edit-dialog/tag-edit-dialog.component.ts b/src-ui/src/app/components/common/edit-dialog/tag-edit-dialog/tag-edit-dialog.component.ts index 18d476dfe..db106d990 100644 --- a/src-ui/src/app/components/common/edit-dialog/tag-edit-dialog/tag-edit-dialog.component.ts +++ b/src-ui/src/app/components/common/edit-dialog/tag-edit-dialog/tag-edit-dialog.component.ts @@ -4,7 +4,6 @@ import { NgbActiveModal } from '@ng-bootstrap/ng-bootstrap' import { EditDialogComponent } from 'src/app/components/common/edit-dialog/edit-dialog.component' import { PaperlessTag } from 'src/app/data/paperless-tag' import { TagService } from 'src/app/services/rest/tag.service' -import { ToastService } from 'src/app/services/toast.service' import { randomColor } from 'src/app/utils/color' import { DEFAULT_MATCHING_ALGORITHM } from 'src/app/data/matching-model' @@ -14,12 +13,8 @@ import { DEFAULT_MATCHING_ALGORITHM } from 'src/app/data/matching-model' styleUrls: ['./tag-edit-dialog.component.scss'], }) export class TagEditDialogComponent extends EditDialogComponent { - constructor( - service: TagService, - activeModal: NgbActiveModal, - toastService: ToastService - ) { - super(service, activeModal, toastService) + constructor(service: TagService, activeModal: NgbActiveModal) { + super(service, activeModal) } getCreateTitle() { diff --git a/src-ui/src/app/components/common/input/number/number.component.html b/src-ui/src/app/components/common/input/number/number.component.html index 3e2cc8d86..ceff40250 100644 --- a/src-ui/src/app/components/common/input/number/number.component.html +++ b/src-ui/src/app/components/common/input/number/number.component.html @@ -2,7 +2,7 @@
    - +
    {{error}} diff --git a/src-ui/src/app/components/common/input/number/number.component.ts b/src-ui/src/app/components/common/input/number/number.component.ts index cb29ff5e5..5ed861b5a 100644 --- a/src-ui/src/app/components/common/input/number/number.component.ts +++ b/src-ui/src/app/components/common/input/number/number.component.ts @@ -1,4 +1,4 @@ -import { Component, forwardRef } from '@angular/core' +import { Component, forwardRef, Input } from '@angular/core' import { NG_VALUE_ACCESSOR } from '@angular/forms' import { FILTER_ASN_ISNULL } from 'src/app/data/filter-rule-type' import { DocumentService } from 'src/app/services/rest/document.service' @@ -17,6 +17,9 @@ import { AbstractInputComponent } from '../abstract-input' styleUrls: ['./number.component.scss'], }) export class NumberComponent extends AbstractInputComponent { + @Input() + showAdd: boolean = true + constructor(private documentService: DocumentService) { super() } diff --git a/src-ui/src/app/components/common/input/password/password.component.html b/src-ui/src/app/components/common/input/password/password.component.html new file mode 100644 index 000000000..57cdd6de8 --- /dev/null +++ b/src-ui/src/app/components/common/input/password/password.component.html @@ -0,0 +1,8 @@ +
    + + + +
    + {{error}} +
    +
    diff --git a/src-ui/src/app/components/common/input/password/password.component.scss b/src-ui/src/app/components/common/input/password/password.component.scss new file mode 100644 index 000000000..e69de29bb diff --git a/src-ui/src/app/components/common/input/password/password.component.ts b/src-ui/src/app/components/common/input/password/password.component.ts new file mode 100644 index 000000000..3216dbed2 --- /dev/null +++ b/src-ui/src/app/components/common/input/password/password.component.ts @@ -0,0 +1,21 @@ +import { Component, forwardRef } from '@angular/core' +import { NG_VALUE_ACCESSOR } from '@angular/forms' +import { AbstractInputComponent } from '../abstract-input' + +@Component({ + providers: [ + { + provide: NG_VALUE_ACCESSOR, + useExisting: forwardRef(() => PasswordComponent), + multi: true, + }, + ], + selector: 'app-input-password', + templateUrl: './password.component.html', + styleUrls: ['./password.component.scss'], +}) +export class PasswordComponent extends AbstractInputComponent { + constructor() { + super() + } +} diff --git a/src-ui/src/app/components/common/input/tags/tags.component.html b/src-ui/src/app/components/common/input/tags/tags.component.html index 77e25d88d..14de0f98a 100644 --- a/src-ui/src/app/components/common/input/tags/tags.component.html +++ b/src-ui/src/app/components/common/input/tags/tags.component.html @@ -7,7 +7,7 @@ [closeOnSelect]="false" [clearSearchOnAdd]="true" [hideSelected]="true" - [addTag]="createTagRef" + [addTag]="allowCreate ? createTagRef : false" addTagText="Add tag" i18n-addTagText (change)="onChange(value)" @@ -31,7 +31,7 @@ - + + Open Django Admin + + + + -
    -
    -
    No saved views defined.
    +
    No saved views defined.
    +
    + + +
    + + + + + + +
  • + Mail + + + +

    + Mail accounts + +

    +
      + +
    • +
      +
      Name
      +
      Server
      +
      Actions
      +
      +
      • + +
    • +
      +
      +
      {{account.imap_server}}
      +
      +
      + + +
      +
      +
      +
      • + +
      No mail accounts defined.
      +
    + +

    + Mail rules + +

    +
      + +
    • +
      +
      Name
      +
      Account
      +
      Actions
      +
      +
      • + +
    • +
      +
      +
      {{(mailAccountService.getCached(rule.account) | async)?.name}}
      +
      +
      + + +
      +
      +
      +
      • + +
      No mail rules defined.
      +
    +     + +
    + +
    diff --git a/src-ui/src/app/components/manage/settings/settings.component.ts b/src-ui/src/app/components/manage/settings/settings.component.ts index 51a401e49..2d23874fd 100644 --- a/src-ui/src/app/components/manage/settings/settings.component.ts +++ b/src-ui/src/app/components/manage/settings/settings.component.ts @@ -26,9 +26,26 @@ import { Subject, } from 'rxjs' import { SETTINGS_KEYS } from 'src/app/data/paperless-uisettings' -import { ActivatedRoute } from '@angular/router' +import { ActivatedRoute, Router } from '@angular/router' import { ViewportScroller } from '@angular/common' import { TourService } from 'ngx-ui-tour-ng-bootstrap' +import { PaperlessMailAccount } from 'src/app/data/paperless-mail-account' +import { PaperlessMailRule } from 'src/app/data/paperless-mail-rule' +import { MailAccountService } from 'src/app/services/rest/mail-account.service' +import { MailRuleService } from 'src/app/services/rest/mail-rule.service' +import { NgbModal } from '@ng-bootstrap/ng-bootstrap' +import { MailAccountEditDialogComponent } from '../../common/edit-dialog/mail-account-edit-dialog/mail-account-edit-dialog.component' +import { MailRuleEditDialogComponent } from '../../common/edit-dialog/mail-rule-edit-dialog/mail-rule-edit-dialog.component' +import { ConfirmDialogComponent } from '../../common/confirm-dialog/confirm-dialog.component' +import { NgbNavChangeEvent } from '@ng-bootstrap/ng-bootstrap' + +enum SettingsNavIDs { + General = 1, + Notifications = 2, + SavedViews = 3, + Mail = 4, + UsersGroups = 5, +} @Component({ selector: 'app-settings', @@ -38,8 +55,14 @@ import { TourService } from 'ngx-ui-tour-ng-bootstrap' export class SettingsComponent implements OnInit, AfterViewInit, OnDestroy, DirtyComponent { + SettingsNavIDs = SettingsNavIDs + activeNavID: number + savedViewGroup = new FormGroup({}) + mailAccountGroup = new FormGroup({}) + mailRuleGroup = new FormGroup({}) + settingsForm = new FormGroup({ bulkEditConfirmationDialogs: new FormControl(null), bulkEditApplyOnClose: new FormControl(null), @@ -50,20 +73,28 @@ export class SettingsComponent darkModeInvertThumbs: new FormControl(null), themeColor: new FormControl(null), useNativePdfViewer: new FormControl(null), - savedViews: this.savedViewGroup, displayLanguage: new FormControl(null), dateLocale: new FormControl(null), dateFormat: new FormControl(null), + commentsEnabled: new FormControl(null), + updateCheckingEnabled: new FormControl(null), + notificationsConsumerNewDocument: new FormControl(null), notificationsConsumerSuccess: new FormControl(null), notificationsConsumerFailed: new FormControl(null), notificationsConsumerSuppressOnDashboard: new FormControl(null), - commentsEnabled: new FormControl(null), - updateCheckingEnabled: new FormControl(null), + + savedViews: this.savedViewGroup, + + mailAccounts: this.mailAccountGroup, + mailRules: this.mailRuleGroup, }) savedViews: PaperlessSavedView[] + mailAccounts: PaperlessMailAccount[] + mailRules: PaperlessMailRule[] + store: BehaviorSubject storeSub: Subscription isDirty$: Observable @@ -81,19 +112,40 @@ export class SettingsComponent constructor( public savedViewService: SavedViewService, + public mailAccountService: MailAccountService, + public mailRuleService: MailRuleService, private documentListViewService: DocumentListViewService, private toastService: ToastService, private settings: SettingsService, @Inject(LOCALE_ID) public currentLocale: string, private viewportScroller: ViewportScroller, private activatedRoute: ActivatedRoute, - public readonly tourService: TourService + private router: Router, + public readonly tourService: TourService, + private modalService: NgbModal ) { this.settings.settingsSaved.subscribe(() => { if (!this.savePending) this.initialize() }) } + ngOnInit() { + this.initialize() + + this.activatedRoute.paramMap.subscribe((paramMap) => { + const section = paramMap.get('section') + if (section) { + const navIDKey: string = Object.keys(SettingsNavIDs).find( + (navID) => navID.toLowerCase() == section + ) + if (navIDKey) { + this.activeNavID = SettingsNavIDs[navIDKey] + this.maybeInitializeTab(this.activeNavID) + } + } + }) + } + ngAfterViewInit(): void { if (this.activatedRoute.snapshot.fragment) { this.viewportScroller.scrollToAnchor( @@ -123,10 +175,13 @@ export class SettingsComponent useNativePdfViewer: this.settings.get( SETTINGS_KEYS.USE_NATIVE_PDF_VIEWER ), - savedViews: {}, displayLanguage: this.settings.getLanguage(), dateLocale: this.settings.get(SETTINGS_KEYS.DATE_LOCALE), dateFormat: this.settings.get(SETTINGS_KEYS.DATE_FORMAT), + commentsEnabled: this.settings.get(SETTINGS_KEYS.COMMENTS_ENABLED), + updateCheckingEnabled: this.settings.get( + SETTINGS_KEYS.UPDATE_CHECKING_ENABLED + ), notificationsConsumerNewDocument: this.settings.get( SETTINGS_KEYS.NOTIFICATIONS_CONSUMER_NEW_DOCUMENT ), @@ -139,41 +194,147 @@ export class SettingsComponent notificationsConsumerSuppressOnDashboard: this.settings.get( SETTINGS_KEYS.NOTIFICATIONS_CONSUMER_SUPPRESS_ON_DASHBOARD ), - commentsEnabled: this.settings.get(SETTINGS_KEYS.COMMENTS_ENABLED), - updateCheckingEnabled: this.settings.get( - SETTINGS_KEYS.UPDATE_CHECKING_ENABLED - ), + savedViews: {}, + mailAccounts: {}, + mailRules: {}, } } - ngOnInit() { - this.savedViewService.listAll().subscribe((r) => { - this.savedViews = r.results - this.initialize() - }) + onNavChange(navChangeEvent: NgbNavChangeEvent) { + this.maybeInitializeTab(navChangeEvent.nextId) + const [foundNavIDkey, foundNavIDValue] = Object.entries( + SettingsNavIDs + ).find(([navIDkey, navIDValue]) => navIDValue == navChangeEvent.nextId) + if (foundNavIDkey) + // if its dirty we need to wait for confirmation + this.router + .navigate(['settings', foundNavIDkey.toLowerCase()]) + .then((navigated) => { + if (!navigated && this.isDirty) { + this.activeNavID = navChangeEvent.activeId + } else if (navigated && this.isDirty) { + this.initialize() + } + }) } - initialize() { + // Load tab contents 'on demand', either on mouseover or focusin (i.e. before click) or called from nav change event + maybeInitializeTab(navID: number): void { + if (navID == SettingsNavIDs.SavedViews && !this.savedViews) { + this.savedViewService.listAll().subscribe((r) => { + this.savedViews = r.results + this.initialize(false) + }) + } else if ( + navID == SettingsNavIDs.Mail && + (!this.mailAccounts || !this.mailRules) + ) { + this.mailAccountService.listAll().subscribe((r) => { + this.mailAccounts = r.results + + this.mailRuleService.listAll().subscribe((r) => { + this.mailRules = r.results + this.initialize(false) + }) + }) + } + } + + initialize(resetSettings: boolean = true) { this.unsubscribeNotifier.next(true) + const currentFormValue = this.settingsForm.value + let storeData = this.getCurrentSettings() - for (let view of this.savedViews) { - storeData.savedViews[view.id.toString()] = { - id: view.id, - name: view.name, - show_on_dashboard: view.show_on_dashboard, - show_in_sidebar: view.show_in_sidebar, + if (this.savedViews) { + for (let view of this.savedViews) { + storeData.savedViews[view.id.toString()] = { + id: view.id, + name: view.name, + show_on_dashboard: view.show_on_dashboard, + show_in_sidebar: view.show_in_sidebar, + } + this.savedViewGroup.addControl( + view.id.toString(), + new FormGroup({ + id: new FormControl(null), + name: new FormControl(null), + show_on_dashboard: new FormControl(null), + show_in_sidebar: new FormControl(null), + }) + ) + } + } + + if (this.mailAccounts && this.mailRules) { + for (let account of this.mailAccounts) { + storeData.mailAccounts[account.id.toString()] = { + id: account.id, + name: account.name, + imap_server: account.imap_server, + imap_port: account.imap_port, + imap_security: account.imap_security, + username: account.username, + password: account.password, + character_set: account.character_set, + } + this.mailAccountGroup.addControl( + account.id.toString(), + new FormGroup({ + id: new FormControl(null), + name: new FormControl(null), + imap_server: new FormControl(null), + imap_port: new FormControl(null), + imap_security: new FormControl(null), + username: new FormControl(null), + password: new FormControl(null), + character_set: new FormControl(null), + }) + ) + } + + for (let rule of this.mailRules) { + storeData.mailRules[rule.id.toString()] = { + name: rule.name, + account: rule.account, + folder: rule.folder, + filter_from: rule.filter_from, + filter_subject: rule.filter_subject, + filter_body: rule.filter_body, + filter_attachment_filename: rule.filter_attachment_filename, + maximum_age: rule.maximum_age, + attachment_type: rule.attachment_type, + action: rule.action, + action_parameter: rule.action_parameter, + assign_title_from: rule.assign_title_from, + assign_tags: rule.assign_tags, + assign_document_type: rule.assign_document_type, + assign_correspondent_from: rule.assign_correspondent_from, + assign_correspondent: rule.assign_correspondent, + } + this.mailRuleGroup.addControl( + rule.id.toString(), + new FormGroup({ + name: new FormControl(null), + account: new FormControl(null), + folder: new FormControl(null), + filter_from: new FormControl(null), + filter_subject: new FormControl(null), + filter_body: new FormControl(null), + filter_attachment_filename: new FormControl(null), + maximum_age: new FormControl(null), + attachment_type: new FormControl(null), + action: new FormControl(null), + action_parameter: new FormControl(null), + assign_title_from: new FormControl(null), + assign_tags: new FormControl(null), + assign_document_type: new FormControl(null), + assign_correspondent_from: new FormControl(null), + assign_correspondent: new FormControl(null), + }) + ) } - this.savedViewGroup.addControl( - view.id.toString(), - new FormGroup({ - id: new FormControl(null), - name: new FormControl(null), - show_on_dashboard: new FormControl(null), - show_in_sidebar: new FormControl(null), - }) - ) } this.store = new BehaviorSubject(storeData) @@ -202,6 +363,11 @@ export class SettingsComponent this.settingsForm.get('themeColor').value ) }) + + if (!resetSettings && currentFormValue) { + // prevents loss of unsaved changes + this.settingsForm.patchValue(currentFormValue) + } } ngOnDestroy() { @@ -372,4 +538,121 @@ export class SettingsComponent clearThemeColor() { this.settingsForm.get('themeColor').patchValue('') } + + editMailAccount(account: PaperlessMailAccount) { + const modal = this.modalService.open(MailAccountEditDialogComponent, { + backdrop: 'static', + size: 'xl', + }) + modal.componentInstance.dialogMode = account ? 'edit' : 'create' + modal.componentInstance.object = account + modal.componentInstance.success + .pipe(takeUntil(this.unsubscribeNotifier)) + .subscribe({ + next: (newMailAccount) => { + this.toastService.showInfo( + $localize`Saved account "${newMailAccount.name}".` + ) + this.mailAccountService.clearCache() + this.mailAccountService.listAll().subscribe((r) => { + this.mailAccounts = r.results + this.initialize() + }) + }, + error: (e) => { + this.toastService.showError( + $localize`Error saving account: ${e.toString()}.` + ) + }, + }) + } + + deleteMailAccount(account: PaperlessMailAccount) { + const modal = this.modalService.open(ConfirmDialogComponent, { + backdrop: 'static', + }) + modal.componentInstance.title = $localize`Confirm delete mail account` + modal.componentInstance.messageBold = $localize`This operation will permanently this mail account.` + modal.componentInstance.message = $localize`This operation cannot be undone.` + modal.componentInstance.btnClass = 'btn-danger' + modal.componentInstance.btnCaption = $localize`Proceed` + modal.componentInstance.confirmClicked.subscribe(() => { + modal.componentInstance.buttonsEnabled = false + this.mailAccountService.delete(account).subscribe({ + next: () => { + modal.close() + this.toastService.showInfo($localize`Deleted mail account`) + this.mailAccountService.clearCache() + this.mailAccountService.listAll().subscribe((r) => { + this.mailAccounts = r.results + this.initialize() + }) + }, + error: (e) => { + this.toastService.showError( + $localize`Error deleting mail account: ${e.toString()}.` + ) + }, + }) + }) + } + + editMailRule(rule: PaperlessMailRule) { + const modal = this.modalService.open(MailRuleEditDialogComponent, { + backdrop: 'static', + size: 'xl', + }) + modal.componentInstance.dialogMode = rule ? 'edit' : 'create' + modal.componentInstance.object = rule + modal.componentInstance.success + .pipe(takeUntil(this.unsubscribeNotifier)) + .subscribe({ + next: (newMailRule) => { + this.toastService.showInfo( + $localize`Saved rule "${newMailRule.name}".` + ) + this.mailRuleService.clearCache() + this.mailRuleService.listAll().subscribe((r) => { + this.mailRules = r.results + + this.initialize() + }) + }, + error: (e) => { + this.toastService.showError( + $localize`Error saving rule: ${e.toString()}.` + ) + }, + }) + } + + deleteMailRule(rule: PaperlessMailRule) { + const modal = this.modalService.open(ConfirmDialogComponent, { + backdrop: 'static', + }) + modal.componentInstance.title = $localize`Confirm delete mail rule` + modal.componentInstance.messageBold = $localize`This operation will permanently this mail rule.` + modal.componentInstance.message = $localize`This operation cannot be undone.` + modal.componentInstance.btnClass = 'btn-danger' + modal.componentInstance.btnCaption = $localize`Proceed` + modal.componentInstance.confirmClicked.subscribe(() => { + modal.componentInstance.buttonsEnabled = false + this.mailRuleService.delete(rule).subscribe({ + next: () => { + modal.close() + this.toastService.showInfo($localize`Deleted mail rule`) + this.mailRuleService.clearCache() + this.mailRuleService.listAll().subscribe((r) => { + this.mailRules = r.results + this.initialize() + }) + }, + error: (e) => { + this.toastService.showError( + $localize`Error deleting mail rule: ${e.toString()}.` + ) + }, + }) + }) + } } diff --git a/src-ui/src/app/data/paperless-mail-account.ts b/src-ui/src/app/data/paperless-mail-account.ts new file mode 100644 index 000000000..9f875e783 --- /dev/null +++ b/src-ui/src/app/data/paperless-mail-account.ts @@ -0,0 +1,23 @@ +import { ObjectWithId } from './object-with-id' + +export enum IMAPSecurity { + None = 1, + SSL = 2, + STARTTLS = 3, +} + +export interface PaperlessMailAccount extends ObjectWithId { + name: string + + imap_server: string + + imap_port: number + + imap_security: IMAPSecurity + + username: string + + password: string + + character_set?: string +} diff --git a/src-ui/src/app/data/paperless-mail-rule.ts b/src-ui/src/app/data/paperless-mail-rule.ts new file mode 100644 index 000000000..9ff133dab --- /dev/null +++ b/src-ui/src/app/data/paperless-mail-rule.ts @@ -0,0 +1,60 @@ +import { ObjectWithId } from './object-with-id' + +export enum MailFilterAttachmentType { + Attachments = 1, + Everything = 2, +} + +export enum MailAction { + Delete = 1, + Move = 2, + MarkRead = 3, + Flag = 4, + Tag = 5, +} + +export enum MailMetadataTitleOption { + FromSubject = 1, + FromFilename = 2, +} + +export enum MailMetadataCorrespondentOption { + FromNothing = 1, + FromEmail = 2, + FromName = 3, + FromCustom = 4, +} + +export interface PaperlessMailRule extends ObjectWithId { + name: string + + account: number // PaperlessMailAccount.id + + folder: string + + filter_from: string + + filter_subject: string + + filter_body: string + + filter_attachment_filename: string + + maximum_age: number + + attachment_type: MailFilterAttachmentType + + action: MailAction + + action_parameter?: string + + assign_title_from: MailMetadataTitleOption + + assign_tags?: number[] // PaperlessTag.id + + assign_document_type?: number // PaperlessDocumentType.id + + assign_correspondent_from?: MailMetadataCorrespondentOption + + assign_correspondent?: number // PaperlessCorrespondent.id +} diff --git a/src-ui/src/app/guards/dirty-form.guard.ts b/src-ui/src/app/guards/dirty-form.guard.ts index 1205f3b0e..e20f1a848 100644 --- a/src-ui/src/app/guards/dirty-form.guard.ts +++ b/src-ui/src/app/guards/dirty-form.guard.ts @@ -1,7 +1,6 @@ import { Injectable } from '@angular/core' import { DirtyCheckGuard } from '@ngneat/dirty-check-forms' import { Observable, Subject } from 'rxjs' -import { map } from 'rxjs/operators' import { NgbModal } from '@ng-bootstrap/ng-bootstrap' import { ConfirmDialogComponent } from 'src/app/components/common/confirm-dialog/confirm-dialog.component' diff --git a/src-ui/src/app/services/rest/mail-account.service.ts b/src-ui/src/app/services/rest/mail-account.service.ts new file mode 100644 index 000000000..438aa8c90 --- /dev/null +++ b/src-ui/src/app/services/rest/mail-account.service.ts @@ -0,0 +1,51 @@ +import { HttpClient } from '@angular/common/http' +import { Injectable } from '@angular/core' +import { combineLatest, Observable } from 'rxjs' +import { tap } from 'rxjs/operators' +import { PaperlessMailAccount } from 'src/app/data/paperless-mail-account' +import { AbstractPaperlessService } from './abstract-paperless-service' + +@Injectable({ + providedIn: 'root', +}) +export class MailAccountService extends AbstractPaperlessService { + loading: boolean + + constructor(http: HttpClient) { + super(http, 'mail_accounts') + } + + private reload() { + this.loading = true + this.listAll().subscribe((r) => { + this.mailAccounts = r.results + this.loading = false + }) + } + + private mailAccounts: PaperlessMailAccount[] = [] + + get allAccounts() { + return this.mailAccounts + } + + create(o: PaperlessMailAccount) { + return super.create(o).pipe(tap(() => this.reload())) + } + + update(o: PaperlessMailAccount) { + return super.update(o).pipe(tap(() => this.reload())) + } + + patchMany( + objects: PaperlessMailAccount[] + ): Observable { + return combineLatest(objects.map((o) => super.patch(o))).pipe( + tap(() => this.reload()) + ) + } + + delete(o: PaperlessMailAccount) { + return super.delete(o).pipe(tap(() => this.reload())) + } +} diff --git a/src-ui/src/app/services/rest/mail-rule.service.ts b/src-ui/src/app/services/rest/mail-rule.service.ts new file mode 100644 index 000000000..c40157598 --- /dev/null +++ b/src-ui/src/app/services/rest/mail-rule.service.ts @@ -0,0 +1,49 @@ +import { HttpClient } from '@angular/common/http' +import { Injectable } from '@angular/core' +import { combineLatest, Observable } from 'rxjs' +import { tap } from 'rxjs/operators' +import { PaperlessMailRule } from 'src/app/data/paperless-mail-rule' +import { AbstractPaperlessService } from './abstract-paperless-service' + +@Injectable({ + providedIn: 'root', +}) +export class MailRuleService extends AbstractPaperlessService { + loading: boolean + + constructor(http: HttpClient) { + super(http, 'mail_rules') + } + + private reload() { + this.loading = true + this.listAll().subscribe((r) => { + this.mailRules = r.results + this.loading = false + }) + } + + private mailRules: PaperlessMailRule[] = [] + + get allRules() { + return this.mailRules + } + + create(o: PaperlessMailRule) { + return super.create(o).pipe(tap(() => this.reload())) + } + + update(o: PaperlessMailRule) { + return super.update(o).pipe(tap(() => this.reload())) + } + + patchMany(objects: PaperlessMailRule[]): Observable { + return combineLatest(objects.map((o) => super.patch(o))).pipe( + tap(() => this.reload()) + ) + } + + delete(o: PaperlessMailRule) { + return super.delete(o).pipe(tap(() => this.reload())) + } +} diff --git a/src-ui/src/styles.scss b/src-ui/src/styles.scss index fcb69c913..ab62dff25 100644 --- a/src-ui/src/styles.scss +++ b/src-ui/src/styles.scss @@ -242,10 +242,12 @@ a, a:hover, } .input-group { - .ng-select-container { - height: 100%; - border-top-right-radius: 0; - border-bottom-right-radius: 0; + ng-select:not(:last-child) { + .ng-select-container { + height: 100%; + border-top-right-radius: 0; + border-bottom-right-radius: 0; + } } } } diff --git a/src/paperless/urls.py b/src/paperless/urls.py index 46309e1e6..8e8f4b404 100644 --- a/src/paperless/urls.py +++ b/src/paperless/urls.py @@ -27,6 +27,8 @@ from documents.views import UiSettingsView from documents.views import UnifiedSearchViewSet from paperless.consumers import StatusConsumer from paperless.views import FaviconView +from paperless_mail.views import MailAccountViewSet +from paperless_mail.views import MailRuleViewSet from rest_framework.authtoken import views from rest_framework.routers import DefaultRouter @@ -39,6 +41,8 @@ api_router.register(r"tags", TagViewSet) api_router.register(r"saved_views", SavedViewViewSet) api_router.register(r"storage_paths", StoragePathViewSet) api_router.register(r"tasks", TasksViewSet, basename="tasks") +api_router.register(r"mail_accounts", MailAccountViewSet) +api_router.register(r"mail_rules", MailRuleViewSet) urlpatterns = [ diff --git a/src/paperless_mail/serialisers.py b/src/paperless_mail/serialisers.py new file mode 100644 index 000000000..5944656a7 --- /dev/null +++ b/src/paperless_mail/serialisers.py @@ -0,0 +1,110 @@ +from documents.serialisers import CorrespondentField +from documents.serialisers import DocumentTypeField +from documents.serialisers import TagsField +from paperless_mail.models import MailAccount +from paperless_mail.models import MailRule +from rest_framework import serializers + + +class ObfuscatedPasswordField(serializers.Field): + """ + Sends *** string instead of password in the clear + """ + + def to_representation(self, value): + return "*" * len(value) + + def to_internal_value(self, data): + return data + + +class MailAccountSerializer(serializers.ModelSerializer): + password = ObfuscatedPasswordField() + + class Meta: + model = MailAccount + depth = 1 + fields = [ + "id", + "name", + "imap_server", + "imap_port", + "imap_security", + "username", + "password", + "character_set", + ] + + def update(self, instance, validated_data): + if "password" in validated_data: + if len(validated_data.get("password").replace("*", "")) == 0: + validated_data.pop("password") + super().update(instance, validated_data) + return instance + + def create(self, validated_data): + mail_account = MailAccount.objects.create(**validated_data) + return mail_account + + +class AccountField(serializers.PrimaryKeyRelatedField): + def get_queryset(self): + return MailAccount.objects.all().order_by("-id") + + +class MailRuleSerializer(serializers.ModelSerializer): + account = AccountField(required=True) + action_parameter = serializers.CharField( + allow_null=True, + required=False, + default="", + ) + assign_correspondent = CorrespondentField(allow_null=True, required=False) + assign_tags = TagsField(many=True, allow_null=True, required=False) + assign_document_type = DocumentTypeField(allow_null=True, required=False) + order = serializers.IntegerField(required=False) + + class Meta: + model = MailRule + depth = 1 + fields = [ + "id", + "name", + "account", + "folder", + "filter_from", + "filter_subject", + "filter_body", + "filter_attachment_filename", + "maximum_age", + "action", + "action_parameter", + "assign_title_from", + "assign_tags", + "assign_correspondent_from", + "assign_correspondent", + "assign_document_type", + "order", + "attachment_type", + ] + + def update(self, instance, validated_data): + super().update(instance, validated_data) + return instance + + def create(self, validated_data): + if "assign_tags" in validated_data: + assign_tags = validated_data.pop("assign_tags") + mail_rule = MailRule.objects.create(**validated_data) + if assign_tags: + mail_rule.assign_tags.set(assign_tags) + return mail_rule + + def validate(self, attrs): + if ( + attrs["action"] == MailRule.MailAction.TAG + or attrs["action"] == MailRule.MailAction.MOVE + ) and attrs["action_parameter"] is None: + raise serializers.ValidationError("An action parameter is required.") + + return attrs diff --git a/src/paperless_mail/tests/test_api.py b/src/paperless_mail/tests/test_api.py new file mode 100644 index 000000000..d20ab5c9a --- /dev/null +++ b/src/paperless_mail/tests/test_api.py @@ -0,0 +1,429 @@ +from django.contrib.auth.models import User +from documents.models import Correspondent +from documents.models import DocumentType +from documents.models import Tag +from paperless_mail.models import MailAccount +from paperless_mail.models import MailRule +from rest_framework.test import APITestCase + + +class TestAPIMailAccounts(APITestCase): + ENDPOINT = "/api/mail_accounts/" + + def setUp(self): + super().setUp() + + self.user = User.objects.create_superuser(username="temp_admin") + self.client.force_authenticate(user=self.user) + + def test_get_mail_accounts(self): + """ + GIVEN: + - Configured mail accounts + WHEN: + - API call is made to get mail accounts + THEN: + - Configured mail accounts are provided + """ + + account1 = MailAccount.objects.create( + name="Email1", + username="username1", + password="password1", + imap_server="server.example.com", + imap_port=443, + imap_security=MailAccount.ImapSecurity.SSL, + character_set="UTF-8", + ) + + response = self.client.get(self.ENDPOINT) + + self.assertEqual(response.status_code, 200) + self.assertEqual(response.data["count"], 1) + returned_account1 = response.data["results"][0] + + self.assertEqual(returned_account1["name"], account1.name) + self.assertEqual(returned_account1["username"], account1.username) + self.assertEqual( + returned_account1["password"], + "*" * len(account1.password), + ) + self.assertEqual(returned_account1["imap_server"], account1.imap_server) + self.assertEqual(returned_account1["imap_port"], account1.imap_port) + self.assertEqual(returned_account1["imap_security"], account1.imap_security) + self.assertEqual(returned_account1["character_set"], account1.character_set) + + def test_create_mail_account(self): + """ + WHEN: + - API request is made to add a mail account + THEN: + - A new mail account is created + """ + + account1 = { + "name": "Email1", + "username": "username1", + "password": "password1", + "imap_server": "server.example.com", + "imap_port": 443, + "imap_security": MailAccount.ImapSecurity.SSL, + "character_set": "UTF-8", + } + + response = self.client.post( + self.ENDPOINT, + data=account1, + ) + + self.assertEqual(response.status_code, 201) + + returned_account1 = MailAccount.objects.get(name="Email1") + + self.assertEqual(returned_account1.name, account1["name"]) + self.assertEqual(returned_account1.username, account1["username"]) + self.assertEqual(returned_account1.password, account1["password"]) + self.assertEqual(returned_account1.imap_server, account1["imap_server"]) + self.assertEqual(returned_account1.imap_port, account1["imap_port"]) + self.assertEqual(returned_account1.imap_security, account1["imap_security"]) + self.assertEqual(returned_account1.character_set, account1["character_set"]) + + def test_delete_mail_account(self): + """ + GIVEN: + - Existing mail account + WHEN: + - API request is made to delete a mail account + THEN: + - Account is deleted + """ + + account1 = MailAccount.objects.create( + name="Email1", + username="username1", + password="password1", + imap_server="server.example.com", + imap_port=443, + imap_security=MailAccount.ImapSecurity.SSL, + character_set="UTF-8", + ) + + response = self.client.delete( + f"{self.ENDPOINT}{account1.pk}/", + ) + + self.assertEqual(response.status_code, 204) + + self.assertEqual(len(MailAccount.objects.all()), 0) + + def test_update_mail_account(self): + """ + GIVEN: + - Existing mail accounts + WHEN: + - API request is made to update mail account + THEN: + - The mail account is updated, password only updated if not '****' + """ + + account1 = MailAccount.objects.create( + name="Email1", + username="username1", + password="password1", + imap_server="server.example.com", + imap_port=443, + imap_security=MailAccount.ImapSecurity.SSL, + character_set="UTF-8", + ) + + response = self.client.patch( + f"{self.ENDPOINT}{account1.pk}/", + data={ + "name": "Updated Name 1", + "password": "******", + }, + ) + + self.assertEqual(response.status_code, 200) + + returned_account1 = MailAccount.objects.get(pk=account1.pk) + self.assertEqual(returned_account1.name, "Updated Name 1") + self.assertEqual(returned_account1.password, account1.password) + + response = self.client.patch( + f"{self.ENDPOINT}{account1.pk}/", + data={ + "name": "Updated Name 2", + "password": "123xyz", + }, + ) + + self.assertEqual(response.status_code, 200) + + returned_account2 = MailAccount.objects.get(pk=account1.pk) + self.assertEqual(returned_account2.name, "Updated Name 2") + self.assertEqual(returned_account2.password, "123xyz") + + +class TestAPIMailRules(APITestCase): + ENDPOINT = "/api/mail_rules/" + + def setUp(self): + super().setUp() + + self.user = User.objects.create_superuser(username="temp_admin") + self.client.force_authenticate(user=self.user) + + def test_get_mail_rules(self): + """ + GIVEN: + - Configured mail accounts and rules + WHEN: + - API call is made to get mail rules + THEN: + - Configured mail rules are provided + """ + + account1 = MailAccount.objects.create( + name="Email1", + username="username1", + password="password1", + imap_server="server.example.com", + imap_port=443, + imap_security=MailAccount.ImapSecurity.SSL, + character_set="UTF-8", + ) + + rule1 = MailRule.objects.create( + name="Rule1", + account=account1, + folder="INBOX", + filter_from="from@example.com", + filter_subject="subject", + filter_body="body", + filter_attachment_filename="file.pdf", + maximum_age=30, + action=MailRule.MailAction.MARK_READ, + assign_title_from=MailRule.TitleSource.FROM_SUBJECT, + assign_correspondent_from=MailRule.CorrespondentSource.FROM_NOTHING, + order=0, + attachment_type=MailRule.AttachmentProcessing.ATTACHMENTS_ONLY, + ) + + response = self.client.get(self.ENDPOINT) + + self.assertEqual(response.status_code, 200) + self.assertEqual(response.data["count"], 1) + returned_rule1 = response.data["results"][0] + + self.assertEqual(returned_rule1["name"], rule1.name) + self.assertEqual(returned_rule1["account"], account1.pk) + self.assertEqual(returned_rule1["folder"], rule1.folder) + self.assertEqual(returned_rule1["filter_from"], rule1.filter_from) + self.assertEqual(returned_rule1["filter_subject"], rule1.filter_subject) + self.assertEqual(returned_rule1["filter_body"], rule1.filter_body) + self.assertEqual( + returned_rule1["filter_attachment_filename"], + rule1.filter_attachment_filename, + ) + self.assertEqual(returned_rule1["maximum_age"], rule1.maximum_age) + self.assertEqual(returned_rule1["action"], rule1.action) + self.assertEqual(returned_rule1["assign_title_from"], rule1.assign_title_from) + self.assertEqual( + returned_rule1["assign_correspondent_from"], + rule1.assign_correspondent_from, + ) + self.assertEqual(returned_rule1["order"], rule1.order) + self.assertEqual(returned_rule1["attachment_type"], rule1.attachment_type) + + def test_create_mail_rule(self): + """ + GIVEN: + - Configured mail account exists + WHEN: + - API request is made to add a mail rule + THEN: + - A new mail rule is created + """ + + account1 = MailAccount.objects.create( + name="Email1", + username="username1", + password="password1", + imap_server="server.example.com", + imap_port=443, + imap_security=MailAccount.ImapSecurity.SSL, + character_set="UTF-8", + ) + + tag = Tag.objects.create( + name="t", + ) + + correspondent = Correspondent.objects.create( + name="c", + ) + + document_type = DocumentType.objects.create( + name="dt", + ) + + rule1 = { + "name": "Rule1", + "account": account1.pk, + "folder": "INBOX", + "filter_from": "from@example.com", + "filter_subject": "subject", + "filter_body": "body", + "filter_attachment_filename": "file.pdf", + "maximum_age": 30, + "action": MailRule.MailAction.MARK_READ, + "assign_title_from": MailRule.TitleSource.FROM_SUBJECT, + "assign_correspondent_from": MailRule.CorrespondentSource.FROM_NOTHING, + "order": 0, + "attachment_type": MailRule.AttachmentProcessing.ATTACHMENTS_ONLY, + "action_parameter": "parameter", + "assign_tags": [tag.pk], + "assign_correspondent": correspondent.pk, + "assign_document_type": document_type.pk, + } + + response = self.client.post( + self.ENDPOINT, + data=rule1, + ) + + self.assertEqual(response.status_code, 201) + + response = self.client.get(self.ENDPOINT) + + self.assertEqual(response.status_code, 200) + self.assertEqual(response.data["count"], 1) + returned_rule1 = response.data["results"][0] + + self.assertEqual(returned_rule1["name"], rule1["name"]) + self.assertEqual(returned_rule1["account"], account1.pk) + self.assertEqual(returned_rule1["folder"], rule1["folder"]) + self.assertEqual(returned_rule1["filter_from"], rule1["filter_from"]) + self.assertEqual(returned_rule1["filter_subject"], rule1["filter_subject"]) + self.assertEqual(returned_rule1["filter_body"], rule1["filter_body"]) + self.assertEqual( + returned_rule1["filter_attachment_filename"], + rule1["filter_attachment_filename"], + ) + self.assertEqual(returned_rule1["maximum_age"], rule1["maximum_age"]) + self.assertEqual(returned_rule1["action"], rule1["action"]) + self.assertEqual( + returned_rule1["assign_title_from"], + rule1["assign_title_from"], + ) + self.assertEqual( + returned_rule1["assign_correspondent_from"], + rule1["assign_correspondent_from"], + ) + self.assertEqual(returned_rule1["order"], rule1["order"]) + self.assertEqual(returned_rule1["attachment_type"], rule1["attachment_type"]) + self.assertEqual(returned_rule1["action_parameter"], rule1["action_parameter"]) + self.assertEqual( + returned_rule1["assign_correspondent"], + rule1["assign_correspondent"], + ) + self.assertEqual( + returned_rule1["assign_document_type"], + rule1["assign_document_type"], + ) + self.assertEqual(returned_rule1["assign_tags"], rule1["assign_tags"]) + + def test_delete_mail_rule(self): + """ + GIVEN: + - Existing mail rule + WHEN: + - API request is made to delete a mail rule + THEN: + - Rule is deleted + """ + + account1 = MailAccount.objects.create( + name="Email1", + username="username1", + password="password1", + imap_server="server.example.com", + imap_port=443, + imap_security=MailAccount.ImapSecurity.SSL, + character_set="UTF-8", + ) + + rule1 = MailRule.objects.create( + name="Rule1", + account=account1, + folder="INBOX", + filter_from="from@example.com", + filter_subject="subject", + filter_body="body", + filter_attachment_filename="file.pdf", + maximum_age=30, + action=MailRule.MailAction.MARK_READ, + assign_title_from=MailRule.TitleSource.FROM_SUBJECT, + assign_correspondent_from=MailRule.CorrespondentSource.FROM_NOTHING, + order=0, + attachment_type=MailRule.AttachmentProcessing.ATTACHMENTS_ONLY, + ) + + response = self.client.delete( + f"{self.ENDPOINT}{rule1.pk}/", + ) + + self.assertEqual(response.status_code, 204) + + self.assertEqual(len(MailRule.objects.all()), 0) + + def test_update_mail_rule(self): + """ + GIVEN: + - Existing mail rule + WHEN: + - API request is made to update mail rule + THEN: + - The mail rule is updated + """ + + account1 = MailAccount.objects.create( + name="Email1", + username="username1", + password="password1", + imap_server="server.example.com", + imap_port=443, + imap_security=MailAccount.ImapSecurity.SSL, + character_set="UTF-8", + ) + + rule1 = MailRule.objects.create( + name="Rule1", + account=account1, + folder="INBOX", + filter_from="from@example.com", + filter_subject="subject", + filter_body="body", + filter_attachment_filename="file.pdf", + maximum_age=30, + action=MailRule.MailAction.MARK_READ, + assign_title_from=MailRule.TitleSource.FROM_SUBJECT, + assign_correspondent_from=MailRule.CorrespondentSource.FROM_NOTHING, + order=0, + attachment_type=MailRule.AttachmentProcessing.ATTACHMENTS_ONLY, + ) + + response = self.client.patch( + f"{self.ENDPOINT}{rule1.pk}/", + data={ + "name": "Updated Name 1", + "action": MailRule.MailAction.DELETE, + }, + ) + + self.assertEqual(response.status_code, 200) + + returned_rule1 = MailRule.objects.get(pk=rule1.pk) + self.assertEqual(returned_rule1.name, "Updated Name 1") + self.assertEqual(returned_rule1.action, MailRule.MailAction.DELETE) diff --git a/src/paperless_mail/views.py b/src/paperless_mail/views.py new file mode 100644 index 000000000..d86240c7c --- /dev/null +++ b/src/paperless_mail/views.py @@ -0,0 +1,41 @@ +from paperless.views import StandardPagination +from paperless_mail.models import MailAccount +from paperless_mail.models import MailRule +from paperless_mail.serialisers import MailAccountSerializer +from paperless_mail.serialisers import MailRuleSerializer +from rest_framework.permissions import IsAuthenticated +from rest_framework.viewsets import ModelViewSet + + +class MailAccountViewSet(ModelViewSet): + model = MailAccount + + queryset = MailAccount.objects.all().order_by("pk") + serializer_class = MailAccountSerializer + pagination_class = StandardPagination + permission_classes = (IsAuthenticated,) + + # TODO: user-scoped + # def get_queryset(self): + # user = self.request.user + # return MailAccount.objects.filter(user=user) + + # def perform_create(self, serializer): + # serializer.save(user=self.request.user) + + +class MailRuleViewSet(ModelViewSet): + model = MailRule + + queryset = MailRule.objects.all().order_by("pk") + serializer_class = MailRuleSerializer + pagination_class = StandardPagination + permission_classes = (IsAuthenticated,) + + # TODO: user-scoped + # def get_queryset(self): + # user = self.request.user + # return MailRule.objects.filter(user=user) + + # def perform_create(self, serializer): + # serializer.save(user=self.request.user)