email_imap_cron.php

<?php

/**
 * Should be run from a cron job to fetch messages from an imap mailbox
 * Can be called from scheduled tasks (fake-cron) if needed
 *
 * @name      ElkArte Forum
 * @copyright ElkArte Forum contributors
 * @license   BSD http://opensource.org/licenses/BSD-3-Clause
 *
 * @version 1.0 Release Candidate 2
 *
 */

// Any output here is not good
error_reporting(0);

// Being run as a cron job
if (!defined('ELK'))
{
	require_once(dirname(__FILE__) . '/SSI.php');
	postbyemail_imap();

	// Need to keep the cli clean on return
	exit(0);
}
// Or a scheduled task
else
	postbyemail_imap();

/**
 * postbyemail_imap()
 *
 * Grabs unread messages from an imap account and saves them as .eml files
 * Passes any new messages found to the postby email function for processing
 * Called by a scheduled task or cronjob
 */
function postbyemail_imap()
{
	global $modSettings;

	// No imap, why bother?
	if (!function_exists('imap_open'))
		return false;

	// Values used for the connection
	$hostname = !empty($modSettings['maillist_imap_host']) ? $modSettings['maillist_imap_host'] : '';
	$username = !empty($modSettings['maillist_imap_uid']) ? $modSettings['maillist_imap_uid'] : '';
	$password = !empty($modSettings['maillist_imap_pass']) ? $modSettings['maillist_imap_pass'] : '';
	$mailbox = !empty($modSettings['maillist_imap_mailbox']) ? $modSettings['maillist_imap_mailbox'] : 'INBOX';
	$type = !empty($modSettings['maillist_imap_connection']) ? $modSettings['maillist_imap_connection'] : '';

	// I suppose that without these informations we can't do anything.
	if (empty($hostname) || empty($username) || empty($password))
		return;

	// Based on the type selected get/set the additional connection details
	$connection = port_type($type);
	$hostname .= (strpos($hostname, ':') === false) ? ':' . $connection['port'] : '';
	$server = '{' . $hostname . '/' . $connection['protocol'] . $connection['flags'] . '}';
	$mailbox = $server .  imap_utf7_encode($mailbox);

	// Connect to the mailbox using the supplied credentials and protocol
	$inbox = @imap_open($mailbox, $username, $password);
	if ($inbox === false)
		return false;

	// If using gmail, we may need the trash bin name as well
	$trash_bin = '';
	if (!empty($modSettings['maillist_imap_delete']) && (strpos($hostname, '.gmail.') !== false))
		$trash_bin = get_trash_folder($inbox, $server);

	// Grab all unseen emails, return by message ID
	$emails = imap_search($inbox, 'UNSEEN', SE_UID);

	// You've got mail,
	if ($emails)
	{
		// Initialize Emailpost controller
		require_once(CONTROLLERDIR . '/Emailpost.controller.php');
		$controller = new Emailpost_Controller();

		// Make sure we work from the oldest to the newest message
		sort($emails);

		// For every email...
		foreach ($emails as $email_uid)
		{
			// Get the headers and prefetch the body as well to avoid a second request
			$headers = imap_fetchheader($inbox, $email_uid, FT_PREFETCHTEXT | FT_UID);
			$message = imap_body($inbox, $email_uid, FT_UID);

			// Create the save-as email
			if (!empty($headers) && !empty($message))
			{
				$email = $headers . "\n" . $message;
				$controller->action_pbe_post($email);

				// Mark it for deletion?
				if (!empty($modSettings['maillist_imap_delete']))
				{
					// Gmail labels make this more complicated
					if (strpos($hostname, '.gmail.') !== false)
						imap_mail_move($inbox, $email_uid, $trash_bin, CP_UID);

					imap_delete($inbox, $email_uid, FT_UID);
					imap_expunge($inbox);
				}
			}
		}

		// Close the connection
		imap_close($inbox);

		return true;
	}
	else
		return false;
}

/**
 * Sets port and connection flags based on the chosen protocol
 *
 * @param string $type type of imap connection, defaults to pop3
 */
function port_type($type)
{
	switch ($type)
	{
		case 'pop3':
			// Standard POP3 mailbox.
			$protocol = 'POP3';
			$port = 110;
			$flags = '/novalidate-cert';
			break;
		case 'pop3tls':
			// POP3, TLS mode.
			$protocol = 'POP3';
			$port = 110;
			$flags = '/tls/novalidate-cert';
			break;
		case 'pop3ssl':
			// POP3, SSL mode.
			$protocol = 'POP3SSL';
			$port = 995;
			$flags = '/ssl/novalidate-cert';
			break;
		case 'imap':
			// Standard IMAP mailbox.
			$protocol = 'IMAP';
			$port = 143;
			$flags = '/novalidate-cert';
			break;
		case 'imaptls':
			// IMAP in TLS mode.
			$protocol = 'IMAPTLS';
			$port = 143;
			$flags = '/tls/novalidate-cert';
			break;
		case 'imapssl':
			// IMAP in SSL mode.
			$protocol = 'IMAP';
			$port = 993;
			$flags = '/ssl/novalidate-cert';
			break;
		default:
			// Somethings wrong, so use a standard POP3 mailbox.
			$protocol = 'POP3';
			$port = 110;
			$flags = '/novalidate-cert';
			break;
	}

	return array('protocol' => $protocol, 'port' => $port, 'flags' => $flags);
}

/**
 * Find and return the proper recycle bin for gmail
 *
 * @param imap_open $mailbox connection object to the mailbox
 * @param string $server server string, used to clean the imap list
 */
function get_trash_folder($mailbox, $server)
{
	// Known names for the trash bin, I'm sure there are more
	$trashbox = array('[Google Mail]/Bin', '[Google Mail]/Trash', '[Gmail]/Bin', '[Gmail]/Trash');

	// Get all the folders / labels
	$mailboxes = imap_list($mailbox, $server, '*');

	// Check the names to see if one is known as a trashbin
	foreach($mailboxes as $mailbox)
	{
		$name = str_replace($server, '', $mailbox);
		if (in_array($name, $trashbox))
			return $name;
	}

	return 'Trash';
}