Fortinet black logo

Zimbra Mailbox v1.0.0

1.0.0
Copy Link
Copy Doc ID fce4a51d-73cf-11ed-8e6d-fa163e15d75b:456

About the connector

Zimbra Collaboration is the world's leading open source messaging and collaboration solution. Zimbra includes complete email, contacts, calendar, file sharing, tasks, and chat solution. It can be accessed from the Zimbra Web client via any device and any other email client. Using Zimbra integration, users can search emails, retrieve unread emails, import, and export emails.

This document provides information about the Zimbra Mailbox Connector, which facilitates automated interactions, with a Zimbra Mailbox server using FortiSOAR™ playbooks. Add the Zimbra Mailbox Connector as a step in FortiSOAR™ playbooks and perform automated operations with Zimbra Mailbox.

Version information

Connector Version: 1.0.0

Authored By: Community

Certified: No

Installing the connector

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-mailbox

Prerequisites to configuring the connector

  • You must have the URL of Zimbra Mailbox server to which you connect and perform automated operations, and credentials to access that server.
  • The FortiSOAR™ server should have outbound connectivity to port 443 on the Zimbra Mailbox server.

Minimum Permissions Required

  • Not applicable

Configuring the connector

For the procedure to configure a connector, click here

Configuration parameters

In FortiSOAR™, on the Content Hub (or Connector Store) page, click the Manage tab, and then click the Zimbra Mailbox connector card. On the connector popup, click the Configurations tab to enter the required configuration details.

Parameter Description
Host URL The host name or the IP address of the Zimbra Collaboration Suite server.
Port The port number through which you connect to the Zimbra Mailbox.
Username The username or the email address to access the Zimbra Mailbox.
Password The password for the specified username or email address to access the Zimbra Mailbox.
Email Address The email address for which to fetch details from the Zimbra Mailbox.
Verify SSL Specifies whether the SSL certificate for the server is to be verified or not.
By default, this option is set to True.

Actions supported by the connector

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
Get Contacts Gets the contacts in the designated folder based on the email address, folder from which to get contacts, and the name you have specified. The default folder is Contacts but user-defined folders are also supported. get_contact
Investigation
Get Unread Emails Gets all unread emails from the selected mailbox folder. get_unread_emails
Investigation
Search Emails Runs a query in your Zimbra account and searches for emails, based on folder name, email address, body, and subject you have specified. search_emails
Investigation
Import Email Imports a message to a mail folder in MIME RFC822 format based on the email address, source folder, and type of file that you have specified. Default (inbox/sent/trash/junk) and user-defined folders are supported. import_email
Investigation
Export Mailbox Exports all the contents of the selected mailbox based on the email address, output format, and export query that you have specified. export_mailbox
Investigation

operation: Get Contacts

Input parameters

Parameter Description
Email Address (Optional) Specify the email address for which to retrieve the contacts.
Folder (Optional) Select the folder from which to retrieve the contacts details. By default, this is set as Contacts
If you choose User Defined, specify the user defined folder from which to retrieve the contacts
Filter contacts by Name (Optional) Specify the name for which to retrieve the contact details.

Output

The output contains the following populated JSON schema:
{
"cn": [
{
"d": "",
"l": "",
"id": "",
"rev": "",
"_attrs": {
"email": "",
"notes": "",
"company": "",
"birthday": "",
"fullName": "",
"jobTitle": "",
"lastName": "",
"firstName": "",
"mobilePhone": ""
},
"fileAsStr": ""
}
]
}

operation: Get Unread Emails

Input parameters

Parameter Description
Email Address (Optional) Specify the email address from which to fetch unread emails.
Source (Optional) Select the source folder from which to retrieve the unread emails from the Zimbra Mailbox. By default, this is set as Inbox
If you choose Custom Folder, specify the folder Name from which to retrieve unread emails in the Zimbra Mailbox.
If a user wants to retrieve unread emails from a nested folder enter the Source in the following format:
parent_folder/target_folder
For example, to retrieve emails from a folder named Invoice that is present within Inbox, Inbox/Invoice in this field.
Parse Headers (Optional) Select this option to retrieve email headers in the response.

Output

The output contains the following populated JSON schema:
{
"s": "",
"d": "",
"l": "",
"cid": "",
"f": "",
"rev": "",
"id": "",
"e": [
{
"a": "",
"d": "",
"p": "",
"t": ""
}
],
"su": "",
"fr": "",
"file": "",
"headers": {
"return-path": "",
"received": [],
"x-spam-flag": "",
"x-spam-score": "",
"x-spam-level": "",
"x-spam-status": "",
"x-virus-scanned": "",
"date": "",
"from": "",
"to": "",
"message-id": "",
"in-reply-to": "",
"references": "",
"subject": "",
"mime-version": "",
"content-type": "",
"x-originating-ip": "",
"thread-topic": "",
"thread-index": ""
},
"preamble": "",
"body": {
"text": "",
"html": "",
"json": null
},
"attachments": [],
"attachment_files": [],
"parsed_attachment_data": [],
"epilogue": ""
}

