hercegdoo/aicomposeplugin

A plugin for AI generated emails.

1.0.5 2025-02-19 15:42 UTC

Requires

• php: >=7.4
• ext-curl: *
• php-curl-class/php-curl-class: ^9.19

Requires (Dev)

• codeigniter/coding-standard: ^1.7
• dg/bypass-finals: ^1.8
• friendsofphp/php-cs-fixer: *
• mockery/mockery: ^1.6
• nexusphp/cs-config: ^3.18
• nexusphp/tachycardia: ^1.5
• phpstan/phpstan: ^1.11
• phpunit/phpunit: ^9.6
• roundcube/roundcubemail: 1.6.5

MIT

• Herceg Doo
• Harun Duranović

README

Overview

The AI Email Generator plugin for Roundcube enhances the email composing experience by integrating AI-based email generation capabilities. With this plugin, users can generate professional and personalized emails with just a few clicks, saving time and effort.

Features

1. AI Email Generation:

   • Allows users to generate an email by providing specific instructions.

2. Customizable Parameters: Users can choose:

   • Style: The tone and style of the email (e.g., formal, casual, informational, etc.).

   • Length: How long the generated email should be (short, medium, or long).

   • Creativity: Adjust the level of creativity in the email (low, medium, or high).

   • Language: Choose from Bosnian, Croatian, English, German, or Dutch.

3. User-Defined Predefined Instructions:

   • Users can create custom predefined instructions that they can reuse for generating emails. Instead of typing instructions each time, users can save and select frequently used ones, enhancing productivity.

4. Default Settings:

   • Users can set default values for style, length, creativity, and language. These default settings will be automatically applied during email generation, allowing for a more streamlined experience.

5. Seamless Integration:

   • Adds a new button to the Compose page in Roundcube that opens a prompt for email generation.

Install

1. Clone repository content to an AIComposePlugin directory inside your RoundCube plugins directory.

2. Then reference the plugin by adding an item AIComposePlugin to the RoundCube plugins list in the configuration:

   $config['plugins'] = array('AIComposePlugin', ...);

3. You can install the required dependencies using Composer, npm, and run the development build. Navigate to the plugin directory and run the following commands:

composer install --no-dev
npm install --omit=dev
npm run build

1. Fill in the settings in the config.inc.php.dist file according to the instructions provided within it. After completing the configuration, rename the file to config.inc.php.

Usage

1. Compose a New Email:

   • Open Roundcube and start composing a new email.
   • A new button labeled Generate will appear on the Compose page.

2. Open the AI Prompt:

   • Click on the Generate Email button.
   • A prompt will appear where you can:
     • Enter instructions for the email.
     • Choose the style, length, creativity, and language of the email.

3. Generate Email:

   • Provide the necessary details, and click Generate.
   • The AI will generate an email based on the provided input.
   • The generated email can be inserted into the Compose window, ready for further editing or immediate sending.