'Mas-mailbox' Configuration

enaio® mail-archive-service • 12.0 »

Configuration parameters of the masmailbox-prod.yml file for journaling and mailbox archiving.

The configuration parameters for Microsoft Exchange Online and for Microsoft Exchange on-premises are different. For hybrid installations, the parameters are entered in the same masmailbox-prod.yml file.

Configuration values such as user name and password can be specified in the encrypted configuration file.

A customizable configuration file for Microsoft Exchange Online is available to download. You can use it as a basis for the configuration.

Microsoft Exchange Online

Parameter

Type

Description

For example

Default

mas.graph.service.page-size

Number

Optional: maximum size of results per Graph API query.

The value should not be greater than 999.

999

999

mas-mailbox.health-cache-duration

 Number Elaborate health checks for resolving mailboxes contrary to active directories are cached. Specified in hours. 6 6

mas-mailbox.journaling.mailboxes

String

Optional: configuration of an alternative journal mailbox.

Specification requirements:

  • mailbox – a mailbox’s e-mail address

  • read-folder – mailbox folder to read from – case sensitive.

  • message‑mode – specifies what type of messages are read from the mailbox. Available values:

    • JOURNAL
      Used when the mailbox stores journal reports.
    • ALTERNATE
      Used when the mailbox stores non-delivery reports.
    • NORMAL
      Used when the mailbox stores normal e-mails.

Additional mailboxes can also be specified here.

 
journaling-mailboxes
  - mailbox: name@muster.de
    read-folder: Inbox
    message-mode: ALTERNATE
  - mailbox: user@muster.de
    read-folder: Inbox
    message-mode: JOURNAL
 -
mas-mailbox.categories.archived String

Mailbox archiving:

category for an e-mail that has been successfully processed.		 Archived Archived
mas-mailbox.categories.error String

Mailbox archiving:

Category for an e-mail that could not be processed due to errors.		 Archiving error Error
mas-mailbox.archiving.mailboxes String List of primary mailboxes, shared mailboxes, and distribution lists for archiving.

- name@example.de

- group@example.de

 -
mas-mailbox.archiving.groups Comma-separated list List of Active Directory groups of type 'Distribution group' for archiving.

Team group,Developers group

 -
mas-mailbox.archiving.whitelist Comma-separated list Mailbox folders from which e-mails are retrieved from mailboxes for archiving – case sensitive. Inbox,Sent -
mas-mailbox.archiving.blacklist Comma-separated list Mailbox folders from which no e-mails are retrieved (case-sensitive). Outbox,Personal -
mas-mailbox.archiving.rules.mail-date Comma-separated list

Time-based rule for directory e-mails.

Values:

  • BEFORE

    E-mails received before a date.

  • AFTER

    E-mails received on or after a date.

Date format: DD-MM-YYYY

Value and date are separated by '|'.

 BEFORE|01-01-2025 -
mas-mailbox.archiving.rules.mail-size Comma-separated list

Size-based rule for retrieving e-mails.

Values in MB:

  • LT

    E-mails that are smaller than specified.

  • GTE

    E-mails that are larger or the same size as specified.

Value and size are separated by '|'.

 LT|10 -
mas-mailbox.archiving.rules.mail-state Comma-separated list

Read status-based rule for retrieving e-mails.

Values

  • ALL

    All e-mails.

  • READ

    E-mails read.

  • UNREAD

    Unread e-mails.

 READ ALL
mas-mailbox.archiving-exclusions.mailboxes Comma-separated list

Online and on-premises:

Mailboxes that appear in e-mails as 'To', 'From', or 'CC' and from which e-mails are not collected – not case sensitive.

 example@mail.com, example2@mail.com -
mas-mailbox.archiving-exclusions.subject-keywords Comma-separated list

Online and on-premises:

Keywords that appear in the subject of e-mails that are not retrieved – not case sensitive.

 keyword1, keyword2, keyword3 -
mas-mailbox.archiving-exclusions.exclusion-category String

Online and on-premises:

Category for e-mails that were not retrieved due to the 'exclusion' restrictions.

 Archiving skipped Skipped archiving
mas-mailbox.archiving.retention-policy.age-condition String

Retention time: successfully archived e-mails are deleted from the mailboxes after a certain period of time.

Specified in days (D), months (M), years (Y), separated by '|'.

 Y|5 -
mas-mailbox.archiving.retention-policy.deletion-schedule String

Time in 6-digit (in cron format) at which the deletion is executed daily.

Indication in single quotation marks.

 '0 * * * * *' '0 0 2 * * *'
Extracting attachments
mas-mailbox.attachment-extraction.mode String

Mode of extraction of attachments:

  • NONE

    No extraction.

  • LINKS

    Extraction and insert enaio® webclient link to attachment document.

  • FILES

    Extraction and insert enaio® client link to attachment document.

  • BOTH

    Extraction and insert enaio® webclient and enaio® client link to attachment document.

 LINKS NONE
mas-mailbox.attachment-extraction.schedule String

Time in 6-digit (in cron format) at which the extraction is executed daily.

Indication in single quotation marks.

 '0 * * * * *' '0 0 3 * * *'
mas-mailbox.attachment-extraction.delay String

The earliest time after the extraction is executed for successfully created e-mails.

Specified in days (D), months (M), years (Y), separated by '|'.

By default, extraction is carried out directly after successful creation.

 D|30

0
mas-mailbox.attachment-extraction.categories.success String Category for e-mails whose attachment has been successfully extracted. Attachment extracted AttExtracted
mas-mailbox.attachment-extraction.categories.error String Category for e-mails whose attachment could not be extracted. Attachment not extracted AttNotExtracted

Microsoft Exchange On-Premises

