Alternate class.mailfetch.php

mittra

I'm still plugging away at getting osTicket to use Zend\Mail instead of the native IMAP C-Client functions. I'm pretty close, but my rookie skills with PHP are hanging me up I think. I've managed to get to a point where the system isn't crashing on load, but it won't save the email information. I think the problem is I'm not passing the login credentials correctly? Attached is my modified class.mailfetch.php and class.email.php scripts. I upgraded to v1.8.0 this week and have reworked class.zmailfetch.php and am SO close.... I would certainly appreciate it if someone with better PHP skills than me could give these a once over and let me know what you think. Thanks!

[class.zmailfetch.txt](https://forum.osticket.com/assets/files/migrated/FileUpload/a3/a76b1bf6831c2c7f4d2f2068e8a529.txt)

[class.email.txt](https://forum.osticket.com/assets/files/migrated/FileUpload/42/3efe0cddc49c19e1085e4f605ec859.txt)

Grizly

You might want to fork out on github or create a gist for your files. The attachments are iffy here.

mittra

Yeah, I'm not that skilled a developer, Grizly, but thanks for the recommendation. I'll just post the entire scripts here.

mittra

<?php

/*********************************************************************

class.email.php

Peter

Rotich <peter@osticket.com>

http://www.osticket.com

Released

under the GNU General Public License WITHOUT ANY WARRANTY.

See

LICENSE.TXT for details.

vim:

expandtab sw=4 ts=4 sts=4:

**********************************************************************/

include_once(INCLUDE_DIR.'class.dept.php');

include_once(INCLUDE_DIR.'class.zmailfetch.php');

class Email {

var

$id;

var

$address;

var

$dept;

var

$ht;

function

Email($id) {

$this->id=0;

$this->load($id);

}

function

load($id=0) {

if(!$id

&& !($id=$this->getId()))

return

false;

$sql='SELECT

* FROM '.EMAIL_TABLE.' WHERE email_id='.db_input($id);

if(!($res=db_query($sql))

|| !db_num_rows($res))

return

false;

$this->ht=db_fetch_array($res);

$this->id=$this->ht;

$this->address=$this->ht?($this->ht.'<'.$this->ht.'>'):$this->ht;

$this->dept

= null;

return

true;

}

mittra

class.email.php (cont) function

reload() {

return

$this->load();

}

function

getId() {

return

$this->id;

}

function

getEmail() {

return

$this->ht;

}

function

getAddress() {

return

$this->address;

}

function

getName() {

return

$this->ht;

}

function

getPriorityId() {

return

$this->ht;

}

function

getDeptId() {

return

$this->ht;

}

function

getDept() {

if(!$this->dept

&& $this->getDeptId())

$this->dept=Dept:($this->getDeptId());

return

$this->dept;

}

function

autoRespond() {

return

(!$this->ht);

}

function

getPasswd() {

return

$this->ht?Crypto:($this->ht, SECRET_SALT,

$this->ht):'';

}

function

getHashtable() {

return

$this->ht;

}

function

getInfo() {

return

$this->getHashtable();

}

mittra

class.email.php (cont) function

getMailAccountInfo() {

/*NOTE:

Do not change any of the tags - otherwise mail fetching will fail */

$info

= array(

//Mail

server info

'host' => $this->ht,

'port' => $this->ht,

'protocol' => $this->ht,

'ssl'

=> $this->ht,

'user' => $this->ht,

'password'

=> Crypto:($this->ht, SECRET_SALT,

$this->ht),

//osTicket

specific

'email_id' => $this->getId(), //Required for email

routing to work.

'max_fetch'

=> $this->ht,

'delete_mail'

=> $this->ht,

'archive_folder'

=> $this->ht

);

return

$info;

}

mittra

class.email.php (cont) function

isSMTPEnabled() {

return

(

$this->ht

($info=$this->getSMTPInfo())

(!$info || $info)

);

}

function

allowSpoofing() {

return

($this->ht);

}

function

getSMTPInfo() {

$info

= array (

'host'

=> $this->ht,

'port'

=> $this->ht,

'auth'

=> (bool) $this->ht,

'username'

=> $this->ht,

'password'

=> Crypto:($this->ht, SECRET_SALT,

$this->ht)

);

return

$info;

}

function

send($to, $subject, $message, $attachments=null, $options=null) {

$mailer

= new Mailer($this);

if($attachments)

$mailer->addAttachments($attachments);

return

$mailer->send($to, $subject, $message, $options);

}

mittra

class.email.php (cont) function

sendAutoReply($to, $subject, $message, $attachments=null, $options=array()) {

$options+=

array('autoreply' => true);

return

$this->send($to, $subject, $message, $attachments, $options);

}

function

sendAlert($to, $subject, $message, $attachments=null, $options=array()) {

$options+=

array('bulk' => true);

return

$this->send($to, $subject, $message, $attachments, $options);

}

function

update($vars,&$errors) {

$vars=$vars;

$vars=$this->getPasswd();

//Current decrypted password.

if(!$this->save($this->getId(),

$vars, $errors))

return

false;

$this->reload();

return

true;

}

mittra

class.email.php (cont) function delete() {

global

$cfg;

//Make

sure we are not trying to delete default emails.

if(!$cfg

|| $this->getId()==$cfg->getDefaultEmailId() ||

$this->getId()==$cfg->getAlertEmailId()) //double...double check.

return 0;

$sql='DELETE

FROM '.EMAIL_TABLE.' WHERE email_id='.db_input($this->getId()).' LIMIT 1';

if(db_query($sql)

&& ($num=db_affected_rows())) {

$sql='UPDATE

'.DEPT_TABLE.' SET autoresp_email_id=0 '.

',email_id='.db_input($cfg->getDefaultEmailId()).

' WHERE

email_id='.db_input($this->getId());

db_query($sql);

}

return

$num;

}

/*******

Static functions ************/

function

getIdByEmail($email) {

$sql='SELECT

email_id FROM '.EMAIL_TABLE.' WHERE email='.db_input($email);

if(($res=db_query($sql))

&& db_num_rows($res))

list($id)=db_fetch_row($res);

return

$id;

}

mittra

class.email.php (cont) function

lookup($var) {

(is_numeric($var))

$id = $var;

else

$id = Email:($var);

//$id=is_numeric($var)?$var:($var);

return

($id && is_numeric($id) && ($email=new Email($id)) &&

$email->getId())?$email;

}

function

create($vars,&$errors) {

return

Email:(0,$vars,$errors);

}

mittra

class.email.php (cont) function

save($id,$vars,&$errors) {

global

$cfg;

//very

basic checks

$vars=Format:(trim($vars));

$vars=trim($vars);

if($id

&& $id!=$vars)

$errors='Internal error.

Get technical help.';

if(!$vars

|| !Validator:($vars)) {

$errors='Valid email

required';

}elseif(($eid=Email:($vars))

&& $eid!=$id) {

$errors='Email already

exists';

}elseif($cfg

&& !strcasecmp($cfg->getAdminEmail(), $vars)) {

$errors='Email already

used as admin email!';

}elseif(Staff:($vars))

{ //make sure the email doesn't belong to any of the staff

$errors='Email in use

by a staff member';

}

if(!$vars)

$errors='Email name

required';

if($vars

|| ($vars && $vars)) {

if(!$vars)

$errors='Username

missing';

if(!$id &&

!$vars)

$errors='Password

required';

elseif($vars

&& $vars

!Crypto:($vars, SECRET_SALT, $vars)

)

$errors

= 'Unable to encrypt password - get technical support';

}

mittra

class.email.php (cont)

if($vars)

{

//Check pop/imap info only when

enabled.

if(!class_exists('Zend\Mail\Storage'))

$errors=

'Zend Class \"Zend\\Mail\\Storage\" doesn\'t exist.';

if(!class_exists('Zend\Mail\Protocol\Imap'))

$errors=

'Zend Class \"Zend\\Mail\\Protocol\\Imap" doesn\'t exist.';

if(!$vars)

$errors='Host

name required';

if(!$vars)

$errors='Port

required';

if(!$vars)

$errors='Select

protocol';

if(!$vars ||

!is_numeric($vars))

$errors='Fetch

interval required';

if(!$vars ||

!is_numeric($vars))

$errors='Maximum

emails required';

if(!$vars ||

!is_numeric($vars))

$errors='You

must select a Dept.';

if(!$vars)

$errors='You

must select a priority';

if(!isset($vars))

$errors='Indicate

what to do with fetched emails';

elseif(!strcasecmp($vars,'archive')

&& !$vars )

$errors='Valid

folder required';

}

if($vars)

{

if(!$vars)

$errors='Host

name required';

if(!$vars)

$errors='Port

required';

}

mittra

class.email.php (cont) //abort

on errors

if($errors)

return false;

if(!$errors

&& ($vars && $vars)) {

$sql='SELECT email_id FROM

'.EMAIL_TABLE

WHERE mail_host='.db_input($vars).' AND

userid='.db_input($vars);

if($id)

$sql.='

AND email_id!='.db_input($id);

if(db_num_rows(db_query($sql)))

$errors=$errors='Host/userid

combination already in use.';

}

$passwd=$vars?$vars:$vars;

if(!$errors

&& $vars) {

//note: password is unencrypted

at this point...MailFetcher expect plain text.

$fetcher = new MailFetcher(

array(

'host' => $vars,

'port' => $vars,

'user' => $vars,

'password' => $passwd,

'ssl'

=> $vars,

'protocol' => $vars)

);

if(!$fetcher->connect()) {

$errors='Invalid

$errors='<br>'.$fetcher->getLastError();

}elseif($vars

&& !$fetcher->checkMailbox($vars,true)) {

$errors='Invalid or unknown mail

folder! >> '.$fetcher->getLastError().'';

if(!$errors)

$errors='Invalid or unknown archive

folder!';

}

mittra

class.email.php (cont) if(!$errors

&& $vars) { //Check SMTP login only.

require_once 'Mail.php'; // PEAR

Mail package

$smtp = mail:('smtp',

array ('host' =>

$vars,

'port' => $vars,

'auth' => (bool) $vars,

'username' =>$vars,

'password' =>$passwd,

'timeout'

=>20,

'debug' => false,

));

$mail = $smtp->connect();

if(PEAR:($mail)) {

$errors='Unable

to log in. Check SMTP settings.';

$errors='<br>'.$mail->getMessage();

}else{

$smtp->disconnect();

//Thank you, sir!

}

if($errors)

return false;

mittra

class.email.php (cont) //Default

to default priority and dept..

if(!$vars

&& $cfg)

$vars=$cfg->getDefaultPriorityId();

if(!$vars

&& $cfg)

$vars=$cfg->getDefaultDeptId();

$sql='updated=NOW(),mail_errors=0,

mail_lastfetch=NULL'.

',email='.db_input($vars).

',name='.db_input(Format:($vars)).

',dept_id='.db_input($vars).

',priority_id='.db_input($vars).

',noautoresp='.db_input(isset($vars)?1).

',userid='.db_input($vars).

',mail_active='.db_input($vars).

',mail_host='.db_input($vars).

',mail_protocol='.db_input($vars?$vars:'POP').

',mail_encryption='.db_input($vars).

',mail_port='.db_input($vars?$vars).

',mail_fetchfreq='.db_input($vars?$vars).

',mail_fetchmax='.db_input($vars?$vars).

',smtp_active='.db_input($vars).

',smtp_host='.db_input($vars).

',smtp_port='.db_input($vars?$vars).

',smtp_auth='.db_input($vars).

',smtp_spoofing='.db_input(isset($vars)?1).

',notes='.db_input(Format:($vars));

mittra

class.email.php (cont) //Post

fetch email handling...

if($vars

&& !strcasecmp($vars,'delete'))

$sql.=',mail_delete=1,mail_archivefolder=NULL';

elseif($vars

&& !strcasecmp($vars,'archive') &&

$vars)

$sql.=',mail_delete=0,mail_archivefolder='.db_input($vars);

else

$sql.=',mail_delete=0,mail_archivefolder=NULL';

if($vars)

//New password - encrypt.

$sql.=',userpass='.db_input(Crypto:($vars,SECRET_SALT,

$vars));

if($id)

{ //update

$sql='UPDATE '.EMAIL_TABLE.' SET

'.$sql.' WHERE email_id='.db_input($id);

if(db_query($sql) &&

db_affected_rows())

return

true;

$errors='Unable to update

email. Internal error occurred';

}else {

$sql='INSERT INTO

'.EMAIL_TABLE.' SET '.$sql.',created=NOW()';

if(db_query($sql) &&

($id=db_insert_id()))

return

$id;

$errors='Unable to add

email. Internal error';

}

return

false;

}

mso-ascii-theme-font-latin;mso-fareast-font-family;mso-fareast-theme-font:

minor-latin;mso-hansi-theme-font-latin;mso-bidi-font-family:"Times New Roman";

mso-bidi-theme-font-bidi;mso-ansi-language-US;mso-fareast-language:

EN-US;mso-bidi-language-SA">?>

mittra

class.zmailfetch.php<?php/********************************************************************* class.zmailfetch.php mail fetcher class. Modded to use Zend\Mail 2.2. Original class.mailfetch.php: Peter Rotich <peter@osticket.com> Copyright (c) 2006-2013 osTicket http://www.osticket.com Released under the GNU General Public License WITHOUT ANY WARRANTY. See LICENSE.TXT for details. vim: expandtab sw=4 ts=4 sts=4:**********************************************************************/ require_once(INCLUDE_DIR.'class.mailparse.php'); require_once(INCLUDE_DIR.'class.ticket.php'); require_once(INCLUDE_DIR.'class.dept.php'); require_once(INCLUDE_DIR.'class.email.php'); require_once(INCLUDE_DIR.'class.filter.php'); require_once(INCLUDE_DIR.'html2text.php'); require_once(ZEND_DIR.'autoload.php'); class MailFetcher { var $ht; var $charset = 'UTF-8'; function MailFetcher($email, $charset='UTF-8') { if($email && is_numeric($email)) //email_id $email = Email:($email); if(is_object($email)) $this->ht = $email->getMailAccountInfo(); elseif(is_array($email) && $email) //hashtable of mail account info $this->ht = $email; else $this->ht = null; $this->charset = $charset;

mittra

class.zmailfetch.php (cont) if($this->ht) { if(!strcasecmp($this->ht,'pop')) //force pop3 $this->ht = 'pop3'; else $this->ht = strtolower($this->ht); //Max fetch per poll if(!$this->ht || !is_numeric($this->ht)) $this->ht = 20; } } function getEmailId() { return $this->ht; } function getHost() { return $this->ht; } function getPort() { return $this->ht; } function getProtocol() { if(!strcasecmp($this->ht,"imap")) $this->ht = "Imap"; else $this->ht = "Pop3"; return $this->ht; } function getEncryption() { return $this->ht; } function getUsername() { return $this->ht; } function getPassword() { return $this->ht; } function canDeleteEmails() { return ($this->ht); } function getMaxFetch() { return $this->ht; } function getArchiveFolder() { return $this->ht; }

mittra

class.zmailfetch.php (cont) function connect() { if (!$zmail_open) $this->open(); return $zmail_open; } function open() { //Zend\Mail array $zmail_config = array('host' => $this->getHost(), 'port' => $this->getPort(), 'ssl' => $this->getEncryption(), 'user' => $this->getUsername(), 'password' => $this->getPassword() ); if ($zmail_open) $this->close(); $zmail_protocol = new Zend\Mail\Protocol\Imap($this->getHost(),$this->getPort(),$this->getEncryption()); $zmail_open = $zmail_protocol->connect($this->getHost(),$this->getPort(),$this->getEncryption()); $zmail_open = $zmail_protocol->login($this->getUsername(),$this->getPassword()); return $zmail_open; } function close() { if($zmail_protocol->logout()) $zmail_open = False; return $zmail_open; } function mailcount() { return $zmail_storage->countMessages(); } function getMailboxes() { if(empty($zmail_storage)) $zmail_storage = new Zend\Mail\Storage\Imap($this->getHost(),$this->getPort(),$this->getEncryption(),$this->getUsername(),$this->getPassword()); $list = $zmail_storage->getFolders(); if (!is_array($list)) return null; return $list; }

mittra

class.zmailfetch.php (cont) function createMailbox($archiveFolder) { if(!$archiveFolder) return false; return $zmail_protocol->create($archiveFolder); } function checkMailbox($archiveFolder, $create=false) { if(empty($zmail_protocol)) $this->open(); if(($gmboxes = $this->getMailboxes()) && array_key_exists($archiveFolder, $gmboxes)) return true; else $zmail_protocol->create($archiveFolder); return $create; } function decode($text, $encoding) { switch($encoding) { case 1: //Convert an 8bit string to a quoted-printable string $text = quoted_printable_encode($text); break; case 2: //Convert an 8bit string to a base64 string $text = base64_encode($text); break; case 3: // Decode BASE64 encoded text $text = base64_decode($text); break; case 4: //Convert a quoted-printable string to an 8 bit string $text = quoted_printable_decode($text); break; } return $text; }