JEM - Acymaiiling Plugin

Add-on name: JEM Events
Package: acym_jem.zip
Integration type: AcyMailing 10 dynamic-content add-on
Applies to: JEM 5.0.1 Beta 1 on Joomla 5.4/6 with AcyMailing 10.

Overview

The JEM Events add-on connects JEM with the AcyMailing 10 email editor. It can insert a specific JEM event into an email or generate a group of events dynamically from one or more JEM categories.

The generated email content can include the event title, date and time, venue, image, introduction and read-more link. Automatic content can be limited by category, date range, featured state and open-date status, making the add-on suitable for newsletters and recurring event campaigns.

Important migration note: This add-on replaces the former tagjem Joomla plugin for AcyMailing 5.x. Uninstall or remove the old plugin before using this version. The old AcyMailing 5 events and tag format are not used by AcyMailing 10.

Requirements

  • Joomla 5.4 or Joomla 6.
  • JEM 5.0.1 Beta 1 installed and enabled.
  • AcyMailing 10 installed and working.
  • PHP 8.3 or newer.
  • At least one published JEM event for individual insertion.
  • Published JEM categories and events for category-based insertion.

Installation

  1. Uninstall the former AcyMailing - JEM or tagjem Joomla plugin, if it is installed.
  2. Extract acym_jem.zip. The archive contains a directory named jem.
  3. Copy the complete jem directory into administrator/components/com_acym/dynamics.
  4. Confirm that the following file exists:
administrator/components/com_acym/dynamics/jem/plugin.php
  1. Open AcyMailing and edit an email.
  2. Open the dynamic-content integrations and confirm that JEM Events is available.
Expected behaviour: JEM Events is an AcyMailing dynamic-content add-on, not a Joomla content plugin. It does not need to appear in System → Manage → Plugins. Its operational interface is inside the AcyMailing email editor.

How the Integration Works

  1. The email editor creates a JEM dynamic-content tag containing the selected event or category options.
  2. When AcyMailing prepares the email, the add-on reads the matching published events from JEM.
  3. JEM formats the event date and time, while the add-on builds the event route, venue text and image path.
  4. AcyMailing applies the selected content layout, picture settings, truncation and column layout.
  5. For an automatic campaign, the event query is executed again when the campaign content is generated.

Add-on Configuration

The add-on exposes the following general settings to AcyMailing. The menu item can also be overridden for each inserted block.

OptionDefaultDescriptionRecommendation
Custom View AcyMailing standard layout Defines the HTML layout used to render a JEM event and makes JEM placeholders available to the AcyMailing custom-view editor. Start with the standard layout and create a custom view only when the newsletter requires different markup.
Hide Past Events Yes Hides completed dated events from the One by one event picker. Open-date events remain available. Keep enabled for normal newsletters. Disable only when old events must be inserted manually.
JEM Menu Item ID Empty Supplies a Joomla Itemid when the add-on creates event links. This controls the menu context, module assignment and SEF route used on the destination page. Enter the ID of a published JEM menu item when generated links use the wrong menu context.

Inserting One Event

  1. Open or create an email in AcyMailing.
  2. Add dynamic content and select JEM Events.
  3. Open the One by one tab.
  4. Optionally search by event ID, title, alias, introduction or venue.
  5. Optionally select a JEM category to narrow the event list.
  6. Select the event to insert.
  7. Choose the display and link options described below.
  8. Insert the content and verify it in the email preview.

Individual and Group Display Options

OptionDefaultDescription
Title Enabled Displays the JEM event title.
Date Enabled Displays the event start and end date/time using JEM's date formatting.
Venue Enabled Displays the venue name and, when available, its city.
Image Enabled Uses the event full image when available and otherwise falls back to the normal event image.
Description Disabled Displays the event introduction text.
Read More Enabled Adds a link to the JEM event detail page.
Clickable Title Enabled Links the title to the JEM event detail page.
Clickable Image Enabled Links the event image to the JEM event detail page.
Truncate 0 Limits the displayed description length. A value of 0 leaves it untruncated.
Display Pictures AcyMailing default Controls image placement, dimensions and handling through AcyMailing's picture options.
JEM Menu Item ID General setting or 0 Overrides the add-on's general Itemid for this inserted block.

Inserting Events by Category

The By category tab creates dynamic content from one or more JEM categories. It is useful for a block such as “Next events”, “Featured concerts” or a recurring weekly agenda.

  1. Open the JEM Events dynamic-content integration.
  2. Select the By category tab.
  3. Select one or more JEM categories. If no category is selected, all published categories can contribute events.
  4. Choose the event order, date range, open-date behaviour and featured filter.
  5. Set the maximum number of events and the column layout.
  6. Choose the same title, date, venue, image, description and link options used for individual events.
  7. Insert the generated block and test it with current JEM data.

Category and Automatic Content Options

