create_mail_account
Create an IMAP account for Paperless to connect to a mail server, enabling document ingestion from email via mail rules.
Instructions
Create an IMAP account for Paperless to fetch mail from. Nothing is fetched until a mail rule uses the account (create_mail_rule). Check the connection first with test_mail_account.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| name | Yes | ||
| owner | No | ||
| is_token | No | true when `password` is an OAuth/app token | |
| password | Yes | IMAP password or OAuth token. Write-only: Paperless returns it masked as all asterisks (at least 10, one per character), and sending any all-asterisks value back leaves the stored password unchanged. | |
| username | Yes | ||
| imap_port | Yes | Usually 993 (SSL) or 143 (STARTTLS / none) | |
| imap_server | Yes | ||
| account_type | No | 1=IMAP, 2=Gmail OAuth, 3=Outlook OAuth | |
| character_set | No | e.g. UTF-8 (default) or US-ASCII | |
| imap_security | No | 1=no encryption, 2=SSL, 3=STARTTLS |