Loading...
 
Skip to main content

History: Email folders Tracker Field

Source of version: 66 (current)

Copy to clipboard
            {syntax type="markdown"  editor="wysiwyg"} # {{page}}

Emails stored as part of the Tiki database, like any other content (files, wiki pages, events, blog posts, etc.)

Email Folder is a new addition to the ((Tracker Field Types)), introduced in ((Tiki23)), being able to hold a list of emails in flat format or IMAP folder-like structured support for Inbox/Sent/Trash folders.

Emails are currently moved to tracker items via the Webmail interface in Tiki (Cypht web interface). Cypht is used to display Tiki-stored messages and handle all relevant actions - read, reply, forward, copy, move, delete. Message can be moved to another tracker item or to an IMAP folder.

[https://recordings.rna1.blindsidenetworks.com/citadelrock/d559965849921585c1849af03b7a51638700d979-1635342911405/presentation/?t=1h17m40s|Recording of demo at October 2021 round table]

#$ Configuration

To configure the email folders tracker field, do the following: 
First of all you have to create a tracker. To create a tracker, proceed as follows:

##$ Creation and configuration of the Tracker

###$ Check the activation of the Trackers feature

If the Tracker tab exists in the system menu go to the next point. 
{img src="display1849" link="display1849" width="350" rel="box[g]" imalign="center" desc="Click to expand" styleimage="border"} 
Otherwise if the Tracker tab does not exist, so the feature is not yet activated, you can activate it by following the following steps :

- Settings -> Control Panels

{img src="display1850" link="display1850" width="350" rel="box[g]" imalign="center" desc="Click to expand" styleimage="border"}

- Global Setup -> Features

{img src="display1851" link="display1851" width="350" rel="box[g]" imalign="center" desc="Click to expand" styleimage="border"}

- In the Main features section, check the Trackers box

{img src="display1852" link="display1852" width="350" rel="box[g]" imalign="center" desc="Click to expand" styleimage="border"}

###$ Create a Tracker

To create a Tracker click on:

- Trackers -> List Trackers

{img src="display1853" link="display1853" width="350" rel="box[g]" imalign="center" desc="Click to expand" styleimage="border"}

- Create

{img src="display1854" link="display1854" width="350" rel="box[g]" imalign="center" desc="Click to expand" styleimage="border"}

- Enter the name of the Tracker

{img src="display1855" link="display1855" width="350" rel="box[g]" imalign="center" desc="Click to expand" styleimage="border"}

- Add a description if possible

{img src="display1856" link="display1856" width="350" rel="box[g]" imalign="center" desc="Click to expand" styleimage="border"}

- Finally save

{img src="display1858" link="display1858" width="400" rel="box[g]" imalign="center" desc="Click to expand" styleimage="border"}

###$ Add fields

Once the tracker is created. Click on :

- the Tracker you just created

{img src="display1922" link="display1922" width="400" rel="box[g]" imalign="center" desc="Click to expand" styleimage="border"}

- then on the `Fields` button

{img src="display1924" link="display1924" width="400" rel="box[g]" imalign="center" desc="Click to expand" styleimage="border"}

The minimal configuration needs two fields:

- the Text type field, which will serve as the description
- the Folder type field, which will be used to store emails


####$ The Text field

Click on `Add Field` 
{img src="display1923" link="display1923" width="400" rel="box[g]" imalign="center" desc="Click to expand" styleimage="border"}

- Enter the field name

{img src="display1925" link="display1925" width="400" rel="box[g]" imalign="center" desc="Click to expand" styleimage="border"}

- Choose the type of field, by default it is already Text Field

{img src="display1926" link="display1926" width="400" rel="box[g]" imalign="center" desc="Click to expand" styleimage="border"}

- Then validate by clicking on the `Add Field` button

{img src="display1927" link="display1927" width="400" rel="box[g]" imalign="center" desc="Click to expand" styleimage="border"}

####$ The Folder field

For the folder type field, click on:

- Add a field

{img src="display1923" link="display1923" width="400" rel="box[g]" imalign="center" desc="Click to expand" styleimage="border"}

- Enter the field name

{img src="display1929" link="display1929" width="400" rel="box[g]" imalign="center" desc="Click to expand" styleimage="border"}

- Choose the field type, you must choose Email Folder

{img src="display1928" link="display1928" width="400" rel="box[g]" imalign="center" desc="Click to expand" styleimage="border"}

- Click the Add Field & Edit Advanced Options button

{img src="display1930" link="display1930" width="400" rel="box[g]" imalign="center" desc="Click to expand" styleimage="border"}

- Click the Options for Email Folder button

{img src="display1931" link="display1931" width="400" rel="box[g]" imalign="center" desc="Click to expand" styleimage="border"}

- In the Gallery ID field, select the File Gallery.

It is better to have a dedicated File Gallery for Email. For this example I have a Folder called "Emails", so let's select the option File Galleries > Emails 
{img src="display1932" link="display1932" width="400" rel="box[g]" imalign="center" desc="Click to expand" styleimage="border"}

- In the field Use Folders select Yes, other fields are added below for the contiguration of the names of the folders. You can leave it like this

{img src="display1933" link="display1933" width="400" rel="box[g]" imalign="center" desc="Click to expand" styleimage="border"}

- And finally Validate by pressing Save

{img src="display1934" link="display1934" width="400" rel="box[g]" imalign="center" desc="Click to expand" styleimage="border"}

###$ Item creation

Once the configuration is complete, you must create an item. For this on the item page :

- click on the Create Item button

{img src="display1935" link="display1935" width="400" rel="box[g]" imalign="center" desc="Click to expand" styleimage="border"}

- A modal window is launched, enter the Name in the Name field and validate

{img src="display1936" link="display1936" width="400" rel="box[g]" imalign="center" desc="Click to expand" styleimage="border"}

#$ Move emails to trackers

To move an email, open the email you want to move :

- Click on the Tracker button

{img src="display1937" link="display1937" width="400" rel="box[g]" imalign="center" desc="Click to expand" styleimage="border"}

- In the small window select the Tracker you created

{img src="display1938" link="display1938" width="400" rel="box[g]" imalign="center" desc="Click to expand" styleimage="border"}

- Finally select the folder.

{img src="display1939" link="display1939" width="400" rel="box[g]" imalign="center" desc="Click to expand" styleimage="border"}

- Once done, here is the end result

{img src="display1940" link="display1940" width="400" rel="box[g]" imalign="center" desc="Click to expand" styleimage="border"}

Related:

- ((Selector Tracker Fields))
- ((Adding fields to a tracker))
- https://gitlab.com/tikiwiki/tiki/-/merge_requests/818
- ((dev:Email as a first-class citizen))




**Alias**

- (alias(Email-folder-Tracker-Field|Email folder Tracker Field))