Email Ingest

For the most up-to-date documentation, please visit docs.brix.ch

No UI

The Email Ingest plugin allows you to send attachments to a dedicated email account, where they will be detected and uploaded into a specific node (-structure) within CELUM. Processed mails will be marked as read.

Note: Usually the total size of attachments is capped at ~10MB, depending on the mail server. We'd recommend Upload Request for larger batches, or a hotfolder for automated scenarios.

Properties

To be configured in {home}/appserver/conf/custom.properties

emailIngest.license

type: string, required: yes, default: -

The license key for the plugin (product: emailIngest), provided by brix.

emailIngest.host

type: String, required: yes, default: -

Which mail host to query, e.g. mail.company.com

emailIngest.port

type: integer, required: no, default: 995

Which port to use

emailIngest.protocol

type: String, required: no, default: imaps

Which protocol to use, imap(s) is recommended

emailIngest.username

type: String, required: yes, default: -

The username to use for authentication

emailIngest.password

type: String, required: yes, default: -

The password to use for authentication

emailIngest.folder

type: String, required: no, default: INBOX

Which folder to query for unread messages.

emailIngest.targetNodeId

type: double, required: yes, default: -

Where to upload the attachments to. Needs to be permission defining.

emailIngest.createSubnodes

type: boolean, required: no, default: true

Whether to create a sub-node per email, named after the subject. Set this to false to simply upload everything into the targetNodeId.

emailIngest.subnodesWithFrom

type: boolean, required: no, default: true

Whether to append the sender's address to the name of the sub-node. Only applies then emailIngest.createSubnodes is true.

emailIngest.cronExpression

type: Quartz-Expression, required: no, default 0 */1 * * * ? (every minute)

How often to check the mailbox for new emails.

Example

emailIngest.license=********
emailIngest.host=mail.brix.ch
emailIngest.username=ingest
emailIngest.password=********
emailIngest.folder=INBOX
emailIngest.targetNodeId=1337

Compatibility Matrix

Email Ingest CELUM
1.0.0 5.13.4 (tested up to 6.8)

Release Notes

1.0.0

Released 2021-04-27

Initial version