expmailpreferencerow
Available since Exponential 6.0.15 (in development, not in a release yet).
Summary
One stored preference (table expmail_preference): a recipient (recipient_key 'u:<user id>' or 'a:<address hash>'), a category, its state (on, off, pending) and frequency.
Description
One stored preference (table expmail_preference): a recipient (recipient_key 'u:<user id>' or 'a:<address hash>'), a category, its state (on, off, pending) and frequency. The master switch is the row of category '_master'. No row means the category's default (or what its handler reads from older data). Use expMailPreferences.
Persistent
Yes. Table expmail_preference.
Attributes
| Attribute | Type | Static* |
|---|---|---|
| id | integer | Yes. |
| recipient_key | string | Yes. |
| user_id | integer | Yes. |
| category | string | Yes. |
| state | string | Yes. |
| frequency | string | Yes. |
| created | integer | Yes. |
| modified | integer | Yes. |
* Yes: a field of the table (a stored value); No: a function attribute, computed when it is asked for.
Source
kernel/classes/mailpreferences/expmailpreferencerow.php, expMailPreferenceRow::definition()
Added to the reference for Exponential 6.0.15: the 4.x reference had no page for this object.
Contributors
- Graham Brookins Updated
Comments
Add a comment