vignesh/dolibarr
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Merge pull request #24858 from noec764/NEW_ADD_SSL_NORSH_OPTION_ON_EMAIL_COLLECTOR

Browse source 
NEW: Add Encryption method and NoRSH configuration on email collector
This commit is contained in:
Laurent Destailleur 2023-05-26 00:16:19 +02:00 committed by GitHub
commit 6a445e844f
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
5 changed files with 25 additions and 13 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

4
htdocs/admin/emailcollector_card.php
View file

@ -395,9 +395,7 @@ if ($object->id > 0 && (empty($action) || ($action != 'edit' && $action != 'crea
$connectstringtarget = '';
// Note: $object->host has been loaded by the fetch
$usessl = 1;
$connectstringserver = $object->getConnectStringIMAP($usessl);
$connectstringserver = $object->getConnectStringIMAP();
if ($action == 'scan') {
if (!empty($conf->global->MAIN_IMAP_USE_PHPIMAP)) {

23
htdocs/emailcollector/class/emailcollector.class.php
View file

@ -131,6 +131,8 @@ class EmailCollector extends CommonObject
'host' => array('type'=>'varchar(255)', 'label'=>'EMailHost', 'visible'=>1, 'enabled'=>1, 'position'=>90, 'notnull'=>1, 'searchall'=>1, 'comment'=>"IMAP server", 'help'=>'Example: imap.gmail.com', 'csslist'=>'tdoverflowmax125'),
'port' => array('type'=>'varchar(10)', 'label'=>'EMailHostPort', 'visible'=>1, 'enabled'=>1, 'position'=>91, 'notnull'=>1, 'searchall'=>0, 'comment'=>"IMAP server port", 'help'=>'Example: 993', 'csslist'=>'tdoverflowmax50', 'default'=>'993'),
'hostcharset' => array('type'=>'varchar(16)', 'label'=>'HostCharset', 'visible'=>-1, 'enabled'=>1, 'position'=>92, 'notnull'=>0, 'searchall'=>0, 'comment'=>"IMAP server charset", 'help'=>'Example: "UTF-8" (May be "US-ASCII" with some Office365)', 'default'=>'UTF-8'),
'imap_encryption' => array('type'=>'varchar(16)', 'label'=>'ImapEncryption', 'visible'=>1, 'enabled'=>1, 'position'=>93, 'searchall'=>0, 'comment'=>"IMAP encryption", 'help'=>'ImapEncryptionHelp', 'arrayofkeyval'=> array('ssl'=>'SSL', 'tls' => 'TLS', 'notls' => 'NOTLS'), 'default'=>'ssl'),
'norsh' => array('type'=>'integer', 'label'=>'NoRSH', 'visible'=>1, 'enabled'=>"!getDolGlobalInt('MAIN_IMAP_USE_PHPIMAP')", 'position'=>94, 'searchall'=>0, 'help'=>'NoRSHHelp', 'arrayofkeyval'=> array(0 =>'No', 1 => 'Yes'), 'default'=> 0),
'acces_type' => array('type'=>'integer', 'label'=>'accessType', 'visible'=>-1, 'enabled'=>"getDolGlobalInt('MAIN_IMAP_USE_PHPIMAP')", 'position'=>101, 'notnull'=>1, 'index'=>1, 'comment'=>"IMAP login type", 'arrayofkeyval'=>array('0'=>'loginPassword', '1'=>'oauthToken'), 'default'=>'0', 'help'=>''),
'login' => array('type'=>'varchar(128)', 'label'=>'Login', 'visible'=>-1, 'enabled'=>1, 'position'=>102, 'notnull'=>-1, 'index'=>1, 'comment'=>"IMAP login", 'help'=>'Example: myaccount@gmail.com'),
'password' => array('type'=>'password', 'label'=>'Password', 'visible'=>-1, 'enabled'=>"1", 'position'=>103, 'notnull'=>-1, 'comment'=>"IMAP password", 'help'=>'WithGMailYouCanCreateADedicatedPassword'),
@ -213,6 +215,8 @@ class EmailCollector extends CommonObject
public $password;
public $acces_type;
public $oauth_service;
public $imap_encryption;
public $norsh;
public $source_directory;
public $target_directory;
public $maxemailpercollect;
@ -775,11 +779,9 @@ class EmailCollector extends CommonObject
/**
* Return the connectstring to use with IMAP connection function
*
* @param int $ssl Add /ssl tag
* @param int $norsh Add /norsh to connectstring
* @return string
*/
public function getConnectStringIMAP($ssl = 1, $norsh = 0)
public function getConnectStringIMAP()
{
global $conf;
@ -787,15 +789,16 @@ class EmailCollector extends CommonObject
$flags = '/service=imap'; // IMAP
if (!empty($conf->global->IMAP_FORCE_TLS)) {
$flags .= '/tls';
} elseif (empty($conf->global->IMAP_FORCE_NOSSL)) {
if ($ssl) {
$flags .= '/ssl';
}
} elseif (empty($this->imap_encryption) || ($this->imap_encryption == 'ssl' && !empty($conf->global->IMAP_FORCE_NOSSL))) {
$flags .= '';
} else {
$flags .= '/' . $this->imap_encryption;
}
$flags .= '/novalidate-cert';
//$flags.='/readonly';
//$flags.='/debug';
if ($norsh || !empty($conf->global->IMAP_FORCE_NORSH)) {
if (!empty($this->norsh) || !empty($conf->global->IMAP_FORCE_NORSH)) {
$flags .= '/norsh';
}
//Used in shared mailbox from Office365
@ -1191,7 +1194,7 @@ class EmailCollector extends CommonObject
$client = $cm->make([
'host' => $this->host,
'port' => $this->port,
'encryption' => 'ssl',
'encryption' => !empty($this->imap_encryption) ? $this->imap_encryption : false,
'validate_cert' => true,
'protocol' => 'imap',
'username' => $this->login,
@ -1204,7 +1207,7 @@ class EmailCollector extends CommonObject
$client = $cm->make([
'host' => $this->host,
'port' => $this->port,
'encryption' => 'ssl',
'encryption' => !empty($this->imap_encryption) ? $this->imap_encryption : false,
'validate_cert' => true,
'protocol' => 'imap',
'username' => $this->login,

5
htdocs/install/mysql/migration/17.0.0-18.0.0.sql
View file

@ -428,3 +428,8 @@ ALTER TABLE llx_c_stcomm ADD COLUMN sortorder smallint DEFAULT 0;
ALTER TABLE llx_element_time ADD COLUMN ref_ext varchar(32);
ALTER TABLE llx_c_ziptown ADD COLUMN town_up varchar(180);
-- Email Collector
ALTER TABLE llx_emailcollector_emailcollector ADD COLUMN imap_encryption varchar(16) DEFAULT "ssl" AFTER hostcharset;
ALTER TABLE llx_emailcollector_emailcollector ADD COLUMN norsh integer DEFAULT 0 AFTER imap_encryption;

2
htdocs/install/mysql/tables/llx_emailcollector_emailcollector.sql
View file

@ -24,6 +24,8 @@ CREATE TABLE llx_emailcollector_emailcollector(
host varchar(255),
port varchar(10) DEFAULT '993',
hostcharset varchar(16) DEFAULT 'UTF-8',
imap_encryption varchar(16) DEFAULT 'ssl',
norsh integer DEFAULT 0,
login varchar(128),
acces_type integer DEFAULT 0,
oauth_service varchar(128),

4
htdocs/langs/en_US/admin.lang
View file

@ -2113,6 +2113,10 @@ oauthToken=Oauth2 token
accessType=Acces type
oauthService=Oauth service
TokenMustHaveBeenCreated=Module OAuth2 must be enabled and an oauth2 token must have been created with the correct permissions (for example scope "gmail_full" with OAuth for Gmail).
ImapEncryption = IMAP encryption method
ImapEncryptionHelp = Example: none, ssl, tls, notls
NoRSH = Use the NoRSH configuration
NoRSHHelp = Do not use RSH or SSH protocols to establish an IMAP pre-identification session
MailboxSourceDirectory=Mailbox source directory
MailboxTargetDirectory=Mailbox target directory
EmailcollectorOperations=Operations to do by collector