operation: Search Emails

Input parameters

Parameter Description
Email Address (Optional) Specify the email address from which to search.
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.
Query (Optional) Specify the search parameters based on which to search for emails in the specified folder within the Zimbra Mailbox.
Parse Headers (Optional) Select this option to retrieve email headers in the response.

Output

The output contains the following populated JSON schema:
{
"s": "",
"d": "",
"l": "",
"cid": "",
"f": "",
"rev": "",
"id": "",
"e": [
{
"a": "",
"d": "",
"p": "",
"t": ""
}
],
"su": "",
"fr": "",
"file": "",
"headers": {
"return-path": "",
"received": [],
"x-spam-flag": "",
"x-spam-score": "",
"x-spam-level": "",
"x-spam-status": "",
"x-virus-scanned": "",
"date": "",
"from": "",
"to": "",
"message-id": "",
"in-reply-to": "",
"references": "",
"subject": "",
"mime-version": "",
"content-type": "",
"x-originating-ip": "",
"thread-topic": "",
"thread-index": ""
},
"preamble": "",
"body": {
"text": "",
"html": "",
"json": null
},
"attachments": [],
"attachment_files": [],
"parsed_attachment_data": [],
"epilogue": ""
}

operation: Import Email

Input parameters

Parameter Description
Email Address (Optional) Specify the email address from where to import emails.
Source (Optional) Select the source folder from which to import emails.
If you choose Custom Folder, specify the folder name to import emails from the Zimbra Mailbox.
Type Select the type of the attachment that you are importing in the specified folder within Zimbra Mailbox. Type can be an Attachment ID or a File IRI.
Reference ID Specify a reference ID to access the attachment metadata from the Attachments module in FortiSOAR™. In the playbook, this defaults to {{vars.attachment_id}} or {{vars.file_iri}}.

Output

No output schema is available at this time.

operation: Export Mailbox

Input parameters

Parameter Description
Email Address (Optional) Specify the email address from which to export emails.
Output Format Select the file format to export to Mailbox.
Query (Optional) Specify the query string. For more information on Zimbra's query strings refer to the Zimbra wiki.

Output

No output schema is available at this time.

Included playbooks

The Sample - Zimbra Mailbox - 1.0.0 playbook collection comes bundled with the Zimbra Mailbox 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 Mailbox connector.

  • Export Mailbox
  • Get Contacts
  • Get Unread Emails
  • Import Email
  • Search Emails

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.

Previous
Next

About the connector

Zimbra Collaboration is the world's leading open source messaging and collaboration solution. Zimbra includes complete email, contacts, calendar, file sharing, tasks, and chat solution. It can be accessed from the Zimbra Web client via any device and any other email client. Using Zimbra integration, users can search emails, retrieve unread emails, import, and export emails.

This document provides information about the Zimbra Mailbox Connector, which facilitates automated interactions, with a Zimbra Mailbox server using FortiSOAR™ playbooks. Add the Zimbra Mailbox Connector as a step in FortiSOAR™ playbooks and perform automated operations with Zimbra Mailbox.

Version information

Connector Version: 1.0.0

Authored By: Community

Certified: No

Installing the connector

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-mailbox

Prerequisites to configuring the connector

Minimum Permissions Required

Configuring the connector

For the procedure to configure a connector, click here

Configuration parameters

In FortiSOAR™, on the Content Hub (or Connector Store) page, click the Manage tab, and then click the Zimbra Mailbox connector card. On the connector popup, click the Configurations tab to enter the required configuration details.

Parameter Description
Host URL The host name or the IP address of the Zimbra Collaboration Suite server.
Port The port number through which you connect to the Zimbra Mailbox.
Username The username or the email address to access the Zimbra Mailbox.
Password The password for the specified username or email address to access the Zimbra Mailbox.
Email Address The email address for which to fetch details from the Zimbra Mailbox.
Verify SSL Specifies whether the SSL certificate for the server is to be verified or not.
By default, this option is set to True.

Actions supported by the connector

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
Get Contacts Gets the contacts in the designated folder based on the email address, folder from which to get contacts, and the name you have specified. The default folder is Contacts but user-defined folders are also supported. get_contact
Investigation
Get Unread Emails Gets all unread emails from the selected mailbox folder. get_unread_emails
Investigation
Search Emails Runs a query in your Zimbra account and searches for emails, based on folder name, email address, body, and subject you have specified. search_emails
Investigation
Import Email Imports a message to a mail folder in MIME RFC822 format based on the email address, source folder, and type of file that you have specified. Default (inbox/sent/trash/junk) and user-defined folders are supported. import_email
Investigation
Export Mailbox Exports all the contents of the selected mailbox based on the email address, output format, and export query that you have specified. export_mailbox
Investigation

