Boost!FOR KUMANEKO
Home / IMAP
KUMANEKO PLUGIN

IMAP

Imports received email from a specified mail account, so you can manage email correspondence in one place with your kumaneko apps.

PREPARATION

Preparation

02

Install the imap module (Unix-like servers)

This plugin uses the PHP imap module to import email. If the imap module is not on your server, install it with the following steps for your PHP version.

For PHP 8.2 and 8.3, install it from a package. Run lines 1–2 on Ubuntu or Debian, or line 3 on RHEL, AlmaLinux or Rocky Linux.

sudo apt-get update
sudo apt-get install php-imap
sudo dnf install php-imap

From PHP 8.4, the imap module was removed from PHP itself, so install it from PECL instead of a package.

For PHP 8.4 and later, install the required libraries, then install the imap module with PECL. The following commands are an example for Ubuntu or Debian.

sudo apt-get install php-pear php-dev libc-client-dev libkrb5-dev
sudo pecl install imap

After installing, check that php.ini contains the following line and add it if it does not. If you installed from a package on Ubuntu or Debian, you can also enable it with phpenmod.

extension=imap

The location of php.ini depends on your PHP version and on whether you use Apache or PHP-FPM. php --ini shows the configuration file for the command line, so check the php.ini loaded by your web server with "Loaded Configuration File" in phpinfo().

Finally, restart the web server. Run line 1 for Apache, or lines 2–3 for nginx and PHP-FPM.

sudo systemctl restart apache2
sudo systemctl restart php8.3-fpm
sudo systemctl restart nginx

Replace "8.3" in php8.3-fpm with your PHP version.

03

Enable the imap module (Windows servers)

For PHP 8.2 and 8.3, open php.ini and remove the ";" at the start of the following line to enable the imap module.

;extension=imap

For PHP 8.4 and later, get php_imap.dll from the Windows version of PECL, place it in the PHP ext folder, and add "extension=imap" to php.ini.

Next, check that extension_dir in php.ini points to the folder containing the extension modules.

extension_dir = "ext"

The imap module uses the OpenSSL files libcrypto-3-x64.dll and libssl-3-x64.dll in the PHP folder. If the PHP folder is not in the PATH environment variable, the imap module is not loaded.

Finally, restart the web server (Apache or IIS).

SETTING

Setup

Boost! plugins are configured and downloaded in the console. If you have not opened your console yet, please open it first.

How to open the console +
01

Prepare a list view

This plugin runs in a read-only list view. If you want to use a view other than the standard "All" view, create a read-only list view.

Using the list view +
02

Add a plugin setting

In the console, click the add button on the right (round red frame) to add a new setting, or click the setting name (square red frame) to edit an existing one.

03

Specify the settings

When the settings screen appears, specify the following items.

Settings

Setting Name
The name shown in the list on the left of the screen. It is also used as the name of the downloaded program.
Target App
The app in which the plugin runs.
View
The read-only list view to which this setting applies.
Execution Button Label
The text shown on the button that imports email.
Execution Confirmation Dialog Message
The message shown before the import runs.
Server Name
The host name of the IMAP server. Add a subdomain at the start if needed (e.g., imap.xxx.com).
Port
The port number used for the IMAP connection. When using SSL, this is usually 993.
Connection Options
The connection options. If left empty, "/imap/ssl" is used. The options depend on your server's security settings and protocol.
Mailbox Name
The mailbox to import from. If left empty, "INBOX" is used.
User Name
The user name of the mail account.
Password
The password of the mail account.
UID
The field that stores the email ID.
Sender
The field that stores the sender.
CC
The field that stores CC. If omitted, CC is not saved. Because CC can contain multiple email addresses, set the input format of the text field to "text" rather than "mail".
Received DateTime
The field that stores the date and time received.
Subject
The field that stores the subject.
Body
The field that stores the body.
Attachment Field
The field that stores attachments.
04

Download and import into kumaneko

Click the "Save & Download" button and import the downloaded program into kumaneko. The steps are explained in "Getting Started" on the top page.

See Getting Started +
HOW TO USE

How to use

01

Display the execution button

Open the list view specified on the settings screen, and the button for importing email is displayed.

02

Import email

Click the button, and a screen for entering the period and sender appears. Specify the period and sender and click "OK" to import the email. By default, the period is from 0:00 to 23:59 today.

If you leave the sender empty, all email in the specified period is imported.

The plugin does not check whether email has already been imported. Importing the same period again registers the same email twice. Setting deduplication on the email ID field prevents duplicates, but if even one already imported email is included, the whole import is canceled.

03

Check the imported email

When the import finishes, the email contents are stored in the fields specified on the settings screen and appear in the list as records.

When imported email is saved, actions by value change are also run.