cjw_newsletter
Available since Exponential 6.0.15 (in development, not in a release yet).
Summary
CJW Newsletter, the newsletter system of Exponential: lists, editions and articles as content, double opt-in, sending from the cron, bounces, deliverability, statistics with consent, A/B tests, SMS and CSV import and export.
Properties
| Property | Value |
|---|---|
| Directory | extension/cjw_newsletter |
| Name | CJW Newsletter - Multi Channel Marketing |
| Version | 4.2.21 |
| License | GNU General Public License v2.0 (or any later version) |
| Website | https://github.com/se7enxweb/cjw_newsletter |
Module newsletter
File module.php @filesource
| View | Parameters | Policy | Summary |
|---|---|---|---|
| ab_test | EditionSendId | newsletter/statistics | File ab_test.php |
| approval | EditionContentObjectId, Version | - | File approval.php: approve or reject an edition. |
| archive | EditionSendHash, OutputFormatId, SubscriptionHash | newsletter/archive | File archive.php -get the stored content of newsletter edition<br> -may be parse user content<br> -newsletter / archive / ... |
| article_pool | NodeId | newsletter/editorial | File article_pool.php: pick articles from the pool for an edition. |
| article_pool_edit | ArticlePoolId | newsletter/editorial | File article_pool_edit.php: create or edit an article pool. |
| article_pool_list | - | newsletter/editorial | File article_pool_list.php: the article pools. |
| blacklist_item_add | - | newsletter/blacklist_item | File blacklist_item_add.php Add an blacklist item |
| blacklist_item_list | - | newsletter/blacklist_item | File blacklist_item_list.php |
| blacklist_item_remove | - | newsletter/blacklist_item | File blacklist_item_remove.php Removes a blacklist item |
| configure | UserHash, ConfirmAll | newsletter/configure | File configure.php Handle list settings for a user by hash |
| import_list | - | newsletter/import_list | File import_list.php |
| import_mapping | ImportId | newsletter/import_export | File import_mapping.php: map the CSV columns of an import, preview, dry run and import. |
| import_view | ImportId | newsletter/import_view | File import_view.php |
| index | - | newsletter/index | File index.php |
| interest_edit | InterestId | newsletter/rendering | File interest_edit.php: create or edit an interest. |
| interest_list | - | newsletter/rendering | File interest_list.php: the interests of the lists. |
| job | JobID | newsletter/index | File job.php |
| mailbox_edit | MailboxId | newsletter/mailbox_edit | File mailbox_edit.php Add or edit mailboxes |
| mailbox_item_list | - | newsletter/mailbox_item_list | File mailbox_item_list.php |
| mailbox_item_view | MailboxItemId | newsletter/mailbox_item_view | File mailbox_item_view.php |
| mailbox_list | - | newsletter/mailbox_list | File mailbox_list.php List all stored mailboxes. |
| mailin_address_edit | MailinAddressId | newsletter/deliverability | File mailin_address_edit.php: create or edit a mail-in address. |
| mailin_address_list | - | newsletter/deliverability | File mailin_address_list.php: the mail-in addresses of the lists. |
| migration_log | RunId | newsletter/import_export | File migration_log.php: the log of the eznewsletter migration runs. |
| o | Key, Signature | newsletter/track | File o.php |
| preview | EditionContentObjectId, VersionId, OutputFormat, SiteAccess, SkinName | newsletter/preview | File preview.php Create a preview - return text or html<br> -preview/ object_id / version_id/ outputformat/ siteaccess |
| preview_archive | EditionSendId, OutputFormat, NewsletterUserId | newsletter/preview | File preview_archive.php -get the stored content of newsletter edition<br> -may be parse user content<br> -newsletter / archive / ... |
| preview_as | NodeId, NewsletterUserId, OutputFormatId | newsletter/preview | File preview_as.php: preview an edition as a chosen subscriber. |
| r | LinkId, Key, Signature | newsletter/track | File r.php |
| report | EditionSendId | newsletter/statistics | File report.php |
| schedule_edit | ScheduleId | newsletter/editorial | File schedule_edit.php: create or edit a schedule. |
| schedule_list | - | newsletter/editorial | File schedule_list.php: the recurring sends. |
| send | NodeId | newsletter/send | File send.php |
| send_abort | EditionSendId | newsletter/send | File send_abort.php |
| settings | - | newsletter/settings | File settings.php |
| skin_preview | SkinName, OutputFormat | newsletter/rendering | File skin_preview.php: preview a skin with sample content. |
| sms_confirm | UserHash | newsletter/sms_public | File sms_confirm.php: enter the SMS confirmation code (public). |
| sms_inbound | Transport | newsletter/sms_public | File sms_inbound.php: incoming SMS of a provider (STOP keyword). |
| sms_send | NodeId | newsletter/sms | File sms_send.php: send an edition by SMS. |
| statistics_export | EditionSendId | newsletter/statistics | File statistics_export.php |
| subscribe | - | newsletter/subscribe | File subscribe.php |
| subscribe_infomail | - | newsletter/subscribe | File subscripe_infomail.php |
| subscriber_export | ListContentObjectId | newsletter/import_export | File subscriber_export.php: export the subscribers of a list as CSV. |
| subscription_list | NodeId | newsletter/subscription_list | File subscription_list.php |
| subscription_list_csvexport | NodeId | newsletter/subscription_list_csvexport | File subscription_list_csvexport.php export subscription data to csv |
| subscription_list_csvimport | NodeId, ImportId | newsletter/subscription_list_csvimport | File subscription_list_csvimport.php import csv data to a subscription list if an nl user with email of csv already exists => override ... |
| subscription_view | SubscriptionId | newsletter/subscription_view | File subscription_view.php |
| suppression_import | - | newsletter/deliverability | File suppression_import.php: CSV import into the kernel suppression list. |
| test_group_edit | TestGroupId | newsletter/deliverability | File test_group_edit.php: create or edit a test group. |
| test_group_list | - | newsletter/deliverability | File test_group_list.php: test groups of the lists. |
| throttle | - | newsletter/deliverability | File throttle.php: rate limits, batches and pauses of the transports. |
| unsubscribe | Hash | newsletter/unsubscribe | File unsubscribe.php |
| user_create | - | newsletter/user_create, newsletter/user_edit | File user_create.php create a new newsletter user - if email exists redirect to user_edit of existing newsletter user |
| user_edit | NewsletterUserId | newsletter/user_edit | File user_edit.php edit a newsletter user |
| user_list | - | newsletter/user_list | File user_list.php |
| user_remove | NewsletterUserId | newsletter/user_remove | File user_remove.php |
| user_view | NewsletterUserId | newsletter/user_view | File user_view.php |
Policy functions: admin; approve; archive; blacklist_item; configure; deliverability; editorial; import_export; import_list; import_view; index; mailbox_edit; mailbox_item_list; mailbox_item_view; mailbox_list; preview; rendering; send; settings; sms; sms_public; statistics; subscribe; subscription_list; subscription_list_csvexport; subscription_list_csvimport; subscription_list_csvimport_import; subscription_view; track; unsubscribe; user_create; user_edit; user_list; user_remove; user_view.
Source: extension/cjw_newsletter/modules/newsletter/module.php
Fetch functions
| Function | Parameters | Calls | Summary |
|---|---|---|---|
| fetch( 'newsletter', 'approval_state' ) | edition_contentobject_id, version (optional) | CjwNewsletterEditorialFetch::fetchApprovalState() | ---- end N4 fetch functions ---- 4.2.0 N2 Editorial: fetch functions {fetch( 'newsletter', 'approval_state', hash( ... |
| fetch( 'newsletter', 'article_pool_list' ) | - | CjwNewsletterEditorialFetch::fetchArticlePoolList() | {fetch( 'newsletter', 'article_pool_list', hash() )} every stored article pool |
| fetch( 'newsletter', 'article_statistics' ) | contentobject_id | CjwNewsletterStatistics::fetchArticleStatistics() | ---- end N1 fetch functions ---- 4.2.0 N4 Statistics: fetch functions {fetch( 'newsletter', 'article_statistics', hash( 'contentobject_id', ... |
| fetch( 'newsletter', 'edition_articles' ) | edition_contentobject_id | CjwNewsletterEditorialFetch::fetchEditionArticles() | {fetch( 'newsletter', 'edition_articles', hash( 'edition_contentobject_id', $id ) )} the articles taken from pools, the readable ones, in ... |
| fetch( 'newsletter', 'edition_send_item_list' ) | limit (optional), offset (optional), newsletter_user_id (optional), as_object (optional) | CjwNewsletterFunctionCollection::fetchEditonSendItemList() | {fetch('newsletter','edition_send_item_list', hash('as_object', true()))|attribute(show)} |
| fetch( 'newsletter', 'edition_send_item_list_count' ) | newsletter_user_id (optional) | CjwNewsletterFunctionCollection::fetchEditonSendItemListCount() | {fetch('newsletter','edition_send_item_list_count', hash()))|attribute(show)} |
| fetch( 'newsletter', 'import_subscription_list' ) | import_id, limit (optional), offset (optional), as_object (optional) | CjwNewsletterFunctionCollection::fetchImportSubscriptionList() | {fetch('modul1','list', hash('as_object', true()))|attribute(show)} |
| fetch( 'newsletter', 'import_subscription_list_count' ) | import_id | CjwNewsletterFunctionCollection::fetchImportSubscriptionListCount() | |
| fetch( 'newsletter', 'list_article_pool' ) | list_contentobject_id (optional) | CjwNewsletterEditorialFetch::fetchListArticlePool() | {fetch( 'newsletter', 'list_article_pool', hash( 'list_contentobject_id', $id ) )} the article pool a list uses |
| fetch( 'newsletter', 'schedule_list' ) | list_contentobject_id (optional) | CjwNewsletterEditorialFetch::fetchScheduleList() | {fetch( 'newsletter', 'schedule_list', hash( 'list_contentobject_id', $id ) )} the recurring sends (0 = of every list) |
| fetch( 'newsletter', 'send_statistics' ) | edition_send_id | CjwNewsletterStatistics::fetchSendStatistics() | {fetch( 'newsletter', 'send_statistics', hash( 'edition_send_id', $id ) )} the report of a send (totals only) |
| fetch( 'newsletter', 'subscription_list' ) | list_contentobject_id, list_contentobject_version (optional), status, limit (optional), offset (optional), as_object (optional) | CjwNewsletterFunctionCollection::fetchSubscriptionList() | {fetch('modul1','list', hash('as_object', true()))|attribute(show)} |
| fetch( 'newsletter', 'subscription_list_count' ) | list_contentobject_id, list_contentobject_version (optional), status | CjwNewsletterFunctionCollection::fetchSubscriptionListCount() | {fetch('modul1','count', hash())} |
| fetch( 'newsletter', 'test_group_list' ) | list_contentobject_id (optional) | CjwNewsletterDeliverabilityFetch::fetchTestGroupList() | ---- 4.2.0 N1 Deliverability: fetch functions {fetch( 'newsletter', 'test_group_list', hash( 'list_contentobject_id', $id ) )} the test ... |
| fetch( 'newsletter', 'user_list' ) | limit (optional), offset (optional), email_search (optional), sort_by (optional), as_object (optional) | CjwNewsletterFunctionCollection::fetchUserList() | {fetch('newsletter','user_list', hash('as_object', true()))|attribute(show)} |
| fetch( 'newsletter', 'user_list_count' ) | email_search (optional) | CjwNewsletterFunctionCollection::fetchUserListCount() | {fetch('newsletter','user_list_count', hash()))|attribute(show)} |
Template operators
| Operator | Named parameters | Class |
|---|---|---|
| cjw_newsletter_preg_replace | string_search, string_replace | CjwNewsletterOperators |
| cjw_newsletter_str_replace | string_search, string_replace | CjwNewsletterOperators |
| cjw_newsletter_variable | variable_name | CjwNewsletterOperators |
| cjwnl_abs_url | - | CjwNewsletterRenderingOperators |
| cjwnl_condition_close | - | CjwNewsletterRenderingOperators |
| cjwnl_condition_else | - | CjwNewsletterRenderingOperators |
| cjwnl_condition_open | settings (optional) | CjwNewsletterRenderingOperators |
| cjwnl_interests_block | limit (optional), heading (optional), accent (optional) | CjwNewsletterRenderingOperators |
| cjwnl_plaintext | - | CjwNewsletterRenderingOperators |
| cjwnl_rendering_data | name, param (optional) | CjwNewsletterRenderingOperators |
| cjwnl_richtext | format (optional) | CjwNewsletterRenderingOperators |
| cjwnl_text_underline | char (optional) | CjwNewsletterRenderingOperators |
| cjwnl_text_wrap | width (optional) | CjwNewsletterRenderingOperators |
Datatypes
| Type string | Name | Source |
|---|---|---|
| cjwnewsletteredition | CJW Newsletter Edition | extension/cjw_newsletter/datatypes/cjwnewsletteredition/cjwnewslettereditiontype.php |
| cjwnewsletterlist | CJW Newsletter List | extension/cjw_newsletter/datatypes/cjwnewsletterlist/cjwnewsletterlisttype.php |
| cjwnewsletterlistvirtual | CJW Newsletter List Virtual | extension/cjw_newsletter/datatypes/cjwnewsletterlistvirtual/cjwnewsletterlistvirtualtype.php |
| cjwnewslettersubscription | CJW Newsletter Subscription | extension/cjw_newsletter/datatypes/cjwnewslettersubscription/cjwnewslettersubscriptiontype.php |
Settings files
| File | Groups |
|---|---|
| extension/cjw_newsletter/settings/admininterface.ini.append.php | [SubItems] |
| extension/cjw_newsletter/settings/audit.ini.append.php | [AuditEventSettings] |
| extension/cjw_newsletter/settings/cjw_newsletter.ini | [NewsletterSettings], [NewsletterMailSettings], [BounceSettings], [DebugSettings], [NewsletterUserSettings], [NewsletterFilterSettings], [NewsletterCsvImportSettings], [ExtensionPointSettings], [DeliverabilitySettings], [ThrottleSettings], [TestSendSettings], [MailInSettings], [ScheduleSettings], [ArticlePoolSettings], [ApprovalSettings], [PlaceholderSettings], [ConditionTagSettings], [InterestSettings], [LanguageSettings], [TextViewSettings], [Skin_default], [Skin_company], [Skin_news], [Skin_shop], [NotificationCardSettings], [TrackingSettings], [ABTestSettings], [StatisticsSettings], [SmsSettings], [SmsTransport_file], [SmsTransport_http], [SmsTransport_twilio], [ImportMappingSettings], [EznewsletterImportSettings] |
| extension/cjw_newsletter/settings/collaboration.ini.append.php | [HandlerSettings] |
| extension/cjw_newsletter/settings/content.ini.append.php | [DataTypeSettings], [CustomTagSettings], [newsletter_condition] |
| extension/cjw_newsletter/settings/contentstructuremenu.ini.append.php | [TreeMenu] |
| extension/cjw_newsletter/settings/cronjob.ini.append.php | [CronjobSettings], [CronjobPart-cjw_newsletter], [CronjobPart-cjw_newsletter_mailqueue_create], [CronjobPart-cjw_newsletter_mailqueue_process], [CronjobPart-cjw_newsletter_mailbox] |
| extension/cjw_newsletter/settings/design.ini.append.php | [ExtensionSettings], [StylesheetSettings] |
| extension/cjw_newsletter/settings/extendedattributefilter.ini.append.php | [CjwNewsletterListFilter], [CjwNewsletterEditionFilter] |
| extension/cjw_newsletter/settings/icon.ini.append.php | [ClassIcons] |
| extension/cjw_newsletter/settings/kernelservices.ini.append.php | [Service_transfer.newsletter] |
| extension/cjw_newsletter/settings/mailpreferences.ini.append.php | [Category_newsletter], [SuppressionSettings], [BounceSettings], [CategorySettings], [Category_newsletter_statistics], [Category_sms] |
| extension/cjw_newsletter/settings/menu.ini.append.php | [NavigationPart], [TopAdminMenu], [Topmenu_newsletter], [MenuSettings] |
| extension/cjw_newsletter/settings/module.ini.append.php | [ModuleSettings] |
| extension/cjw_newsletter/settings/notification.ini.append.php | [NotificationEventHandlerSettings] |
| extension/cjw_newsletter/settings/override.ini.append.php | [node/view/full#cjw_newsletter_edition], [node/view/full#cjw_newsletter_list], [node/view/full#cjw_newsletter_list_virtual], [node/view/line#cjw_newsletter_edition], [admin_preview_cjw_newsletter_article] |
| extension/cjw_newsletter/settings/site.ini.append.php | [RegionalSettings], [TemplateSettings], [RoleSettings] |
| extension/cjw_newsletter/settings/template.ini.append.php | [PHP] |
| extension/cjw_newsletter/settings/websitetoolbar.ini.append.php | [CustomTemplateSettings] |
Source
extension/cjw_newsletter (extension.xml, ezinfo.php, modules/*/module.php, modules/*/function_definition.php, autoloads/eztemplateautoload.php, datatypes/, eventtypes/, settings/)
Added to the reference for Exponential 6.0.15.
Contributors
- Graham Brookins Updated
Comments
Add a comment