'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. UR information 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.		 ErrorArchive 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 -

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. UR information 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.on-prem.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.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