Version 5
Back to LATEST version Our site Forum Blog

Plugin: CiviCRM

Description

This plugin enables you to insert items (one by one or by a selection on one or several categories) from CiviCRM in your Newsletters.

You can also use this plugin to automatically include your upcoming events in an Auto-newsletter or a Newsletter.

You can search in all your events and then click on one of the events to include it in your Newsletter.

If you purchased at least one of the commercial versions of AcyMailing, you can download this plugin on our plugins section, then install and publish it like a standard Joomla plugin.

Your events will look like this in your newsletter :

Plugin

You can use this interface to insert your contact's information in your newsletter by clicking on it.

You can use this interface to insert your contact's address details in your newsletter by clicking on it.

Single Event

You can use this interface to insert any event in your Newsletter.

Each event can be selected one by one.

  • Display: select the information to display with the event

  • Display pictures: you can decide to display or not the pictures in your event's description.

  • Clickable Title: make your title clickable (so linked to your online version) or not.

  • Read More: add a "read more" link at the end of the event (so linked to your online version)

  • Truncate the text after...: it will truncate the event description, keep "0" or empty if you do not want to truncate it

Upcoming Events

You can select one or several event categories and AcyMailing will automatically include the upcoming events from the selected categories when their starting date is inferior to the maximum starting date you specified.

  • Columns: display the events in one, two or more columns

  • Max. Number of items: The inserted tag will be replaced by a maximum of X events.

  • Min. Number of items: This option will only be displayed if you access this plugin for a Smart-Newsletter. AcyMailing will only generates your Smart-Newsletter if the minimum number of events found is reached.

  • Order by: order the events by ID, title, etc...

  • Maximum Starting Date: AcyMailing will only include events when their starting date is less than X days after the current time. You can define this delay using this parameter.

Filters

You can filter your AcyMailing subscribers based on CiviCRM information.

  • CiviCRM : Contact field: Select the CiviCRM field or extra field, the operator then the value. If there are less than 100 possible values, it will show a list of possible values.

  • CiviCRM : Group: Filter you subscribers depending on their CiviCRM group, nested group or smart group.

  • CiviCRM : Tag: Filter the users depending on their Civi tag.

  • CiviCRM : Contact type: You can filter your users on their contact type.

Parameters

  • Subscription: Acy imports regularly Civi users, you can specify here if you want to auto-subscribe them to some lists when imported

  • Select only allowed users: Do you want Acy to automatically select only users you're allowed to e-mail from CiviCRM ?

  • Only e-mail allowed users: If you select Yes, Acy will automatically delete not allowed CiviCRM users from the queue each time you send a Newsletter

  • Block Civi Users based on Acy users: AcyMailing can block CiviCRM users based on AcyMailing users

  • Display events: This parameter enables you to filter the list of events in the tag system

    • All events: AcyMailing will display all your events

    • Only published events: AcyMailing will only display your published events

Customize your CiviCRM event template

Customize your event using some CSS

You can change the styles used for the title and the content area by editing your AcyMailing template.

Edit the AcyMailing template used for your Newsletter and then set some styles:

  • Style for the content area will be used to encompass your event

  • Style for the content title will be applied to your event title

  • Style for the read more link will be applied to your read more link (if you have one)

  • You can also set the style of all your links using the Link a field

Set styles template

Create your own template

You can also modify the way your CiviCRM event is displayed by creating your own template which will be used to render the event. Please follow those instructions, we don't recommend you to modify the CiviCRM plugin directly otherwise your changes will be overwritten when you update the plugin.

Create a file in the folder media / com_acymailing / plugins (if the folder does not exist, please create it first). The name of the file should be civicrmevent.php If this file is available on your server, AcyMailing will use it and won't use the default one.

On this file you can access the element $varFields (which contains all the event information), the element $tag (which contains the information of the current tag used in your Newsletter) and $link (the event link)

You can insert the event information using this simple syntax : {name}, {description}, or {link}

Using all those variables, you can create your own event template.

Here is an example:

<div class="acymailing_content"><a href="{link}" target="_blank" ><h2 class="acymailing_title">{title}</h2></a>{summary}<br/>{description}<br/>From: {start_date}<br/>To: {end_date}<br/>At: {location}</div>

Last updated