Viewing File: /usr/local/cpanel/base/3rdparty/roundcube/plugins/formbricks/README.md

# Formbricks Plugin for Roundcube Webmail

A plugin that brings Formbricks survey and feedback capabilities into Roundcube
Webmail. Collect user feedback, conduct research, and engage with your webmail
users through targeted in-app surveys.

## Features

- 🔐 **Track Users with Privacy**: Track users with RC native random hash
- 🌍 **Automatic Language Detection**: Respects Roundcube language preferences

## Requirements

### 1. Set Up Formbricks Account

1. **Create/Login to Formbricks**
   - Visit [https://app.formbricks.com](https://app.formbricks.com)
   - Create account or log in

2. **Get Your Credentials**
   - Navigate to **Settings** → **Environment**
   - Copy your **Environment ID** (starts with `cl...`)
   - Note your **App URL** (usually `https://app.formbricks.com`)

### 2. Configure the Plugin

**Configure these values:**

```php
<?php
$config['formbricks'] = array(
    'app_url' => 'https://app.formbricks.com',  // Your Formbricks URL
    'environment_id' => 'clXXXXXXXXXXXXXXXXXX', // From Formbricks dashboard
);
```

### 3. Test in Browser (Debug Mode)


1. **Log in to Roundcube**
2. **Open Browser Console**
3. **Look for Formbricks Messages**
   - You should see: `✓ Formbricks ready: [hash]`
   - No red errors should appear

### 4. Verify in Formbricks Dashboard

1. Log in to [Formbricks dashboard](https://app.formbricks.com)
2. Go to **People** or **Activity**
3. You should see your hashed user ID appear
4. Track event `roundcube_webmail_access` should be recorded

### Custom Event Tracking

To track custom events, you can extend the JavaScript:

```javascript
// Add to formbricks.js
if (window.formbricks) {
    // Track custom events
    window.formbricks.track("email_sent");
    window.formbricks.track("folder_created");
}
```