Send email of a task with comments

etalasquera · January 15, 2019, 10:41am

Hi folks!

There is a way to send email of a finished task including all comments on that task?

creecros · January 15, 2019, 2:10pm

not out of the box.

you could:
1.) add an automatic action that does it for you
https://docs.kanboard.org/en/latest/plugins/automatic_actions.html

or

2.) override the notification template for the appropriate event (i.e. task close), with your own template to include all the comments.
https://docs.kanboard.org/en/latest/plugins/overrides.html

aljawaid · September 16, 2022, 3:43am

Hello, did you manage to find a solution for this?

creecros · September 16, 2022, 11:15am

which part cant you figure out?

creecros · September 16, 2022, 12:38pm

github.com

creecros/SendEmailCreator/blob/master/Action/SendTaskComment.php

<?php

namespace Kanboard\Plugin\SendEmailCreator\Action;

use Kanboard\Model\TaskModel;
use Kanboard\Model\CommentModel;
use Kanboard\Action\Base;

class SendTaskComment extends Base
{
   
    public function getDescription()
    {
        return t('Send new comments on a task by email');
    }

   
    public function getCompatibleEvents()
    {
        return array(

This file has been truncated. show original

This action sends and email whenever there is a “New Comment” on a task.
I would think it should give you a good baseline to figure out how to send “All comments” when a task is closed.

If you can’t figure it out, let me know.

aljawaid · September 16, 2022, 1:26pm

I will look at it again, Im just getting confused with how to create the action to send an email so that when the task closes, besides sending an email to comment that the task is closed… another email is fired through actions to send the ‘summary’ of the closed task… e.g. description and full comment history.

creecros · September 16, 2022, 1:31pm

so do you want 1 email upon task close, with all comments and descriptions, or do you want 2 emails?

aljawaid · September 16, 2022, 1:33pm

I already get an email that a task is closed… through an action…
I need a seperate email with a subject (Task summary) which will consist of the task description with a full history of the comments.

So for this board i would get 2 emails, but for other boards it would depend on which actions i use for that board.

creecros · September 16, 2022, 1:46pm

ya that should be pretty simple.

get as far as you can, and then either add me to the repo or send me the code, and i will complete it.

aljawaid · October 16, 2022, 8:57pm

am I right or wrong in saying that the only thing to change (in a duplicate file of course) would be:

$this->template->render('commen/show', array(
                            'task' => $data['task'],
                            'comment' => $data['comment'],
                        ))

this wouldďsend ALL the task comments… then to add the description it would be to add 'description' => $data['description'], to the array?

Or have I got it all wrong?

creecros · October 16, 2022, 11:04pm

that would be a negative. you want to send all comments, the current action i wrote, is based on when a new comment is created, i.e. the event. That event only carries the data for that comment, its also not your event, that you want. your event is on task close. TaskModel::EVENT_CLOSE

you need to look at a controller that sends data to “comment/show” template, see how they handle that. Probably the TaskViewController, is where that is going to start, and then follow the code until you find exactly what to send to the “comment/show” template, and whether or not you need any iterations, may already be handled with the iterations.

you can see here the beginning of the comment data coming to fruition.

github.com

kanboard/kanboard/blob/0b8a270bbb9179c14b73fabc3853f698a21775e5/app/Controller/TaskViewController.php#L72


      
          {
              $task = $this->getTask();
              $subtasks = $this->subtaskModel->getAll($task['id']);
              $commentSortingDirection = $this->userMetadataCacheDecorator->get(UserMetadataModel::KEY_COMMENT_SORTING_DIRECTION, 'ASC');
          
          
    $this->response->html($this->helper->layout->task('task/show', array(
                  'task' => $task,
                  'project' => $this->projectModel->getById($task['project_id']),
                  'files' => $this->taskFileModel->getAllDocuments($task['id']),
                  'images' => $this->taskFileModel->getAllImages($task['id']),
                  'comments' => $this->commentModel->getAll($task['id'], $commentSortingDirection),
                  'subtasks' => $subtasks,
                  'internal_links' => $this->taskLinkModel->getAllGroupedByLabel($task['id']),
                  'external_links' => $this->taskExternalLinkModel->getAll($task['id']),
                  'link_label_list' => $this->linkModel->getList(0, false),
                  'tags' => $this->taskTagModel->getTagsByTask($task['id']),
              )));
          }
          
          
/**
           * Display task analytics

it actually sends the data to “task_comment/show” next, id follow suit if i were you.

github.com

kanboard/kanboard/blob/0b8a270bbb9179c14b73fabc3853f698a21775e5/app/Template/task/show.php#L46-52


      
          )) ?>
          
          
<?= $this->hook->render('template:task:show:before-attachments', array('task' => $task, 'project' => $project)) ?>
          <?= $this->render('task_file/show', array(
              'task' => $task,
              'files' => $files,
              'images' => $images
          )) ?>
          
          
<?= $this->hook->render('template:task:show:before-comments', array('task' => $task, 'project' => $project)) ?>
          <?= $this->render('task_comments/show', array(
              'task' => $task,
              'comments' => $comments,
              'project' => $project,
              'editable' => $this->user->hasProjectAccess('CommentController', 'edit', $project['id']),
          )) ?>
          
          
<?= $this->hook->render('template:task:show:bottom', array('task' => $task, 'project' => $project)) ?>

from there it takes care of all the iterations for you.

github.com

kanboard/kanboard/blob/0b8a270bbb9179c14b73fabc3853f698a21775e5/app/Template/task_comments/show.php#L14-22


      
          <?php if (!isset($is_public) || !$is_public): ?>
              <div class="comment-sorting">
                  <small>
                      <?= $this->url->icon('sort', t('Change sorting'), 'CommentController', 'toggleSorting', array('task_id' => $task['id'], 'csrf_token' => $this->app->getToken()->getReusableCSRFToken())) ?>
                      <?php if ($editable): ?>
                          <?= $this->modal->medium('paper-plane', t('Send by email'), 'CommentMailController', 'create', array('task_id' => $task['id'])) ?>
                      <?php endif ?>
                  </small>
              </div>
          <?php endif ?>
          <?php foreach ($comments as $comment): ?>
              <?= $this->render('comment/show', array(
                  'comment'   => $comment,
                  'task'      => $task,
                  'project'   => $project,
                  'editable'  => $editable,
                  'is_public' => isset($is_public) && $is_public,
              )) ?>
          <?php endforeach ?>
          
          
<?php if ($editable): ?>

it might seem complicated, but its actually simple, send the exact same data, to the “task_comment/show” template, and then all the comments will be rendered in your email.

the above gives you all the information you need to do that, how to get the data(mostly found in the controller using the $task variable which you have, for $editable just use false), and what to send after you got it(found in the “task/show” template, which sends 4 variables on lines 47-50, you need them all).

aljawaid · October 18, 2022, 7:13pm

thank you so much forŕthe detailed explanation… I have tried my best to understand it with my basic skills…

Please check the code for me here: GitHub - aljawaid/KanboardEmailHistory

I’m trying to create an action so that:
when the task closes:

a comment is added to the task to say that the task history including comments was sent to xyz.
the task description is in the body of the email, followed by the full task history.

creecros · October 18, 2022, 10:29pm

I fixed what you had, but did not add any features. If you need more help, again, try and let me know when stuck.

aljawaid · October 18, 2022, 10:55pm

woah thanks foŕthis… I had a glance, will test when I get home… it seems I was way out lol

creecros · October 19, 2022, 12:41am

thats good, because i didnt test it. i see one thing i missed, forgot to add projectmodel in the “use” section.

aljawaid · October 20, 2022, 3:47pm

Can you please review my changes? I missed the description, but I think I have fully done it now. I just need you to have a glance at it as you understand the code for Kanboard a lot better than me.

creecros · October 20, 2022, 4:34pm

glanced.

commented on your changes. it will need a lot of fixes.

aljawaid · October 20, 2022, 8:05pm

I’ve got it working and released the first version. Hope it’s useful to others too.

Topic		Replies	Views
Send someone (other than creator or assignee) an email when a task is edited or when a comment is added Questions	12	1216	May 12, 2023
New Action Plugin: KanboardEmailHistory Plugins	6	327	January 18, 2023
Add comments (tasks) : send notification to several mails	2	699	September 2, 2019
Email notification of impending due date are send even when task is closed Questions	5	2263	February 4, 2020
Sending email when creating and assigning a task to somebody	6	1864	February 9, 2019

Send email of a task with comments

Related Topics