Documentation

{{docApp.title}}

{{docApp.description}}

INDEX

Documentation Library

Search for information on Hornbill Documentation.

{{docApp.searchError}}

{{docApp.searchResultFilteredItems.length}} results for "{{docApp.currentResultsSearchText}}" in {{docApp.searchFilterBySpecificBookTitle}}

Have questions about this site?


What is this site?

  • This website is Hornbill's new product documentation website and is currently under development.
  • It is intended that all existing and future public-facing documentation we produce will be available to search, browse and share.
  • Hornbill's current documentation is available at Hornbill Wiki but over time this content will be migrated to this documentation site.
  • Please feel free to have a look around at any time.

Why has Hornbill created this site?

  • Hornbill's products have moved on considerably since we introduced it almost 10 years ago. At the time, the MediaWiki tool was sufficient, but we have outgrown it.
  • Our customers are more enterprise focused and more self-sufficient than ever before, so for 2023 and beyond we have established a new documentation platform and team to drive our documentation initiative forwards.
  • We are aiming to deprecate the use of Hornbill Wiki for most Hornbill related documentation.
  • We want to enable our growing partner network with product resources and information, documentation beyond our Wiki approach is required.
  • We could definitely do with some help, and may even pay for some! If you have domain knowledge and would like to help, please check out our Hornbill Docs Contributor Guide and contact the Hornbill docs team at docs@hornbill.com.

What will this site be good for?

  • Community contribution will be facilitated, encouraged, and most welcome.
  • High quality documentation, will be kept up to date as rapidly as our products evolve.
  • Real-time content search and discovery.
  • Articles organized into books, books into libraries, creating a more natural and logical structure to our documentation.
  • Legacy API documentation and various other documentation sources will all be consolidated into a single unified documentation system.
  • Documentation available in browser as well as printable/viewable as PDF on demand.
  • Personalized documentation experience, allowing dark/light mode, article subscriptions, social media sharing and other useful features.
  • Almost all publicly available documentation on docs.hornbill.com will be open-source and available to fork on GitHub, allowing customers to derive their own custom documentation around Hornbill products should they wish to.

What is the timeline for this site?

  • We have taken the decision to publish and make available early, there is very little content at this time.
  • As and when we have completed/usable documentation, it will be published here.
  • We have a host of additional features we wish to add over time, so please watch this space.
  • We expect most of our existing documentation should be reviewed/migrated to docs.hornbill.com over the coming months.
  • The documentation project will be ongoing, will continue to expand, evolve and improve day-by-day.

{{docApp.libraryHomeViewProduct.title || docApp.libraryHomeViewProduct.id}}

{{docApp.libraryHomeViewProduct.description}}

  1. {{book.title}}

{{group.title || group.id}}

{{group.description}}

  1. {{book.title}}

{{group.title}}

Email Domains

Creating and configuring an email domain is a required part of providing email functionality within some of the Hornbill applications. The domain is primarily concerned with facilitating the outbound mail operation, delivering from the Hornbill instance to the outside world.

Topics Covered

  • Creating a new email domain.
  • Enabling DKIM.
  • Choosing a routing mode.
  • Performing an SPF test.

Before You Begin

This guide takes you through administrative configurations. The following will be needed to complete this guide:

  • Hornbill Admin User access.
  • General knowledge of using Configuration.
  • A fully qualified domain name for outgoing email.
  • A working knowledge of your mail servers and firewalls within your organization.

Creating an Email Domain

To create and configure a new email domain in Configuration.

  1. Search Configuration for Email Domain.
  2. In the results, select Email Domain.
  3. Click on the + Add Outbound Route button.

Details

  • Domain Name
    The name that is used here must be a valid domain name. For example ‘mycompany.com’.
  • Enable processing of incoming mail on this route
    Turning this on will allow any email that has been sent to this domain to be processed by the SMTP service and allow it to be routed to the appropriate mailbox.
  • Automatically create an address for this route when a new mailbox is created
    When a new user is created a personal mailbox is created and associated with that user. When this feature is enabled, each new user will be automatically allocated an email address using this domain name. The Address Format can then be used to set the format of the username.
  • Address Format
    The Address Format is to be used when a new personal mailbox is created. This is only available if you have enabled the option above to automatically create addresses for this route. The formats that can be selected are based on variations of the Firstname and Lastname of the user with the exception of the LoginID.

