Plugin Cypht

This permits to plug the Cypht webmail client in a wiki page.

History and status

Tiki and Cypht webmail interoperability started with Tiki20 (2019). Tiki had a webmail since the early days but it was buggy, lacked features and was not improving. Since it would require too much work (and some specific expertise about email protocols) to get it up to modern standards, it was determined a better strategy to integrate an existing project (despite tradeoffs like feature overlap, integration challenges, etc.). See also: Why did Tiki pick Cypht? Major work has been done since that time in Cypht, and in Tiki 21, 22, 23, 24, 25 and 26. Work is ongoing, so it's recommended to run the latest 26.x (and 27.x when released) from Git or Daily Build. Most enhancements and many fixes will not be backported as there are lots of changes. Please see this known issue. In June 2023, Cypht became a community project and Jason (the original author) is no longer the most active contributor. Jason is now more in an advisor mode. Cypht 1.4.0 was released in 2023-07. For the period of 2022-08-08 to 2023-08-08, there were 246 code commits, which represents an increase of 50 (25%) from previous 12 months.

Syntax

Copy to clipboard
{cypht}

Parameters

Embed Cypht webmail and news reader.
Introduced in Tiki 20.0.
Go to the source code
Preferences required: wikiplugin_cypht

Parameters Accepted Values Description Default Since
group any string except for HTML and PHP tags GroupMail: Group (e.g. "Help Team") 20.0
imap_name text Name for the IMAP connection. E.g. "My Mailbox" 20.0
imap_password password Account IMAP password. 20.0
imap_port text Default is 993. 993 20.0
imap_server text E.g. imap.example.com 20.0
imap_username text Account IMAP username. 20.0
smtp_name text Name for the SMTP connection. E.g. "My Account" 20.0
smtp_password password Account SMTP password. 21.1
smtp_port text Default is 587. 587 20.0
smtp_server text E.g. smtp.example.com 20.0
smtp_username text Account SMTP username. 21.1
accountFId int GroupMail: Account Field (Id of field in tracker to store Webmail account name) 20.0
contentFId int GroupMail: Content Field (Id of field in tracker to store email message body content) 20.0
datetimeFId int GroupMail: Date Time Field (Id of field in tracker to store email sent timestamp) 20.0
fromFId int GroupMail: From Field (Id of field in tracker to store email From header) 20.0
groupmail n
y		 Share this mailbox for Groupmail usage or keep it private. n 20.0
imap_tls y
n		 Use secure connection to IMAP server. y 20.0
messageFId int GroupMail: Message Field (Id of field in tracker to store email message identifier) 20.0
operatorFId int GroupMail: Operator Field (Id of field in tracker to store operator name (username)) 20.0
smtp_no_auth n
y		 Disable SMTP authentication if your server does not support it. n 20.0
smtp_tls y
n		 Use secure TLS/SSL connection to SMTP server. y 20.0
subjectFId int GroupMail: Subject Field (Id of field in tracker to store email Subject header) 20.0
trackerId int GroupMail: Tracker ID (to store GroupMail activity) 20.0
use_global_settings n
nw
y		 Use global Cypht settings available at Tiki Webmail page. Choosing "No" will make this instance of Cypht use its own settings. Useful if this is a Groupmail box or you don't want to mix mailbox server and/or site settings from other pages. There are two modes of non-global settings - default one stores settings per user where each individual Tiki user will have their own copy of the settings whereas the second one stores settings per wiki page. Use per-wiki-page option if you want the plugin Cypht settings shared between users using the plugin on the same wiki page. n 20.0


Aliases

Plugin Cypht
Plugin Cypth