lainwir3d/dolibarr
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Work on email collector

Browse Source
This commit is contained in:
Laurent Destailleur 2019-04-08 21:22:10 +02:00
commit 65e931cfe2
5 changed files with 71 additions and 27 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

85
htdocs/emailcollector/class/emailcollector.class.php
View File

@ -103,9 +103,10 @@ class EmailCollector extends CommonObject
//'filter' => array('type'=>'text', 'label'=>'Filter', 'visible'=>1, 'enabled'=>1, 'position'=>105), //'filter' => array('type'=>'text', 'label'=>'Filter', 'visible'=>1, 'enabled'=>1, 'position'=>105),
//'actiontodo' => array('type'=>'varchar(255)', 'label'=>'ActionToDo', 'visible'=>1, 'enabled'=>1, 'position'=>106), //'actiontodo' => array('type'=>'varchar(255)', 'label'=>'ActionToDo', 'visible'=>1, 'enabled'=>1, 'position'=>106),
'target_directory' => array('type'=>'varchar(255)', 'label'=>'MailboxTargetDirectory', 'visible'=>1, 'enabled'=>1, 'position'=>110, 'notnull'=>0, 'comment'=>"Where to store messages once processed"), 'target_directory' => array('type'=>'varchar(255)', 'label'=>'MailboxTargetDirectory', 'visible'=>1, 'enabled'=>1, 'position'=>110, 'notnull'=>0, 'comment'=>"Where to store messages once processed"),
'datelastresult' => array('type'=>'datetime', 'label'=>'DateLastResult', 'visible'=>1, 'enabled'=>'$action != "create"', 'position'=>121, 'notnull'=>-1,), 'datelastresult' => array('type'=>'datetime', 'label'=>'DateLastCollectResult', 'visible'=>1, 'enabled'=>'$action != "create" && $action != "edit"', 'position'=>121, 'notnull'=>-1,),
'codelastresult' => array('type'=>'varchar(16)', 'label'=>'CodeLastResult', 'visible'=>1, 'enabled'=>'$action != "create" && $action != "edit"', 'position'=>122, 'notnull'=>-1,), 'codelastresult' => array('type'=>'varchar(16)', 'label'=>'CodeLastResult', 'visible'=>1, 'enabled'=>'$action != "create" && $action != "edit"', 'position'=>122, 'notnull'=>-1,),
'lastresult' => array('type'=>'varchar(255)', 'label'=>'LastResult', 'visible'=>1, 'enabled'=>'$action != "create" && $action != "edit"', 'position'=>123, 'notnull'=>-1,), 'lastresult' => array('type'=>'varchar(255)', 'label'=>'LastResult', 'visible'=>1, 'enabled'=>'$action != "create" && $action != "edit"', 'position'=>123, 'notnull'=>-1,),
'datelastok' => array('type'=>'datetime', 'label'=>'DateLastcollectResultOk', 'visible'=>1, 'enabled'=>'$action != "create"', 'position'=>125, 'notnull'=>-1,),
'note_public' => array('type'=>'html', 'label'=>'NotePublic', 'visible'=>0, 'enabled'=>1, 'position'=>61, 'notnull'=>-1,), 'note_public' => array('type'=>'html', 'label'=>'NotePublic', 'visible'=>0, 'enabled'=>1, 'position'=>61, 'notnull'=>-1,),
'note_private' => array('type'=>'html', 'label'=>'NotePrivate', 'visible'=>0, 'enabled'=>1, 'position'=>62, 'notnull'=>-1,), 'note_private' => array('type'=>'html', 'label'=>'NotePrivate', 'visible'=>0, 'enabled'=>1, 'position'=>62, 'notnull'=>-1,),
'date_creation' => array('type'=>'datetime', 'label'=>'DateCreation', 'visible'=>-2, 'enabled'=>1, 'position'=>500, 'notnull'=>1,), 'date_creation' => array('type'=>'datetime', 'label'=>'DateCreation', 'visible'=>-2, 'enabled'=>1, 'position'=>500, 'notnull'=>1,),
@ -757,7 +758,7 @@ class EmailCollector extends CommonObject
} }
if ($tmpclass && ($tmpclass != $object->element)) continue; // Property is for another type of object if ($tmpclass && ($tmpclass != $object->element)) continue; // Property is for another type of object
if (property_exists($object, $tmpproperty)) if (property_exists($object, $tmpproperty) || preg_match('/^options_/', $tmpproperty))
{ {
$sourcestring=''; $sourcestring='';
$sourcefield=''; $sourcefield='';
@ -794,7 +795,8 @@ class EmailCollector extends CommonObject
} }
elseif (preg_match('/^SET:(.*)$/', $valueforproperty, $reg)) elseif (preg_match('/^SET:(.*)$/', $valueforproperty, $reg))
{ {
$object->$tmpproperty = $reg[1]; if (preg_match('/^options_/', $tmpproperty)) $object->array_options[preg_replace('/^options_/', '', $tmpproperty)] = $reg[1];
else $object->$tmpproperty = $reg[1];
} }
else else
{ {
@ -868,6 +870,7 @@ class EmailCollector extends CommonObject
$this->error = 'Failed to open IMAP connection '.$connectstringsource; $this->error = 'Failed to open IMAP connection '.$connectstringsource;
return -3; return -3;
} }
imap_errors(); // Clear stack of errors.
// $conf->global->MAIL_PREFIX_FOR_EMAIL_ID must be defined // $conf->global->MAIL_PREFIX_FOR_EMAIL_ID must be defined
$host=dol_getprefix('email'); $host=dol_getprefix('email');
@ -875,7 +878,7 @@ class EmailCollector extends CommonObject
// Define the IMAP search string // Define the IMAP search string
// See https://tools.ietf.org/html/rfc3501#section-6.4.4 // See https://tools.ietf.org/html/rfc3501#section-6.4.4
//$search='ALL'; //$search='ALL';
$search='UNDELETED NOT DRAFT'; $search='UNDELETED'; // Seems not supported by some servers
$searchhead=''; $searchhead='';
$searchfilterdoltrackid=0; $searchfilterdoltrackid=0;
$searchfilternodoltrackid=0; $searchfilternodoltrackid=0;
@ -903,8 +906,9 @@ class EmailCollector extends CommonObject
if (empty($targetdir)) // Use last date as filter if there is no targetdir defined. if (empty($targetdir)) // Use last date as filter if there is no targetdir defined.
{ {
$fromdate=0; $fromdate=0;
if ($this->datelastresult && $this->codelastresult == 'OK') $fromdate = $this->datelastresult; if ($this->datelastok) $fromdate = $this->datelastok;
if ($fromdate > 0) $search.=($search?' ':'').'SINCE '.dol_print_date($fromdate - 1, 'dayhourrfc'); if ($fromdate > 0) $search.=($search?' ':'').'SINCE '.date('j-M-Y', $fromdate - 1); // SENTSINCE not supported. Date must be X-Abc-9999 (X on 1 digit if < 10)
//$search.=($search?' ':'').'SINCE 8-Apr-2018';
} }
dol_syslog("IMAP search string = ".$search); dol_syslog("IMAP search string = ".$search);
//var_dump($search); //var_dump($search);
@ -914,11 +918,21 @@ class EmailCollector extends CommonObject
$nbactiondone=0; $nbactiondone=0;
// Scan IMAP inbox // Scan IMAP inbox
$arrayofemail= imap_search($connection, $search); $arrayofemail= imap_search($connection, $search, null, "UTF-8");
//var_dump($arrayofemail);exit; if ($arrayofemail === false)
{
// Nothing found or search string not understood
$mapoferrrors = imap_errors();
if ($mapoferrrors !== false)
{
$error++;
$this->error = "Search string not understood - ".join(',', $mapoferrrors);
$this->errors[] = $this->error;
}
}
// Loop on each email found // Loop on each email found
if (! empty($arrayofemail) && count($arrayofemail) > 0) if (! $error && ! empty($arrayofemail) && count($arrayofemail) > 0)
{ {
foreach($arrayofemail as $imapemail) foreach($arrayofemail as $imapemail)
{ {
@ -1076,16 +1090,18 @@ class EmailCollector extends CommonObject
$partplain=1; $partplain=1;
}*/ }*/
//var_dump($structure); /*var_dump($structure);
//var_dump($parthtml);var_dump($partplain); var_dump($parthtml);
var_dump($partplain);*/
$messagetext = imap_fetchbody($connection, $imapemail, ($parthtml != '-1' ? $parthtml : ($partplain != '-1' ? $partplain : 0)), FT_PEEK); $messagetext = imap_fetchbody($connection, $imapemail, ($parthtml != '-1' ? $parthtml : ($partplain != '-1' ? $partplain : 1)), FT_PEEK);
//var_dump($overview); //var_dump($messagetext);
//var_dump($header);
//var_dump($message);
//var_dump($structure->parts[0]->parts); //var_dump($structure->parts[0]->parts);
//var_dump($messagetext);exit; //print $header;
//print $messagetext;
//exit;
$fromstring=$overview[0]->from; $fromstring=$overview[0]->from;
$sender=$overview[0]->sender; $sender=$overview[0]->sender;
$to=$overview[0]->to; $to=$overview[0]->to;
@ -1244,6 +1260,25 @@ class EmailCollector extends CommonObject
// Make Operation // Make Operation
dol_syslog("Execute action ".$operation['type']." actionparam=".$operation['actionparam'].' thirdpartystatic->id='.$thirdpartystatic->id.' contactstatic->id='.$contactstatic->id.' projectstatic->id='.$projectstatic->id); dol_syslog("Execute action ".$operation['type']." actionparam=".$operation['actionparam'].' thirdpartystatic->id='.$thirdpartystatic->id.' contactstatic->id='.$contactstatic->id.' projectstatic->id='.$projectstatic->id);
$description = $descriptionfull = '';
if (in_array($operation['type'], array('recordevent', 'project', 'ticket')))
{
$description = $langs->trans("ProjectCreatedByEmailCollector", $msgid);
$description = dol_concatdesc($description, "-----");
$description = dol_concatdesc($description, $langs->trans("Topic").' : '.$subject);
$description = dol_concatdesc($description, $langs->trans("From").' : '.$fromstring);
if ($sender) $description = dol_concatdesc($description, $langs->trans("Sender").' : '.$sender);
$description = dol_concatdesc($description, $langs->trans("To").' : '.$to);
//if ($cc) $description = dol_concatdesc($description, $langs->trans("Cc").' : '.$cc);
//if ($bcc) $description = dol_concatdesc($description, $langs->trans("Bcc").' : '.$bcc);
$description = dol_concatdesc($description, "-----");
$description = dol_concatdesc($description, $messagetext);
$descriptionfull = $description;
$descriptionfull = dol_concatdesc($descriptionfull, "----- Header");
$descriptionfull = dol_concatdesc($descriptionfull, $header);
}
// Search and create thirdparty // Search and create thirdparty
if ($operation['type'] == 'loadthirdparty' || $operation['type'] == 'loadandcreatethirdparty') if ($operation['type'] == 'loadthirdparty' || $operation['type'] == 'loadandcreatethirdparty')
{ {
@ -1354,6 +1389,10 @@ class EmailCollector extends CommonObject
elseif ($operation['type'] == 'recordevent') elseif ($operation['type'] == 'recordevent')
{ {
$actioncode = 'EMAIL_IN'; $actioncode = 'EMAIL_IN';
// If we scan the Sent box, we use the code for out email
if ($this->source_directory == 'Sent') {
$actioncode = 'EMAIL_OUT';
}
if ($projectstatic->id > 0) if ($projectstatic->id > 0)
{ {
@ -1373,8 +1412,8 @@ class EmailCollector extends CommonObject
$actioncomm->type_code = 'AC_OTH_AUTO'; // Type of event ('AC_OTH', 'AC_OTH_AUTO', 'AC_XXX'...) $actioncomm->type_code = 'AC_OTH_AUTO'; // Type of event ('AC_OTH', 'AC_OTH_AUTO', 'AC_XXX'...)
$actioncomm->code = 'AC_'.$actioncode; $actioncomm->code = 'AC_'.$actioncode;
$actioncomm->label = $langs->trans("ActionAC_EMAIL_IN").' - '.$langs->trans("MailFrom").' '.$from; $actioncomm->label = $langs->trans("ActionAC_".$actioncode).' - '.$langs->trans("MailFrom").' '.$from;
$actioncomm->note = $messagetext; $actioncomm->note = $descriptionfull;
$actioncomm->fk_project = $projectstatic->id; $actioncomm->fk_project = $projectstatic->id;
$actioncomm->datep = $date; $actioncomm->datep = $date;
$actioncomm->datef = $date; $actioncomm->datef = $date;
@ -1421,17 +1460,16 @@ class EmailCollector extends CommonObject
// Create event // Create event
elseif ($operation['type'] == 'project') elseif ($operation['type'] == 'project')
{ {
$note_private = $langs->trans("ProjectCreatedByEmailCollector", $msgid);
$projecttocreate = new Project($this->db); $projecttocreate = new Project($this->db);
if ($thirdpartystatic->id > 0) if ($thirdpartystatic->id > 0)
{ {
$projecttocreate->socid = $thirdpartystatic->id; $projecttocreate->socid = $thirdpartystatic->id;
if ($thirdpartyfoundby) $note_private .= ' - Third party found from '.$thirdpartyfoundby; if ($thirdpartyfoundby) $messagetext .= dol_concatdesc($messagetext, 'Third party found from '.$thirdpartyfoundby);
} }
if ($contactstatic->id > 0) if ($contactstatic->id > 0)
{ {
$projecttocreate->contact_id = $contactstatic->id; $projecttocreate->contact_id = $contactstatic->id;
if ($contactfoundby) $note_private .= ' - Contact/address found from '.$contactfoundby; if ($contactfoundby) $messagetext .= dol_concatdesc($messagetext, 'Contact/address found from '.$contactfoundby);
} }
$id_opp_status = dol_getIdFromCode($this->db, 'PROSP', 'c_lead_status', 'code', 'rowid'); $id_opp_status = dol_getIdFromCode($this->db, 'PROSP', 'c_lead_status', 'code', 'rowid');
@ -1442,8 +1480,8 @@ class EmailCollector extends CommonObject
$projecttocreate->date_end = ''; $projecttocreate->date_end = '';
$projecttocreate->opp_status = $id_opp_status; $projecttocreate->opp_status = $id_opp_status;
$projecttocreate->opp_percent = $percent_opp_status; $projecttocreate->opp_percent = $percent_opp_status;
$projecttocreate->description = dol_concatdesc(dol_concatdesc($note_private, dolGetFirstLineOfText(dol_string_nohtmltag($messagetext, 2), 3)), '...'.$langs->transnoentities("SeePrivateNote").'...'); $projecttocreate->description = dol_concatdesc(dolGetFirstLineOfText(dol_string_nohtmltag($description, 2), 8), '...'.$langs->transnoentities("SeePrivateNote").'...');
$projecttocreate->note_private = dol_concatdesc($note_private, dol_string_nohtmltag($messagetext, 2)); $projecttocreate->note_private = dol_concatdesc($descriptionfull, dol_string_nohtmltag($descriptionfull, 2));
$projecttocreate->entity = $conf->entity; $projecttocreate->entity = $conf->entity;
// Get next project Ref // Get next project Ref
@ -1654,6 +1692,7 @@ class EmailCollector extends CommonObject
$this->debuginfo = 'IMAP search string used : '.$search; $this->debuginfo = 'IMAP search string used : '.$search;
if ($searchhead) $this->debuginfo .= '<br>Then search string into email header : '.$searchhead; if ($searchhead) $this->debuginfo .= '<br>Then search string into email header : '.$searchhead;
if (! $error) $this->datelastok = $now;
if (! empty($this->errors)) $this->lastresult.= " - ".join(" - ", $this->errors); if (! empty($this->errors)) $this->lastresult.= " - ".join(" - ", $this->errors);
$this->codelastresult = ($error ? 'KO' : 'OK'); $this->codelastresult = ($error ? 'KO' : 'OK');

2
htdocs/install/mysql/migration/9.0.0-10.0.0.sql
View File

@ -275,3 +275,5 @@ ALTER TABLE llx_product ADD COLUMN fk_project integer DEFAULT NULL;
ALTER TABLE llx_product ADD INDEX idx_product_fk_project (fk_project); ALTER TABLE llx_product ADD INDEX idx_product_fk_project (fk_project);
ALTER TABLE llx_actioncomm ADD COLUMN calling_duration integer; ALTER TABLE llx_actioncomm ADD COLUMN calling_duration integer;
ALTER TABLE llx_emailcollector_emailcollector ADD COLUMN datelastok datetime;

1
htdocs/install/mysql/tables/llx_emailcollector_emailcollector.sql
View File

@ -29,6 +29,7 @@ CREATE TABLE llx_emailcollector_emailcollector(
datelastresult datetime, datelastresult datetime,
codelastresult varchar(16), codelastresult varchar(16),
lastresult varchar(255), lastresult varchar(255),
datelastok datetime,
note_public text, note_public text,
note_private text, note_private text,
date_creation datetime NOT NULL, date_creation datetime NOT NULL,

9
htdocs/langs/en_US/admin.lang
View File

@ -1829,8 +1829,9 @@ MailboxSourceDirectory=Mailbox source directory
MailboxTargetDirectory=Mailbox target directory MailboxTargetDirectory=Mailbox target directory
EmailcollectorOperations=Operations to do by collector EmailcollectorOperations=Operations to do by collector
CollectNow=Collect now CollectNow=Collect now
DateLastResult=Date last collect DateLastCollectResult=Date latest collect tried
LastResult=Last result DateLastcollectResultOk=Date latest collect successfull
LastResult=Latest result
EmailCollectorConfirmCollectTitle=Email collect confirmation EmailCollectorConfirmCollectTitle=Email collect confirmation
EmailCollectorConfirmCollect=Do you want to run the collection for this collector now ? EmailCollectorConfirmCollect=Do you want to run the collection for this collector now ?
NoNewEmailToProcess=No new email (matching filters) to process NoNewEmailToProcess=No new email (matching filters) to process
@ -1839,7 +1840,7 @@ XEmailsDoneYActionsDone=%s emails qualified, %s emails successfully processed (f
RecordEvent=Record email event RecordEvent=Record email event
CreateLeadAndThirdParty=Create lead (and third party if necessary) CreateLeadAndThirdParty=Create lead (and third party if necessary)
CreateTicketAndThirdParty=Create ticket (and third party if necessary) CreateTicketAndThirdParty=Create ticket (and third party if necessary)
CodeLastResult=Result code of last collect CodeLastResult=Latest result code
NbOfEmailsInInbox=Number of emails in source directory NbOfEmailsInInbox=Number of emails in source directory
LoadThirdPartyFromName=Load third party from name (load only) LoadThirdPartyFromName=Load third party from name (load only)
LoadThirdPartyFromNameOrCreate=Load third party from name (create if not found) LoadThirdPartyFromNameOrCreate=Load third party from name (create if not found)
@ -1848,7 +1849,7 @@ WithoutDolTrackingID=Dolibarr Tracking ID not found
FormatZip=Zip FormatZip=Zip
MainMenuCode=Menu entry code (mainmenu) MainMenuCode=Menu entry code (mainmenu)
ECMAutoTree=Show automatic ECM tree ECMAutoTree=Show automatic ECM tree
OperationParamDesc=Define values to use for action, or how to extract values. For example:<br>objproperty1=SET:abc<br>objproperty2=EXTRACT:HEADER:X-Myheaderkey.*[^\s]+(.*)<br>objproperty3=EXTRACT:SUBJECT:([^\s]*)<br>objproperty4=EXTRACT:BODY:My company name is\s([^\s]*)<br><br>Use a ; char as separator to extract or set several properties. OperationParamDesc=Define values to use for action, or how to extract values. For example:<br>objproperty1=SET:abc<br>objproperty2=EXTRACT:HEADER:X-Myheaderkey.*[^\s]+(.*)<br>objproperty3=EXTRACT:SUBJECT:([^\s]*)<br>object.objproperty4=EXTRACT:BODY:My company name is\s([^\s]*)<br><br>Use a ; char as separator to extract or set several properties.
OpeningHours=Opening hours OpeningHours=Opening hours
OpeningHoursDesc=Enter here the regular opening hours of your company. OpeningHoursDesc=Enter here the regular opening hours of your company.
ResourceSetup=Configuration of Resource module ResourceSetup=Configuration of Resource module

1
htdocs/langs/en_US/main.lang
View File

@ -968,3 +968,4 @@ AnalyticCode=Analytic code
TMenuMRP=MRP TMenuMRP=MRP
ShowMoreInfos=Show More Infos ShowMoreInfos=Show More Infos
NoFilesUploadedYet=Please upload a document first NoFilesUploadedYet=Please upload a document first
SeePrivateNote=See private note