Enable DKIM

DomainKeys Identified Mail (DKIM) is an email authentication method designed to make sure messages aren’t altered in transit between the sending and recipient servers and to detect forged sender addresses in email (email spoofing), a technique often used in phishing and email spam.

  • DKIM Selector
    A DKIM selector is specified when the private/public key pair is created when DKIM is set up for the email domain (or email sender), and it can be any arbitrary string of text.
  • DKIM Key Size
    Choose between 1024 and 2048 bits for your key size.

Note

Once the domain has been saved, you will be presented with a DKIM Key

Outbound Routing Mode

There are two methods of outbound routing available in Hornbill. Select the one that is most desirable to you based on the descriptions below.

Option 1: DNS Routing

If you wish to use DNS Routing, this requires the following steps.

  1. Add an SPF and TXT record to your DNS server.
  2. Validating the record using the Test SPF button.
  3. After a successful test, click on the Create Route button.

When an email is delivered, our servers will automatically negotiate the highest level of transport encryption supported by the remote SMTP server. This is completely automatic and is negotiated every time a new SMTP connection is made. We support the TLS 1.2, TLS 1.1, TLS 1.0, SSL 3.0, and Plain Text protocols, prioritized and negotiated for in that order. The SPF/TXT record allows Hornbill to send emails using the configured domain without the risk of breaching any anti-spam/email source validation checks.

Note

If the domain name is set to live.hornbill.com, a SPF/TXT Record is not required.

Option 2: SMTP SmartHost

A smart host is a type of email message transfer agent that allows a Simple Mail Transfer Protocol (SMTP) server to route email via an intermediate e-mail server rather than directly to the recipient’s server. With this method, an e-mail server within your organization is configured to allow the relaying of emails from your Hornbill instance (based in our data center) to your end users. With the relay configured, any outbound email will pass through your domain, and therefore, from the recipient’s perspective, the source domain will correspond to that used in the “from address” that we configure within Hornbill.

To successfully complete the email integration using this method you will need to:

  1. Create an outbound route in Hornbill and configure the necessary details.
  2. Configure a relay connector on your mail server (allowing relay from the appropriate origin IP stated below).
  3. Configure any necessary firewall rules (allowing traffic from the appropriate origin IP) to allow communication from your Hornbill instance.

Note

If you are not familiar with how to complete steps 2 and 3, please refer to the relevant vendor-specific documentation for your mail server and firewall interfaces.

Firewall - Origin IP Address

The origin IP that should be specified in any such firewall rules is one of the following and is dependent on the location of your instance. You should have both the Primary and Secondary IP for your geographical area:

  • Europe
    87.117.243.10 or 212.71.225.67
    If you are a UK or European customer, your instance will be located in our European data center and any outbound mail will originate from these IP addresses.
  • North America
    69.174.249.200 or 64.34.188.200
    If you are a North American customer, your instance will be located in our North American data center and any outbound mail will originate from these IP addresses.

Note

You will find a default domain entry (live.hornbill.com) comes already configured with your instance which allows you to test aspects of the Hornbill applications while you are organizing the email configuration required in your infrastructure.

FCrDNS

This is known as Forward-Confirmed reverse DNS (FCrDNS). This means that the hostname’s A record must match the reverse DNS (PTR) record for the IP (and Vice Versa). This was a historic attempt to ensure that the Sender owned the domain and the DNS record. In reality, it never really worked once cloud services or multi-tenant systems became a reality with multiple SMTP serves serving many customers and having resilience and was dropped by all but 2 lists years ago.

Therefore as with many other cloud vendors, we are advising our customers and their email recipients to avoid using any blacklist that implements FCrDNS or if not possible, configure Hornbill to use their own SMART host rather than the live.hornbill.com provided SMART HOST

In This Document