formCheckbox('integration_gravatar', t('Enable Gravatar images'), 1, $values['integration_gravatar'] == 1) ?>
diff --git a/app/Template/project/edit.php b/app/Template/project/edit.php
index c1f983153..ffd9be00a 100644
--- a/app/Template/project/edit.php
+++ b/app/Template/project/edit.php
@@ -9,6 +9,10 @@
formLabel(t('Name'), 'name') ?>
formText('name', $values, $errors, array('required', 'maxlength="50"')) ?>
+ formLabel(t('Identifier'), 'identifier') ?>
+ formText('identifier', $values, $errors, array('maxlength="50"')) ?>
+
diff --git a/app/Template/project/index.php b/app/Template/project/index.php
index 05a7d9552..8d2bc30b4 100644
--- a/app/Template/project/index.php
+++ b/app/Template/project/index.php
@@ -15,6 +15,7 @@
| order(t('Id'), 'id') ?> |
order(t('Status'), 'is_active') ?> |
+ order(t('Identifier'), 'identifier') ?> |
order(t('Project'), 'name') ?> |
|
@@ -30,6 +31,9 @@
+
+ e($project['identifier']) ?>
+ |
a('', 'board', 'show', array('project_id' => $project['id']), false, 'dashboard-table-link', t('Board')) ?>
diff --git a/assets/img/gravatar-icon.png b/assets/img/gravatar-icon.png
new file mode 100644
index 000000000..d9b3e6516
Binary files /dev/null and b/assets/img/gravatar-icon.png differ
diff --git a/assets/img/postmark-icon.png b/assets/img/postmark-icon.png
new file mode 100644
index 000000000..87f075948
Binary files /dev/null and b/assets/img/postmark-icon.png differ
diff --git a/composer.json b/composer.json
index 79ec0abfc..9e08dfc79 100644
--- a/composer.json
+++ b/composer.json
@@ -13,7 +13,8 @@
"symfony/console" : "@stable",
"symfony/event-dispatcher" : "~2.6",
"fguillot/simpleLogger" : "0.0.1",
- "christian-riesen/otp": "1.4"
+ "christian-riesen/otp": "1.4",
+ "nickcernis/html-to-markdown": "2.2.1"
},
"autoload" : {
"psr-0" : {
diff --git a/composer.lock b/composer.lock
index 22602c496..a50f9480b 100644
--- a/composer.lock
+++ b/composer.lock
@@ -4,7 +4,7 @@
"Read more about it at http://getcomposer.org/doc/01-basic-usage.md#composer-lock-the-lock-file",
"This file is @generated automatically"
],
- "hash": "01ebe465ed3a59d8350670ebd4ef8793",
+ "hash": "1799891b06d5a8a516a48fefd429a3ed",
"packages": [
{
"name": "christian-riesen/base32",
@@ -356,6 +356,52 @@
],
"time": "2014-09-05 15:19:58"
},
+ {
+ "name": "nickcernis/html-to-markdown",
+ "version": "2.2.1",
+ "source": {
+ "type": "git",
+ "url": "https://github.com/nickcernis/html-to-markdown.git",
+ "reference": "7263d2ce65011b050fa7ecda0cbe09b23e84271d"
+ },
+ "dist": {
+ "type": "zip",
+ "url": "https://api.github.com/repos/nickcernis/html-to-markdown/zipball/7263d2ce65011b050fa7ecda0cbe09b23e84271d",
+ "reference": "7263d2ce65011b050fa7ecda0cbe09b23e84271d",
+ "shasum": ""
+ },
+ "require": {
+ "php": ">=5.3"
+ },
+ "require-dev": {
+ "php": ">=5.3.3",
+ "phpunit/phpunit": "4.*"
+ },
+ "type": "library",
+ "autoload": {
+ "classmap": [
+ "HTML_To_Markdown.php"
+ ]
+ },
+ "notification-url": "https://packagist.org/downloads/",
+ "license": [
+ "MIT"
+ ],
+ "authors": [
+ {
+ "name": "Nick Cernis",
+ "email": "nick@cern.is",
+ "homepage": "http://modernnerd.net"
+ }
+ ],
+ "description": "An HTML-to-markdown conversion helper for PHP",
+ "homepage": "https://github.com/nickcernis/html-to-markdown",
+ "keywords": [
+ "html",
+ "markdown"
+ ],
+ "time": "2015-02-22 12:59:02"
+ },
{
"name": "pimple/pimple",
"version": "v3.0.0",
diff --git a/docs/postmark.markdown b/docs/postmark.markdown
new file mode 100644
index 000000000..f0469dad8
--- /dev/null
+++ b/docs/postmark.markdown
@@ -0,0 +1,59 @@
+Postmark
+========
+
+You can use the service [Postmark](https://postmarkapp.com/) to create tasks directly by email.
+
+This integration works with the inbound email service of Postmark.
+Kanboard use a webhook to handle incoming emails.
+
+Incoming emails workflow
+------------------------
+
+1. You send an email to a specific address, by example **something+myproject@inbound.mydomain.tld**
+2. Your email is forwarded to Postmark SMTP servers
+3. Postmark call the Kanboard webhook with the email in JSON format
+4. Kanboard parse the received email and create the task to the right project
+
+Note: New tasks are automatically created in the first column.
+
+Email format
+------------
+
+- The local part of the email address must use the plus separator, by example **kanboard+project123**
+- The string defined after the plus sign must match a project identifier, by example **project123** is the identifier of the project **Project 123**
+
+Email format
+------------
+
+- The email subject becomes the task subject
+- The email body becomes the task description (Markdown format)
+
+Incoming emails can be written in text or HTML formats.
+**Kanboard is able to convert simple HTML emails to Markdown**.
+
+Security and requirements
+-------------------------
+
+- The Kanboard webhook is protected by a random token
+- The sender email address (From header) must match a Kanboard user
+- The Kanboard project must have a unique identifier, by example **MYPROJECT**
+- The Kanboard user must be member of the project
+
+Postmark configuration
+----------------------
+
+- Follow the [official documentation about inbound email processing](http://developer.postmarkapp.com/developer-process-configure.html)
+- The Kanboard webhook url is displayed in **Settings > Integrations > Postmark**
+
+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**
+3. Try to send an email to your project
+
+Troubleshootings
+----------------
+
+- Test the webhook url from the Postmark console, you should have a status code `200 OK`
+- Double-check requirements mentioned above
diff --git a/tests/units/Base.php b/tests/units/Base.php
index bce65f2d8..b63029424 100644
--- a/tests/units/Base.php
+++ b/tests/units/Base.php
@@ -6,6 +6,8 @@ require __DIR__.'/../../app/constants.php';
use Symfony\Component\EventDispatcher\EventDispatcher;
use Symfony\Component\EventDispatcher\Debug\TraceableEventDispatcher;
use Symfony\Component\Stopwatch\Stopwatch;
+use SimpleLogger\Logger;
+use SimpleLogger\File;
date_default_timezone_set('UTC');
@@ -38,6 +40,9 @@ abstract class Base extends PHPUnit_Framework_TestCase
);
$this->container['db']->log_queries = true;
+
+ $this->container['logger'] = new Logger;
+ $this->container['logger']->setLogger(new File('/dev/null'));
}
public function tearDown()
diff --git a/tests/units/PostmarkWebhookTest.php b/tests/units/PostmarkWebhookTest.php
new file mode 100644
index 000000000..34be85155
--- /dev/null
+++ b/tests/units/PostmarkWebhookTest.php
@@ -0,0 +1,83 @@
+container);
+ $p = new Project($this->container);
+ $pp = new ProjectPermission($this->container);
+ $u = new User($this->container);
+ $tc = new TaskCreation($this->container);
+ $tf = new TaskFinder($this->container);
+
+ $this->assertEquals(2, $u->create(array('name' => 'me', 'email' => 'me@localhost')));
+
+ $this->assertEquals(1, $p->create(array('name' => 'test1')));
+ $this->assertEquals(2, $p->create(array('name' => 'test2', 'identifier' => 'TEST1')));
+
+ // Empty payload
+ $this->assertFalse($w->parsePayload(array()));
+
+ // Unknown user
+ $this->assertFalse($w->parsePayload(array('From' => 'a@b.c', 'Subject' => 'Email task', 'MailboxHash' => 'foobar', 'TextBody' => 'boo')));
+
+ // Project not found
+ $this->assertFalse($w->parsePayload(array('From' => 'me@localhost', 'Subject' => 'Email task', 'MailboxHash' => 'test', 'TextBody' => 'boo')));
+
+ // User is not member
+ $this->assertFalse($w->parsePayload(array('From' => 'me@localhost', 'Subject' => 'Email task', 'MailboxHash' => 'test1', 'TextBody' => 'boo')));
+ $this->assertTrue($pp->addMember(2, 2));
+
+ // The task must be created
+ $this->assertTrue($w->parsePayload(array('From' => 'me@localhost', 'Subject' => 'Email task', 'MailboxHash' => 'test1', 'TextBody' => 'boo')));
+
+ $task = $tf->getById(1);
+ $this->assertNotEmpty($task);
+ $this->assertEquals(2, $task['project_id']);
+ $this->assertEquals('Email task', $task['title']);
+ $this->assertEquals('boo', $task['description']);
+ $this->assertEquals(2, $task['creator_id']);
+ }
+
+ public function testHtml2Markdown()
+ {
+ $w = new PostmarkWebhook($this->container);
+ $p = new Project($this->container);
+ $pp = new ProjectPermission($this->container);
+ $u = new User($this->container);
+ $tc = new TaskCreation($this->container);
+ $tf = new TaskFinder($this->container);
+
+ $this->assertEquals(2, $u->create(array('name' => 'me', 'email' => 'me@localhost')));
+ $this->assertEquals(1, $p->create(array('name' => 'test2', 'identifier' => 'TEST1')));
+ $this->assertTrue($pp->addMember(1, 2));
+
+ $this->assertTrue($w->parsePayload(array('From' => 'me@localhost', 'Subject' => 'Email task', 'MailboxHash' => 'test1', 'TextBody' => 'boo', 'HtmlBody' => ' boo ')));
+
+ $task = $tf->getById(1);
+ $this->assertNotEmpty($task);
+ $this->assertEquals(1, $task['project_id']);
+ $this->assertEquals('Email task', $task['title']);
+ $this->assertEquals('**boo**', $task['description']);
+ $this->assertEquals(2, $task['creator_id']);
+
+ $this->assertTrue($w->parsePayload(array('From' => 'me@localhost', 'Subject' => 'Email task', 'MailboxHash' => 'test1', 'TextBody' => '**boo**', 'HtmlBody' => '')));
+
+ $task = $tf->getById(2);
+ $this->assertNotEmpty($task);
+ $this->assertEquals(1, $task['project_id']);
+ $this->assertEquals('Email task', $task['title']);
+ $this->assertEquals('**boo**', $task['description']);
+ $this->assertEquals(2, $task['creator_id']);
+ }
+}
diff --git a/tests/units/ProjectTest.php b/tests/units/ProjectTest.php
index 4864a3aee..231d403f9 100644
--- a/tests/units/ProjectTest.php
+++ b/tests/units/ProjectTest.php
@@ -203,4 +203,57 @@ class ProjectTest extends Base
$this->assertFalse($p->disablePublicAccess(123));
}
+
+ public function testIdentifier()
+ {
+ $p = new Project($this->container);
+
+ // Creation
+ $this->assertEquals(1, $p->create(array('name' => 'UnitTest1', 'identifier' => 'test1')));
+ $this->assertEquals(2, $p->create(array('name' => 'UnitTest2')));
+
+ $project = $p->getById(1);
+ $this->assertNotEmpty($project);
+ $this->assertEquals('TEST1', $project['identifier']);
+
+ $project = $p->getById(2);
+ $this->assertNotEmpty($project);
+ $this->assertEquals('', $project['identifier']);
+
+ // Update
+ $this->assertTrue($p->update(array('id' => '2', 'identifier' => 'test2')));
+
+ $project = $p->getById(2);
+ $this->assertNotEmpty($project);
+ $this->assertEquals('TEST2', $project['identifier']);
+
+ $project = $p->getByIdentifier('test1');
+ $this->assertNotEmpty($project);
+ $this->assertEquals('TEST1', $project['identifier']);
+
+ // Validation rules
+ $r = $p->validateCreation(array('name' => 'test', 'identifier' => 'TEST1'));
+ $this->assertFalse($r[0]);
+
+ $r = $p->validateCreation(array('name' => 'test', 'identifier' => 'test1'));
+ $this->assertFalse($r[0]);
+
+ $r = $p->validateModification(array('id' => 1, 'name' => 'test', 'identifier' => 'TEST1'));
+ $this->assertTrue($r[0]);
+
+ $r = $p->validateModification(array('id' => 1, 'name' => 'test', 'identifier' => 'test3'));
+ $this->assertTrue($r[0]);
+
+ $r = $p->validateModification(array('id' => 1, 'name' => 'test', 'identifier' => ''));
+ $this->assertTrue($r[0]);
+
+ $r = $p->validateModification(array('id' => 1, 'name' => 'test', 'identifier' => 'TEST2'));
+ $this->assertFalse($r[0]);
+
+ $r = $p->validateCreation(array('name' => 'test', 'identifier' => 'a-b-c'));
+ $this->assertFalse($r[0]);
+
+ $r = $p->validateCreation(array('name' => 'test', 'identifier' => 'test 123'));
+ $this->assertFalse($r[0]);
+ }
}
| 
