CRM_Mailing_MailStore_Mbox

class CRM_Mailing_MailStore_Mbox extends CRM_Mailing_MailStore

Class CRM_Mailing_MailStore_Mbox

Properties

bool $_debug flag to decide whether to print debug messages from CRM_Mailing_MailStore

Methods

static object
getStore(string $name = NULL)

Return the proper mail store implementation, based on config settings.

from CRM_Mailing_MailStore
array
allMails()

Return all emails in the mail store.

from CRM_Mailing_MailStore
expunge()

Expunge the messages marked for deletion; stub function to be redefined by IMAP store.

from CRM_Mailing_MailStore
array
fetchNext(int $count = 1)

Return the next X messages from the mail store.

from CRM_Mailing_MailStore
string
maildir(string $name)

Point to (and create if needed) a local Maildir for storing retrieved mail

from CRM_Mailing_MailStore
CRM_Mailing_MailStore_Mbox
__construct(string $file)

Connect to and lock the supplied file and make sure the two mail dirs exist.

__destruct()

Empty the mail source (if it was processed fully) and unlock the file.

markIgnored(int $nr)

Fetch the specified message to the local ignore folder.

markProcessed(int $nr)

Fetch the specified message to the local processed folder.

Details

in CRM_Mailing_MailStore at line 50
static object getStore(string $name = NULL)

Return the proper mail store implementation, based on config settings.

Parameters

string $name Name of the settings set from civimail_mail_settings to use (null for default).

Return Value

object mail store implementation for processing CiviMail-bound emails

Exceptions

Exception

in CRM_Mailing_MailStore at line 93
array allMails()

Return all emails in the mail store.

Return Value

array array of ezcMail objects

in CRM_Mailing_MailStore at line 100
expunge()

Expunge the messages marked for deletion; stub function to be redefined by IMAP store.

in CRM_Mailing_MailStore at line 112
array fetchNext(int $count = 1)

Return the next X messages from the mail store.

Parameters

int $count Number of messages to fetch (0 to fetch all).

Return Value

array array of ezcMail objects

in CRM_Mailing_MailStore at line 155
string maildir(string $name)

Point to (and create if needed) a local Maildir for storing retrieved mail

Parameters

string $name Name of the Maildir.

Return Value

string path to the Maildir's cur directory

Exceptions

Exception

at line 47
CRM_Mailing_MailStore_Mbox __construct(string $file)

Connect to and lock the supplied file and make sure the two mail dirs exist.

Parameters

string $file Mbox to operate upon.

Return Value

CRM_Mailing_MailStore_Mbox

at line 70
__destruct()

Empty the mail source (if it was processed fully) and unlock the file.

at line 87
markIgnored(int $nr)

Fetch the specified message to the local ignore folder.

Parameters

int $nr Number of the message to fetch.

at line 103
markProcessed(int $nr)

Fetch the specified message to the local processed folder.

Parameters

int $nr Number of the message to fetch.