\Marketing\EmailMarketing
Templating
Global Functions
Website
\Components\Website\Designs \Components\Website\Media \Components\Website\Pages \Components\Website\Pages\Forms \Components\Website\Posts \Components\Website\Posts\Categories
Customers
\Components\Customers\Contacts \Components\Customers\Contacts\Relationships \Components\Customers\Contacts\Relationships\Types \Components\Customers\Groups
Marketing
\Components\Marketing\EmailMarketing
DESCRIPTION
METHODS
delete()
get()
getAll()
getColumn()
getCount()
getCurrentId()
getCurrentURL()
save()
saveColumn()
search()
\Components\Marketing\Events \Components\Marketing\Events\Attendees \Components\Marketing\Events\Categories \Components\Marketing\Events\Locations
Commerce
\Components\Commerce\Carts \Components\Commerce\Carts\Current \Components\Commerce\Configuration\PaymentMethods \Components\Commerce\Configuration\ShippingMethods \Components\Commerce\Discounts \Components\Commerce\Products \Components\Commerce\Products\Brands \Components\Commerce\Products\Categories \Components\Commerce\Products\Inventory \Components\Commerce\Sales \Components\Commerce\Sales\Items \Components\Commerce\Sales\Receipts \Components\Commerce\Sales\Receipts\Allocations
Settings
\Components\Settings\Administrators \Components\Settings\CustomFields \Components\Settings\Domains
Other Apps
\Components\Website\Comments \Components\Commerce\Affiliates \Components\Commerce\Affiliates\Administrators \Components\Commerce\Affiliates\Commissions \Components\Commerce\Affiliates\Payments \Components\Commerce\RecurringSales \Components\Commerce\RecurringSales\StoredCards
Framework
\Framework\Caching \Framework\Data\Util \Framework\DOM\CurrentContext \Framework\HTML\Bleacher \Framework\HTML\Converters \Framework\HTTP\Cookies \Framework\HTTP\Redirection \Framework\HTTP\Request \Framework\HTTP\Session \Framework\HTTP\UserAgent \Framework\I18N\CompanyTypes \Framework\I18N\Countries \Framework\I18N\Languages \Framework\Network\GeoIP

EmailMarketing

Use this API to create, update and delete e-mail marketing messages.

Methods

Invoke via \Components\Marketing\EmailMarketing::method()
Click a method name to copy it.
bool delete($iEmailMessageId, $bDeleteMedia)
Deletes a record from the database
Parameters
$iEmailMessageId
int
A record's email_message_id
$bDeleteMedia
mixed
Return
Returns true if record existed and was deleted, otherwise false
array get($iEmailMessageId)
Gets a record from the database
Parameters
$iEmailMessageId
int
A record's email_message_id
Return
EmailMarketings
array getAll($arrQuery)
Return a set of records from the database
Parameters
$arrQuery
mixed
Return
Array of EmailMarketings
mixed getColumn($iEmailMessageId, $strColumn)
Gets a single field from a record
Parameters
$iEmailMessageId
int
A record's email_message_id
$strColumn
mixed
Return
mixed
int getCount($arrFilter)
Returns the number of records in the database (matching the filter if specified)
Parameters
$arrFilter
mixed
Return
int
int getCurrentId()
Returns the currently sending message id
Return
or NULL when not currently sending
string getCurrentURL()
Returns a link to the currently sending message

Useful for linking to a "View Online" function inside an email.
Return
URL of email preview
string|int save($arrEntity)
Saves a record into the database
Parameters
$arrEntity
mixed
Return
string|int
void saveColumn($iEmailMessageId, $strColumn, $strValue)
Saves a specific column of a row into a database
Parameters
$iEmailMessageId
int
A record's email_message_id
$strColumn
mixed
$strValue
mixed
array search($strSearch, $arrQuery)
Performs a search
Parameters
$strSearch
mixed
$arrQuery
mixed
Return
Array of EmailMarketings that match the search query.

Database Fields

The following fields are used when retrieving and saving entities.
email_message_id
int (11)
email_message_type
Default value: broadcast
email_message_datetime
datetime
Default value: current_timestamp()
email_message_subject
string (127)
email_message_content_html
string (4294967295)
email_message_content_plaintext
string (4294967295)
email_message_content_plaintext_only
0 or 1
email_message_content_plaintext_autogenerate
0 or 1
Default value: 1
email_message_from_address
string (255)
email_message_from_name
string (255)
email_message_reads_tracked
0 or 1
Default value: 1
email_message_links_tracked
0 or 1
Default value: 1
email_message_links_login
Default value: no
email_message_handle_bounces
0 or 1
Default value: 1
email_message_automation_always_send
0 or 1
design_id
int (11)