Class Newsletter

Single Newsletter Item

cGenericDb

Item

Newsletter

Package: Plugin\Newsletter
Copyright: four for business AG <www.4fb.de>
License: http://www.contenido.org/license/LIZENZ.txt
Author: Bjoern Behrens
Located at plugins/newsletter/classes/class.newsletter.php

Methods summary
`public`	# `__construct( mixed $mId = false )` Constructor Function Constructor Function Parameters `$mId` `mixed` $mId Specifies the ID of item to load Throws `cInvalidArgumentException` If table name or primary key is not set Overrides `Item::__construct()`
`public boolean`	# `store( )` Overriden store()-Method to set modified and modifiedby data and to ensure, that there is only one welcome newsletter Overriden store()-Method to set modified and modifiedby data and to ensure, that there is only one welcome newsletter Returns `boolean` Overrides `Item::store()`
`public boolean`	# `setField( string $name, mixed $value, boolean $bSafe = true )` Userdefined setter for newsletter fields. Userdefined setter for newsletter fields. Parameters `$name` `string` $name `$value` `mixed` $value `$bSafe` `boolean` $bSafe Flag to run defined inFilter on passed value Returns `boolean` Overrides `Item::setField()`
`public`	# `_replaceTag( string & $sCode, boolean $bIsHTML, string $sField, string $sData )` Replaces newsletter tag (e.g. MAIL_NAME) with data. If code is just text using str_replace; if it is HTML by using regular expressions Replaces newsletter tag (e.g. MAIL_NAME) with data. If code is just text using str_replace; if it is HTML by using regular expressions Parameters `$sCode` `string` $sCode Code, where the tags will be replaced (by reference) `$bIsHTML` `boolean` $bIsHTML Is code HTML? `$sField` `string` $sField Field name, without MAIL_ (e.g. just "name") `$sData` `string` $sData Data
`protected`	# `_getNewsletterTagData( mixed $sHTML, mixed $sTag )`
`protected`	# `_deChunkHTTPBody( mixed $sHeader, mixed $sBody, mixed $sEOL = "\r\n" )`
`public string`	# `getHTMLMessage( )` If newsletter is HTML newsletter and necessary data available returns final HTML message If newsletter is HTML newsletter and necessary data available returns final HTML message Returns `string` HTML message
`public boolean`	# `htmlArticleExists( )` Checks, if html newsletter article still exists Checks, if html newsletter article still exists Returns `boolean`
`public`	# `sendEMail( integer $iIDCatArt, string $sEMail, string $sName = "", boolean $bSimulatePlugins = true, string $sEncoding = "iso-8859-1" )` Sends test newsletter directly to specified email address Sends test newsletter directly to specified email address Parameters `$iIDCatArt` `integer` $iIDCatArt idcatart of newsletter handler article `$sEMail` `string` $sEMail Recipient email address `$sName` `string` $sName Optional: Recipient name `$bSimulatePlugins` `boolean` $bSimulatePlugins If recipient plugin activated, include plugins and simulate values from plugins `$sEncoding` `string` $sEncoding Message (and header) encoding, e.g. iso-8859-1
`public`	# `sendDirect( integer $iIDCatArt, integer $iIDNewsRcp = false, integer $iIDNewsGroup = false, array & $aSendRcps, string $sEncoding = "iso-8859-1" )` Sends test newsletter directly to specified recipients (single or group) Sends test newsletter directly to specified recipients (single or group) Note: Sending in chunks not supported! Only usable for tests and only a few recipients. Parameters `$iIDCatArt` `integer` $iIDCatArt idcatart of newsletter handler article `$iIDNewsRcp` `integer` $iIDNewsRcp If specified, newsletter recipient id, ignored, if group specified `$iIDNewsGroup` `integer` $iIDNewsGroup If specified, newsletter recipient group id `$aSendRcps` `array` $aSendRcps As reference: Filled with a list of succesfull recipients `$sEncoding` `string` $sEncoding Message (and header) encoding, e.g. iso-8859-1

Methods inherited from Item
`_inFilter(), _loadByWhereClause(), _onLoad(), _resetItem(), _setMetaObject(), deleteProperty(), deletePropertyById(), get(), getField(), getMetaObject(), getProperty(), loadBy(), loadByMany(), loadByPrimaryKey(), loadByRecordSet(), outFilter(), set(), setFilters(), setProperty(), toArray(), toObject()`

Methods inherited from cItemBaseAbstract
`__get(), __set(), _getPropertiesCollectionInstance(), _getSecondDBInstance(), _setLoaded(), _setPrimaryKeyName(), escape(), getPrimaryKeyName(), isLoaded()`

Methods inherited from cGenericDb
`_executeCallbacks(), register(), unregister()`

Constants inherited from cGenericDb
`CREATE_BEFORE, CREATE_FAILURE, CREATE_SUCCESS, DELETE_BEFORE, DELETE_FAILURE, DELETE_SUCCESS, STORE_BEFORE, STORE_FAILURE, STORE_SUCCESS`

Properties summary
`public string`	`$_sError`		# Error storage Error storage

Properties inherited from Item
`$_arrInFilters, $_arrOutFilters, $_lastSQL, $_metaObject, $modifiedValues, $oldPrimaryKey, $values`

Properties inherited from cItemBaseAbstract
`$_className, $_loaded, $_oCache, $_primaryKeyName, $_settings, $db, $lasterror, $properties, $secondDb, $table`

Packages

Classes

Class Newsletter

Parameters

Throws

Overrides

Returns

Overrides

Parameters

Returns

Overrides

Parameters

Returns

Returns

Parameters

Parameters