Parameter

Type

Description

For example

Default

mas-mailbox.onprem.health-cache-duration

 Number Elaborate health checks for resolving mailboxes contrary to active directories are cached. Specified in hours. 6 6

mas-mailbox.onprem.journaling.mailboxes

String

Optional: configuration of an alternative journal mailbox.

Specification requirements:

  • mailbox – a mailbox’s e-mail address

  • read-folder – mailbox folder to read from – case sensitive.

  • message‑mode – specifies what type of messages are read from the mailbox. Available values:

    • JOURNAL
      Used when the mailbox stores journal reports.
    • ALTERNATE
      Used when the mailbox stores non-delivery reports.
    • NORMAL
      Used when the mailbox stores normal e-mails.

Additional mailboxes can also be specified here.

 
mas-mailbox:
onprem:
  journaling:
    mailboxes:
      - mailbox: name@muster.de
        read-folder: Inbox
        message-mode: NORMAL   
      - mailbox: journal@muster.de
        read-folder: Posteingang
        message-mode: JOURNAL
 -
mas-mailbox.onprem.categories.archived String

Mailbox archiving:

category for an e-mail that has been successfully processed.		 Archived Archived
mas-mailbox.onprem.categories.error String

Mailbox archiving:

Category for an e-mail that could not be processed due to errors.		 ErrorArchive Error
mas-mailbox.onprem.archiving.mailboxes String List of primary mailboxes, shared mailboxes, and distribution lists for archiving.

- name@example.de

- group@example.de

 -
mas-mailbox.onprem.archiving.groups Comma-separated list List of Active Directory groups of type 'Distribution group' for archiving.

group@muster.de,dev@muster.de

 -
mas-mailbox.onprem.archiving.whitelist Comma-separated list

Mailbox folders from which e-mails are retrieved from mailboxes for archiving – case sensitive.

 Inbox,Sent -
mas-mailbox.onprem.archiving.blacklist Comma-separated list

Mailbox folders from which no e-mails are retrieved (case-sensitive).

 Outbox,Personal -
mas-mailbox.onprem.archiving.rules.mail-date Comma-separated list

Time-based rule for directory e-mails.

Values:

  • BEFORE

    E-mails received before a date.

  • AFTER

    E-mails received on or after a date.

Date format: DD-MM-YYYY

Value and date are separated by '|'.

 BEFORE|01-01-2025 -
mas-mailbox.onprem.archiving.rules.mail-size Comma-separated list

Size-based rule for retrieving e-mails.

Values in MB:

  • LT

    E-mails that are smaller than specified.

  • GTE

    E-mails that are larger or the same size as specified.

Value and size are separated by '|'.

 LT|10 -
mas-mailbox.onprem.archiving.rules.mail-state Comma-separated list

Read status-based rule for retrieving e-mails.

Values

  • ALL

    All e-mails.

  • READ

    E-mails read.

  • UNREAD

    Unread e-mails.

 READ ALL
mas-mailbox.archiving-exclusions.mailboxes Comma-separated list

Online and on-premises:

Mailboxes that appear in e-mails as 'To', 'From', or 'CC' and from which e-mails are not collected – not case sensitive.

 example@mail.com, example2@mail.com -
mas-mailbox.archiving-exclusions.subject-keywords Comma-separated list

Online and on-premises:

Keywords that appear in the subject of e-mails and are not retrieved – not case sensitive.

 keyword1, keyword2, keyword3 -
mas-mailbox.archiving-exclusions.exclusion-category String

Online and on-premises:

Category for e-mails that were not retrieved due to the 'exclusion' restrictions.

 Archiving skipped Skipped archiving
mas.onprem-mailbox-related-storage.folder-name-config.domains Comma-separated list

If specified, all mailboxes must be part of the specified domains.

Otherwise, the health check reports the status DOWN.

 test.de, dev.org -
mas.onprem-mailbox-related-storage.folder-name-config.property String

Value used for folder indexing when other data is not available.

Values: USERNAME, DISPLAY_NAME, FIRST_NAME, LAST_NAME

 LAST NAME USERNAME
mas-mailbox.onprem.archiving.retention-policy.age-condition String

Retention time: successfully archived e-mails are deleted from the mailboxes after a certain period of time.

Specified in days (D), months (M), years (Y), separated by '|'.

 Y|5 -
mas-mailbox.onprem.archiving.retention-policy.deletion-schedule String

Time in 6-digit (in cron format) at which the deletion is executed daily.

Indication in single quotation marks.

 '0 * * * * *' '0 0 2 * * *'
Extracting attachments
mas-mailbox.onprem.attachment-extraction.mode String

Mode of extraction of attachments:

  • NONE

    No extraction.

  • LINKS

    Extraction and insert enaio® webclient links to attachment documents.

  • FILES

    Extraction and insert enaio® client links to attachment documents.

  • BOTH

    Extraction and insert enaio® webclient and enaio® client link to attachment documents.

 LINKS NONE
mas-mailbox.onprem.attachment-extraction.schedule String

Time in 6-digit (in cron format) at which the extraction is executed daily.

Indication in single quotation marks.

 '0 * * * * *' '0 0 3 * * *'
mas-mailbox.onprem.attachment-extraction.delay String

The earliest time after the extraction is executed for successfully created e-mails.

Specified in days (D), months (M), years (Y), separated by '|'.

By default, extraction is carried out directly after successful creation.

 D|30

0
mas-mailbox.onprem.attachment-extraction.categories.success String Category for e-mails whose attachment has been successfully extracted. Attachment extracted AttExtracted
mas-mailbox.onprem.attachment-extraction.categories.error String Category for e-mails whose attachment could not be extracted. Attachment not extracted AttNotExtracted