Fetching mail from specific IMAP folder, not INBOX

amh

Hi there,for our ticket system, we pre-sort incoming mails to one of several shared IMAP folders, which correspond to different working groups / OSticket topics.Below comes a small code hack that allows to specify the IMAP folder to fetch mail from. In our case, there are several email "accounts" in OSticket that share the same credentials, but use separate folders for mail inflow and process mails in different ways, depending on the folder that the mail was sorted into.include/class.mailfetch.php, around line 130: function open($box='') {

if ($this->mbox)

$this->close();

if ( $box == '' ) {

if ( isset($this->ht) ) {

$box = $this->ht;

} else {

$box = "INBOX";

}

}and function MailFetcher (ca. line 56): //Max fetch per poll

if(!$this->ht || !is_numeric($this->ht))

$this->ht = 20;

if ( ! isset($this->ht) ) {

if ( FALSE !== ( $p = strpos($this->ht, '/') ) ) {

$this->ht = substr($this->ht,$p+1);

$this->ht = substr($this->ht, 0, $p);

}

}After applying these additions, specify (optional) the folder to use right after the servername in the IMAP configuration, like mail.example.com/foldername (append / and the foldername to the server name). Note that sometimes, folders are children of e.g. Inbox, so maybe something like mail.example.com/INBOX.foldername or mail.example.com/inbox/foldername is needed, depending on your setup.Comments welcome.

ahall

I'm trying to do the exact same thing. We have an email account with Gmail for which we're making some aliases, one per department. Filters send emails to the different aliases to different imap folders, so I need OST to look in a particular folder for each email we add to the system. Otherwise, they'll all be looking in the inbox of the same address, which would be a disaster.I'm asking this with absolutely no experience of OST's code, and using the current 1.9.12. I was implementing the changes you suggested, and got the first one done with no problem. The other one, in the MailFetcher function, is proving more difficult.You say to access ht, but was that ever set? Also, wouldn't I need to modify this->getHost() so that it returns just the host, with the imap folder stripped off? Put another way, wouldn't there be somewhere more central where 'imap_folder' should be set and where the host should be stripped of that folder, if it exists?

ahall

In case anyone comes along looking for how to do this, I think I have it working. My approach was different from the original poster, but I couldn't get that mod to work so had to borrow from it and make some changes. I'm using 1.9.14, but this should work in any recent version. Be advised that you *will* need to use direct changing of a MySQL table to get this to work, which will make upgrading a pain. Also note that I have only tested this briefly, so there may be unforeseen problems that crop up later. Use at your own risk, and please don't try this on a production system first!First, get into MySQL (I used the command line). Then:use osticket;(or whatever you called your OST database)We next need to add the column that holds the imap folder we want each email account to use. Below, and in all other commands, ost_ is the prefix I chose during installation (the default). Substitute your prefix if you changed it.ALTER TABLE ost_email ADD imap_folder VARCHAR(32) AFTER mail_host;Then use SQL to insert the imap folder for any emails you want, such as:UPDATE ost_email SET imap_folder = 'sales' WHERE mail_id = 3;Repeat for any other accounts you want to. This is also how you'll add imap folders for new accounts or adjust the folders for existing accounts in the future. I really don't feel like going to all the trouble of adding an entire UI for this. To get that ID, the easiest way is to select it from Admin Panel > Emails; the resulting URL should be something like /scp/mails.php?id=3Next, open up include/class.email.php in your OST folder. Find the getMailAccountInfo() function, then the part where we create an 'info' array--setting host, username, protocol, and so on. To that array, add:'imap_folder' => $this->ht,Finally, we'll use part of ANH's mod to make sure things work correctly for accounts where this imap adjustment has not been made. In include/class.mailfetch.php, do what ANH said. That is: function open($box='') { if ($this->mbox) $this->close(); if ( $box == '' ) { if ( isset($this->ht) ) { $box = $this->ht; } else { $box = "INBOX"; } }However, you don't need to modify the other function ANH said to, since we've made imap_folder part of the database itself rather than an add-on to the host string. I did this because it was too time-consuming to try to break that string up by slashes every time the actual host was needed, and even when I did, imap authentication still failed. My way avoids that problem, but, again, will make upgrading more difficult. It also requires you to modify a table, and use the table itself to change any imap_folder assignments you need to. This is less than ideal, obviously, but until OST adds these changes into core, it's the best I can come up with.Once more: this is minimally tested, so PLEASE DON'T use it in production until you verify that it works and you did it right. Please also keep in mind that I'm not a PHP programmer nor much of a web developer. As I said before, use at your own risk.

dbinoj

This mod has valid utility! +1.Does this look like something which can be added to core?GSuite charges on a per email account basis.If this is tested and officially implemented, small shops can have multiple support streams off of one paying Gmail ID.