emailcollector.lib.php File Reference

Library files with common functions for EmailCollector. More...

Go to the source code of this file.

Functions
	emailcollectorPrepareHead ($object)
	Prepare array of tabs for EmailCollector.
	getParts ($structure)
	Get parts of a message.
	getDParameters ($part)
	Array with joined files.
	getAttachments ($jk, $mbox)
	Get attachments of a given mail.
	getFileData ($jk, $fpos, $type, $mbox)
	Get content of a joined file from its position into a given email.
	saveAttachment ($path, $filename, $data)
	Save the attached file into a directory with a given name.
	getDecodeValue ($message, $coding)
	Decode content of a message.

Detailed Description

Library files with common functions for EmailCollector.

Definition in file emailcollector.lib.php.

Function Documentation

emailcollectorPrepareHead()

emailcollectorPrepareHead

(

$object

)

Prepare array of tabs for EmailCollector.

Parameters

EmailCollector

$object

EmailCollector

Returns

array<array{0:string,1:string,2:string}> Array of tabs to show

Definition at line 32 of file emailcollector.lib.php.

References $conf, $object, and complete_head_from_modules().

getAttachments()

getAttachments	(		$jk,
			$mbox )

Get attachments of a given mail.

Parameters

integer	$jk	Number of email
\IMAP\Connection	$mbox	object connection imap

Returns

array<array{type:int,filename:string,pos:int}> type, filename, pos

Definition at line 118 of file emailcollector.lib.php.

References getDParameters(), and getParts().

getDecodeValue()

getDecodeValue	(		$message,
			$coding )

Decode content of a message.

Parameters

string	$message	Message
integer	$coding	Type of content

Returns

string Decoded message

Definition at line 200 of file emailcollector.lib.php.

Referenced by getFileData().

getDParameters()

getDParameters

(

$part

)

Array with joined files.

Parameters

stdClass

$part

Part of message

Returns

stdclass|boolean Definition of message|false in case of error

Definition at line 106 of file emailcollector.lib.php.

Referenced by getAttachments().

getFileData()

getFileData	(		$jk,
			$fpos,
			$type,
			$mbox )

Get content of a joined file from its position into a given email.

Parameters

integer	$jk	numéro du mail
string	$fpos	position de la pièce jointe
integer	$type	type de la pièce jointe
\IMAP\Connection	$mbox	object connection imap

Returns

string data

Definition at line 155 of file emailcollector.lib.php.

References getDecodeValue().

getParts()

getParts

(

$structure

)

Get parts of a message.

Parameters

stdClass

$structure

Structure of message

Returns

stdClass[]|false Array of parts of the message|false if error

Definition at line 95 of file emailcollector.lib.php.

Referenced by getAttachments().

saveAttachment()

saveAttachment	(		$path,
			$filename,
			$data )

Save the attached file into a directory with a given name.

Parameters

string	$path	Path to file
string	$filename	Name of file
mixed	$data	Content to save

Returns

string|-1 Return the path to the saved file, or -1 if error

Definition at line 171 of file emailcollector.lib.php.

References dol_mkdir().