Documentation
THIS FUNCTIONALITY IS ONLY AVAILABLE IN OUR CLOUD OR ON-PREMISE VERSIONS.
FOR MORE INFORMATION ON PRICING AND ADDITIONAL FUNCTIONALITY, PLEASE VISIT
http://kanbanize.com/ctrl_needmore
OR CONTACT OUR SALES TEAM HERE.
The Email Integration functionality allows you to create new cards or to update existing ones
only by sending an email to a predefined address.
Creating new cards
You can create a new card by simply sending an email to the specified address.
The subject will be used as a title and the email body will be used as a card description.
The name of the board where the card is to be created should be present in the subject
surrounded by curly brackets.
For example:
{boardname} This is title - This will create a new card in board called boardname
If you are assigned to only one board or if you have a board set to auto-open,
then you can omit the boardname parameter.
All email attachments will be added to the card.
When creating new cards you can also specify the extended parameters described in the
"Updating existing cards" section below.
When creating a new card, all the content after the curly brackets will be taken as a
description of the card, unless the #description parameter has been explicitly
set.
Updating existing cards
Whether you create a new card or update an existing one depends on the presence of
the {id} parameter in the email subject.
For example:
{boardname} This is title will create a new card, but
{boardname}{123} This is title will update card with id 123.
You can add custom parameters in the email body to control various options.
The parameters are passed by surrounding them with curly brackets and following the format
#param: value
For example:
{
#assignee: username
#color: FF00FF
}
When you update a card, its title will not be updated unless you explicitly specify
the #title parameter.
This is the complete list of parameters that can be set:
-
title - Title of the card.
When creating a new card, the subject of the card is used as a title.
-
description - description. When creating a new card, the email body will be used as a description.
-
color - The code of the color without the # sign.
-
priority - low, average or high.
-
size - Could be number or S, M, L, XL, XXL, XXXL
-
assignee - a valid username (must exist)
-
deadline - Deadline in any of the following formats: 2012-05-05', 'now', '10 September 2012', '-1 day', '-1 week 2 days', 'last Monday'
-
tags - any tag
-
extlink - external link
-
comment - Adds a comment to the card. There could be multiple comments.
-
subtask - Adds a sub-task or multiple sub-tasks. If you add @username, the sub-task will be assigned to that person. For example: #subtask: This is subtask @username2
-
watching - If you put it to anything but FALSE you will be watching the card. By default watching is off.
-
column - Valid only when creating new cards. If you have columns with the same names, you need to specify the complete path: Column.SubColumn.Subcolumn2. If this parameter is not set, the card is created in the backlog. If a card is to be created in a column and the limit of the column is to be exceeded, you need to set the parameter "reason".
-
lane - The swim-lane the card is to be created into. If not set, the card is created in the first swim-lane.
-
reason - Reason to exceed a limit.