EmailMessage Class Reference

Inheritance diagram for EmailMessage:
OwnedSecurableItem MashableActivityInterface SecurableItem Item CustomFieldsModel RedBeanModel BeanModel ObservableComponent

Public Member Functions

 __toString ()
 hasSendError ()

Static Public Member Functions

static getMashableActivityRulesType ()
static getAllByFolderType ($type, $excludePausedCampaignMessages=false)
static getByFolderType ($type, $count=null, $excludePausedCampaignMessages=false)
static getByFolderTypeAndCampaignId ($type, $campaignId, $count=null)
static getModuleClassName ()
static canSaveMetadata ()
static getDefaultMetadata ()
static isTypeDeletable ()
static hasReadPermissionsOptimization ()
static hasRelatedItems ()

Protected Member Functions

 afterDelete ()

Static Protected Member Functions

static getModifiedSignalAttribute ()
static translatedAttributeLabels ($language)
static getLabel ($language=null)
static getPluralLabel ($language=null)

Protected Attributes

 $isAudited = false

Detailed Description

Model for storing an email message.

Definition at line 40 of file EmailMessage.php.


Member Function Documentation

__toString (  ) 

Returns the displayable string for the class. Should be overridden in any model that can provide a meaningful string representation of itself.

Returns:
A string.

Reimplemented from RedBeanModel.

Definition at line 118 of file EmailMessage.php.

static getModifiedSignalAttribute (  )  [static, protected]
See also:
OwnedSecurableItem::getModifiedSignalAttribute()
Returns:
string

Reimplemented from OwnedSecurableItem.

Definition at line 131 of file EmailMessage.php.

static canSaveMetadata (  )  [static]

By default models cannot save their metadata, allowing them to be loaded quickly because the loading of of metadata can be avoided as much as possible. To make a model able to save its metadata override this method to return true. PUT it before the getDefaultMetadata in the derived class.

Reimplemented from RedBeanModel.

Definition at line 141 of file EmailMessage.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 OwnedSecurableItem.

Definition at line 146 of file EmailMessage.php.

static isTypeDeletable (  )  [static]

To be overriden on intermediate derived classes to return false so that deletes are not done on intermediate classes because the object relational mapping will not clean up properly. For example if User is a Person, and Person is a RedBeanModel delete should be called only on User, not on Person. So User must override isDeletable to return false.

Reimplemented from OwnedSecurableItem.

Definition at line 211 of file EmailMessage.php.

afterDelete (  )  [protected]

This method is invoked after deleting a record. The default implementation raises the onAfterDelete event. You may override this method to do postprocessing after the record is deleted. Make sure you call the parent implementation so that the event is raised properly.

Reimplemented from RedBeanModel.

Definition at line 216 of file EmailMessage.php.

static hasReadPermissionsOptimization (  )  [static]

Override on any models you want to utilize ReadPermissionsOptimization

Reimplemented from SecurableItem.

Definition at line 226 of file EmailMessage.php.

static getLabel ( language = null  )  [static, protected]

Returns the display name for the model class.

Parameters:
null | string $language
Returns:
dynamic label name based on module.

Reimplemented from RedBeanModel.

Definition at line 261 of file EmailMessage.php.

static getPluralLabel ( language = null  )  [static, protected]

Returns the display name for plural of the model class.

Parameters:
null | string $language
Returns:
dynamic label name based on module.

Reimplemented from RedBeanModel.

Definition at line 271 of file EmailMessage.php.


The documentation for this class was generated from the following file:
 All Data Structures Functions Variables
Generated on Wed Dec 11 07:10:58 2019