Send Email to KanBo - Installation (OnPremise)
The Send Emails to KanBo feature will allow you to send emails directly to a KanBo Board and create a new Card out of the email. It will also allow you to add email and its attachments to an existing KanBo Card.
- This feature is enabled for KanBo in version 2.7 or higher. Make sure you have this KanBo version installed.
- Functionality requires having a service account on your Exchange to serve as a Catch-All account. This user needs to have an Exchange license.
- You need to set up an email account for Incoming Email with a custom domain. Create an account with this domain in his email address (example: [email protected]). You can use a subdomain or fully qualified domain.
1. Creating a Catch-All email address.
You will need to create a Catch-All email account on Exchange server.
- Read how create a Catch-All email address here.
- Read more about Catch-All address and how to create it on Exchange here.
- Create a new account for the Catch-All purpose. Make sure this account has the Exchange license and mailbox.
- Add the custom domain to accepted domains.
2. Creating a SSL certificate.
This is a recommended method for the IIS scenario. Please perform these steps on your Virtual Machine.
- Go to the IIS and double click on Server Certificates.
- Now click on Create Self-Signed Certificate.
- Specify a friendly name for a certificate and select Personal. Click on OK.
- Select the certificate and select Export.
- Select the path and name for the certificate and add new password to it.
3. Changing KanBo web.config.
- Move to the location where your KanBo backend is hosted (the KanBo package). Open the web.config in any text editor.
- Add the following code before </plugins> and change the path to the certificate.
<auth.app issuer="incoming-mails"> <signature algo="rs256"> <cert type="x509-file" file="C:\Certs\mails\somecert.cer" /> </signature> <!-- set name to whatever you want, but there's no scenario where it would be used --> <mapper type="service" name="incoming emails" roles="service" /> <mapper type="user" /> <mapper type="email" roles="service" /> <mapper type="login" /> </auth.app>
- Move slightly to the bottom to see the <appSettings> section.
- Set KanBoIncomingMail value to true.
<add key="KanBoIncomingMail" value="true" />
- Set KanBoIncomingMailDomain to your sending domain name - the one on which you have the Catch-All mailbox.
<add key="KanBoIncomingMailDomain" value="YourDomain" />
Save the web.config.
TIP: If you intend to send emails to your catch-all address and some other email addresses (multiple at once), add this entry and adjust the number inside it to match the maximum number of receivers.
<add key="kanbo.max-receivers" value="1" />
4. Configure the Email Tool
Contact us at [email protected] to receive an Email to KanBo tool package.
- Once you download the package, unzip it and move it a chosen location. In our case it would be C:\Email Tool\EmailToKanBo\EmailToKanBo .
- Open your directory and start editing EmailToKanBo.exe.config
- In the following section please change the following values:
- Password - add here the Catch-All account's email
- mail.url - server address of your Exchange instance
<add key="mail.type" value="ews-unread" /> <add key="mail.receiver-email" value="[email protected]"/> <add key="mail.receiver-password" value="Password"/> <!-- will autodiscover if empty --> <add key="mail.url" value="https://some-host-address"/>
- In the next section, adjust the following values:
- CertPath - local path to your certificate,
- Password - your certificate password,
- https://YourKanboAddress - add here your KanBo address
- YourDomain - add here your email domain to which Catch-All address is connected to
<add key="kanbo.api.cert.file" value="CerthPath\CertName.pfx"/> <add key="kanbo.api.cert.pass" value="Password"/> <add key="kanbo.api.url" value="https://YourKanBoAddress"/> <add key="kanbo.incoming-mail-domain" value="YourDomain"/>
5. Add a task to the Task Scheduler.
Here is the simple example how to add Email to KanBo Task to the Windows Task Scheduler.
Full manual for Windows Scheduled Tasks you can find in the Microsoft web site: https://technet.microsoft.com/en-us/library/cc766428.aspx
- Execute Task Scheduler. Insert data in the following values:
- Select user with proper privileges to execute task.
- Select Run whether user is logged on or not
- We also recommend to select Run with highest priviledges.
- Select Triggers tab and create a new trigger. Complete the steps as it follows:
- Begin the task - On a Schedule
- Settings: Daily
- Advanced settings: Repeat task every 5 minutes for a duration of Indefinitely (you can of course chose another period of time to suit your needs)
- Select Enabled
- Select Actions tab and add new action pointing to the EmailToKanBo.Webjob.exe file within the folder where you unpacked the Email To KanBo tool.
- Start in (optional) - add a local path to the folder where EmailToKanBo.Webjob.exe is located (example: C:\Email Tool\EmailToKanBo\EmailToKanBo\)
After this action is completed, select OK and confirm your administrator credentials.