Zimbra Collaboration is the world's leading open-source messaging and collaboration solution. Zimbra includes complete email, contacts, calendar, file sharing, tasks and chat and can be accessed from the Zimbra Web client via any device and any other email client. Using Zimbra Administrator integration users can search across mailboxes, delete emails, and get account details of any user.
This document provides information about the Zimbra Administrator Connector, which facilitates automated interactions, with a Zimbra Administrator server using FortiSOAR™ playbooks. Add the Zimbra Administrator Connector as a step in FortiSOAR™ playbooks and perform automated operations with Zimbra Administrator.
Connector Version: 1.0.0
Authored By: Fortinet
Certified: No
Use the Content Hub to install the connector. For the detailed procedure to install a connector, click here.
You can also use the following yum command as a root
user to install connectors from an SSH session:
yum install cyops-connector-zimbra-administrator
For the procedure to configure a connector, click here
In FortiSOAR™, on the Connectors page, click the Zimbra Administrator connector row (if you are in the Grid view on the Connectors page) and in the Configurations tab enter the following configuration details:
Parameter | Description |
---|---|
Server URL | The hostname or the IP address of the Zimbra Collaboration Suite server. |
SSH Username | The username, with admin credentials, to access the Zimbra Collaboration server using SSH. |
SSH Password | The password for the specified username required to access the Zimbra Collaboration server. |
The following automated operations can be included in playbooks and you can also use the annotations to access operations from FortiSOAR™ release 4.10.0 and onwards:
Function | Description | Annotation and Category |
---|---|---|
Search Email | Searches across mailboxes to find messages and attachments based on the folder in which to search, the user's email address, and the search query you have specified. | search_emails Investigation |
Delete Email | Deletes an email based on the message ID you have specified. | delete_email Remediation |
Get Account Details | Fetches the specified account details based on the account ID and username you have specified. | get_account_details Investigation |
Parameter | Description |
---|---|
Source | (Optional) Select the source folder where to search for emails in the Zimbra Mailbox. By default, this is set as Inbox If you choose Custom Folder specify the folder name in which to search for emails within the Zimbra Mailbox. |
Email Addresses | Specify a comma-separated list of email addresses in whose mailboxes you want to perform the search operation. |
Subject to be Search | Specify the subject line to search across the mailboxes. |
Query | Specify the search query string to search across the mailboxes. |
The output contains the following populated JSON schema:
{
"ID": "",
"Subject": "",
"Address": "",
"Date": "",
"Size": "",
"Conv": "",
"Flags": "",
"Folder": "",
"Fragment": ""
}
Parameter | Description |
---|---|
Email Address | Specify the email address in whose mailbox you want to delete emails. |
Message ID | Specify a message ID of the email message that you want to delete from a Zimbra account. |
The output contains the following populated JSON schema:
{
"result": ""
}
Parameter | Description |
---|---|
Account ID or Name | Specify an account ID or the name of the user for which you want to retrieve the account details. |
The output contains a non-dictionary value.
The Sample - Zimbra Administrator - 1.0.0
playbook collection comes bundled with the Zimbra Administrator connector. These playbooks contain steps using which you can perform all supported actions. You can see bundled playbooks in the Automation > Playbooks section in FortiSOAR™ after importing the Zimbra Administrator connector.
Note: If you are planning to use any of the sample playbooks in your environment, ensure that you clone those playbooks and move them to a different collection since the sample playbook collection gets deleted during connector upgrade and delete.
Zimbra Collaboration is the world's leading open-source messaging and collaboration solution. Zimbra includes complete email, contacts, calendar, file sharing, tasks and chat and can be accessed from the Zimbra Web client via any device and any other email client. Using Zimbra Administrator integration users can search across mailboxes, delete emails, and get account details of any user.
This document provides information about the Zimbra Administrator Connector, which facilitates automated interactions, with a Zimbra Administrator server using FortiSOAR™ playbooks. Add the Zimbra Administrator Connector as a step in FortiSOAR™ playbooks and perform automated operations with Zimbra Administrator.
Connector Version: 1.0.0
Authored By: Fortinet
Certified: No
Use the Content Hub to install the connector. For the detailed procedure to install a connector, click here.
You can also use the following yum command as a root
user to install connectors from an SSH session:
yum install cyops-connector-zimbra-administrator
For the procedure to configure a connector, click here
In FortiSOAR™, on the Connectors page, click the Zimbra Administrator connector row (if you are in the Grid view on the Connectors page) and in the Configurations tab enter the following configuration details:
Parameter | Description |
---|---|
Server URL | The hostname or the IP address of the Zimbra Collaboration Suite server. |
SSH Username | The username, with admin credentials, to access the Zimbra Collaboration server using SSH. |
SSH Password | The password for the specified username required to access the Zimbra Collaboration server. |
The following automated operations can be included in playbooks and you can also use the annotations to access operations from FortiSOAR™ release 4.10.0 and onwards:
Function | Description | Annotation and Category |
---|---|---|
Search Email | Searches across mailboxes to find messages and attachments based on the folder in which to search, the user's email address, and the search query you have specified. | search_emails Investigation |
Delete Email | Deletes an email based on the message ID you have specified. | delete_email Remediation |
Get Account Details | Fetches the specified account details based on the account ID and username you have specified. | get_account_details Investigation |
Parameter | Description |
---|---|
Source | (Optional) Select the source folder where to search for emails in the Zimbra Mailbox. By default, this is set as Inbox If you choose Custom Folder specify the folder name in which to search for emails within the Zimbra Mailbox. |
Email Addresses | Specify a comma-separated list of email addresses in whose mailboxes you want to perform the search operation. |
Subject to be Search | Specify the subject line to search across the mailboxes. |
Query | Specify the search query string to search across the mailboxes. |
The output contains the following populated JSON schema:
{
"ID": "",
"Subject": "",
"Address": "",
"Date": "",
"Size": "",
"Conv": "",
"Flags": "",
"Folder": "",
"Fragment": ""
}
Parameter | Description |
---|---|
Email Address | Specify the email address in whose mailbox you want to delete emails. |
Message ID | Specify a message ID of the email message that you want to delete from a Zimbra account. |
The output contains the following populated JSON schema:
{
"result": ""
}
Parameter | Description |
---|---|
Account ID or Name | Specify an account ID or the name of the user for which you want to retrieve the account details. |
The output contains a non-dictionary value.
The Sample - Zimbra Administrator - 1.0.0
playbook collection comes bundled with the Zimbra Administrator connector. These playbooks contain steps using which you can perform all supported actions. You can see bundled playbooks in the Automation > Playbooks section in FortiSOAR™ after importing the Zimbra Administrator connector.
Note: If you are planning to use any of the sample playbooks in your environment, ensure that you clone those playbooks and move them to a different collection since the sample playbook collection gets deleted during connector upgrade and delete.