API Documentation
\
Nag
Backup

\Nag_LoginTasks_Task_PurgeCompleted

Login tasks module that purges completed tasks.

Copyright 2012-2017 Horde LLC (http://www.horde.org/)

See the enclosed file LICENSE for license information (GPL). If you did not receive this file, see http://www.horde.org/licenses/gpl.

Summary

Methods
Properties
Constants
__construct()
execute()
describe()
No public properties found
No constants found
No protected methods found
No protected properties found
N/A
No private methods found
No private properties found
N/A

Methods

__construct()

__construct()

Constructor.

execute()

execute() : boolean

Purge completed tasks that were completed before the configured date.

Returns

boolean —

Whether any messages were purged from the mailbox.

describe()

describe() : string

Return information for the login task.

Returns

string —

Description of what the operation is going to do during this login.