\Components\Commerce\Affiliates \Components\Commerce\Affiliates\Administrators \Components\Commerce\Affiliates\Commissions \Components\Commerce\Affiliates\Payments \Components\Commerce\Configuration\PaymentMethods \Components\Commerce\Configuration\ShippingMethods \Components\Commerce\Discounts \Components\Commerce\Products \Components\Commerce\Products\Brands \Components\Commerce\Products\Categories \Components\Commerce\RecurringSales \Components\Commerce\RecurringSales\StoredCards \Components\Commerce\Sales \Components\Commerce\Sales\Items \Components\Commerce\Sales\Receipts \Components\Commerce\Sales\Receipts\Allocations \Components\Customers\Contacts \Components\Customers\Contacts\Relationships \Components\Customers\Contacts\Relationships\Types \Components\Customers\Groups \Components\Customers\Groups\Contacts \Components\Marketing\EmailMarketing \Components\Marketing\Events \Components\Marketing\Events\Attendees \Components\Marketing\Events\Locations \Components\Settings\Administrators \Components\Settings\Domains \Components\Website\Analytics\Sessions \Components\Website\Comments \Components\Website\Designs \Components\Website\Media \Components\Website\Pages \Components\Website\Pages\Forms \Components\Website\Posts \Components\Website\Posts\Categories \Framework\Architecture\PublicAssets \Framework\Assets\CSS \Framework\Assets\JavaScript \Framework\Caching\FileBased \Framework\Data\Util \Framework\Database\MainConnection \Framework\Date \Framework\DOM\Renderer \Framework\HTML\Converters \Framework\HTML\Highlighter \Framework\HTML\JavaScript \Framework\HTTP\Redirection \Framework\HTTP\Request \Framework\HTTP\Session \Framework\HTTP\UserAgent \Framework\I18N\CompanyTypes \Framework\I18N\Countries \Framework\I18N\Languages \Framework\Network\CIDR \Framework\Network\DNS \Framework\Network\GeoIP \Framework\Random \Framework\System\FileNames \Framework\System\FileSystem \Framework\Toasts
.
.
.
quick access
\ methods

\Components\Marketing\EmailMarketing::

Manage the set of e-mail marketing messages.

Class Methods

The following static methods are available on this class:
string configGetValue($strConfigId)
Description
Retrieves the value of a config item for the current component
Parameters
$strConfigId
string
Return
Config item value
bool delete($strKeyValue, $bDeleteMedia, $strReason)
Description
Deletes an entity and triggers the pre/post component events
Parameters
$strKeyValue
string
$bDeleteMedia
bool
$strReason
mixed
Return
bool
string generateValidBody($strPrompt)
Description
Pass this function the body text of the email, and have valid body text returned. If there is no default email design selected, then the body text is wrapped in some default markup.
Parameters
$strPrompt
mixed
Return
The body of the email, possibly wrapped in default markup if no design was selected.
array get($strKey)
Description
Returns an entity
Parameters
$strKey
mixed
Value of the primary key
{Array} getAll($arrProperties)
Description
Return all entities in the database.
Parameters
$arrProperties
mixed
Return
Array of EmailMarketing
mixed getColumn($strKey, $strColumn)
Description
Returns a single column of an entity
Parameters
$strKey
string
$strColumn
string
Return
mixed
int getCount($arrFilter)
Description
Returns a count of all rows in the data adapter
Parameters
$arrFilter
array
Return
int
int getCurrentURL()
Description
Returns a link to the currently sending message

Useful for linking to a "View Online" function inside an email.
Parameters
none
Return
or NULL when not currently sending
string mediaFolderGet($strKey)
Description
Returns the media folder for this data adapter
Parameters
$strKey
mixed
Return
Folder
mixed save($arrEntity, $strReason)
Description
Saves an entity and triggers the pre/post component events
Parameters
$arrEntity
array
$strReason
string
Return
mixed
mixed saveColumn($strKeyValue, $strColumn, $strValue, $strReason)
Description
Changes a column of an existing entity Supports primary keys spanning on several columns if passing $strKeyValue as an associative arry
Parameters
$strKeyValue
string
$strColumn
string
$strValue
string
$strReason
string
Return
Id
array search($strSearch, $arrProperties)
Description
Performs a search
Parameters
$strSearch
string
$arrProperties
mixed
Return
array

Database Fields

The following fields are used when retrieving and saving entities.
design_id
int (11)
email_message_automation_always_send
tinyint unsigned (1)
email_message_content_html
mediumtext
email_message_content_plaintext
mediumtext
email_message_content_plaintext_autogenerate
tinyint unsigned (1)
Default value: 1
email_message_content_plaintext_only
tinyint unsigned (1)
email_message_datetime
datetime
Default value: 0000-00-00 00:00:00
email_message_embed_images
tinyint unsigned (1)
email_message_from_address
varchar (255)
email_message_from_name
varchar (255)
email_message_handle_bounces
tinyint unsigned (1)
Default value: 1
email_message_id
int (11)
email_message_links_login
enum ('no','notforwarded','always')
Default value: no
email_message_links_tracked
tinyint unsigned (1)
Default value: 1
email_message_reads_tracked
tinyint unsigned (1)
Default value: 1
email_message_subject
varchar (127)
email_message_type
enum ('broadcast','autoresponder')
Default value: broadcast