/kanboard-plugin-pullmailtasks

Kanboard Task by pulling Mails from an IMAP Account

Primary LanguagePHPMIT LicenseMIT

PullMailTasks Plugin for Kanboard

(Based on Mailgun Plugin)

Use your IMAP Email account to create tasks directly by email

  • Create tasks from incoming emails sent to a mailbox
  • Optionally set color and/or tag(s) for all pulled tasks
  • Experimental support for attachments (any help welcome)

Incoming Emails for Kanboard are identified using the email subject kanboard+MYPROJECT:TASKNAME. Emails are deleted after task creation. Other emails will be ignored.

Developed using Kanboard Version 1.2.5

Authors

  • Ralf Blumenthal, with enhancements by Benedikt Hopmann
  • License MIT
  • Entypo Email pictogram by Daniel Bruce — www.entypo.com, released under CC BY-SA 4.0

Installation

  • Create a folder plugins/PullMailTasks
  • Copy all files under this directory
  • php-imap extension required
  • Setup a cron job calling the URL to pull email task (URL is found under Settings > Integrations > PullMailTasks)

Plugin Setup

Define those constants in your config.php file :

### PullMailTasks Plugin Settings ###
// System name, port and flags
define('PMT_DOMAIN', 'imap.goneo.de:993/imap/ssl');
// Mailbox name
define('PMT_MSGBOX', 'INBOX');
// Username and password
define('PMT_USER', '');
define('PMT_PASWORD', '');

Kanboard configuration

  1. Be sure that your users have an email address in their profiles
  2. Assign a project identifier to the desired projects: Project settings > Edit Project > Identifier. The format has to be alphanumeric like MYPROJECT
  3. Send an email to your project using the email subject kanboard+MYPROJECT:TASKNAME.

Attention: The from address must be same as the email address in the user profile in Kanboard and the user must be member of the project.

  1. Pull email by calling URL, which is found under Settings > Integrations > PullMailTasks along with some other settings
  2. Optionally set color, tag(s), support for receiving attachments and support for adding email body as task attachment for all pulled tasks. Furthermore kanboard+MYPROJECT:TASKNAME as email subject with keyword kanboard is the default value for all pulled tasks. Alternatively, the keyword could be suspended completely. This may be useful, if the imap account is used only for pulling tasks. In this case, the necessary email subject could be changed to MYPROJECT:TASKNAME. As another option Email Address Tags like + or - could be activated. When acivated, PullMailTasks allows listening to foo-MYPROJECT＠example.com resp. foo+MYPROJECT＠example.com for extracting the project identifier. Thus the email subject should only contain the TASKNAME (more information about address tags).