EmailMessagesModule Class Reference

Inheritance diagram for EmailMessagesModule:
SecurableModule Module

Public Member Functions

 getDependencies ()
 getRootModelNames ()

Static Public Member Functions

static getTranslatedRightsLabels ()
static getDefaultMetadata ()
static getPrimaryModelName ()
static getAccessRight ()
static getCreateRight ()
static getDeleteRight ()
static getDefaultDataMakerClassName ()
static getDemoDataMakerClassNames ()
static hasPermissions ()
static isReportable ()
static getLastArchivingImapDropboxCheckTime ()
static setLastArchivingImapDropboxCheckTime ($lastImapDropboxCheckTime)
static getLastBounceImapDropboxCheckTime ()
static setLastBounceImapDropboxCheckTime ($lastImapDropboxCheckTime)

Data Fields

const RIGHT_ACCESS_CONFIGURATION = 'Access Email Configuration'
const RIGHT_CREATE_EMAIL_MESSAGES = 'Create Emails'
const RIGHT_DELETE_EMAIL_MESSAGES = 'Delete Emails'
const RIGHT_ACCESS_EMAIL_MESSAGES = 'Access Emails Tab'

Static Protected Member Functions

static getLastImapDropboxCheckTimeByKey ($key)
static setLastImapDropboxCheckTimeByKey ($key, $value)
static getSingularModuleLabel ($language)
static getPluralModuleLabel ($language)

Detailed Description

Module used to manage email messages, folders, and boxes.

Definition at line 40 of file EmailMessagesModule.php.


Member Function Documentation

getDependencies (  ) 

Returns an array of the names of the the modules the module depends on. ie: if the module is enabled then those modules must be too, recursively through their dependencies.

Reimplemented from Module.

Definition at line 47 of file EmailMessagesModule.php.

getRootModelNames (  ) 

Implement in all modules that have models. The root models are the models that if they are created, then their related models are created, and so on recursively, then all of module's models will have been created, allowing RedBean to create all of the required tables and columns.

Reimplemented from Module.

Definition at line 55 of file EmailMessagesModule.php.

static getDefaultMetadata (  )  [static]

Returns the default meta data for the class. It must be appended to the meta data from the parent model, if any.

Reimplemented from Module.

Definition at line 77 of file EmailMessagesModule.php.

static getPrimaryModelName (  )  [static]

Get the primary model name for a module. Make sure to override in modules that have a Primary model otherwise the method is not supported.

Reimplemented from Module.

Definition at line 127 of file EmailMessagesModule.php.

static getAccessRight (  )  [static]

Override if the module has a right that determines if a user can access the module tab/subtabs in the user interface.

Returns:
null or access right

Reimplemented from SecurableModule.

Definition at line 132 of file EmailMessagesModule.php.

static getCreateRight (  )  [static]

Override if the module has a right that determines if a user can create the models in this modules

Returns:
null or access right

Reimplemented from SecurableModule.

Definition at line 137 of file EmailMessagesModule.php.

static getDeleteRight (  )  [static]

Override if the module has a right that determines if a user can delete the models in this modules

Returns:
null or access right

Reimplemented from SecurableModule.

Definition at line 142 of file EmailMessagesModule.php.

static getDefaultDataMakerClassName (  )  [static]

Override in modules that create default data during an installation.

Reimplemented from Module.

Definition at line 147 of file EmailMessagesModule.php.

static getDemoDataMakerClassNames (  )  [static]

Override in modules that create demo data during an installation.

Reimplemented from Module.

Definition at line 152 of file EmailMessagesModule.php.

static hasPermissions (  )  [static]

Override and set to true if the module has a model that utilizes permissions.

Reimplemented from SecurableModule.

Definition at line 157 of file EmailMessagesModule.php.

static isReportable (  )  [static]

Override in modules that are reportable in the reporting module

Reimplemented from Module.

Definition at line 162 of file EmailMessagesModule.php.

static getSingularModuleLabel ( language  )  [static, protected]

Override in all children modules to ensure proper availability of module labels in the translation system. If the override is not available, then it will generate a label as a last resort.

Parameters:
string $language
Returns:
string - singular module label.

Reimplemented from Module.

Definition at line 200 of file EmailMessagesModule.php.

static getPluralModuleLabel ( language  )  [static, protected]

Override in all children modules to ensure proper availability of module labels in the translation system If the override is not available, then it will generate a label as a last resort.

Parameters:
string $language
Returns:
string - plural module label

Reimplemented from Module.

Definition at line 205 of file EmailMessagesModule.php.


The documentation for this class was generated from the following file:
 All Data Structures Functions Variables
Generated on Wed Nov 22 07:10:24 2017