Skip to main content
Version: 2025.2

MailbridgeMailserver

This page provides generated reference documentation for the MailbridgeMailserver data model.

Enthält die Einstellungen des Mailservers für die Mailbridge. Dieses Datenmodell ist Teil des ServerConfigDataModels.

Overview​

PropertySummary
attachmentHandlingDetermines how to process mails with attachments.
bridgeModeOne of three modes:
bridgeNameThe name can be set freely and is used to identify the mailbridge. It is recommended to use a name that describes which mailserver is used.
enabledIf true, this mailbridge will run.
errorProcessYou can choose a process from your project, which gets executed when an error occurs while processing an email. I.e. an email with attachment, which are too…
flagModeThis determines which emails are loaded by the mailbridge.
intervallThe time intervall, in milliseconds, for the regular runs of the mailbridge.
maxMailSizeOverrides the mailGlobalMaxSizeRecieve property.
processYou can choose a process from your project, which gets executed when the mailbridge processes mails in mode Process or Both. You can use three special…
receivingFilterWith these, filters you can add some extra processing to the mailbridge. Possible values are:
serverNameThe alias name of one of your mailservers. The mailbridge will access the chosen mailserver.
timeoutTime interval, in milliseconds, after which the mailbridge stops trying to read from a mailbox.
userThe login of an ADITO user, who has their e-mail configurations set. The mailbridge will use the configured credentials of this user to authenticate at the…

attachmentHandling​

Type: String

Determines how to process mails with attachments.

  • ALL: Reads all attachments, should the email together with its attachments exceed the file size set in the mailGlobalMaxSizeRecieve property or in the maximum size column of the mailbridge config, the email is not processed and an error gets thrown.
  • THRESHOLD: Reads the email and all attachments, whose file size is below what’s set in the mailGlobalMaxSizeRecieve property or in the maximum size column of the mailbridge config. Every attachment that’s bigger gets returned as an empty file.
  • NONE: Only reads the email, attachments are replaced with empty files.

bridgeMode​

Type: Integer

One of three modes:

  • 0 / PROCESS: only the mailbridge process is executed, the email is not copied to the mail repository.
  • 1 / COPY: the email is copied to the mail repository, no further processing is done.
  • 2 / BOTH: the actions of PROCESS and COPY are combined. The email gets copied into the mail repository and is then processed by the mailbridge process

bridgeName​

Type: String

The name can be set freely and is used to identify the mailbridge. It is recommended to use a name that describes which mailserver is used.

enabled​

Type: Boolean

If true, this mailbridge will run.

errorProcess​

Type: String

You can choose a process from your project, which gets executed when an error occurs while processing an email. I.e. an email with attachment, which are too big. The following $local. variables are provided in this process:

  • $local.error: Contains the ADITO error code
  • $local.error: Contains the id of the error
  • $local.errormessage: Contains the complete error message
  • $local.mailid: Contains the id of the email. This can be used to process the mail separately.

flagMode​

Type: Integer

This determines which emails are loaded by the mailbridge.

  • 0 / New: Only fetches newly received emails, this does not include older unread emails
  • 1 / Read: Only fetches emails that were read by a user
  • 2 / Unread: Fetches all unread emails
  • 3 / All: Fetches all emails in the specified inbox of the mailbridge user

intervall​

Type: Long

The time intervall, in milliseconds, for the regular runs of the mailbridge.

maxMailSize​

Type: Long

Overrides the mailGlobalMaxSizeRecieve property.

With this a mailbridge may handle bigger files or be restricted to smaller files than specified in the global property.

process​

Type: String

You can choose a process from your project, which gets executed when the mailbridge processes mails in mode Process or Both. You can use three special $local. variables in this process:

  • $local.mail: Contains the complete mail as an object
  • $local.recipients: Contains all recipient email addresses
  • $local.sender: Contains the sender email address

Parameters​

$local.mail
  The mail object

$local.recipients
  The recipient

$local.sender
  The sender

receivingFilter​

Type: String

With these, filters you can add some extra processing to the mailbridge. Possible values are:

  • CRLF: Replaces are line breaks with " ". This can be used to ensure correct processing, if emails are read that were created by Linux or macOS users, as these operating system either only use (Linux) or (macOS).
  • Extractattachment: Expects all incoming emails to only have one attachment and then uses the attachment to create the mail object.
  • Extractattachment2: Expects all incoming emails to only have one attachment that’s encoded in MIME type Message/rfc822. The mailbridge will extract the attachment and form the mail object based on the attachment.
  • log: Writes the email to the log.
  • printtext: Writes the email to the console logger.

serverName​

Type: String

The alias name of one of your mailservers. The mailbridge will access the chosen mailserver.

timeout​

Type: Long

Time interval, in milliseconds, after which the mailbridge stops trying to read from a mailbox.

user​

Type: String

The login of an ADITO user, who has their e-mail configurations set. The mailbridge will use the configured credentials of this user to authenticate at the mailserver.