Legal Intercept

Legal Interception

   KB 2418        Last updated on 07/11/2015  

(0 votes)
Article-check.png  - This is certified documentation and is protected for editing by Zimbra Employees & Moderators only.
 - This is archive documentation, which means it is not supported or valid for recent versions of Zimbra Collaboration.
 - This article is a Work in Progress, and may be unfinished or missing sections.


Service Providers are increasingly under the legal obligation to capture any persistent state changes within a separate archive mailbox for legal intercept/discovery. For example, if a message is saved as a draft, and then deleted, this still needs to be recorded somehow in the archive mailbox as this mechanism could be used by multiple users to communicate (one writes a draft, the other reads and deletes) without necessarily having those communications ever make it into the archive mailbox.

Legal Intercept is the ability to intercept user messages and send them to another mailbox. Once intercept is turned on, any time that the user sends a message, receives a message, or saves a draft, an intercept message is sent to the specified mailbox with the original message attached. This is different than forwarding, here a new message envelope is constructed to avoid the possibility of bounces returning to the original sender or monitored user.

Note: This feature is implemented in ZCS 5.0.3+ intended for recording web-client actions only. While it may log IMAP/ZCO outgoing actions if you 'save a copy to the sent folder' it does not include basic SMTP sends; please see the ZAD add-on if you need guaranteed recording of actions outside of the ZWC.

Command Usage

The following CLI commands are for common Legal Intercept tasks.

To enable Legal Intercept:

zmprov ma zimbraInterceptAddress

To check status of Legal Intercept:

zmprov ga zimbraInterceptAddress

To disable Legal Intercept:

zmprov ma zimbraInterceptAddress ''


zmprov ma -zimbraInterceptAddress

Intercept Values

The following are Legal Intercept values.

  • zimbraInterceptAddress. Intercept messages are sent to this address. When empty, lawful intercept is turned off.
  • zimbraInterceptSendHeadersOnly. When TRUE, only the headers are sent, not the message body.

For example, for headers only mode (no message body) you would set:

zmprov ma zimbraInterceptSendHeadersOnly TRUE

Message Composition Templates

  • zimbraInterceptFrom. Template used to construct the From header of the intercept message.
  • zimbraInterceptSubject. Template used to construct the Subject header of the intercept message.
  • zimbraInterceptBody. Template used to construct the body of the intercept message.

The default format of the body of the intercept message is currently:

Intercepted message for []. 
Operation=[Action], folder=[Name], folder ID=[#].
Template Values

The following parameters can be passed to the from/subject/body templates:

  • ACCOUNT_DOMAIN. Domain of the account being intercepted.
  • ACCOUNT_ADDRESS. Address being intercepted.
  • MESSAGE_SUBJECT. Subject of the message being intercepted.
  • OPERATION. Operation that the user is performing (E.g. add message, send message, save draft)
  • FOLDER_NAME. Name of the folder to which the message was saved.
  • FOLDER_ID. ID of the folder to which the message was saved.
  • NEWLINE. Used for formatting multi-line message bodies.


By design legal lntercept does not include mail sent via SMTP clients - please see Bug 30232

In 5.0.3 there's some additional manual configuration needed Bug 26471 - intercept throws NPE (solved in 5.0.5+)

(Workaround is to manually set all the zimbraIntercept COS attributes else you will get an error in the Web-UI.)

For example,

zmprov mc default zimbraInterceptSendHeadersOnly FALSE
zmprov mc default zimbraInterceptFrom "Postmaster <postmaster@\${ACCOUNT_DOMAIN}>"
zmprov mc default zimbraInterceptSubject "Intercepted message for \${ACCOUNT_ADDRESS}: \${MESSAGE_SUBJECT}"
zmprov mc default zimbraInterceptBody "Intercepted message for \${ACCOUNT_ADDRESS}.\${NEWLINE}Operation=\${OPERATION}, folder=\${FOLDER_NAME}, folder ID=\${FOLDER_ID}."


While legal intercept may log IMAP/ZCO outgoing actions if you 'save a copy to the sent folder' it does not include basic SMTP sends. Please see the Zimbra Archiving & Discovery add-on which does envelope forking & includes cross-mailbox search.

Verified Against: ZCS 5.0.3+ Date Created: 4/11/2008
Article ID: Date Modified: 07/11/2015

Try Zimbra

Try Zimbra Collaboration with a 60-day free trial.
Get it now »

Want to get involved?

You can contribute in the Community, Wiki, Code, or development of Zimlets.
Find out more. »

Looking for a Video?

Visit our YouTube channel to get the latest webinars, technology news, product overviews, and so much more.
Go to the YouTube channel »

Jump to: navigation, search