paperless-ngx/src-ui/src/app/data/mail-rule.ts

import { ObjectWithPermissions } from './object-with-permissions'

export enum MailFilterAttachmentType {
  Attachments = 1,
  Everything = 2,
}

export enum MailRuleConsumptionScope {
  Attachments = 1,
  EmailOnly = 2,
  Everything = 3,
}

export enum MailRulePdfLayout {
  Default = 0,
  TextHtml = 1,
  HtmlText = 2,
  HtmlOnly = 3,
  TextOnly = 4,
}

export enum MailAction {
  Delete = 1,
  Move = 2,
  MarkRead = 3,
  Flag = 4,
  Tag = 5,
}

export enum MailMetadataTitleOption {
  FromSubject = 1,
  FromFilename = 2,
  None = 3,
}

export enum MailMetadataCorrespondentOption {
  FromNothing = 1,
  FromEmail = 2,
  FromName = 3,
  FromCustom = 4,
}

export interface MailRule extends ObjectWithPermissions {
  name: string

  account: number // PaperlessMailAccount.id

  order: number

  enabled: boolean

  folder: string

  filter_from: string

  filter_to: string

  filter_subject: string

  filter_body: string

  filter_attachment_filename_include: string

  filter_attachment_filename_exclude: string

  maximum_age: number

  attachment_type: MailFilterAttachmentType

  pdf_layout: MailRulePdfLayout

  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

  assign_owner_from_rule: boolean
}