operation: Get Contacts

Input parameters

Parameter Description
Email Address (Optional) Specify the email address for which to retrieve the contacts.
Folder (Optional) Select the folder from which to retrieve the contacts details. By default, this is set as Contacts
If you choose User Defined, specify the user defined folder from which to retrieve the contacts
Filter contacts by Name (Optional) Specify the name for which to retrieve the contact details.

Output

The output contains the following populated JSON schema:
{
"cn": [
{
"d": "",
"l": "",
"id": "",
"rev": "",
"_attrs": {
"email": "",
"notes": "",
"company": "",
"birthday": "",
"fullName": "",
"jobTitle": "",
"lastName": "",
"firstName": "",
"mobilePhone": ""
},
"fileAsStr": ""
}
]
}

operation: Get Unread Emails

Input parameters

Parameter Description
Email Address (Optional) Specify the email address from which to fetch unread emails.
Source (Optional) Select the source folder from which to retrieve the unread emails from the Zimbra Mailbox. By default, this is set as Inbox
If you choose Custom Folder, specify the folder Name from which to retrieve unread emails in the Zimbra Mailbox.
If a user wants to retrieve unread emails from a nested folder enter the Source in the following format:
parent_folder/target_folder
For example, to retrieve emails from a folder named Invoice that is present within Inbox, Inbox/Invoice in this field.
Parse Headers (Optional) Select this option to retrieve email headers in the response.

Output

The output contains the following populated JSON schema:
{
"s": "",
"d": "",
"l": "",
"cid": "",
"f": "",
"rev": "",
"id": "",
"e": [
{
"a": "",
"d": "",
"p": "",
"t": ""
}
],
"su": "",
"fr": "",
"file": "",
"headers": {
"return-path": "",
"received": [],
"x-spam-flag": "",
"x-spam-score": "",
"x-spam-level": "",
"x-spam-status": "",
"x-virus-scanned": "",
"date": "",
"from": "",
"to": "",
"message-id": "",
"in-reply-to": "",
"references": "",
"subject": "",
"mime-version": "",
"content-type": "",
"x-originating-ip": "",
"thread-topic": "",
"thread-index": ""
},
"preamble": "",
"body": {
"text": "",
"html": "",
"json": null
},
"attachments": [],
"attachment_files": [],
"parsed_attachment_data": [],
"epilogue": ""
}

operation: Search Emails

Input parameters

Parameter Description
Email Address (Optional) Specify the email address from which to search.
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.
Query (Optional) Specify the search parameters based on which to search for emails in the specified folder within the Zimbra Mailbox.
Parse Headers (Optional) Select this option to retrieve email headers in the response.

Output

The output contains the following populated JSON schema:
{
"s": "",
"d": "",
"l": "",
"cid": "",
"f": "",
"rev": "",
"id": "",
"e": [
{
"a": "",
"d": "",
"p": "",
"t": ""
}
],
"su": "",
"fr": "",
"file": "",
"headers": {
"return-path": "",
"received": [],
"x-spam-flag": "",
"x-spam-score": "",
"x-spam-level": "",
"x-spam-status": "",
"x-virus-scanned": "",
"date": "",
"from": "",
"to": "",
"message-id": "",
"in-reply-to": "",
"references": "",
"subject": "",
"mime-version": "",
"content-type": "",
"x-originating-ip": "",
"thread-topic": "",
"thread-index": ""
},
"preamble": "",
"body": {
"text": "",
"html": "",
"json": null
},
"attachments": [],
"attachment_files": [],
"parsed_attachment_data": [],
"epilogue": ""
}

operation: Import Email

Input parameters

Parameter Description
Email Address (Optional) Specify the email address from where to import emails.
Source (Optional) Select the source folder from which to import emails.
If you choose Custom Folder, specify the folder name to import emails from the Zimbra Mailbox.
Type Select the type of the attachment that you are importing in the specified folder within Zimbra Mailbox. Type can be an Attachment ID or a File IRI.
Reference ID Specify a reference ID to access the attachment metadata from the Attachments module in FortiSOAR™. In the playbook, this defaults to {{vars.attachment_id}} or {{vars.file_iri}}.

Output

No output schema is available at this time.

operation: Export Mailbox

Input parameters

Parameter Description
Email Address (Optional) Specify the email address from which to export emails.
Output Format Select the file format to export to Mailbox.
Query (Optional) Specify the query string. For more information on Zimbra's query strings refer to the Zimbra wiki.

Output

No output schema is available at this time.

Included playbooks

The Sample - Zimbra Mailbox - 1.0.0 playbook collection comes bundled with the Zimbra Mailbox 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 Mailbox 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.

Previous
Next