Skip to main content
Version: 1.4

Add message banner

This action puts a banner above the message when the recipient reads it in the Zimbra web client, for example EXTERNAL - This message comes from outside the organization. Do not click links you did not expect. It is in the Zimlets group of the Add menu of policy rules.

Unlike a subject tag or a disclaimer, the banner does not change the subject or the body: the message stays as the sender wrote it, a reply quotes no warning, and a DKIM signature still verifies for any filter after the rules.

The dialog has two tabs, Notice and Advanced, and below them a Preview of the notice as the Modern web client shows it, updated as you type.

Notice​

The Notice tab of the Add message banner dialog, with the Level None, Info, Warning or Danger, the Icon list, the Badge, Text, Link and Link text fields, and the Preview below

FieldMeaning
LevelNone (gray, default), Info, Warning or Danger. Sets the color.
IconAn icon from the list, such as warning, account-external, shield, lock or paperclip. You can also type the name of another icon of the web client: lowercase letters, digits and hyphens.
BadgeA short word shown in capitals, for example External. At most 30 characters.
TextThe text of the banner. At most 300 characters.
LinkAn optional link at the end of the banner, an https:// address, for example to your security guidelines. At most 500 characters.
Link textThe text of the link, at most 60 characters. Required with a link.

Enter at least an icon, a badge, a text or a link. Variables can be used in Badge, Text and Link text, for example {message:envelope:sender}, see Variables. They are not filled in in Link.

Advanced​

The Advanced tab of the Add message banner dialog, with the Notice id field set to notice

Notice id names the notice, in lowercase letters, digits and hyphens, at most 40 characters. It is filled in from the badge, the icon or the text until you change it, and is notice while they are empty.

How it works​

The action adds an X-MSH-Message-Notice header to the message, for example:

X-MSH-Message-Notice: external; type=banner; icon=account-external; level=warning; badge="External"; text="This message comes from outside the organization."

The Message Notices zimlets for the Modern and the Classic Zimbra web client read the header and show the banner. Other mail clients ignore the header and show the message without it.

X-MSH-Message-Notice headers a message arrives with are removed before the rules run, so a sender cannot put a banner of their own into your users' mail.

note

Users see the banner only once the Message Notices zimlets are deployed, see Zimlet configuration. Until then the header is added but no banner is shown.

Additional resources​