EmailMarketing

Returns whether the current visitor may view the web version of a message (/community/email/{id}/)

Administrators always can. Anyone can once it has been sent to all contacts. Otherwise it must have been sent to the current contact — identified by login or by the tracking cookie set when a tracked email link is clicked.

bool

Returns the raw rows dbGetAll() would return as an iterator, without building them all into an array

The dbGetAll() counterpart of getAllIterable(), for scans over every stored row of a large table (eg: the site-wide content scans in \Framework\Developer\Refactoring). Rows are as stored - JSON fields are not decoded - and are not entity-cached. Because it bypasses getAll(), components that override getAll() are iterated; search queries and components overriding dbGetAll() are refused.

Yields EmailMarketings

Returns all the columns this component supports

array

Deletes a record from the database

Returns true if record existed and was deleted, otherwise false

Gets a record from the database

EmailMarketings

Return a set of records from the database

Array of EmailMarketings

Returns the entities getAll() would return as an iterator, without building them all into an array

For result sets too large to hold as arrays (eg: every recipient of a marketing send) - only the database driver's compact buffer of the result is held, a fraction of getAll()'s memory. Runs the same SQL as getAll(), and runs it now, as getAll() would; rows are decoded as you iterate.
Search queries are not supported, rows are not entity-cached, and components that override getAll() or dbGetAll() (eg: merging in defaults) are refused rather than iterated without their extra rows.

Yields EmailMarketings

Gets a single field from a record

mixed

Returns the number of records in the database (matching the filter if specified)

int

Returns the currently sending message id

or NULL when not currently sending

Returns a link to the currently sending message

Useful for linking to a "View Online" function inside an email.

URL of email preview

Resolve an e-mail design, falling back to the configured e-mail design or No Design.

int

Saves a record into the database

string|int

Saves a specific column of a row into a database

Performs a search

Array of EmailMarketings that match the search query.