mirror of
https://github.com/paperless-ngx/paperless-ngx.git
synced 2025-09-16 21:55:37 -05:00
Compare commits
1 Commits
feature-pr
...
dependabot
Author | SHA1 | Date | |
---|---|---|---|
![]() |
016ccbcc96 |
@@ -251,10 +251,6 @@ different means. These are as follows:
|
|||||||
Paperless is set up to check your mails every 10 minutes. This can be
|
Paperless is set up to check your mails every 10 minutes. This can be
|
||||||
configured via [`PAPERLESS_EMAIL_TASK_CRON`](configuration.md#PAPERLESS_EMAIL_TASK_CRON)
|
configured via [`PAPERLESS_EMAIL_TASK_CRON`](configuration.md#PAPERLESS_EMAIL_TASK_CRON)
|
||||||
|
|
||||||
#### Processed Mail
|
|
||||||
|
|
||||||
Paperless keeps track of emails it has processed in order to avoid processing the same mail multiple times. This uses the message `UID` provided by the mail server, which should be unique for each message. You can view and manage processed mails from the web UI under Mail > Processed Mails. If you need to re-process a message, you can delete the corresponding processed mail entry, which will allow Paperless-ngx to process the email again the next time the mail fetch task runs.
|
|
||||||
|
|
||||||
#### OAuth Email Setup
|
#### OAuth Email Setup
|
||||||
|
|
||||||
Paperless-ngx supports OAuth2 authentication for Gmail and Outlook email accounts. To set up an email account with OAuth2, you will need to create a 'developer' app with the respective provider and obtain the client ID and client secret and set the appropriate [configuration variables](configuration.md#email_oauth). You will also need to set either [`PAPERLESS_OAUTH_CALLBACK_BASE_URL`](configuration.md#PAPERLESS_OAUTH_CALLBACK_BASE_URL) or [`PAPERLESS_URL`](configuration.md#PAPERLESS_URL) to the correct value for the OAuth2 flow to work correctly.
|
Paperless-ngx supports OAuth2 authentication for Gmail and Outlook email accounts. To set up an email account with OAuth2, you will need to create a 'developer' app with the respective provider and obtain the client ID and client secret and set the appropriate [configuration variables](configuration.md#email_oauth). You will also need to set either [`PAPERLESS_OAUTH_CALLBACK_BASE_URL`](configuration.md#PAPERLESS_OAUTH_CALLBACK_BASE_URL) or [`PAPERLESS_URL`](configuration.md#PAPERLESS_URL) to the correct value for the OAuth2 flow to work correctly.
|
||||||
|
@@ -50,7 +50,7 @@ dependencies = [
|
|||||||
"jinja2~=3.1.5",
|
"jinja2~=3.1.5",
|
||||||
"langdetect~=1.0.9",
|
"langdetect~=1.0.9",
|
||||||
"nltk~=3.9.1",
|
"nltk~=3.9.1",
|
||||||
"ocrmypdf~=16.10.0",
|
"ocrmypdf~=16.11.0",
|
||||||
"pathvalidate~=3.3.1",
|
"pathvalidate~=3.3.1",
|
||||||
"pdf2image~=1.17.0",
|
"pdf2image~=1.17.0",
|
||||||
"psycopg-pool",
|
"psycopg-pool",
|
||||||
|
@@ -109,11 +109,10 @@
|
|||||||
<li class="list-group-item">
|
<li class="list-group-item">
|
||||||
<div class="row">
|
<div class="row">
|
||||||
<div class="col" i18n>Name</div>
|
<div class="col" i18n>Name</div>
|
||||||
<div class="col-1 d-none d-sm-block" i18n>Sort Order</div>
|
<div class="col d-none d-sm-block" i18n>Sort Order</div>
|
||||||
<div class="col-2" i18n>Account</div>
|
<div class="col" i18n>Account</div>
|
||||||
<div class="col-2 d-none d-sm-block" i18n>Status</div>
|
<div class="col d-none d-sm-block" i18n>Status</div>
|
||||||
<div class="col d-none d-sm-block" *pngxIfPermissions="{ action: PermissionAction.View, type: PermissionType.ProcessedMail }">Processed Mail</div>
|
<div class="col" i18n>Actions</div>
|
||||||
<div class="col-3" i18n>Actions</div>
|
|
||||||
</div>
|
</div>
|
||||||
</li>
|
</li>
|
||||||
|
|
||||||
@@ -128,9 +127,9 @@
|
|||||||
<li class="list-group-item">
|
<li class="list-group-item">
|
||||||
<div class="row fade" [class.show]="showRules">
|
<div class="row fade" [class.show]="showRules">
|
||||||
<div class="col d-flex align-items-center"><button class="btn btn-link p-0 text-start" type="button" (click)="editMailRule(rule)" [disabled]="!permissionsService.currentUserCan(PermissionAction.Change, PermissionType.MailRule) || !userCanEdit(rule)">{{rule.name}}</button></div>
|
<div class="col d-flex align-items-center"><button class="btn btn-link p-0 text-start" type="button" (click)="editMailRule(rule)" [disabled]="!permissionsService.currentUserCan(PermissionAction.Change, PermissionType.MailRule) || !userCanEdit(rule)">{{rule.name}}</button></div>
|
||||||
<div class="col-1 d-flex align-items-center d-none d-sm-flex">{{rule.order}}</div>
|
<div class="col d-flex align-items-center d-none d-sm-flex">{{rule.order}}</div>
|
||||||
<div class="col-2 d-flex align-items-center">{{(mailAccountService.getCached(rule.account) | async)?.name}}</div>
|
<div class="col d-flex align-items-center">{{(mailAccountService.getCached(rule.account) | async)?.name}}</div>
|
||||||
<div class="col-2 d-flex align-items-center d-none d-sm-flex">
|
<div class="col d-flex align-items-center d-none d-sm-flex">
|
||||||
<div class="form-check form-switch mb-0">
|
<div class="form-check form-switch mb-0">
|
||||||
<input #inputField type="checkbox" class="form-check-input cursor-pointer" [id]="rule.id+'_enable'" [(ngModel)]="rule.enabled" (change)="onMailRuleEnableToggled(rule)" *pngxIfPermissions="{ action: PermissionAction.Change, type: PermissionType.MailRule }">
|
<input #inputField type="checkbox" class="form-check-input cursor-pointer" [id]="rule.id+'_enable'" [(ngModel)]="rule.enabled" (change)="onMailRuleEnableToggled(rule)" *pngxIfPermissions="{ action: PermissionAction.Change, type: PermissionType.MailRule }">
|
||||||
<label class="form-check-label cursor-pointer" [for]="rule.id+'_enable'">
|
<label class="form-check-label cursor-pointer" [for]="rule.id+'_enable'">
|
||||||
@@ -138,12 +137,7 @@
|
|||||||
</label>
|
</label>
|
||||||
</div>
|
</div>
|
||||||
</div>
|
</div>
|
||||||
<div class="col d-flex align-items-center d-none d-sm-flex" *pngxIfPermissions="{ action: PermissionAction.View, type: PermissionType.ProcessedMail }">
|
<div class="col">
|
||||||
<button class="btn btn-sm btn-outline-secondary" type="button" (click)="viewProcessedMail(rule)">
|
|
||||||
<i-bs width="1em" height="1em" name="clock-history"></i-bs> <ng-container i18n>View Processed Mail</ng-container>
|
|
||||||
</button>
|
|
||||||
</div>
|
|
||||||
<div class="col-3">
|
|
||||||
<div class="btn-group d-block d-sm-none">
|
<div class="btn-group d-block d-sm-none">
|
||||||
<div ngbDropdown container="body" class="d-inline-block">
|
<div ngbDropdown container="body" class="d-inline-block">
|
||||||
<button type="button" class="btn btn-link" id="actionsMenuMobile" (click)="$event.stopPropagation()" ngbDropdownToggle>
|
<button type="button" class="btn btn-link" id="actionsMenuMobile" (click)="$event.stopPropagation()" ngbDropdownToggle>
|
||||||
|
@@ -409,13 +409,4 @@ describe('MailComponent', () => {
|
|||||||
jest.advanceTimersByTime(200)
|
jest.advanceTimersByTime(200)
|
||||||
expect(editSpy).toHaveBeenCalled()
|
expect(editSpy).toHaveBeenCalled()
|
||||||
})
|
})
|
||||||
|
|
||||||
it('should open processed mails dialog', () => {
|
|
||||||
completeSetup()
|
|
||||||
let modal: NgbModalRef
|
|
||||||
modalService.activeInstances.subscribe((refs) => (modal = refs[0]))
|
|
||||||
component.viewProcessedMail(mailRules[0] as MailRule)
|
|
||||||
const dialog = modal.componentInstance as any
|
|
||||||
expect(dialog.rule).toEqual(mailRules[0])
|
|
||||||
})
|
|
||||||
})
|
})
|
||||||
|
@@ -27,7 +27,6 @@ import { MailRuleEditDialogComponent } from '../../common/edit-dialog/mail-rule-
|
|||||||
import { PageHeaderComponent } from '../../common/page-header/page-header.component'
|
import { PageHeaderComponent } from '../../common/page-header/page-header.component'
|
||||||
import { PermissionsDialogComponent } from '../../common/permissions-dialog/permissions-dialog.component'
|
import { PermissionsDialogComponent } from '../../common/permissions-dialog/permissions-dialog.component'
|
||||||
import { ComponentWithPermissions } from '../../with-permissions/with-permissions.component'
|
import { ComponentWithPermissions } from '../../with-permissions/with-permissions.component'
|
||||||
import { ProcessedMailDialogComponent } from './processed-mail-dialog/processed-mail-dialog.component'
|
|
||||||
|
|
||||||
@Component({
|
@Component({
|
||||||
selector: 'pngx-mail',
|
selector: 'pngx-mail',
|
||||||
@@ -348,14 +347,6 @@ export class MailComponent
|
|||||||
)
|
)
|
||||||
}
|
}
|
||||||
|
|
||||||
viewProcessedMail(rule: MailRule) {
|
|
||||||
const modal = this.modalService.open(ProcessedMailDialogComponent, {
|
|
||||||
backdrop: 'static',
|
|
||||||
size: 'xl',
|
|
||||||
})
|
|
||||||
modal.componentInstance.rule = rule
|
|
||||||
}
|
|
||||||
|
|
||||||
userCanEdit(obj: ObjectWithPermissions): boolean {
|
userCanEdit(obj: ObjectWithPermissions): boolean {
|
||||||
return this.permissionsService.currentUserHasObjectPermissions(
|
return this.permissionsService.currentUserHasObjectPermissions(
|
||||||
PermissionAction.Change,
|
PermissionAction.Change,
|
||||||
|
@@ -1,107 +0,0 @@
|
|||||||
<div class="modal-header">
|
|
||||||
<h6 class="modal-title" id="modal-basic-title" i18n>Processed Mail for <em>{{ rule.name }}</em></h6>
|
|
||||||
<button class="btn btn-sm btn-link text-muted me-auto p-0 p-md-2" title="What's this?" i18n-title type="button" [ngbPopover]="infoPopover" [autoClose]="true">
|
|
||||||
<i-bs name="question-circle"></i-bs>
|
|
||||||
</button>
|
|
||||||
<ng-template #infoPopover>
|
|
||||||
<a href="https://docs.paperless-ngx.com/usage#processed-mail" target="_blank" referrerpolicy="noopener noreferrer" i18n>Read more</a>
|
|
||||||
<i-bs class="ms-1" width=".8em" height=".8em" name="box-arrow-up-right"></i-bs>
|
|
||||||
</ng-template>
|
|
||||||
<button type="button" class="btn-close" aria-label="Close" (click)="close()"></button>
|
|
||||||
</div>
|
|
||||||
<div class="modal-body">
|
|
||||||
@if (loading) {
|
|
||||||
<div class="text-center my-5">
|
|
||||||
<div class="spinner-border" role="status">
|
|
||||||
<span class="visually-hidden" i18n>Loading...</span>
|
|
||||||
</div>
|
|
||||||
</div>
|
|
||||||
} @else if (processedMails.length === 0) {
|
|
||||||
<span i18n>No processed email messages found.</span>
|
|
||||||
} @else {
|
|
||||||
<div class="table-responsive">
|
|
||||||
<table class="table table-hover table-sm align-middle">
|
|
||||||
<thead>
|
|
||||||
<tr>
|
|
||||||
<th scope="col" style="width: 40px;">
|
|
||||||
<div class="form-check m-0 ms-2 me-n2">
|
|
||||||
<input type="checkbox" class="form-check-input" id="all-objects" [(ngModel)]="toggleAllEnabled" [disabled]="processedMails.length === 0" (click)="toggleAll($event); $event.stopPropagation();">
|
|
||||||
<label class="form-check-label" for="all-objects"></label>
|
|
||||||
</div>
|
|
||||||
</th>
|
|
||||||
<th scope="col" i18n>Subject</th>
|
|
||||||
<th scope="col" i18n>Received</th>
|
|
||||||
<th scope="col" i18n>Processed</th>
|
|
||||||
<th scope="col" i18n>Status</th>
|
|
||||||
<th scope="col" i18n>Error</th>
|
|
||||||
</tr>
|
|
||||||
</thead>
|
|
||||||
<tbody>
|
|
||||||
@for (mail of processedMails; track mail.id) {
|
|
||||||
<ng-template #statusTooltip>
|
|
||||||
<div class="small text-light font-monospace">
|
|
||||||
{{mail.status}}
|
|
||||||
</div>
|
|
||||||
</ng-template>
|
|
||||||
<tr>
|
|
||||||
<td>
|
|
||||||
<div class="form-check m-0 ms-2 me-n2">
|
|
||||||
<input type="checkbox" class="form-check-input" [id]="mail.id" [checked]="selectedMailIds.has(mail.id)" (click)="toggleSelected(mail); $event.stopPropagation();">
|
|
||||||
<label class="form-check-label" [for]="mail.id"></label>
|
|
||||||
</div>
|
|
||||||
</td>
|
|
||||||
<td>{{ mail.subject }}</td>
|
|
||||||
<td>{{ mail.received | customDate:'longDate' }}</td>
|
|
||||||
<td>{{ mail.processed | customDate:'longDate' }}</td>
|
|
||||||
<td>
|
|
||||||
@switch (mail.status) {
|
|
||||||
@case ('SUCCESS') {
|
|
||||||
<i-bs name="check-circle" title="SUCCESS" class="text-success" [ngbTooltip]="statusTooltip"></i-bs>
|
|
||||||
}
|
|
||||||
@case ('FAILED') {
|
|
||||||
<i-bs name="exclamation-triangle" title="FAILED" class="text-danger" [ngbTooltip]="statusTooltip"></i-bs>
|
|
||||||
}
|
|
||||||
@default {
|
|
||||||
<i-bs name="slash-circle" title="{{ mail.status }}" class="text-muted" [ngbTooltip]="statusTooltip"></i-bs>
|
|
||||||
}
|
|
||||||
}
|
|
||||||
</td>
|
|
||||||
<td>
|
|
||||||
<ng-template #errorPopover>
|
|
||||||
<pre class="small text-light">
|
|
||||||
{{ mail.error }}
|
|
||||||
</pre>
|
|
||||||
</ng-template>
|
|
||||||
@if (mail.error) {
|
|
||||||
<span class="text-danger" triggers="mouseenter:mouseleave" [ngbPopover]="errorPopover">{{ mail.error | slice:0:20 }}</span>
|
|
||||||
}
|
|
||||||
</td>
|
|
||||||
</tr>
|
|
||||||
}
|
|
||||||
</tbody>
|
|
||||||
</table>
|
|
||||||
</div>
|
|
||||||
<div class="btn-toolbar">
|
|
||||||
<button type="button" class="btn btn-outline-secondary me-2" (click)="clearSelection()" [disabled]="selectedMailIds.size === 0" i18n>Clear</button>
|
|
||||||
<pngx-confirm-button
|
|
||||||
label="Delete selected"
|
|
||||||
i18n-label
|
|
||||||
title="Delete selected"
|
|
||||||
i18n-title
|
|
||||||
buttonClasses="btn-outline-danger"
|
|
||||||
iconName="trash"
|
|
||||||
[disabled]="selectedMailIds.size === 0"
|
|
||||||
(confirm)="deleteSelected()">
|
|
||||||
</pngx-confirm-button>
|
|
||||||
<div class="ms-auto">
|
|
||||||
<ngb-pagination
|
|
||||||
[collectionSize]="processedMails.length"
|
|
||||||
[(page)]="page"
|
|
||||||
[pageSize]="50"
|
|
||||||
[maxSize]="5"
|
|
||||||
(pageChange)="loadProcessedMails()">
|
|
||||||
</ngb-pagination>
|
|
||||||
</div>
|
|
||||||
</div>
|
|
||||||
}
|
|
||||||
</div>
|
|
@@ -1,8 +0,0 @@
|
|||||||
::ng-deep .popover {
|
|
||||||
max-width: 350px;
|
|
||||||
|
|
||||||
pre {
|
|
||||||
white-space: pre-wrap;
|
|
||||||
word-break: break-word;
|
|
||||||
}
|
|
||||||
}
|
|
@@ -1,150 +0,0 @@
|
|||||||
import { DatePipe } from '@angular/common'
|
|
||||||
import { provideHttpClient, withInterceptorsFromDi } from '@angular/common/http'
|
|
||||||
import {
|
|
||||||
HttpTestingController,
|
|
||||||
provideHttpClientTesting,
|
|
||||||
} from '@angular/common/http/testing'
|
|
||||||
import { ComponentFixture, TestBed } from '@angular/core/testing'
|
|
||||||
import { FormsModule } from '@angular/forms'
|
|
||||||
import { By } from '@angular/platform-browser'
|
|
||||||
import { NgbActiveModal } from '@ng-bootstrap/ng-bootstrap'
|
|
||||||
import { NgxBootstrapIconsModule, allIcons } from 'ngx-bootstrap-icons'
|
|
||||||
import { ToastService } from 'src/app/services/toast.service'
|
|
||||||
import { environment } from 'src/environments/environment'
|
|
||||||
import { ProcessedMailDialogComponent } from './processed-mail-dialog.component'
|
|
||||||
|
|
||||||
describe('ProcessedMailDialogComponent', () => {
|
|
||||||
let component: ProcessedMailDialogComponent
|
|
||||||
let fixture: ComponentFixture<ProcessedMailDialogComponent>
|
|
||||||
let httpTestingController: HttpTestingController
|
|
||||||
let toastService: ToastService
|
|
||||||
|
|
||||||
const rule: any = { id: 10, name: 'Mail Rule' } // minimal rule object for tests
|
|
||||||
const mails = [
|
|
||||||
{
|
|
||||||
id: 1,
|
|
||||||
rule: rule.id,
|
|
||||||
folder: 'INBOX',
|
|
||||||
uid: 111,
|
|
||||||
subject: 'A',
|
|
||||||
received: new Date().toISOString(),
|
|
||||||
processed: new Date().toISOString(),
|
|
||||||
status: 'SUCCESS',
|
|
||||||
error: null,
|
|
||||||
},
|
|
||||||
{
|
|
||||||
id: 2,
|
|
||||||
rule: rule.id,
|
|
||||||
folder: 'INBOX',
|
|
||||||
uid: 222,
|
|
||||||
subject: 'B',
|
|
||||||
received: new Date().toISOString(),
|
|
||||||
processed: new Date().toISOString(),
|
|
||||||
status: 'FAILED',
|
|
||||||
error: 'Oops',
|
|
||||||
},
|
|
||||||
]
|
|
||||||
|
|
||||||
beforeEach(async () => {
|
|
||||||
await TestBed.configureTestingModule({
|
|
||||||
imports: [
|
|
||||||
ProcessedMailDialogComponent,
|
|
||||||
FormsModule,
|
|
||||||
NgxBootstrapIconsModule.pick(allIcons),
|
|
||||||
],
|
|
||||||
providers: [
|
|
||||||
DatePipe,
|
|
||||||
NgbActiveModal,
|
|
||||||
provideHttpClient(withInterceptorsFromDi()),
|
|
||||||
provideHttpClientTesting(),
|
|
||||||
],
|
|
||||||
}).compileComponents()
|
|
||||||
|
|
||||||
httpTestingController = TestBed.inject(HttpTestingController)
|
|
||||||
toastService = TestBed.inject(ToastService)
|
|
||||||
fixture = TestBed.createComponent(ProcessedMailDialogComponent)
|
|
||||||
component = fixture.componentInstance
|
|
||||||
component.rule = rule
|
|
||||||
})
|
|
||||||
|
|
||||||
afterEach(() => {
|
|
||||||
httpTestingController.verify()
|
|
||||||
})
|
|
||||||
|
|
||||||
function expectListRequest(ruleId: number) {
|
|
||||||
const req = httpTestingController.expectOne(
|
|
||||||
`${environment.apiBaseUrl}processed_mail/?page=1&page_size=50&ordering=-processed_at&rule=${ruleId}`
|
|
||||||
)
|
|
||||||
expect(req.request.method).toEqual('GET')
|
|
||||||
return req
|
|
||||||
}
|
|
||||||
|
|
||||||
it('should load processed mails on init', () => {
|
|
||||||
fixture.detectChanges()
|
|
||||||
const req = expectListRequest(rule.id)
|
|
||||||
req.flush({ count: 2, results: mails })
|
|
||||||
expect(component.loading).toBeFalsy()
|
|
||||||
expect(component.processedMails).toEqual(mails)
|
|
||||||
})
|
|
||||||
|
|
||||||
it('should delete selected mails and reload', () => {
|
|
||||||
fixture.detectChanges()
|
|
||||||
// initial load
|
|
||||||
const initialReq = expectListRequest(rule.id)
|
|
||||||
initialReq.flush({ count: 0, results: [] })
|
|
||||||
|
|
||||||
// select a couple of mails and delete
|
|
||||||
component.selectedMailIds.add(5)
|
|
||||||
component.selectedMailIds.add(6)
|
|
||||||
const toastInfoSpy = jest.spyOn(toastService, 'showInfo')
|
|
||||||
component.deleteSelected()
|
|
||||||
|
|
||||||
const delReq = httpTestingController.expectOne(
|
|
||||||
`${environment.apiBaseUrl}processed_mail/bulk_delete/`
|
|
||||||
)
|
|
||||||
expect(delReq.request.method).toEqual('POST')
|
|
||||||
expect(delReq.request.body).toEqual({ mail_ids: [5, 6] })
|
|
||||||
delReq.flush({})
|
|
||||||
|
|
||||||
// reload after delete
|
|
||||||
const reloadReq = expectListRequest(rule.id)
|
|
||||||
reloadReq.flush({ count: 0, results: [] })
|
|
||||||
expect(toastInfoSpy).toHaveBeenCalled()
|
|
||||||
})
|
|
||||||
|
|
||||||
it('should toggle all, toggle selected, and clear selection', () => {
|
|
||||||
fixture.detectChanges()
|
|
||||||
// initial load with two mails
|
|
||||||
const req = expectListRequest(rule.id)
|
|
||||||
req.flush({ count: 2, results: mails })
|
|
||||||
fixture.detectChanges()
|
|
||||||
|
|
||||||
// toggle all via header checkbox
|
|
||||||
const inputs = fixture.debugElement.queryAll(
|
|
||||||
By.css('input.form-check-input')
|
|
||||||
)
|
|
||||||
const header = inputs[0].nativeElement as HTMLInputElement
|
|
||||||
header.dispatchEvent(new Event('click'))
|
|
||||||
header.checked = true
|
|
||||||
header.dispatchEvent(new Event('click'))
|
|
||||||
expect(component.selectedMailIds.size).toEqual(mails.length)
|
|
||||||
|
|
||||||
// toggle a single mail
|
|
||||||
component.toggleSelected(mails[0] as any)
|
|
||||||
expect(component.selectedMailIds.has(mails[0].id)).toBeFalsy()
|
|
||||||
component.toggleSelected(mails[0] as any)
|
|
||||||
expect(component.selectedMailIds.has(mails[0].id)).toBeTruthy()
|
|
||||||
|
|
||||||
// clear selection
|
|
||||||
component.clearSelection()
|
|
||||||
expect(component.selectedMailIds.size).toEqual(0)
|
|
||||||
expect(component.toggleAllEnabled).toBeFalsy()
|
|
||||||
})
|
|
||||||
|
|
||||||
it('should close the dialog', () => {
|
|
||||||
const activeModal = TestBed.inject(NgbActiveModal)
|
|
||||||
const closeSpy = jest.spyOn(activeModal, 'close')
|
|
||||||
component.close()
|
|
||||||
expect(closeSpy).toHaveBeenCalled()
|
|
||||||
})
|
|
||||||
})
|
|
@@ -1,96 +0,0 @@
|
|||||||
import { SlicePipe } from '@angular/common'
|
|
||||||
import { Component, inject, Input, OnInit } from '@angular/core'
|
|
||||||
import { FormsModule, ReactiveFormsModule } from '@angular/forms'
|
|
||||||
import {
|
|
||||||
NgbActiveModal,
|
|
||||||
NgbPagination,
|
|
||||||
NgbPopoverModule,
|
|
||||||
NgbTooltipModule,
|
|
||||||
} from '@ng-bootstrap/ng-bootstrap'
|
|
||||||
import { NgxBootstrapIconsModule } from 'ngx-bootstrap-icons'
|
|
||||||
import { ConfirmButtonComponent } from 'src/app/components/common/confirm-button/confirm-button.component'
|
|
||||||
import { MailRule } from 'src/app/data/mail-rule'
|
|
||||||
import { ProcessedMail } from 'src/app/data/processed-mail'
|
|
||||||
import { CustomDatePipe } from 'src/app/pipes/custom-date.pipe'
|
|
||||||
import { ProcessedMailService } from 'src/app/services/rest/processed-mail.service'
|
|
||||||
import { ToastService } from 'src/app/services/toast.service'
|
|
||||||
|
|
||||||
@Component({
|
|
||||||
selector: 'pngx-processed-mail-dialog',
|
|
||||||
imports: [
|
|
||||||
ConfirmButtonComponent,
|
|
||||||
CustomDatePipe,
|
|
||||||
NgbPagination,
|
|
||||||
NgbPopoverModule,
|
|
||||||
NgbTooltipModule,
|
|
||||||
NgxBootstrapIconsModule,
|
|
||||||
FormsModule,
|
|
||||||
ReactiveFormsModule,
|
|
||||||
SlicePipe,
|
|
||||||
],
|
|
||||||
templateUrl: './processed-mail-dialog.component.html',
|
|
||||||
styleUrl: './processed-mail-dialog.component.scss',
|
|
||||||
})
|
|
||||||
export class ProcessedMailDialogComponent implements OnInit {
|
|
||||||
private readonly activeModal = inject(NgbActiveModal)
|
|
||||||
private readonly processedMailService = inject(ProcessedMailService)
|
|
||||||
private readonly toastService = inject(ToastService)
|
|
||||||
|
|
||||||
public processedMails: ProcessedMail[] = []
|
|
||||||
|
|
||||||
public loading: boolean = true
|
|
||||||
public toggleAllEnabled: boolean = false
|
|
||||||
public readonly selectedMailIds: Set<number> = new Set<number>()
|
|
||||||
|
|
||||||
public page: number = 1
|
|
||||||
|
|
||||||
@Input() rule: MailRule
|
|
||||||
|
|
||||||
ngOnInit(): void {
|
|
||||||
this.loadProcessedMails()
|
|
||||||
}
|
|
||||||
|
|
||||||
public close() {
|
|
||||||
this.activeModal.close()
|
|
||||||
}
|
|
||||||
|
|
||||||
private loadProcessedMails(): void {
|
|
||||||
this.loading = true
|
|
||||||
this.clearSelection()
|
|
||||||
this.processedMailService
|
|
||||||
.list(this.page, 50, 'processed_at', true, { rule: this.rule.id })
|
|
||||||
.subscribe((result) => {
|
|
||||||
this.processedMails = result.results
|
|
||||||
this.loading = false
|
|
||||||
})
|
|
||||||
}
|
|
||||||
|
|
||||||
public deleteSelected(): void {
|
|
||||||
this.processedMailService
|
|
||||||
.bulk_delete(Array.from(this.selectedMailIds))
|
|
||||||
.subscribe(() => {
|
|
||||||
this.toastService.showInfo($localize`Processed mail(s) deleted`)
|
|
||||||
this.loadProcessedMails()
|
|
||||||
})
|
|
||||||
}
|
|
||||||
|
|
||||||
public toggleAll(event: PointerEvent) {
|
|
||||||
if ((event.target as HTMLInputElement).checked) {
|
|
||||||
this.selectedMailIds.clear()
|
|
||||||
this.processedMails.forEach((mail) => this.selectedMailIds.add(mail.id))
|
|
||||||
} else {
|
|
||||||
this.clearSelection()
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
public clearSelection() {
|
|
||||||
this.toggleAllEnabled = false
|
|
||||||
this.selectedMailIds.clear()
|
|
||||||
}
|
|
||||||
|
|
||||||
public toggleSelected(mail: ProcessedMail) {
|
|
||||||
this.selectedMailIds.has(mail.id)
|
|
||||||
? this.selectedMailIds.delete(mail.id)
|
|
||||||
: this.selectedMailIds.add(mail.id)
|
|
||||||
}
|
|
||||||
}
|
|
@@ -1,12 +0,0 @@
|
|||||||
import { ObjectWithId } from './object-with-id'
|
|
||||||
|
|
||||||
export interface ProcessedMail extends ObjectWithId {
|
|
||||||
rule: number // MailRule.id
|
|
||||||
folder: string
|
|
||||||
uid: number
|
|
||||||
subject: string
|
|
||||||
received: Date
|
|
||||||
processed: Date
|
|
||||||
status: string
|
|
||||||
error: string
|
|
||||||
}
|
|
@@ -28,7 +28,6 @@ export enum PermissionType {
|
|||||||
ShareLink = '%s_sharelink',
|
ShareLink = '%s_sharelink',
|
||||||
CustomField = '%s_customfield',
|
CustomField = '%s_customfield',
|
||||||
Workflow = '%s_workflow',
|
Workflow = '%s_workflow',
|
||||||
ProcessedMail = '%s_processedmail',
|
|
||||||
}
|
}
|
||||||
|
|
||||||
@Injectable({
|
@Injectable({
|
||||||
|
@@ -1,39 +0,0 @@
|
|||||||
import { HttpTestingController } from '@angular/common/http/testing'
|
|
||||||
import { TestBed } from '@angular/core/testing'
|
|
||||||
import { Subscription } from 'rxjs'
|
|
||||||
import { environment } from 'src/environments/environment'
|
|
||||||
import { commonAbstractPaperlessServiceTests } from './abstract-paperless-service.spec'
|
|
||||||
import { ProcessedMailService } from './processed-mail.service'
|
|
||||||
|
|
||||||
let httpTestingController: HttpTestingController
|
|
||||||
let service: ProcessedMailService
|
|
||||||
let subscription: Subscription
|
|
||||||
const endpoint = 'processed_mail'
|
|
||||||
|
|
||||||
// run common tests
|
|
||||||
commonAbstractPaperlessServiceTests(endpoint, ProcessedMailService)
|
|
||||||
|
|
||||||
describe('Additional service tests for ProcessedMailService', () => {
|
|
||||||
beforeEach(() => {
|
|
||||||
// Dont need to setup again
|
|
||||||
|
|
||||||
httpTestingController = TestBed.inject(HttpTestingController)
|
|
||||||
service = TestBed.inject(ProcessedMailService)
|
|
||||||
})
|
|
||||||
|
|
||||||
afterEach(() => {
|
|
||||||
subscription?.unsubscribe()
|
|
||||||
httpTestingController.verify()
|
|
||||||
})
|
|
||||||
|
|
||||||
it('should call appropriate api endpoint for bulk delete', () => {
|
|
||||||
const ids = [1, 2, 3]
|
|
||||||
subscription = service.bulk_delete(ids).subscribe()
|
|
||||||
const req = httpTestingController.expectOne(
|
|
||||||
`${environment.apiBaseUrl}${endpoint}/bulk_delete/`
|
|
||||||
)
|
|
||||||
expect(req.request.method).toEqual('POST')
|
|
||||||
expect(req.request.body).toEqual({ mail_ids: ids })
|
|
||||||
req.flush({})
|
|
||||||
})
|
|
||||||
})
|
|
@@ -1,19 +0,0 @@
|
|||||||
import { Injectable } from '@angular/core'
|
|
||||||
import { ProcessedMail } from 'src/app/data/processed-mail'
|
|
||||||
import { AbstractPaperlessService } from './abstract-paperless-service'
|
|
||||||
|
|
||||||
@Injectable({
|
|
||||||
providedIn: 'root',
|
|
||||||
})
|
|
||||||
export class ProcessedMailService extends AbstractPaperlessService<ProcessedMail> {
|
|
||||||
constructor() {
|
|
||||||
super()
|
|
||||||
this.resourceName = 'processed_mail'
|
|
||||||
}
|
|
||||||
|
|
||||||
public bulk_delete(mailIds: number[]) {
|
|
||||||
return this.http.post(`${this.getResourceUrl()}bulk_delete/`, {
|
|
||||||
mail_ids: mailIds,
|
|
||||||
})
|
|
||||||
}
|
|
||||||
}
|
|
@@ -51,7 +51,6 @@ import {
|
|||||||
check,
|
check,
|
||||||
check2All,
|
check2All,
|
||||||
checkAll,
|
checkAll,
|
||||||
checkCircle,
|
|
||||||
checkCircleFill,
|
checkCircleFill,
|
||||||
checkLg,
|
checkLg,
|
||||||
chevronDoubleLeft,
|
chevronDoubleLeft,
|
||||||
@@ -60,7 +59,6 @@ import {
|
|||||||
clipboardCheck,
|
clipboardCheck,
|
||||||
clipboardCheckFill,
|
clipboardCheckFill,
|
||||||
clipboardFill,
|
clipboardFill,
|
||||||
clockHistory,
|
|
||||||
dash,
|
dash,
|
||||||
dashCircle,
|
dashCircle,
|
||||||
diagram3,
|
diagram3,
|
||||||
@@ -263,7 +261,6 @@ const icons = {
|
|||||||
check,
|
check,
|
||||||
check2All,
|
check2All,
|
||||||
checkAll,
|
checkAll,
|
||||||
checkCircle,
|
|
||||||
checkCircleFill,
|
checkCircleFill,
|
||||||
checkLg,
|
checkLg,
|
||||||
chevronDoubleLeft,
|
chevronDoubleLeft,
|
||||||
@@ -272,7 +269,6 @@ const icons = {
|
|||||||
clipboardCheck,
|
clipboardCheck,
|
||||||
clipboardCheckFill,
|
clipboardCheckFill,
|
||||||
clipboardFill,
|
clipboardFill,
|
||||||
clockHistory,
|
|
||||||
dash,
|
dash,
|
||||||
dashCircle,
|
dashCircle,
|
||||||
diagram3,
|
diagram3,
|
||||||
|
@@ -57,7 +57,6 @@ from paperless.views import UserViewSet
|
|||||||
from paperless_mail.views import MailAccountViewSet
|
from paperless_mail.views import MailAccountViewSet
|
||||||
from paperless_mail.views import MailRuleViewSet
|
from paperless_mail.views import MailRuleViewSet
|
||||||
from paperless_mail.views import OauthCallbackView
|
from paperless_mail.views import OauthCallbackView
|
||||||
from paperless_mail.views import ProcessedMailViewSet
|
|
||||||
|
|
||||||
api_router = DefaultRouter()
|
api_router = DefaultRouter()
|
||||||
api_router.register(r"correspondents", CorrespondentViewSet)
|
api_router.register(r"correspondents", CorrespondentViewSet)
|
||||||
@@ -78,7 +77,6 @@ api_router.register(r"workflow_actions", WorkflowActionViewSet)
|
|||||||
api_router.register(r"workflows", WorkflowViewSet)
|
api_router.register(r"workflows", WorkflowViewSet)
|
||||||
api_router.register(r"custom_fields", CustomFieldViewSet)
|
api_router.register(r"custom_fields", CustomFieldViewSet)
|
||||||
api_router.register(r"config", ApplicationConfigurationViewSet)
|
api_router.register(r"config", ApplicationConfigurationViewSet)
|
||||||
api_router.register(r"processed_mail", ProcessedMailViewSet)
|
|
||||||
|
|
||||||
|
|
||||||
urlpatterns = [
|
urlpatterns = [
|
||||||
|
@@ -1,12 +0,0 @@
|
|||||||
from django_filters import FilterSet
|
|
||||||
|
|
||||||
from paperless_mail.models import ProcessedMail
|
|
||||||
|
|
||||||
|
|
||||||
class ProcessedMailFilterSet(FilterSet):
|
|
||||||
class Meta:
|
|
||||||
model = ProcessedMail
|
|
||||||
fields = {
|
|
||||||
"rule": ["exact"],
|
|
||||||
"status": ["exact"],
|
|
||||||
}
|
|
@@ -6,7 +6,6 @@ from documents.serialisers import OwnedObjectSerializer
|
|||||||
from documents.serialisers import TagsField
|
from documents.serialisers import TagsField
|
||||||
from paperless_mail.models import MailAccount
|
from paperless_mail.models import MailAccount
|
||||||
from paperless_mail.models import MailRule
|
from paperless_mail.models import MailRule
|
||||||
from paperless_mail.models import ProcessedMail
|
|
||||||
|
|
||||||
|
|
||||||
class ObfuscatedPasswordField(serializers.CharField):
|
class ObfuscatedPasswordField(serializers.CharField):
|
||||||
@@ -131,20 +130,3 @@ class MailRuleSerializer(OwnedObjectSerializer):
|
|||||||
if value > 36500: # ~100 years
|
if value > 36500: # ~100 years
|
||||||
raise serializers.ValidationError("Maximum mail age is unreasonably large.")
|
raise serializers.ValidationError("Maximum mail age is unreasonably large.")
|
||||||
return value
|
return value
|
||||||
|
|
||||||
|
|
||||||
class ProcessedMailSerializer(OwnedObjectSerializer):
|
|
||||||
class Meta:
|
|
||||||
model = ProcessedMail
|
|
||||||
fields = [
|
|
||||||
"id",
|
|
||||||
"owner",
|
|
||||||
"rule",
|
|
||||||
"folder",
|
|
||||||
"uid",
|
|
||||||
"subject",
|
|
||||||
"received",
|
|
||||||
"processed",
|
|
||||||
"status",
|
|
||||||
"error",
|
|
||||||
]
|
|
||||||
|
@@ -3,7 +3,6 @@ from unittest import mock
|
|||||||
|
|
||||||
from django.contrib.auth.models import Permission
|
from django.contrib.auth.models import Permission
|
||||||
from django.contrib.auth.models import User
|
from django.contrib.auth.models import User
|
||||||
from django.utils import timezone
|
|
||||||
from guardian.shortcuts import assign_perm
|
from guardian.shortcuts import assign_perm
|
||||||
from rest_framework import status
|
from rest_framework import status
|
||||||
from rest_framework.test import APITestCase
|
from rest_framework.test import APITestCase
|
||||||
@@ -14,7 +13,6 @@ from documents.models import Tag
|
|||||||
from documents.tests.utils import DirectoriesMixin
|
from documents.tests.utils import DirectoriesMixin
|
||||||
from paperless_mail.models import MailAccount
|
from paperless_mail.models import MailAccount
|
||||||
from paperless_mail.models import MailRule
|
from paperless_mail.models import MailRule
|
||||||
from paperless_mail.models import ProcessedMail
|
|
||||||
from paperless_mail.tests.test_mail import BogusMailBox
|
from paperless_mail.tests.test_mail import BogusMailBox
|
||||||
|
|
||||||
|
|
||||||
@@ -723,285 +721,3 @@ class TestAPIMailRules(DirectoriesMixin, APITestCase):
|
|||||||
|
|
||||||
self.assertEqual(response.status_code, status.HTTP_400_BAD_REQUEST)
|
self.assertEqual(response.status_code, status.HTTP_400_BAD_REQUEST)
|
||||||
self.assertIn("maximum_age", response.data)
|
self.assertIn("maximum_age", response.data)
|
||||||
|
|
||||||
|
|
||||||
class TestAPIProcessedMails(DirectoriesMixin, APITestCase):
|
|
||||||
ENDPOINT = "/api/processed_mail/"
|
|
||||||
|
|
||||||
def setUp(self):
|
|
||||||
super().setUp()
|
|
||||||
|
|
||||||
self.user = User.objects.create_user(username="temp_admin")
|
|
||||||
self.user.user_permissions.add(*Permission.objects.all())
|
|
||||||
self.user.save()
|
|
||||||
self.client.force_authenticate(user=self.user)
|
|
||||||
|
|
||||||
def test_get_processed_mails_owner_aware(self):
|
|
||||||
"""
|
|
||||||
GIVEN:
|
|
||||||
- Configured processed mails with different users
|
|
||||||
WHEN:
|
|
||||||
- API call is made to get processed mails
|
|
||||||
THEN:
|
|
||||||
- Only unowned, owned by user or granted processed mails are provided
|
|
||||||
"""
|
|
||||||
user2 = User.objects.create_user(username="temp_admin2")
|
|
||||||
|
|
||||||
account = 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",
|
|
||||||
)
|
|
||||||
|
|
||||||
rule = MailRule.objects.create(
|
|
||||||
name="Rule1",
|
|
||||||
account=account,
|
|
||||||
folder="INBOX",
|
|
||||||
filter_from="from@example.com",
|
|
||||||
order=0,
|
|
||||||
)
|
|
||||||
|
|
||||||
pm1 = ProcessedMail.objects.create(
|
|
||||||
rule=rule,
|
|
||||||
folder="INBOX",
|
|
||||||
uid="1",
|
|
||||||
subject="Subj1",
|
|
||||||
received=timezone.now(),
|
|
||||||
processed=timezone.now(),
|
|
||||||
status="SUCCESS",
|
|
||||||
error=None,
|
|
||||||
)
|
|
||||||
|
|
||||||
pm2 = ProcessedMail.objects.create(
|
|
||||||
rule=rule,
|
|
||||||
folder="INBOX",
|
|
||||||
uid="2",
|
|
||||||
subject="Subj2",
|
|
||||||
received=timezone.now(),
|
|
||||||
processed=timezone.now(),
|
|
||||||
status="FAILED",
|
|
||||||
error="err",
|
|
||||||
owner=self.user,
|
|
||||||
)
|
|
||||||
|
|
||||||
ProcessedMail.objects.create(
|
|
||||||
rule=rule,
|
|
||||||
folder="INBOX",
|
|
||||||
uid="3",
|
|
||||||
subject="Subj3",
|
|
||||||
received=timezone.now(),
|
|
||||||
processed=timezone.now(),
|
|
||||||
status="SUCCESS",
|
|
||||||
error=None,
|
|
||||||
owner=user2,
|
|
||||||
)
|
|
||||||
|
|
||||||
pm4 = ProcessedMail.objects.create(
|
|
||||||
rule=rule,
|
|
||||||
folder="INBOX",
|
|
||||||
uid="4",
|
|
||||||
subject="Subj4",
|
|
||||||
received=timezone.now(),
|
|
||||||
processed=timezone.now(),
|
|
||||||
status="SUCCESS",
|
|
||||||
error=None,
|
|
||||||
)
|
|
||||||
pm4.owner = user2
|
|
||||||
pm4.save()
|
|
||||||
assign_perm("view_processedmail", self.user, pm4)
|
|
||||||
|
|
||||||
response = self.client.get(self.ENDPOINT)
|
|
||||||
|
|
||||||
self.assertEqual(response.status_code, status.HTTP_200_OK)
|
|
||||||
self.assertEqual(response.data["count"], 3)
|
|
||||||
returned_ids = {r["id"] for r in response.data["results"]}
|
|
||||||
self.assertSetEqual(returned_ids, {pm1.id, pm2.id, pm4.id})
|
|
||||||
|
|
||||||
def test_get_processed_mails_filter_by_rule(self):
|
|
||||||
"""
|
|
||||||
GIVEN:
|
|
||||||
- Processed mails belonging to two different rules
|
|
||||||
WHEN:
|
|
||||||
- API call is made with rule filter
|
|
||||||
THEN:
|
|
||||||
- Only processed mails for that rule are returned
|
|
||||||
"""
|
|
||||||
account = 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=account,
|
|
||||||
folder="INBOX",
|
|
||||||
filter_from="from1@example.com",
|
|
||||||
order=0,
|
|
||||||
)
|
|
||||||
rule2 = MailRule.objects.create(
|
|
||||||
name="Rule2",
|
|
||||||
account=account,
|
|
||||||
folder="INBOX",
|
|
||||||
filter_from="from2@example.com",
|
|
||||||
order=1,
|
|
||||||
)
|
|
||||||
|
|
||||||
pm1 = ProcessedMail.objects.create(
|
|
||||||
rule=rule1,
|
|
||||||
folder="INBOX",
|
|
||||||
uid="r1-1",
|
|
||||||
subject="R1-A",
|
|
||||||
received=timezone.now(),
|
|
||||||
processed=timezone.now(),
|
|
||||||
status="SUCCESS",
|
|
||||||
error=None,
|
|
||||||
owner=self.user,
|
|
||||||
)
|
|
||||||
pm2 = ProcessedMail.objects.create(
|
|
||||||
rule=rule1,
|
|
||||||
folder="INBOX",
|
|
||||||
uid="r1-2",
|
|
||||||
subject="R1-B",
|
|
||||||
received=timezone.now(),
|
|
||||||
processed=timezone.now(),
|
|
||||||
status="FAILED",
|
|
||||||
error="e",
|
|
||||||
)
|
|
||||||
ProcessedMail.objects.create(
|
|
||||||
rule=rule2,
|
|
||||||
folder="INBOX",
|
|
||||||
uid="r2-1",
|
|
||||||
subject="R2-A",
|
|
||||||
received=timezone.now(),
|
|
||||||
processed=timezone.now(),
|
|
||||||
status="SUCCESS",
|
|
||||||
error=None,
|
|
||||||
)
|
|
||||||
|
|
||||||
response = self.client.get(f"{self.ENDPOINT}?rule={rule1.pk}")
|
|
||||||
|
|
||||||
self.assertEqual(response.status_code, status.HTTP_200_OK)
|
|
||||||
returned_ids = {r["id"] for r in response.data["results"]}
|
|
||||||
self.assertSetEqual(returned_ids, {pm1.id, pm2.id})
|
|
||||||
|
|
||||||
def test_bulk_delete_processed_mails(self):
|
|
||||||
"""
|
|
||||||
GIVEN:
|
|
||||||
- Processed mails belonging to two different rules and different users
|
|
||||||
WHEN:
|
|
||||||
- API call is made to bulk delete some of the processed mails
|
|
||||||
THEN:
|
|
||||||
- Only the specified processed mails are deleted, respecting ownership and permissions
|
|
||||||
"""
|
|
||||||
user2 = User.objects.create_user(username="temp_admin2")
|
|
||||||
|
|
||||||
account = 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",
|
|
||||||
)
|
|
||||||
|
|
||||||
rule = MailRule.objects.create(
|
|
||||||
name="Rule1",
|
|
||||||
account=account,
|
|
||||||
folder="INBOX",
|
|
||||||
filter_from="from@example.com",
|
|
||||||
order=0,
|
|
||||||
)
|
|
||||||
|
|
||||||
# unowned and owned by self, and one with explicit object perm
|
|
||||||
pm_unowned = ProcessedMail.objects.create(
|
|
||||||
rule=rule,
|
|
||||||
folder="INBOX",
|
|
||||||
uid="u1",
|
|
||||||
subject="Unowned",
|
|
||||||
received=timezone.now(),
|
|
||||||
processed=timezone.now(),
|
|
||||||
status="SUCCESS",
|
|
||||||
error=None,
|
|
||||||
)
|
|
||||||
pm_owned = ProcessedMail.objects.create(
|
|
||||||
rule=rule,
|
|
||||||
folder="INBOX",
|
|
||||||
uid="u2",
|
|
||||||
subject="Owned",
|
|
||||||
received=timezone.now(),
|
|
||||||
processed=timezone.now(),
|
|
||||||
status="FAILED",
|
|
||||||
error="e",
|
|
||||||
owner=self.user,
|
|
||||||
)
|
|
||||||
pm_granted = ProcessedMail.objects.create(
|
|
||||||
rule=rule,
|
|
||||||
folder="INBOX",
|
|
||||||
uid="u3",
|
|
||||||
subject="Granted",
|
|
||||||
received=timezone.now(),
|
|
||||||
processed=timezone.now(),
|
|
||||||
status="SUCCESS",
|
|
||||||
error=None,
|
|
||||||
owner=user2,
|
|
||||||
)
|
|
||||||
assign_perm("delete_processedmail", self.user, pm_granted)
|
|
||||||
pm_forbidden = ProcessedMail.objects.create(
|
|
||||||
rule=rule,
|
|
||||||
folder="INBOX",
|
|
||||||
uid="u4",
|
|
||||||
subject="Forbidden",
|
|
||||||
received=timezone.now(),
|
|
||||||
processed=timezone.now(),
|
|
||||||
status="SUCCESS",
|
|
||||||
error=None,
|
|
||||||
owner=user2,
|
|
||||||
)
|
|
||||||
|
|
||||||
# Success for allowed items
|
|
||||||
response = self.client.post(
|
|
||||||
f"{self.ENDPOINT}bulk_delete/",
|
|
||||||
data={
|
|
||||||
"mail_ids": [pm_unowned.id, pm_owned.id, pm_granted.id],
|
|
||||||
},
|
|
||||||
format="json",
|
|
||||||
)
|
|
||||||
self.assertEqual(response.status_code, status.HTTP_200_OK)
|
|
||||||
self.assertEqual(response.data["result"], "OK")
|
|
||||||
self.assertSetEqual(
|
|
||||||
set(response.data["deleted_mail_ids"]),
|
|
||||||
{pm_unowned.id, pm_owned.id, pm_granted.id},
|
|
||||||
)
|
|
||||||
self.assertFalse(ProcessedMail.objects.filter(id=pm_unowned.id).exists())
|
|
||||||
self.assertFalse(ProcessedMail.objects.filter(id=pm_owned.id).exists())
|
|
||||||
self.assertFalse(ProcessedMail.objects.filter(id=pm_granted.id).exists())
|
|
||||||
self.assertTrue(ProcessedMail.objects.filter(id=pm_forbidden.id).exists())
|
|
||||||
|
|
||||||
# 403 and not deleted
|
|
||||||
response = self.client.post(
|
|
||||||
f"{self.ENDPOINT}bulk_delete/",
|
|
||||||
data={
|
|
||||||
"mail_ids": [pm_forbidden.id],
|
|
||||||
},
|
|
||||||
format="json",
|
|
||||||
)
|
|
||||||
self.assertEqual(response.status_code, status.HTTP_403_FORBIDDEN)
|
|
||||||
self.assertTrue(ProcessedMail.objects.filter(id=pm_forbidden.id).exists())
|
|
||||||
|
|
||||||
# missing mail_ids
|
|
||||||
response = self.client.post(
|
|
||||||
f"{self.ENDPOINT}bulk_delete/",
|
|
||||||
data={"mail_ids": "not-a-list"},
|
|
||||||
format="json",
|
|
||||||
)
|
|
||||||
self.assertEqual(response.status_code, status.HTTP_400_BAD_REQUEST)
|
|
||||||
|
@@ -3,10 +3,8 @@ import logging
|
|||||||
from datetime import timedelta
|
from datetime import timedelta
|
||||||
|
|
||||||
from django.http import HttpResponseBadRequest
|
from django.http import HttpResponseBadRequest
|
||||||
from django.http import HttpResponseForbidden
|
|
||||||
from django.http import HttpResponseRedirect
|
from django.http import HttpResponseRedirect
|
||||||
from django.utils import timezone
|
from django.utils import timezone
|
||||||
from django_filters.rest_framework import DjangoFilterBackend
|
|
||||||
from drf_spectacular.types import OpenApiTypes
|
from drf_spectacular.types import OpenApiTypes
|
||||||
from drf_spectacular.utils import extend_schema
|
from drf_spectacular.utils import extend_schema
|
||||||
from drf_spectacular.utils import extend_schema_view
|
from drf_spectacular.utils import extend_schema_view
|
||||||
@@ -14,29 +12,23 @@ from drf_spectacular.utils import inline_serializer
|
|||||||
from httpx_oauth.oauth2 import GetAccessTokenError
|
from httpx_oauth.oauth2 import GetAccessTokenError
|
||||||
from rest_framework import serializers
|
from rest_framework import serializers
|
||||||
from rest_framework.decorators import action
|
from rest_framework.decorators import action
|
||||||
from rest_framework.filters import OrderingFilter
|
|
||||||
from rest_framework.generics import GenericAPIView
|
from rest_framework.generics import GenericAPIView
|
||||||
from rest_framework.permissions import IsAuthenticated
|
from rest_framework.permissions import IsAuthenticated
|
||||||
from rest_framework.response import Response
|
from rest_framework.response import Response
|
||||||
from rest_framework.viewsets import ModelViewSet
|
from rest_framework.viewsets import ModelViewSet
|
||||||
from rest_framework.viewsets import ReadOnlyModelViewSet
|
|
||||||
|
|
||||||
from documents.filters import ObjectOwnedOrGrantedPermissionsFilter
|
from documents.filters import ObjectOwnedOrGrantedPermissionsFilter
|
||||||
from documents.permissions import PaperlessObjectPermissions
|
from documents.permissions import PaperlessObjectPermissions
|
||||||
from documents.permissions import has_perms_owner_aware
|
|
||||||
from documents.views import PassUserMixin
|
from documents.views import PassUserMixin
|
||||||
from paperless.views import StandardPagination
|
from paperless.views import StandardPagination
|
||||||
from paperless_mail.filters import ProcessedMailFilterSet
|
|
||||||
from paperless_mail.mail import MailError
|
from paperless_mail.mail import MailError
|
||||||
from paperless_mail.mail import get_mailbox
|
from paperless_mail.mail import get_mailbox
|
||||||
from paperless_mail.mail import mailbox_login
|
from paperless_mail.mail import mailbox_login
|
||||||
from paperless_mail.models import MailAccount
|
from paperless_mail.models import MailAccount
|
||||||
from paperless_mail.models import MailRule
|
from paperless_mail.models import MailRule
|
||||||
from paperless_mail.models import ProcessedMail
|
|
||||||
from paperless_mail.oauth import PaperlessMailOAuth2Manager
|
from paperless_mail.oauth import PaperlessMailOAuth2Manager
|
||||||
from paperless_mail.serialisers import MailAccountSerializer
|
from paperless_mail.serialisers import MailAccountSerializer
|
||||||
from paperless_mail.serialisers import MailRuleSerializer
|
from paperless_mail.serialisers import MailRuleSerializer
|
||||||
from paperless_mail.serialisers import ProcessedMailSerializer
|
|
||||||
from paperless_mail.tasks import process_mail_accounts
|
from paperless_mail.tasks import process_mail_accounts
|
||||||
|
|
||||||
|
|
||||||
@@ -134,34 +126,6 @@ class MailAccountViewSet(ModelViewSet, PassUserMixin):
|
|||||||
return Response({"result": "OK"})
|
return Response({"result": "OK"})
|
||||||
|
|
||||||
|
|
||||||
class ProcessedMailViewSet(ReadOnlyModelViewSet, PassUserMixin):
|
|
||||||
permission_classes = (IsAuthenticated, PaperlessObjectPermissions)
|
|
||||||
serializer_class = ProcessedMailSerializer
|
|
||||||
pagination_class = StandardPagination
|
|
||||||
filter_backends = (
|
|
||||||
DjangoFilterBackend,
|
|
||||||
OrderingFilter,
|
|
||||||
ObjectOwnedOrGrantedPermissionsFilter,
|
|
||||||
)
|
|
||||||
filterset_class = ProcessedMailFilterSet
|
|
||||||
|
|
||||||
queryset = ProcessedMail.objects.all().order_by("-processed")
|
|
||||||
|
|
||||||
@action(methods=["post"], detail=False)
|
|
||||||
def bulk_delete(self, request):
|
|
||||||
mail_ids = request.data.get("mail_ids", [])
|
|
||||||
if not isinstance(mail_ids, list) or not all(
|
|
||||||
isinstance(i, int) for i in mail_ids
|
|
||||||
):
|
|
||||||
return HttpResponseBadRequest("mail_ids must be a list of integers")
|
|
||||||
mails = ProcessedMail.objects.filter(id__in=mail_ids)
|
|
||||||
for mail in mails:
|
|
||||||
if not has_perms_owner_aware(request.user, "delete_processedmail", mail):
|
|
||||||
return HttpResponseForbidden("Insufficient permissions")
|
|
||||||
mail.delete()
|
|
||||||
return Response({"result": "OK", "deleted_mail_ids": mail_ids})
|
|
||||||
|
|
||||||
|
|
||||||
class MailRuleViewSet(ModelViewSet, PassUserMixin):
|
class MailRuleViewSet(ModelViewSet, PassUserMixin):
|
||||||
model = MailRule
|
model = MailRule
|
||||||
|
|
||||||
|
8
uv.lock
generated
8
uv.lock
generated
@@ -1982,7 +1982,7 @@ wheels = [
|
|||||||
|
|
||||||
[[package]]
|
[[package]]
|
||||||
name = "ocrmypdf"
|
name = "ocrmypdf"
|
||||||
version = "16.10.4"
|
version = "16.11.0"
|
||||||
source = { registry = "https://pypi.org/simple" }
|
source = { registry = "https://pypi.org/simple" }
|
||||||
dependencies = [
|
dependencies = [
|
||||||
{ name = "deprecation", marker = "sys_platform == 'darwin' or sys_platform == 'linux'" },
|
{ name = "deprecation", marker = "sys_platform == 'darwin' or sys_platform == 'linux'" },
|
||||||
@@ -1995,9 +1995,9 @@ dependencies = [
|
|||||||
{ name = "pluggy", marker = "sys_platform == 'darwin' or sys_platform == 'linux'" },
|
{ name = "pluggy", marker = "sys_platform == 'darwin' or sys_platform == 'linux'" },
|
||||||
{ name = "rich", marker = "sys_platform == 'darwin' or sys_platform == 'linux'" },
|
{ name = "rich", marker = "sys_platform == 'darwin' or sys_platform == 'linux'" },
|
||||||
]
|
]
|
||||||
sdist = { url = "https://files.pythonhosted.org/packages/cd/40/cb85e6260e5a20d08195d03541b31db4296f8f4d3442ee595686f47a75b0/ocrmypdf-16.10.4.tar.gz", hash = "sha256:de749ef5f554b63d57e68d032e7cba5500cbd5030835bf24f658f7b7a04f3dc1", size = 7003649, upload-time = "2025-07-07T20:55:01.735Z" }
|
sdist = { url = "https://files.pythonhosted.org/packages/44/af/947d6abb0cb41f99971a7a4bd33684d3cee20c9e32c8f9dc90e8c5dcf21c/ocrmypdf-16.11.0.tar.gz", hash = "sha256:d89077e503238dac35c6e565925edc8d98b71e5289853c02cacbc1d0901f1be7", size = 7015068, upload-time = "2025-09-12T08:36:53.507Z" }
|
||||||
wheels = [
|
wheels = [
|
||||||
{ url = "https://files.pythonhosted.org/packages/8e/6a/53bb2b0e57f8ca8d4a021194202cc772d1ce049269e9b0cb88d1fa87a0ef/ocrmypdf-16.10.4-py3-none-any.whl", hash = "sha256:061f3165d09ffafac975cea00803802b8a75551ada9965292ea86ea382673688", size = 162559, upload-time = "2025-07-07T20:55:00.061Z" },
|
{ url = "https://files.pythonhosted.org/packages/d9/b2/eda3bb0939bf81d889812dd82cf37fa6f8769af8e31008bd586ba12fae09/ocrmypdf-16.11.0-py3-none-any.whl", hash = "sha256:13628294a309c85b21947b5c7bc7fcd202464517c14b71a050adc9dde85c48f7", size = 162883, upload-time = "2025-09-12T08:36:51.611Z" },
|
||||||
]
|
]
|
||||||
|
|
||||||
[[package]]
|
[[package]]
|
||||||
@@ -2194,7 +2194,7 @@ requires-dist = [
|
|||||||
{ name = "langdetect", specifier = "~=1.0.9" },
|
{ name = "langdetect", specifier = "~=1.0.9" },
|
||||||
{ name = "mysqlclient", marker = "extra == 'mariadb'", specifier = "~=2.2.7" },
|
{ name = "mysqlclient", marker = "extra == 'mariadb'", specifier = "~=2.2.7" },
|
||||||
{ name = "nltk", specifier = "~=3.9.1" },
|
{ name = "nltk", specifier = "~=3.9.1" },
|
||||||
{ name = "ocrmypdf", specifier = "~=16.10.0" },
|
{ name = "ocrmypdf", specifier = "~=16.11.0" },
|
||||||
{ name = "pathvalidate", specifier = "~=3.3.1" },
|
{ name = "pathvalidate", specifier = "~=3.3.1" },
|
||||||
{ name = "pdf2image", specifier = "~=1.17.0" },
|
{ name = "pdf2image", specifier = "~=1.17.0" },
|
||||||
{ name = "psycopg", extras = ["c", "pool"], marker = "extra == 'postgres'", specifier = "==3.2.9" },
|
{ name = "psycopg", extras = ["c", "pool"], marker = "extra == 'postgres'", specifier = "==3.2.9" },
|
||||||
|
Reference in New Issue
Block a user