CRM_Mailing_MailStore

class CRM_Mailing_MailStore

Properties

bool $_debug flag to decide whether to print debug messages

Methods

static object
getStore(string $name = NULL)

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

array
allMails()

Return all emails in the mail store.

expunge()

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

array
fetchNext(int $count = 1)

Return the next X messages from the mail store.

string
maildir(string $name)

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

Details

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

at line 93
array allMails()

Return all emails in the mail store.

Return Value

array array of ezcMail objects

at line 100
expunge()

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

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

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