CRM_Mailing_MailStore_Imap

class CRM_Mailing_MailStore_Imap extends CRM_Mailing_MailStore

Class CRM_Mailing_MailStore_Imap

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, CRM-7356

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_Imap
__construct(string $host, string $username, string $password, bool $ssl = TRUE, string $folder = 'INBOX')

Connect to the supplied IMAP server and make sure the two mailboxes exist.

markIgnored(int $nr)

Move the specified message to the ignored folder.

markProcessed(int $nr)

Move the specified message to the 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

at line 92
expunge()

Expunge the messages marked for deletion, CRM-7356

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 55
CRM_Mailing_MailStore_Imap __construct(string $host, string $username, string $password, bool $ssl = TRUE, string $folder = 'INBOX')

Connect to the supplied IMAP server and make sure the two mailboxes exist.

Parameters

string $host Host to connect to.
string $username Authentication username.
string $password Authentication password.
bool $ssl Whether to use IMAP or IMAPS.
string $folder Name of the inbox folder.

Return Value

CRM_Mailing_MailStore_Imap

at line 102
markIgnored(int $nr)

Move the specified message to the ignored folder.

Parameters

int $nr Number of the message to move.

at line 117
markProcessed(int $nr)

Move the specified message to the processed folder.

Parameters

int $nr Number of the message to move.