IMP_LoginTasks_Task_RenameSentmailMonthly
extends Horde_LoginTasks_Task
in package
Login tasks module that renames sent-mail mailboxes every month.
Tags
Table of Contents
Methods
- __construct() : mixed
- Constructor.
- describe() : string
- Returns information for the login task.
- execute() : bool
- Renames the old sent-mail mailboxes.
- _getSentmail() : array<string|int, mixed>
- Returns the list of sent-mail mailboxes.
Methods
__construct()
Constructor.
public
__construct() : mixed
describe()
Returns information for the login task.
public
describe() : string
Return values
string —Description of what the operation is going to do during this login.
execute()
Renames the old sent-mail mailboxes.
public
execute() : bool
Mailbox name: sent-mail-month-year month = English: 3 letter abbreviation Other Languages: Month value (01-12) year = 4 digit year
The mailbox name needs to be in this specific format (as opposed to a user-defined one) to ensure that 'delete_sentmail_monthly' processing can accurately find all the old sent-mail mailboxes.
Return values
bool —Whether all sent-mail mailboxes were renamed.
_getSentmail()
Returns the list of sent-mail mailboxes.
protected
_getSentmail() : array<string|int, mixed>
Return values
array<string|int, mixed> —All sent-mail mailboxes (IMP_Mailbox objects).