OptionDefaultAllowed ValuesOperational Effect
Order By Date, ascending Date, title, ID or random Controls the sequence of events in the generated block.
Open-date Events Exclude Exclude, include or only Controls events whose JEM start date is empty. Only creates a block containing open-date events exclusively.
Featured Events Only No Yes or no When enabled, only events marked as featured in JEM are selected.
From Current date Date or AcyMailing relative date Sets the earliest event start date. It prevents older dated events from entering the generated block.
To Empty Date or AcyMailing relative date Optionally sets the latest permitted event start date.
Columns 1 Positive integer Splits generated event cards into the selected number of email columns.
Horizontal Padding 10 Number of pixels Sets horizontal spacing between generated event columns.
Vertical Padding 10 Number of pixels Sets vertical spacing between generated event rows.
Maximum Number of Elements 20 Positive integer Limits the number of JEM events inserted into the block.
Only Newly Created Enabled for automatic campaigns Yes or no After the first generation, limits later automatic generations to events created after the campaign was last generated.
Minimum Number of Elements 0 Zero or positive integer Stops successful automatic content generation when fewer than the required number of matching events is available.
Automatic-campaign note: The Only Newly Created and Minimum Number of Elements controls are shown by AcyMailing when the content is used in an automatic campaign. They are not needed for an ordinary one-time newsletter.

Event Selection Rules

The add-on applies the following rules when it resolves dynamic event content:

  • Only published JEM events are inserted.
  • The JEM publication start and publication end dates are respected for category-generated content.
  • Selected JEM categories are matched through the event-category relations.
  • The From date defaults to the current date for dated events.
  • The To date is optional.
  • Open-date events are controlled separately by the Open-date Events option.
  • The featured filter is applied only when Featured Events Only is enabled.
  • The Only Newly Created filter uses the JEM event creation date.

Event Links and Joomla Menu Context

The add-on first checks the JEM Menu Item ID stored in the inserted block. If it is empty, it uses the add-on's general menu item setting. If neither value is available, it asks the JEM route helper to build the event URL.

A correct Itemid is useful when the destination event page must:

  • Use a particular Joomla menu alias or SEF route.
  • Display modules assigned to a specific JEM menu item.
  • Preserve the expected template style and breadcrumb context.

Custom Layouts

AcyMailing can replace the standard event card with a custom HTML view. The main JEM placeholders are:

PlaceholderValue
{title} Full JEM event title.
{date} Formatted JEM event date/time block.
{venue} Venue name and city when available.
{description} JEM event introduction text selected for display.
{image} Path to the selected event image.
{link} Final event detail URL generated for the email.
{readmore} Complete AcyMailing read-more link markup.
{wrappedText} Description after AcyMailing truncation and wrapping.

Raw JEM event fields detected by the add-on can also be available to the custom-view editor. Prefer the documented placeholders above for layouts that should remain stable across JEM updates.

Basic Custom Layout Example

<div class="jem-newsletter-event">
  <h2><a href="/{link}">{title}</a></h2>
  {date}
  {venue}
  <div class="jem-newsletter-description">{wrappedText}</div>
  {readmore}
</div>

Common Use Cases

Single Event Announcement

  • Use One by one.
  • Enable title, date, venue, image, description and read more.
  • Use a JEM Itemid if the event page requires a particular menu context.

Weekly Upcoming Events Newsletter

  • Use By category.
  • Set From to the current date and To to seven days later.
  • Order by date ascending and set a suitable maximum number of events.
  • Exclude open-date events unless they belong in the agenda.

Featured Events Campaign

  • Select the relevant categories.
  • Enable Featured Events Only.
  • Use a two-column layout when event images are suitable for narrower cards.

Open-date Events Block

  • Set Open-date Events to Only.
  • Consider disabling the date display because these events do not have a fixed start date.
  • Use the description to explain how the reader can obtain scheduling information.

Operational Recommendations

  • Send a test email as well as checking the browser preview; email clients can render columns and images differently.
  • Keep the maximum number of generated events reasonable to avoid oversized emails.
  • Use event introduction text rather than very long descriptions in newsletters.
  • Verify that event and venue images use paths accessible from the public website.
  • Test generated links with Joomla SEF enabled and disabled if the site configuration is changing.
  • After updating AcyMailing, confirm that administrator/components/com_acym/dynamics/jem still exists and that JEM Events remains available in the editor.

Troubleshooting

ProblemPossible CauseSuggested Fix
JEM Events is not shown in AcyMailing. The directory is missing, is nested incorrectly, or JEM is not enabled. Confirm the exact path administrator/components/com_acym/dynamics/jem/plugin.php and verify that com_jem is installed and enabled.
The add-on is not listed in Joomla's Plugin Manager. This integration is an AcyMailing dynamic-content add-on, not a Joomla plugin. Look for JEM Events inside the AcyMailing email editor instead.
No events are available in One by one. No published event matches the search/category filter, or past events are hidden. Clear the filters, verify the event publication state and check the Hide Past Events setting.
An automatic block is empty. The category, date range, featured or open-date filters exclude all events. Test with all categories, no featured restriction, an empty To date and the appropriate open-date mode.
Only Newly Created returns no events. No matching event was created after the campaign's last generation time. Disable Only Newly Created when the campaign should repeat existing upcoming events.
Event links open with the wrong modules or template style. The generated route uses a different Joomla menu context. Set the JEM Menu Item ID to the ID of the intended published JEM menu item.
The event image is missing. The image option is disabled, the JEM image field is empty, or the image path is not publicly accessible. Enable Image, check the event's full/standard image and verify the file under images/jem/events.
Old tagjem tags are displayed as text. The email was created for the AcyMailing 5.x plugin. Remove the old tags and insert the content again with the AcyMailing 10 JEM Events integration.

Alternative Module Integration

JEM also includes an AcyMailing-oriented layout for the JEM Basic Module. That method remains useful when an email should reproduce a module's configured output. The JEM Events add-on is preferable when editors need to select events directly, filter categories, or generate automatic event content inside AcyMailing.

Related Documentation