# AcyMailing 5 documentation

Here is the old documentation for AcyMailing 5.

For an updated version, select the latest version at the top-left of the screen:

![](/files/TwQ1M45anAN0Re04OF1I)


# Users

## Description <a href="#description" id="description"></a>

This screen enables you to manage all your users.

You can sort your users by any field, search using the "filter" box and directly modify some properties by clicking on the icons.

By default, this listing is ordered by created date so that you can directly see the latest users on your website.

![](/files/-MJSARA1zqZnXezd9Yuo)

User Listing Toolbar

* **Action :** Enables you to apply actions on the selected users of the current listing view.
* **Import :** Enables you to import users in AcyMailing from other components or from a CSV file.
* **Export** : Enables you to export users from AcyMailing based on some filters.
* **New** : Enables you to create a new user and subscribe him to one or several Mailing Lists.
* **Edit** : Select a user and then click on this button to edit his information or his subscription.
* **Delete** : Select one or several users and click on this button in order to completely delete the user and all his subscription.
* **Help** : This button enables you to turn ON/OFF the help section, this screen will appear or disappear.

## Column Headers <a href="#column-headers" id="column-headers"></a>

![](/files/-MJSAUB0eB9XtnQzLBoT)

User Listing Columns

* **#** : An indexing number automatically assigned for ease of reference.
* **Checkbox** : Check this box to select one or more items. To select all items, check the box in the column heading. Then, you can delete the selected users by clicking on the Delete button or apply actions by clicking on the Actions button.
* **Name** : Name of the user
* **E-mail** : E-mail of the user
* **Subscription** : This column displays the subscription of the user. Each list will be represented by a colored circle (each list has its own colour so that you can easily identify it). A plain circle indicates the user is subscribed, a blank circle with a colored border an unsubscribed user, a hatched circle is a pending one (which means the user is still not confirmed). If there is no circle for a user, that means this user is neither subscribed, nor unsubscribed from the list. You can click on each circle in order to change the status of the subscription (if you click on a plain circle, the user will be unsubscribed from the list). *This column was only available for our Business and Enterprise editions. We added it to our Starter and Essential editions since AcyMailing 1.6.0.*
* **Created Date** : Indicates the created date of the user in the database.
* **Receive HTML** : Your users can have the option to receive html or not. A user who accepted to receive HTML will be able to see pictures and styles in the e-mail. A user who accepts only text messages will only see text in the e-mail.
* **Confirmed** : This field indicates if the user has been confirmed or not (did he clicked on the confirmation e-mail or not?). If you don't require a confirmation (this option can be modified in the AcyMailing configuration page), this field has absolutely NO IMPACT on the send process. But if you require a confirmation, only confirmed users will receive e-mails.
* **Enabled** : In some cases, you want to "black list" some users. This fields enables you to disable a user so that this user won't receive messages any more.
* **J! user ID** : If the user is a registered user, this field indicates the ID of the Joomla User. You can click on this ID to edit the user in Joomla.
* **ID** : This field indicates the ID of the user in the AcyMailing table.

## Filters <a href="#filters" id="filters"></a>

![](/files/-MJSAWtyawdTM6ywtB57)

User Listing Filters

* The filters enable you to filter the users displayed on this listing.
* The first filter enabled you to select users based on their subscription or based on some properties. This second filter will be replaced by another one if you select a specific list.
* The second filter enables you to select only users which are subscribed (or unsubscribed / in pending process) of a specific list / list category.


# Export Users

## Description <a href="#description" id="description"></a>

This screen enables you to export your users to a CSV file.

![](/files/-MJSAclmYgH3zTGlVNSP)

Toolbar

* **Export** : Export the selected users to a file.
* **Cancel** : Go back to the users Management
* **Help** : This button enables you to turn ON/OFF the help section, this screen will appear or disappear.

## Fields <a href="#fields" id="fields"></a>

AcyMailing does not impose you the exporting format but gives you the possibility to select the fields you want to export.

By default, the fields "email","name","confirmed" and "html" will be selected so that the exported file will be :

email,name,confirmed,html This email address is being protected from spambots. You need JavaScript enabled to view it.,myname,1,1 This email address is being protected from spambots. You need JavaScript enabled to view it.,myname2,1,0 ...

If you use special characters, you may want to modify the exporting format. The data in your database are encoded in UTF-8, that's why we export in UTF-8 by default but if you see weird characters in your exported file, please select your own encoding format.

![](/files/-MJSAffU9d1whpSSe4lb)

Fields

## Lists <a href="#lists" id="lists"></a>

You can select here the lists you want to export. If you choose **"No All Users**" for the filter "**Only Users subscribed to at least one of the selected lists"**, the selection of the lists done here won't be taken in account and all your users will be exported.

You can click on a category name to automatically select all the related lists.

![](/files/-MJSAne8LFoXHsrNFN-j)

Export Lists

## Filters <a href="#filters" id="filters"></a>

This area enables you to apply some filters so that you can export only the users you want.

![](/files/-MJSApy_ylkGxnJj6jTb)

Filters

* **Only Users subscribed to at least one of the selected lists** : if you select "Yes", please make sure you selected at least one list so that users subscribed to at least one of the selected lists will be exported.
* **Only Registered Users (Joomla Users)** : If you select "Yes", only Joomla registered users will be exported, simple visitors won't be exported.
* **Only Confirmed Users** : If you select "Yes", only confirmed users will be exported.
* **Only Enabled Users** : If you select "Yes", only enabled users will be exported.


# Import Users in AcyMailing

## Description <a href="#description" id="description"></a>

This screen enables you to import users from different sources.

AcyMailing keeps track of the subscription of your users and of their unsubscription! This way, even if you try to import twice the same users, AcyMailing will take care of the duplicate entries and won't subscribe an unsubscribed user again. Nevertheless, if you import the users to a newly created list, all the imported users will be subscribed to this list! You can still remove some users in mass based on their subscription status using the screen "Subscribe Users" from the Lists management.

If you want to subscribe users in mass to your Mailing Lists using filters, you should go to the screen "Subscribe Users" from the Lists Management.

## How to access this screen <a href="#how-to-access-this-screen" id="how-to-access-this-screen"></a>

![](/files/-MJSB7MfI-IGVc5wekx6)

Import access

* Go on the AcyMailing users management
* Click on the button "**Import**"

![](/files/-MJSBA1GyOaMnvsJx1_9)

Toolbar

* **Import :** If you click on this button, the users will be imported based on the options you chose.
* **Cancel** : Return to the Users management listing.
* **Help** : This button enables you to turn ON/OFF the help section, this screen will appear or disappear.

## Source <a href="#source" id="source"></a>

![](/files/-MJSBCW9A68kHdem8qDZ)

Source

* **Text Area** : Instead of uploading a file, you can directly copy/paste your contacts in an input box and let AcyMailing import them.
* **File** : Import your users from a CSV or a text file.
* **Joomla Users** : Synchronise/Import your Joomla Users.
* **com\_contact** : Import your users from com\_contact. AcyMailing will import each contact using the name and e-mail specified in the contact manager.
* **Database** : If you have a table in your database with a list of users you would like to use, you can import them in AcyMailing
* **Acajoom** : Import your users from Acajoom You also have the possibility to import the Acajoom Mailing Lists in order to keep the subscription of your Acajoom users.
* **ccNewsletter** : Import your ccNewsletter Users
* **Communicator** : Import your Communicator Users
* **jNews** : Import your users from jNews You will see options to not only import your users from jNews but also import the jNews lists and Newsletters so you can easily migrate from jNews to AcyMailing.
* **Vemod News Mailer**: Import your users from Vemod News Mailer
* **Letterman** : Import your Letterman Users
* **Yanc** : Import your users from Yanc. You also have the possibility to import the Yanc Mailing Lists in order to keep the subscription of your Yanc users.
* **CiviCRM** : Import your users from CiviCRM.
* **ZohoCRM** : Import your users from ZohoCRM.

You won't see all those options on your interface but only the components installed on your website. So if you start with AcyMailing and didn't install any other component, the available choices will be to import data from a file, a textarea, database, com\_contact, your Joomla Users or ZohoCRM. Only the database tables of the other component will be necessary... so if you moved your website to another server, you can copy your old component tables to see the import option.

## Lists <a href="#lists" id="lists"></a>

![](/files/-MJSBF5nsiWKSM6E2vD6)

Lists

AcyMailing will import users... Those imported users will be subscribed or unsubscribed to the selected lists.

AcyMailing keeps track of the unsubscription status of the user so that even if you import twice the same users on your lists, AcyMailing won't subscribe users who already unsubscribed.

No welcome message, nor confirmation message will be sent during this import.

If you created a follow-up campaign assigned to a list, you will see the "Subscribe + Campaign" option and if you select it, Acy will subscribe the user to your list and also trigger the campaign for the imported users.

## Text Area <a href="#text-area" id="text-area"></a>

![](/files/-MJSBHKzUHI-H55QwFKq)

Textarea import

This option enables you to directly write a series of e-mail addresses in addition to as many fields as you want in this input and import them in AcyMailing. That will enable you to avoid any access rights or encoding issue you may have with the file import function.

Once you filled in the text area with your users data, click on the "Import" button, you will get to [the second import page](/old/main-pages/users/import-users-in-acymailing#second-import-page) where you will find all the import options.

## File <a href="#file" id="file"></a>

![](/files/-MJSBJwOx-d9XB27G0R_)

Import File

You can browse a CSV file to import it.

The first line of your CSV file can indicate AcyMailing the name of the fields to import (column names of the #\_\_acymailing\_subscriber table from the database if you want AcyMailing to assign them correctly). For example, if your file contains a list of users with the format "email,name,confirmed", this first line of your file should be "email,name,confirmed" (always in English).

If your file contains a list of e-mails (one per line!) and no extra information, simply add the string "email" at the top of your file and import it.

If you are not sure about your column names, simply try to upload your file and AcyMailing will allow you to assign the columns to the right Acy fields.

AcyMailing does not impose any CSV format and is able to import files with any kind of separator.

For the field ***confirmed***, the values should be 0 (for not confirmed) or 1 (for confirmed). If you don't specify this column in your file, the default value is 0 (not confirmed). For the field ***html***, the values should be 0 (receive Text) or 1 (receive HTML). If you don't specify this column in your file, the default value is 1 (receive HTML).

*Example:*

name,email john,joh&#x6E;*@*&#x65;xample.com adrien,adrie&#x6E;*@*&#x65;xample.com mike,mik&#x65;*@*&#x65;xample.com

If you have an excel file with all your contacts, simply add a new line at the top to indicate the column name (email, name...) and then save your file in a CSV format (Save as -> CSV). Then import your CSV file in AcyMailing. You can open your file with a text editor (notepad for example) to check if your file has the right format.

In some cases you want to import users and individually subscribe them to some lists. In that case you can add a column called listids in your import file. If you do so, you can then specify the ids of the AcyMailing lists you want the user to be subscribed to during the import.

*Example:* name,email,listids Adrien,This email address is being protected from spambots. You need JavaScript enabled to view it.,3 John,This email address is being protected from spambots. You need JavaScript enabled to view it.,8-4

So Adrien will be subscribed to list ID 3 and John will be subscribed to lists ID 8 and 4. If you want to subscribe them all to the same list, please remember you don't have to use this extra parameter!

You can also add a column called "listname" in your import file. If you do so, you can then specify the name of the AcyMailing lists you want the user to be subscribed to during the import. If the list doesn't exist yet, it will be automatically created.

*Example:* name,email,listname Adrien,This email address is being protected from spambots. You need JavaScript enabled to view it.,My list A John,This email address is being protected from spambots. You need JavaScript enabled to view it.,My list B - My new list C

So Adrien will be subscribed to list A and John will be subscribed to lists B and C. As the list C didn't exist yet, AcyMailing created it.

Once you selected your file, click on the "Import" button, you will get to [the second import page](/old/main-pages/users/import-users-in-acymailing#second-import-page) where you will find all the import options.

## Second import page <a href="#second-import-page" id="second-import-page"></a>

![](/files/-MJSBRevmyYjpPh5vuUQ)

Assign columns

You will first have to assign (if it's not already done) the columns of your data taken from the text area/imported file.

You can either assign a column to an Acy field/custom field or create a new custom field with on column's values (only in AcyMailing Enterprise). You can also ignore some imported columns. If you have more than 5 imported columns, you will see a button below "Assign columns" that enables you to ignore all unassigned columns.

![](/files/-MJSBUbEwDEc-icg7C2V)

Params

* **File Charset**: We recommend you to import an utf-8 file but if you import another format, you can let AcyMailing handle the conversion in which case you should specify the encoding format of your imported file/text area data.
* **Import the user as confirmed**: If you require a confirmation in AcyMailing, then this option will be displayed if you try to import a file so you can decide if you want your users to be imported as confirmed users (so you will be able to send them an e-mail) or if you want the users to be imported as unconfirmed, in which case you could then send a confirmation e-mail to your unconfirmed users.
* **Auto-generate user's name**: If you import a file and the name field is empty, AcyMailing can automatically generate a name for each user (based on its e-mail address).
* **Import users as blocked**: You can choose to import the users as blocked or not.
* **Overwrite existing user's information**: By default (option turned OFF), if the user already exists (based on its e-mail address), the user information won't be updated. If you turn ON that option, the user's data will be updated so for example if you import a file including an existing user (same e-mail address) but with a new name, the user's name will be updated in AcyMailing.

Once you selected the options and assigned the columns as you want, click again on the "Import" button to import your users.

## Joomla Users <a href="#joomla-users" id="joomla-users"></a>

![](/files/-MJSBXYmqYPqwtkuvOIW)

Import Joomla Users

Using this option, AcyMailing will not only add your Joomla Users in the list of AcyMailing users, it will also synchronize its data based on the Joomla Users data.

This operation is already done during the install so you should not have to do it again. If you want your users to be automatically added in AcyMailing and subscribed to one or several lists during their Joomla registration process, please configure the Joomla User Synchronization plugin.

![](/files/-MJSBZl7yFHW9bfCTAJ0)

com\_contact import

You can import your contacts from the default Joomla contact component in AcyMailing.

The name and e-mail of the contact specified in the com\_contact component will be added in AcyMailing as a new user.

## Database <a href="#database" id="database"></a>

Using this option, you will be able to import your contacts from any other table in your database.

![](/files/-MJSBbojFJndbiZeel6C)

Database import

* **Table Name** : You should specify in this field the name of the table you want to import
* **email** : This fields is a required field for the import process, you should specify the name of the column which contains e-mail addresses in your other table.
* **name** : If the other table contains the name of the user, you can import it as well. This field is not mandatory.
* .... you will be able to specify an equivalent for all your other fields but they are not mandatory.

### Import from HikaShop <a href="#import-from-hikashop" id="import-from-hikashop"></a>

HikaShop uses the standard Joomla User table so you can use our default user plugin to display the lists on the HikaShop registration page and the user will be automatically subscribed to AcyMailing.

Nevertheless, if you use HikaShop without using the Joomla registration process, then the user won't have account and won't be added to your Joomla User table... so he won't be automatically added to AcyMailing.

You can nevertheless use this AcyMailing database import to import all your users from HikaShop to AcyMailing regardless of the fact they have an account on Joomla or not.

> * Table Name : #\_\_hikashop\_user
> * email: user\_email
> * name : column name of the custom user field in hikashop (not required)

### Import from Prestashop <a href="#import-from-prestashop" id="import-from-prestashop"></a>

If Joomla and Prestahop are installed on the same database, you can import your Prestashop users using the parameters:

> * Table Name: ps\_customer
> * email: email
> * name: firstname

![](/files/-MJSBecRLmwB-n1S6RJA)

Import Prestashop

If Prestashop is not installed on the same database but your Joomla website is able to access this database, you can specify the table name: prestashopdatabase.ps\_customer

### Import from phpFox <a href="#import-from-phpfox" id="import-from-phpfox"></a>

If Joomla and phpFox are installed on the same database, you can import your phpFox users using the parameters:

> * Table Name: phpfox\_user
> * email: email
> * name: user\_name

### Import from phpBB <a href="#import-from-phpbb" id="import-from-phpbb"></a>

If Joomla and phpBB are installed on the same database, you can import your phpBB users using the parameters:

> * Table Name: phpbb\_users
> * email: user\_email
> * name: username

![](/files/-MJSBnrYsT8QsFoixKNe)

## Acajoom <a href="#acajoom" id="acajoom"></a>

![](/files/-MJSBrji4gXb7m3_bi6R)

Import from Acajoom

Acajoom, like AcyMailing, handles multiple Mailing List management. So, in order to not lose the subscription state of your Acajoom Users, we created a process enabling you to import your Acajoom lists in AcyMailing and keep the subscription state of each user. This way, you can safely move from Acajoom to AcyMailing without losing data.

If you select the option "Import the Acajoom Lists too", AcyMailing will re-create your Acajoom Mailing Lists in AcyMailing.

## ZohoCRM <a href="#zohocrm" id="zohocrm"></a>

If you use ZohoCRM as your customer relationship manager, you can import your users from ZohoCRM to subscribe them to your AcyMailing lists and start sending messages to your contacts.

* **Import the users as confirmed**: If you require a confirmation in AcyMailing, then this option will be displayed so you can decide if you want your users to be imported as confirmed users (so you will be able to send them an e-mail) or if you want the users to be imported as unconfirmed, in which case you could then send a confirmation e-mail to your unconfirmed users.
* **Overwrite existing user‘s information**: If you set it to "yes" and you modified your contacts via ZohoCRM then your contacts will also be updated in AcyMailing.
* **Delete users**: This option will delete the users which are no longer in your ZohoCRM contacts. Only users previously imported from ZohoCRM will be deleted.
* **Auth token**: You should enter here your auth token that you can generate on your ZohoCRM account:
  1. Log in to Zoho CRM
  2. Open **\[Username]** > **My Zoho Account**
  3. In the *My Zoho Account* page, click **Active Authtokens** In this page, you can also **Remove** or **Regenerate** Auth Tokens.
* **Fields**: You can attach ZohoCRM fields to AcyMailing ones. It will be useful if you created extra fields in AcyMailing. By default the first name in ZohoCRM is saved in the name field of Acymailing.
* **Lists**: For each type of user in ZohoCRM you should select an Acymailing list where all the users will be subscribed to. If you don't select an AcyMailing list for one ZohoCRM contact type, users belonging to that contact type won't be imported in AcyMailing.
* **Subscribe the imported users to**: All the users who have been imported from ZohoCRM will be subscribed in this list.

## Facebook leads <a href="#facebook-leads" id="facebook-leads"></a>

If you created some ads on Facebook, you can use this option to import the users.

![](/files/-MJSBvDfGzA5jogaUAmN)

FB leads import

* **App access token**: You can generate a new access token on [this page](https://developers.facebook.com/tools/accesstoken/). By default, Facebook generates a short time token, click on the appearing "Debug" button to extend your token's lifetime.

![](/files/-MJSC30QnBczUe7IdWnN)

* If some permissions are missing on the token you generated, you can go on the following page to manage them: <https://developers.facebook.com/apps/> **YOUR APP ID** /marketing-api/tools
* **Ad ID**: You can find the ad ID on your ads management page. This field must be empty if you use the "Form ID" field.
* **Form ID**: You can use multiple forms for the same ad, use this option if you want to import only users collected with a specific form.
* **Only leads created after**: By default Facebook will return all leads generated from the beginning, we recommend specifying a date for this field
* **Only leads created before**: If you want to only import leads generated from the start of the ad to a week ago, use this option.
* **E-mail**: This field is mandatory and must refer to the email field you added in the ad. By default it is "email", so if you didn't modify it when creating your lead form just leave the default value.
* **Name**: This field is optional and refers to the name field of your ad. It is not possible to merge two fields (i.e first name and last name) for this field.

## Outlook <a href="#outlook" id="outlook"></a>

You can export your contacts from Outlook and import them in AcyMailing as a [CSV file](https://www.acyba.com/index.php#file).

* Select **File -> Import and Export...** from the menu.

![](/files/-MJSC9vsZOBR0_PWL09m)

Export Outlook step 1

* Select **Export to a file** and click **Next**.

![](/files/-MJSCBvrX1FiCKHMv8MD)

Export Outlook step 2

* Select ***Comma Separated Values (Windows)*** and click **Next**.

![](/files/-MJSCE9_nNOovAPS83xr)

Export Outlook step 3

* Select the **Contacts** folder and click **Next**

![](/files/-MJSCGEq15N7tuilRC_r)

Export Outlook step 4

* Use the **Browse...** button to specify a location and file name for the exported contacts ("Outlook.csv" on our example) and click **Next**.

![](/files/-MJSCI2DrOC5KPkELN4u)

Export Outlook step 5

* Click on the **Map Custom Fields ...** button to export only the email and name field. You can export more fields if you added extra fields using AcyMailing Enterprise.

![](/files/-MJSCK-lLTcoK5JvAM9O)

Export Outlook step 6

* * Click on the button **Clear Map** and then drag and drop only the necessary information: name and e-mail of the user. Be careful, the field e-mail must be the sub-category of the group e-mail, not the whole group of fields.

![](/files/-MJSCLivBqmvpvChhhsJ)

Export Outlook step 7

* Click **Ok** and then **Finish** to export your contacts.
* Open the exported file with a text editor (notepad) and make sure you exported the right information and the first line of your file is "name","email" (if not, modify it and save your file).
*

## Frequently Asked Questions <a href="#frequently-asked-questions" id="frequently-asked-questions"></a>

### My subscriber's name are truncated during the import - Special characters are not imported properly <a href="#my-subscribers-name-are-truncated-during-the-import-special-characters-are-not-imported-properly" id="my-subscribers-name-are-truncated-during-the-import-special-characters-are-not-imported-properly"></a>

Text can be truncated and special characters not imported properly if the file you submitted is not encoded as utf-8. The easiest way to solve that issue is to use the "import via text-area" method instead. If you know your file encoding, you could select that charset during the import and Acy will convert it automatically. Greek users, you should select ISO-8859-7 If it still does not work, you should open your file with a text editor such as notepad++ to convert it into utf-8.

Using AcyMailing Enterprise you can create as many [extra fields](/old/main-pages/configuration/custom-fields) as you want on the user profile. Once created, you can add these extra fields to your import file by adding the column name to the first line of your file:

name,email,phone,country John,This email address is being protected from spambots. You need JavaScript enabled to view it.,8390264,France Mike,This email address is being protected from spambots. You need JavaScript enabled to view it.,2907165,USA ...


# Mass actions

## Description <a href="#description" id="description"></a>

This screen enables you to execute actions on a selection of AcyMailing subscribers (using criteria).

It's the right tool to use if you want to mass confirm, enable, subscribe, delete users.

AcyMailing keeps track of the unsubscription of each user so that if you try to subscribe a user which already unsubscribed, this user won't be added back.

If you really want to add him back to your list, you should first remove his subscription and then subscribe him to the list.

Using AcyMailing Enterprise, you will get the same interface but we added a save button so you can save your filters and even execute them automatically!

This whole system uses the Joomla plugin triggers so you can add plugins to AcyMailing and add more filters or more actions to this powerful feature.

This feature filters AcyMailing users based on criteria, so keep in mind that your users MUST be AcyMailing users (if you filter them by Community builder fields for example). The plugin "(auto)subscribe on Joomla registration" should already create an AcyMailing user on Joomla registration so make sure it is enabled.

## How to access this screen <a href="#how-to-access-this-screen" id="how-to-access-this-screen"></a>

![](/files/-MJSCcLAGoqmaG55PyjX)

Access filter area

* On the AcyMailing back-end, go over the **Users** menu to access the sub-menu **Mass actions**

![](/files/-MJSCeUSvrylKvrvasxI)

Toolbar

* **View users :** This button enables you to preview the first 20 users filtered by your current filters. This is useful to do some tests and make sure your filters are correct.
* **Process :** This button enables you to execute the filters/actions you configured
* **Save** : Save the current filter. If you click on this button, more options will be displayed enabling you to automatically trigger the saved filter, you will then have to save again the filter&#x20;
* **Close** : Returns to the List management view.
* **Help** : This button enables you to turn ON/OFF the help section, this screen will appear or disappear.

## Filters <a href="#filters" id="filters"></a>

The filters enable you to create a selection of AcyMailing users. If you don't add any filter, then all your users will be selected.

If you add more than one filter, an AND condition will be applied between all the filters.

When adding a filter, you will see "xxx users selected": this is the number of users selected by this filter only. When the "mass action" is processed, the users selected MUST match all the filters you added (for example the following "mass action" will select 0 users)

![](/files/-MJSCoDgHwA2hIKLxmDY)

Filters

* **Group**: Main Joomla group of the user (it will also select Acy users that are not Joomla users. To avoid that, add a filter "AcyMailing field" => "userid" != "0")
* **AcyMailing List**: You can choose if the selected users should be subscribed to one list and unsubscribed from another list or in pending status...
* **AcyMailing Field**: You can set a filter on any information of the AcyMailing User profile
* **Joomla User Field**: You can set a filter on any information of the Joomla User profile

### Subscriptions to lists <a href="#subscriptions-to-lists" id="subscriptions-to-lists"></a>

You can filter your users based on their subscription, for example select all the users that have no subscription for a specific list, and send them an email inviting them to subscribe.

![](/files/-MJSCrHQ4LyLaa3VkqMm)

Stats filter

### User fields and custom fields <a href="#user-fields-and-custom-fields" id="user-fields-and-custom-fields"></a>

You can filter the users based on their AcyMailing fields / custom fields with this filter. For example, add in the English list all the users that selected "United states" in the country field you've created.

![](/files/-MJSCvsge8lw4YDjR_Je)

Stats filter

### Joomla fields <a href="#joomla-fields" id="joomla-fields"></a>

This filter works the same as the previous one, filter the AcyMailing users based on their Joomla user fields.

![](/files/-MJSCy-7C4DXSynK57h7)

Stats filter

### Statistics Open/Not open <a href="#statistics-open-not-open" id="statistics-open-not-open"></a>

You can set a filter on the fact your e-mail has been opened, not opened, failed (or bounced for AcyMailing Enterprise).

![](/files/-MJSD0gZgs2l3sDWrskD)

Please remember the open statistics are not 100% accurate so **never resend** a Newsletter **based on** the fact the e-mail has not been **opened** by the user.

### Clicked/didn't click a link <a href="#clicked-didnt-click-a-link" id="clicked-didnt-click-a-link"></a>

You can filter the users that clicked or not on a specific link, then do an action based on this information. For example, if the users clicked on the link to a product but they didn't buy it, send them an email with products of the same category, they might be interested.

![](/files/-MJSD5H3nOp_enL7QM_w)

Stats filter

### Geolocation <a href="#geolocation" id="geolocation"></a>

If you activated the geolocation in the AcyMailing configuration page, tab "Subscription", you will be able to filter your AcyMailing users based on the collected information. You will then be able to send specific newsletters based on the users' location.

![](/files/-MJSD7dGQDMtG6hzHp5O)

Stats filter

### Joomla group <a href="#joomla-group" id="joomla-group"></a>

You can filter your AcyMailing users based on the Joomla groups they are in / not in. You can also include the sub-groups in the filter so if you select "Manager", the users in the "Administrator" group will be taken in the filter.

![](/files/-MJSD9pkj9EKxs8eMYRh)

Stats filter

### Randomly select X users <a href="#randomly-select-x-users" id="randomly-select-x-users"></a>

If you need to select only X users, randomly, this filter will help you. For example, if you want that 10 of your clients win a prize each month, you can use this filter to pick the winners.

![](/files/-MJSDBpKytPVw-ICd-37)

Stats filter

## Actions <a href="#actions" id="actions"></a>

You can execute several actions on the selected users.

### AcyMailing List <a href="#acymailing-list" id="acymailing-list"></a>

You can subscribe, unsubscribe or remove your users from a list. This system is also working with our follow-up campaigns so you can massively start a campaign on your subscribers that way (in that case select the list name + Campaign at the end of the dropdown). The campaign starts on the subscription date of the user so if you mass subscribe them on a campaign, all your users will receive the follow-ups at the same time.

AcyMailing keeps track of the unsubscription of each user so that if you try to subscribe a user which already unsubscribed, this user won't be added back. If you really want to add him back, you should first remove the users from your lists and then subscribe them.

![](/files/-MJSEB3PwZyGkLJILZUp)

Action list

### Action on the user <a href="#action-on-the-user" id="action-on-the-user"></a>

You can massively confirm / unconfirm / enable / block or delete AcyMailing users. If you want to delete the Joomla user account, you can use [our "Modify user group" plugin](/old/integration-plugins/other/plugin-modify-user-group).

![](/files/-MJSEF2Jqusycxy6Vl5M)

Acymailing fields

### Set subscriber's profile value <a href="#set-subscribers-profile-value" id="set-subscribers-profile-value"></a>

You can massively modify / replace the value of one of your users' field.

![](/files/-MJSEIMkq8rlHWTNjWLY)

Acymailing set value

* **=:** the new value will replace the previous one
* **+:** the new value will be added to the previous one (both values should be numeric)
* **-:** the new value will be substracted from the previous one (both values should be numeric)
* **Add at the end:** the new value will be added just after the previous one
* **Add at the beginning:** the new value will be added just before the previous one

In the "New value" field, you can also include the other user's fields using this simple syntax: {field:namekey} so, for example, {field:email}

You can even include date tags, for example {year} will be replaced by the current year, {month|add:1} will be replaced by the next month's number and {day|remove:3} will be replaced by 23 if today is the 26th.

### Add an e-mail in the queue <a href="#add-an-e-mail-in-the-queue" id="add-an-e-mail-in-the-queue"></a>

Based on your filters, you can decide to add an e-mail in the queue and send it at the specific date.

The send date field is a dynamic date field.

![](/files/-MJSEKuyS2RL0W6jwzwh)

Add e-mail in the queue

AcyMailing will add the e-mail in your queue. Commercial versions of AcyMailing will then automatically send your e-mail using an automatic task so you have nothing to do. If you use this filter to add a Newsletter in the queue with our free version, don't forget to process the queue manually.

Few things you should know before using this method to send your Newsletters instead of the standard way:

* If you add an unsubscribe link in your Newsletter, AcyMailing will unsubscribe the user to the lists you attached to your Newsletter. So even if you use this interface to send an e-mail to a portion of your list, please make sure you edited your Newsletter and attached it to one or several lists so the unsubscribe link will work.
* DO NEVER use the filter "statistics: not opened" to resend a Newsletter. [The statistics are not 100% accurate](/old/main-pages/statistics) and your users will receive twice the Newsletter.

### Remove an e-mail from the queue <a href="#remove-an-e-mail-from-the-queue" id="remove-an-e-mail-from-the-queue"></a>

In many cases you will find it useful to remove e-mails from your queue based on some filters.

![](/files/-MJSENbWZ4f1GeDHJBHu)

## Auto-filters  <a href="#auto-filters" id="auto-filters"></a>

Using AcyMailing Enterprise, you can save your filter to trigger it later or let AcyMailing triggering it automatically.

If you click a first time on the save button, more options will appear on the screen

![](/files/-MJSEQiR19ln6QG29SUy)

* **Title**: You can set a title to your filter in order to recognize it easier in the future.
* **Description**: You can set a description for your own information.
* **Published**: A filter which is not enabled won't be triggered automatically.
* **Automatically trigger the filter**: you can select a series of events so the filter will be automatically triggered on a user action.
  * **Every day** : the filter will be automatically triggered everyday. Please make sure you already have a cron task configured for AcyMailing to enable this option. This option will make sure the filter is triggered once a day regardless of your cron frequency.
  * **Each time AcyMailing is triggered** : the filter will be triggered each time the AcyMailing cron task is triggered. So every 15 minutes by default.
  * **On user creation** : the filter will be triggered on the user creation but only when created from the front-end. That way, you can automatically subscribe your user to a campaign depending on his selection on the extra fields you created. The filter will be only executed on the current user, not on all users. With this option, you cannot add filters on the subscribed lists as the user is not subscribed yet on creation.
  * **On user modification** : the filter will be triggered on the user modification (i.e if a user field is modified).
  * **When the user clicks on an url from your Newsletter** : the filter will be triggered on the user when he clicks on an url on your Newsletter (only displayed if you enabled the url tracker plugin). Please don't select both options "on open" and "on user click" otherwise both will be executed one after the other. You should rather select "on open" if you want to have both as if a user clicks on your link, AcyMailing will considered he opened your Newsletter.
  * **When the user opens your Newsletter** : the filter will be triggered on the user when he opens a Newsletter.

## Examples <a href="#examples" id="examples"></a>

### Subscribe all your users to a list <a href="#subscribe-all-your-users-to-a-list" id="subscribe-all-your-users-to-a-list"></a>

If you want to subscribe absolutely all your users to a certain list, simply select the action type "AcyMailing List" and the action to subscribe users to your list. You don't have to add any filter if you want to select all your users.

Then click on the button **Process**.

![](/files/-MJSEWxgQigUTLadxR5S)

Mass subscribe

### Subscribe all your Joomla users to a list <a href="#subscribe-all-your-joomla-users-to-a-list" id="subscribe-all-your-joomla-users-to-a-list"></a>

If you want to add all your Joomla Users in a list but not add the simple visitors (who subscribed to one or several lists on your website without registering on it), open a filter with the type "AcyMailing Field", select the field "userid", select the operator ">" and enter the number 0 in the input.

Then select the action type "AcyMailing List" and the action to subscribe your users to your list.

Then click on the button **Process**.

![](/files/-MJSEYmD0DFN2y8LiDdI)

Mas subscribe registered users

### Resend your confirmation e-mail to your users <a href="#resend-your-confirmation-e-mail-to-your-users" id="resend-your-confirmation-e-mail-to-your-users"></a>

You can use our filters to resend your confirmation e-mail to unconfirmed users. (This feature has been added since AcyMailing 1.5.2)

On this example, we added three filters:

> * confirmed = 0 (we only select unconfirmed users)
> * created < {time} - 86400 (we only select users created before yesterday. Of course you can directly write a date in this field with the format YYYY-MM-DD such as 2010-03-25)
> * created > {time} - 172800 (we only select users created two days ago)

> Then we added one action: add the confirmation email in the queue when the filter is triggered.

![](/files/-MJSE_nIDjiCq2lszKxm)

Resend Confirmation e-mail

Once the e-mail is added in the queue, our commercial versions of AcyMailing will automatically take care of the send process using an [automatic task](/old/main-pages/users/mass-actions).

You can execute this kind of filter with our free version but then you will have to manually trigger the send process.

Using AcyMailing Enterprise, you could save this filter and let AcyMailing automatically execute it every day (Auto-filters only trigger once a day regardless of your cron frequency).

If you create a reminder, only target at 24 hour range per confirmation reminder filter otherwise the same user might receive twice the reminder in a day. If you want to remind multiple times, create separate filters for each reminder - each only targeting a separate 24 hour range.

AcyMailing will not let you send a message to unconfirmed users if you require a confirmation... unless you add the word "confirm" in your Newsletter alias. That's a trick you can use to avoid an error message when sending a confirmation e-mail you created.

### Send a reminder to users who didn't log in since 30 days <a href="#send-a-reminder-to-users-who-didnt-log-in-since-30-days" id="send-a-reminder-to-users-who-didnt-log-in-since-30-days"></a>

With AcyMailing Enterprise and the auto-filter feature, you can set up a message automatically sent to your users who didn't log in since 30 days on your website.

"Hey {subtag:name}, it's been a while since you last logged in, come to visit us again!"

Once your message created and published, access the mass actions interface and add this filter:

![](/files/-MJSEbhtm6ZpXmlRf20-)

mass actions reminder logged in

* The last logged in date should be between 30 days (2592000 seconds) and 31 days (2678400 seconds) ago. Don't worry, out date picker avoids you to do the calculation.
* We also add a filter "not sent" with the same message to make sure that message is not already sent to the user (we may want to always send a reminder 1 month after the last logged in date even if the user already received it a few months ago).
* And then we add an action to add the e-mail in the queue.
* Save this filter and select the option to automatically run it every day.

### Resend your Joomla confirmation email <a href="#resend-your-joomla-confirmation-email" id="resend-your-joomla-confirmation-email"></a>

You can configure AcyMailing to (automatically) send a message to users who didn't confirm their Joomla account.

First, create a Newsletter via AcyMailing:

* Alias: joomla-confirmation-enabled The alias matters... we add "confirm" and "enable" to it so Acy won't check the user based on its confirm and enabled field. So make sure to use that one!
* Published: Yes
* Your message content should include a link so the user can confirm his Joomla account, click on the tags button when you edit your Newsletter and within the tag menu "Joomla user fields" you will find the Joomla confirmation tag that you can insert in your Newsletter.

Then access the filters/actions system and add the following filters to select only the right users :

* Users with the Joomla field : activation !=
* Users with the Joomla field : block = 1
* You can also add an extra filter to only select users created within a period of time if you want to automate this action

Add the action "add email to the queue" and click on the button "process".

Your reminders will be inserted in the queue, you can now process it or let Acy send your emails automatically if you use the automatic send process.

## Frequently Asked Questions <a href="#frequently-asked-questions" id="frequently-asked-questions"></a>

### What's the format to create dynamic dates? <a href="#whats-the-format-to-create-dynamic-dates" id="whats-the-format-to-create-dynamic-dates"></a>

On many of our filters, you can write a date. This date always has the database format: YYYY-MM-DD. You can optionally add a time to it: YYYY-MM-DD HH:MM:SS.

Using our automatic filters, you will find it handy to create dynamic dates so instead of a fixed date, you can write a tag or an operation which will be replaced by a date depending on the executed time.

{time} will be replaced by the current time (in seconds) and you can execute some operations on this field so:

> * {time} + 60 will be replaced by the current time plus 1 minute (60 seconds)
> * {time} - 60 will be replaced by the current time minus 1 minute (60 seconds)
> * {time} + 3600 will be replaced by the current time plus 1 hour (3600 seconds)
> * {time} - 3600 will be replaced by the current time minus 1 hour (3600 seconds)
> * {time} + 86400 will be replaced by the current time plus 1 day (86400 seconds)
> * {time} - 86400 will be replaced by the current time minus 1 day (86400 seconds)

> The same way, you can create any date you want ({time} \[+-] \[amount of seconds]) based on the time the filter will be executed.

> When you create a condition on a date, you can't use the equal sign (created = 2010-03-19), you should create two filters instead: created > 2010-03-19 and created < 2010-03-20

> You can also use the tag {year}, {month}, {weekday} and {day} which will be replaced by the current year, month, weekday or day.

Since AcyMailing 4.7.2, you can select your dates quickly and easily thanks to a calendar that appears automatically when editing.

![](/files/-MJSEez6oXkzAHT3RbiF)

### Can I do an OR condition between two filters? <a href="#can-i-do-an-or-condition-between-two-filters" id="can-i-do-an-or-condition-between-two-filters"></a>

> Filters are connected with an AND condition only, we don't support OR conditions. Nevertheless within the same filter you can do an OR condition by using the REGEXP operator. use : "tennis|handball|football" to select users having tennis or handball or football in the field.


# Lists

## Description <a href="#description" id="description"></a>

This screen enables you to manage all your mailing lists.

You can sort your lists by any field, search using the "filter" box and directly modify some properties by clicking on the icons.

![](/files/-MJSFUwQqEglZKXxPMVM)

List Listing Toolbar

* **Filters :** This button gives you access to another page where you will be able to execute mass actions on your subscribers such as mass remove and/or mass subscribe users to one or several lists using filters.
* **New** : Enables you to create a new list.
* **Edit** : Select a list and then click on this button in order to edit its information.
* **Delete** : Select one or several lists and click on this button in order to completely delete the list. The users subscribed to this lists won't be deleted (simply the subscription will be removed) nor the e-mails attached to this list.
* **Help** : This button enables you to turn ON/OFF the help section, this screen will appear or disappear.

## Column Headers <a href="#column-headers" id="column-headers"></a>

![](/files/-MJSFXHzbqmQ8AS4r9TK)

List Listing Columns

* **#** : An indexing number automatically assigned for ease of reference.
* **Ordering** : The lists are ordered and you can modify their ordering using drag and drop on the rows with this column. Each time AcyMailing displays your lists on the front-end or on the back-end, they will be displayed following this ordering. So, if you want to modify the ordering of the lists displayed on your Module, you have to do it here.
* **Checkbox** : Check this box to select one or more items. To select all items, check the box in the column heading. After, click on the delete button in order to delete the selected lists.
* **Colour** : Each list has a colour so that you can easily and quickly identify it on the backend. This colour is not displayed on the front-end but helps you manage your lists efficiently. You can edit the colour assigned to your list if you edit your list.
* **List Name** : Name of the list
* **Subscribers** : Number of users subscribed to this list. If you click on this number, you will be redirected to the user listing where you will see all its subscribers. The number of pending subscriptions (users which still didn't confirm their subscription) is displayed between brackets.
* **Unsubscribers** : Number of users who unsubscribed from this list. You can click on this number to see the users who unsubscribed from it.
* **Creator** : Creator of the list.
* **Visible** : A visible list will be displayed on the front-end. There is one exception, the display of lists on the Module strictly follows the Module parameters and not this field. So, if you want to hide a list in your Module, you have to modify the Module parameters.
* **Enabled** : AcyMailing will never send Newsletters to a list which is not enabled. A user can not subscribe or see a list which is not enabled.
* **ID** : This field indicates the ID of the list.

## Filters <a href="#filters" id="filters"></a>

![](/files/-MJSFZHoHPhYf8NDVdPS)

List Listing Filters

* The filter caption enables you to easily search in your lists.
* The filter "All categories" enables you to filter your lists based on their categories.
* The filter "All Creators" enables you to filter your lists based on their creator.


# Distribution lists

## Description <a href="#description" id="description"></a>

The distribution lists sytem allows you to check a specific mailbox, and if AcyMailing sees that there is an email inside, it will forward it to a specific list or a specific email address.

This feature is available in AcyMailing Enterprise under the "Lists" menu.

The Thunderbird mailboxes are not compatible with this system yet (whether it is the sending mailbox, or the mailbox you configure in the "Distribution lists" system).

## Access this feature <a href="#access-this-feature" id="access-this-feature"></a>

![](/files/-MJSFgpgaFeQaUo48HR5)

## Listing <a href="#listing" id="listing"></a>

![](/files/-MJSFiPGSv2JjnWA4dli)

* **New:** Create a new item
* **Edit:** Edit the selected item
* **Copy:** Copy the selected item, it will be named "copy\_" + copied item's name
* **Delete:** Delete the selected items
* **Help:** Displays this documentation in your site

### Filters <a href="#filters" id="filters"></a>

![](/files/-MJSFkERSshqD7S8fQVq)

&#x20;With this filter area you can search in the name/description/id of the existing items, and filter them by creator.

### Columns <a href="#columns" id="columns"></a>

![](/files/-MJSFmGce4K0pTApv4SV)

* **#:** An indexing number automatically assigned for ease of reference
* **Ordering:** The items are ordered and you can modify their ordering using the drag and drop on the rows with this column. Each time AcyMailing processes the distribution lists system, they will be executed following this ordering.
* **Checkbox:** Check this box to select one or more items. To select all items, check the box in the column heading. After, click on the copy or delete button in order to copy/delete the selected items.
* **Name:** The item's name
* **Email address:** The email address attached to the item
* **Creator:** The creator of the item
* **Enabled:** You can publish/unpublish an item simply by clicking on the icon you see in this column
* **ID:** The ID of the item

## Edition <a href="#edition" id="edition"></a>

### Tooblar <a href="#tooblar" id="tooblar"></a>

![](/files/-MJSFnvVS7ycCLaeyirL)

* **Test:** Test the connection with your mailbox
* **Save:** Save and close the current item
  * **Apply:** Save the current item and stay in edition mode
* **Cancel:** Close the item without saving
* **Help:** Displays this documentation in your site

### Main information <a href="#main-information" id="main-information"></a>

![](/files/-MJSFqBeMYkiLgMzSxi2)

* **Name:** The name of the item displayed on the listing
* **Enabled:** Activate or not the item using this option
* **Frequency:** AcyMailing will process this item following the frequency you set. Choose "0" if you want AcyMailing to process it on each cron task.
* **Creator:** The Joomla user that created this item.
* **Description:** This description is only displayed on the listing page (as a tooltip on the item's name).

### Configuration <a href="#configuration" id="configuration"></a>

![](/files/-MJSFs3TbzqzU4EDCqwY)

* **Server:** The mail server AcyMailing should connect to
* **Connection Method:** Choose the method AcyMailing should use to connect to your mailbox
* **Username:** The username of your mailbox, it usually is the email address itself.
* **Secure Method:** You can select a secured method to connect to your e-mail server (if you use Gmail, you should select "SSL")
* **Password:** The password of your mailbox
* **Port:** The port AcyMailing should use to connect to the mailbox, you can leave it empty if you don't know what to use. In most cases, it is 110 for POP3, 143 for IMAP and 993 for IMAP using a secured connection so make sure the port you use is opened on your server by asking your host.
* **Self-signed Certificates:** Should AcyMailing auto-sign your certificates?

Once you've configured the connection, you can click on the "Test" button in the toolbar to see if it is correct. If so, AcyMailing will tell you how many emails are in your mailbox.

### Conditions <a href="#conditions" id="conditions"></a>

![](/files/-MJSFuEo4iMJ-hPHpkeV)

* **Allowed sender**

You can allow specific users to use the distribution lists system (you should always do as everyone can send an email to the mailbox you specified).

You can:

* Specify one or more email addresses, separated by a coma
* Select a Joomla group like in the above screenshot so only emails sent by a member of the selected group will be taken into account
* Select one or more AcyMailing lists so only emails sent by a member of the selected lists will be taken into account
* **Allowed subject**

You can add a condition on the email's subject so only emails matching this condition will be handled. The available conditions are "Begins with", "Ends with" and "Contains" the specified text.

* **Delete not allowed emails**

If you turn this option On, the emails not matching the above two conditions will be deleted from the mailbox.

### Actions <a href="#actions" id="actions"></a>

![](/files/-MJSFwhqgU0eQAUWKGaP)

Once AcyMailing detects an email in the specified mailbox, if it passes the above conditions it will then execute some actions you specify here. For example, If an email is sent to "This email address is being protected from spambots. You need JavaScript enabled to view it." from a user in the group "Publishers", AcyMailing will forward this email to the List 2, subscribe the sender to the list D, unsubscribe him from the list C and send him the newsletter "AcyMailing v5 is out!" as selected in the above screenshot.

* **Forward to a list**: It forwards the email to the selected list.
* **Forward the message to**: It will forward the email to the specified email addresses
* **Subscribe**: Subscribes the email address that sent the email to the selected list
* **Unsubscribe**: Unsubscribes the email address that sent the email from the selected list
* **Send a newsletter**: Sends the selected newsletter to the one who sent the email

If you want to forward the email in an AcyMailing template, you will have to add the tag {emailcontent} in the templates you want to use so that AcyMailing knows where it should include the email content.

### Report <a href="#report" id="report"></a>

![](/files/-MJSFyfSRWe0DEQMCd7e)

&#x20;The last part of the edition page shows you the last report showing you the success messages or error messages.

## Examples <a href="#examples" id="examples"></a>

### Forward to multiple lists <a href="#forward-to-multiple-lists" id="forward-to-multiple-lists"></a>

&#x20;To fully use the capabilities of this feature, you may want to forward an email to multiple lists, with a different template for each list:

![](/files/-MJSG56sVCaXdw_av4R_)

### Be notified when an action is made <a href="#be-notified-when-an-action-is-made" id="be-notified-when-an-action-is-made"></a>

You may want to be notified when an action is performed using this system. If so, simply add an other action that forwards the email to your address:

![](/files/-MJSG7n1Oc7W3OvqYEve)


# List: Add/Edit

## Description <a href="#description" id="description"></a>

This screen enables you to create or edit a Mailing List.

You will also be able to attach a welcome message or an unsubscribe confirmation to the list.

![](/files/-MJSGEGeRKDf2ylFu3ru)

User Form Toolbar

* **Save :** Save the current list and return to the User Listing screen.
  * **Apply** : Apply the modifications to the current list and stay on the same screen.
* **Cancel** : Return to the previous screen.
* **Help** : This button enables you to turn ON/OFF the help section, this screen will appear or disappear.

## List Information  <a href="#list-information" id="list-information"></a>

![](/files/-MJSGGOGNVtulyX4emP8)

List Form Infos

* **List Name** : Name of your list. This name will be displayed on the front-end.
* **Alias** : Alias of your list, this field is used to create friendly URLs.
* **Enabled** : AcyMailing will never send Newsletters to a list which is not enabled. A user cannot subscribe nor see a list which is not enabled.
* **Visible** : A visible list will be displayed on the front-end. There is one exception, the lists displayed on the Module strictly follow the Module parameters and not this field. So if you want to hide a list in your Module, you have to modify the Module parameters.
* **Category** : You can assign / create a category for this list using this field. If you want to rename a category, simply create a new one, if the old one isn't used, it will be automatically deleted. If you have categories, you'll be able to automatically select lists on the newsletter edition page and on the export page.
* **Creator** : Creator of the list. In AcyMailing Enterprise, the creator of the list is also allowed to manage Newsletters from the front-end for that list.
* **Colour** : Each list has its own colour so that you can easily and quickly identify it on the backend. This colour is not displayed on the front-end but helps you manage your lists efficiently.
* **Unsubscribe Message** : When a user unsubscribe from the list, you can send him an Unsubscribe Confirmation. You can personalize this unsubscribe message by clicking on the Edit button or add a new unsubscribe confirmation by clicking on the Add button. Each List can have its own unsubscribe confirmation. If the user unsubscribes from several lists at the same time, each unsubscribe confirmation will be sent. For example, if I created 3 lists. My first list has the unsubscribe message #1, my second list has the unsubscribe message #2 and my third list has the unsubscribe message #1. If a user unsubscribes from those three lists at the same time, this user will receive 2 unsubscribe confirmations. If you want your user to receive only one unsubscribe confirmation, you have to create only one unsubscribe message and use this same message for all your lists.
* **Welcome Message** : The welcome message works the same way the unsubscribe message does. You can attach one welcome message to each list or use the same one for several lists. When a user subscribes to one or several Mailing Lists, the welcome message attached to each list will be sent to the user. If several mailing lists share the same welcome message, only one copy will be sent. Welcome messages as well as unsubscribe confirmation are not sent if you modify the user subscription from the back-end. Both messages will be only sent if the user himself subscribes or unsubscribes from your lists. This feature is only available from AcyMailing Essential.

## List Description <a href="#list-description" id="list-description"></a>

![](/files/-MJSGITdix9q6HlWxECD)

List Description

* This field enables you to add a description to your list. This description will be displayed on the front-end of your website.
* You can add text, pictures or anything else to this list description.

## List Colour <a href="#list-colour" id="list-colour"></a>

![](/files/-MJSGM49mVWQ-28rtRUW)

List Colour

* If you click on the colour input, a list of colours will be displayed on the screen so that you can easily pick one.
* You can also directly write the HTML code of the colour in the field.
* This colour will be used only on the back-end of your website to quickly identify each list. It will also be used in the statistics (the colour of the line will be the colour of the list) but to make it work properly, do not enter anything else than the HTML colour code in this field.

## Unsubscribe Confirmation / Welcome Message  <a href="#unsubscribe-confirmation-welcome-message" id="unsubscribe-confirmation-welcome-message"></a>

If you click on the edit or add button of the unsubscribe confirmations (or on the welcome message), a popup will appear and you will be able to write or modify the message.

You will quickly become familiar with this popup as the same one is used to edit the notification e-mails in the AcyMailing Configuration page.

![](/files/-MJSGONE73SEDFDFi3RK)

Unsub Screen

* If you click on the button "send a test", AcyMailing will send a test of this e-mail to the currently logged in user (you!).
* Once you saved this message, you can close the popup by clicking on the white cross on the top right corner of the popup.

## Language  <a href="#language" id="language"></a>

Using all our commercial versions, you can attach a list to one or more languages so that list will only be displayed if the user browses your website in this language.

This method enables you to keep separate mailing lists, one for each language for example, so you can adapt your communication and create different Newsletters in each language.

![](/files/-MJSGR_2xnhBX73j8evN)

List language

## Access Level <a href="#access-level" id="access-level"></a>

Using AcyMailing Enterprise, you can set an access on your list so you can limit the group of users which can view and subscribe to your list and/or you can define some groups which are able to manage Newsletters for that list from the front-end.

Please note that the owner of the list will also be able to manage Newsletters for that list via the front-end so you can attach a list to a single user if you want.

![](/files/-MJSGUFH84A-stsaNPWZ)

List ACL

## Frequently Asked Questions <a href="#frequently-asked-questions" id="frequently-asked-questions"></a>

### How can I subscribe all my users to my list? <a href="#how-can-i-subscribe-all-my-users-to-my-list" id="how-can-i-subscribe-all-my-users-to-my-list"></a>

> * Save your list
> * Go back to the **lists management screen**
> * Click on the button "[**Filters**](/old/main-pages/users/mass-actions)"
> * Don't select any filter
> * Select the action AcyMailing List -> Subscribe users to -> select your list
> * Click on the button "**Process**"
> * All your users will be subscribed to your selected lists.

### I want my registered users to be automatically subscribed to this list... <a href="#i-want-my-registered-users-to-be-automatically-subscribed-to-this-list" id="i-want-my-registered-users-to-be-automatically-subscribed-to-this-list"></a>

> * Save your list
> * Go to the **AcyMailing Configuration page**
> * Click on the tab "[**Subscription**](/old/main-pages/configuration#subscription)"
> * Select your list for the parameter "**Auto-subscribe on Joomla registration**" (using the button **Select**)
> * Save your AcyMailing configuration page


# Newsletters

## Description <a href="#description" id="description"></a>

This screen enables you to preview your Newsletter, test it, send it or schedule it (from AcyMailing Essential on).

![](/files/-MJSGbQmQv8A2sE60PgZ)

Preview Toolbar

* **Schedule :** If you click on this button, a popup will open which will enable you to schedule your Newsletter so that you can send it at a fixed date in the future.
* **Send** : If you click on this button, a popup will open in order to send your Newsletter.
* **Edit** : If you click on this button, you will return to the Newsletter edition screen.
* **Cancel** : Returns to the Newsletter management listing.
* **Help** : This button enables you to turn ON/OFF the help section, this screen will appear or disappear.

## Send a test <a href="#send-a-test" id="send-a-test"></a>

![](/files/-MJSGqQWaI8i63ghdHt5)

Send a test

* **Send a test to** : AcyMailing enables you to send a test to the current logged in user (You!), or a backend group (Manager, Administrator, Super Administrator) or any other user (simply enter his e-mail address).
* **Send Version** : When you send a test, the version which will be sent to the user is forced by this option, so his personal preferences does not matter. During the real send process, the personal preference of the user predominates.
* **Send a test** : Click on the button "Send a test" in order to send a test of your Newsletter. All the tags will be replaced so that you can really fully test your Newsletter and make sure everything is working. If you selected a group of users (Manager for example), the Newsletter will be sent to all the Joomla Manager Users.

## Lists <a href="#lists" id="lists"></a>

![](/files/-MJSGfgeR7d_0bYBPqrS)

List of receivers

Each Newsletter should be attached to at least one list. In this example, we attached the Newsletter to two lists : "Updates & Infos" which contains 24903 users and "Downloaded AcyMailing" which contains 12426 Users. So, if you click on the send button, this Newsletter will be sent to those lists and AcyMailing will take care of the duplicates entries (users subscribed to both lists will only get one e-mail). Nevertheless, you can see a warning on the list "Downloaded AcyMailing" because this list is not published! AcyMailing does not send a Newsletter to an unpublished list, you have to publish it first.

## Schedule <a href="#schedule" id="schedule"></a>

If you click on the button "Schedule", a popup will open asking you a date (in the future) so that AcyMailing will send this Newsletter automatically. Using this method, you can plan a series of Newsletters which will be sent one after the other at a specified date.

The Newsletter scheduling system requires the configuration of a cron task in order to automatically trigger AcyMailing. Please make sure your cron task is enabled (it is very easy to configure it on your AcyMailing Configuration page).

![](/files/-MJSGh_ltsMBIKijnwsH)

Scheduled Newsletter

* **This Newsletter will be sent to** : This field indicates you the receivers of the Newsletter. As you can see, the list "Downloaded AcyMailing" disappeared because this list is not published.
* **Send Date** : By default this field contains the current time so that you can know exactly what time is it on your server (you may change this default date by changing the time offset on your Joomla Configuration page). Enter a date in the future and then click on the button "**Schedule**".

If you schedule your Newsletter, you will get a confirmation message and the **Schedule Icon** on the toolbar will immediately be replaced by an **Unschedule Icon** so that you can cancel the scheduling of this Newsletter.

![](/files/-MJSGkUA6Kllzcc8ftNH)

Unschedule

## Send <a href="#send" id="send"></a>

if you click on the send button, a popup will open to confirm your send process.

As you can see, the list "Downloaded AcyMailing" disappeared because this list was not published, so AcyMailing won't send the e-mail to this list but only to the "Updates & Infos" list which contains 24903 Users. The number of e-mails finally sent may differ from the number of subscribers displayed as AcyMailing won't send any e-mail to non confirmed users (only if you require a confirmation!) or blocked users.

If you click on the button "Send", the send process will start, AcyMailing will queue all your e-mails and send them batch per batch depending on your AcyMailing Configuration.

If the process fails for any reason, you will ALWAYS be able to resume it by clicking again on the button "Send" (another message will appear to confirm that you want to resume the Send Process and not start a new one).

As all e-mails are personalised, AcyMailing sends the e-mails one by one, so it may take a some time. Please, do not close the send process popup otherwise the send process will stop (e-mails not sent will still be in the queue, so you will be able to resume it anyway).

From AcyMailing Essential on, you can configure AcyMailing to not start the send process but simply queue all your e-mails (**Queue Processing : Automatic Only**). This way, the cron task will do the job and you won't have to keep the connexion open until the end. It's the best way to send e-mails as it does not overload your server and enables you to automatically overcome any server limitation.

![](/files/-MJSGmWmxiL_C4sRoCpk)

Send popup


# A/B Testing

You don’t know what will be the best newsletter to send? Since AcyMailing 4.8.0, we included in our Enterprise version the A/B Split testing feature! It allows you to compare different newsletters and send the best one to your subscribers. You can not only compare two Newsletters but many of them at once! So it can be a A/B/C/D/E Testing...

&#x20;Send different newsletters to a part of your receivers, compare statistics to determine what's the best Newsletter and complete the send process with the optimized version. You can choose manually the Newsletter you want to send to the rest of your subscribers or let Acy automatically select the best one based on the open rate, click rate or a mix of both statistics. AcyMailing will create a new newsletter according to the choice and complete the sending!

## Create a test <a href="#create-a-test" id="create-a-test"></a>

In your newsletters listing, select the newsletters you want to compare (at least 2) and then click on the A/B Testing button.

![](/files/-MJSGy2APQ37yDlY5q01)

In the popup window, you can first choose the percentage of your receivers that will be part of the test. The users are chosen randomly, so it won’t be the same users each time you perform a test. Below this, you will see a recap of the selected newsletters and the lists and filters of the first newsletter. The number of users who will receive the test and the total number of users concerned by the sending are displayed next. If the receivers do not satisfy you, you can use the link to edit the lists and filters applied to the newsletter.

![](/files/-MJSH-ae-J5XejbW73pW)

The second part will let you choose what to do after the test. You can choose the number of days before taking action (only for automatic actions), and the action to take:

* **Do nothing**: manual action, you will have to come back and choose which newsletter to send.
* **Generate and send automatically the newsletter with the best open rate**
* **Generate and send automatically the newsletter with the best click rate**
* **Generate and send automatically a newsletter with the subject of the best open rate and the body of the best click rate**

Once the test is finished, the selected action will be executed (i.e the newsletter will be added to the queue to be sent), if you change the value of this field to "Do nothing" **after** the action has been executed, it will not remove the email from the queue, you will have to do it manually.

Then click on the test button to launch it. When accessing again the newsletter listing, you will see a new icon next to the newsletter name for newsletters included in the test. Just click on it to open the related test.

![](/files/-MJSH1tZr8UuQ2DL2Zj1)

## Compare results <a href="#compare-results" id="compare-results"></a>

After you have launched the test, some emails will be added in the queue. If you use manual sending, then go process the queue. If you use the automatic sending, then you just have to wait for the sending to proceed on its own. After the test has been sent to the testing part of the list, you can go back to the A/B Testing window and see the result of the test. It will display the number of emails sent of each newsletter, their number of opens and clicks.

![](/files/-MJSH3lsI17r7dRFGOSq)

## Final sending <a href="#final-sending" id="final-sending"></a>

If you have chosen not to take any action, then you will be able to manually choose which newsletter to finally send. This will create a copy of the newsletter you chose and send it to the rest of the receivers. If you chose an automatic action, don’t do anything. Acy will automatically choose the newsletter when the time has come according to what you chose when configuring the test. If you choose the mix action, it will create a newsletter with the subject and the sending information of the newsletter with the best open rate, and the body of the newsletter with the best click rate.


# Spam Test

Since AcyMailing 3.7.0, we included in all version 5 paid versions a spam test so you can easily test your Newsletter against spam filters (SpamAssassin), check your server configuration and malformed content.

## Test your Newsletter against spam filters <a href="#test-your-newsletter-against-spam-filters" id="test-your-newsletter-against-spam-filters"></a>

When you preview a newsletter, you will see a button named "Spam Test" in the top right corner of the window. Click it to start the test.

![](/files/-MJSH9wZCtelv0BeeE6R)

AcyMailing will send an e-mail from your server and check it.

If this is the first time you run a test for this newsletter, you will be asked to wait a few seconds in order for your mail to be processed.

![](/files/-MJSHBluYkAD5F5WFb_1)

Once your newsletter is processed, you should be able to see the following page with your score.

![](/files/-MJSHDrz4G9viI6UJjIz)

Clicking on a test title will give you details.

![](/files/-MJSHFmt_OgH3YB4CsDG)


# Schedule your Newsletter

## What's a scheduled Newsletter <a href="#whats-a-scheduled-newsletter" id="whats-a-scheduled-newsletter"></a>

A scheduled Newsletter is a Newsletter you will schedule to be automatically sent in the future.

You can prepare your Newsletter and set a send date in the future so AcyMailing will automatically take care of sending it at the time you specified without you having to do anything else.

You can schedule as many Newsletters as you want.

This feature is included in all our commercial versions.

## Configure AcyMailing to handle automatic processes <a href="#configure-acymailing-to-handle-automatic-processes" id="configure-acymailing-to-handle-automatic-processes"></a>

You have to [configure your cron task](/old/main-pages/configuration/configuration-tabs/cron-task) to make sure the automatic send process will work (it's just one extra click on the AcyMailing configuration page).

## How to schedule a Newsletter <a href="#how-to-schedule-a-newsletter" id="how-to-schedule-a-newsletter"></a>

First, create a Newsletter, attach it to one or several published lists and then access the "Preview / Send" screen.

> * Click on the "Schedule" button

![](/files/-MJSHMjAKqKjUi9AD7e8)

Schedule Newsletter

> * A popup will open enabling you to enter a send date in the future.
>
> The default displayed date is your current time. If it's not the case, please make sure you selected the right timezone on your Joomla configuration page
>
> * Select a send date in the future and then click on the button "Schedule"

![](/files/-MJSHQZzXWGyG5uzw64B)

Schedule confirmation

At the bottom of the popup, you can see a graph showing you when your users opened the most your previous newsletters so you can choose when scheduling the newsletter will be the most efficient.

> * A confirmation message will appear and you can now close the popup

![](/files/-MJSHTazd1eF2q--pqC9)

Configuration

> * That's all you have to do, your Newsletter is now scheduled and will automatically be sent at the specified send date.
> * You should not click on the "Send" button if you click on it, your Newsletter will be sent immediately and automatically un-scheduled.

## Un-schedule your Newsletter <a href="#un-schedule-your-newsletter" id="un-schedule-your-newsletter"></a>

If your Newsletter is scheduled, you will see the scheduled icon on the Newsletter listings.

You can click on it to unschedule your Newsletter in case of you don't want to send it any more.

![](/files/-MJSHWogJ3LuubvmUdqH)

Unschedule button

If your Newsletter is scheduled and you access the "Preview/Send" screen, you will see an unschedule icon instead of the schedule one so you can click on it to unschedule your Newsletter.

![](/files/-MJSHYmU0hOCzHnfxtcr)

Unschedule

## Test your scheduled Newsletter <a href="#test-your-scheduled-newsletter" id="test-your-scheduled-newsletter"></a>

> If you scheduled your Newsletter and the specified send date is now in the past but your Newsletter is still not sent, you should first go on the "queue" listing and click on the button "process".

![](/files/-MJSHmT6ir5Z70BdADgO)

> AcyMailing will tell you what's currently in the queue and the pending Newsletters.

![](/files/-MJSHq68bfzA8incH85R)

> You can see the current time for AcyMailing and when your schedule Newsletter will be sent. In our example, the send date is still in the future so it's normal the Newsletter has not been sent automatically.

> If the send date is in the past, the same message will appear but you will also see a "Generate" button enabling you to manually send the scheduled Newsletter.

![](/files/-MJSHvuWaxbvqebm6Gw2)

> This button has been added for testing purpose only as this process should be automatically executed by AcyMailing.

> If you see this button, that means next time your cron task will trigger your website, the Newsletter will be added to the queue and sent automatically.

> Please remember your cron task triggers your website at a fixed frequency so you may have to wait half an hour before your scheduled Newsletter is sent automatically. If after half an hour your Newsletter is still not sent, [please make sure your cron task is working fine](/old/main-pages/configuration/configuration-tabs/cron-task#test-your-cron-task).


# Smart-Newsletters

This article will explain you how to create a Smart-Newsletter.

The Smart-Newsletter feature is included in AcyMailing Enterprise.

## What's a Smart-Newsletter? <a href="#whats-a-smart-newsletter" id="whats-a-smart-newsletter"></a>

An Smart-Newsletter is a Newsletter automatically sent to one or several of your lists at a fixed frequency (every day, every week, every month... you can select anything you want).

Our Smart-Newsletter system is integrated with several Joomla components so you can include in your Smart-Newsletter your newly created (or modified) Joomla articles, your newly created VirtueMart products, your upcoming events from jCalPro, jEvents, EventList, your new content for K2, your new listings from Mosets Tree...

And for each of these integrations, you will be able to specify a "Min. number of items" to allow the generation of the Newsletter so you can use our Smart-Newsletter system as a notification system too for newly created content / article / events / products...

If the result of the tag does not match your minimum number of items, the Newsletter won't be generated and won't be sent.

You can create as many Smart-Newsletters as you want and attach those Smart-Newsletters to one or several lists.

## Create your Smart-Newsletter <a href="#create-your-smart-newsletter" id="create-your-smart-newsletter"></a>

* Connect to the back-end of your website and then click on the menu **AcyMailing -> Smart-Newsletters**

![](/files/-MJSI9XNaUepRgbNnGsA)

* Click on the **New** button to create a new Smart-Newsletter

![](/files/-MJSIECgeoi4f7CIsviE)

Create Auto-newsletter

* Enter the subject of your Smart-Newsletter. You can add in this subject the tag **{issuenb}** which will be replaced by the current issue number (incremented each time a Newsletter is generated). You can also include other tags in this subject (like a list of content articles, a date, a user information...).
* Set your Smart-Newsletter as **published** (an unpublished Smart-Newsletter won't be generated/sent).
* **Send HTML**: Choose if you want to send the text only version of the Newsletter or the HTML Version too.
* **Language**: You can attach your Smart-Newsletter to a specific language so the links inserted in your newsletter using tags will add the correct language parameter. This option is available when you have a multilingual site (you installed at least two languages or use JoomFish/FaLang)
* **Next Generate Date**: Indicates the next time the Newsletter should be generated.
* **Generate Frequency**: Specify the frequency at which your Newsletter should be generated. If you want to use the Smart-Newsletter as a notification system, you should select the option "as soon as possible" so AcyMailing will check for new content each time the cron triggers your website.
* **Issue Number** : This is an automatic number indicating the next issue number of the Newsletter. This number will be incremented each time AcyMailing generates a Newsletter from this Smart-Newsletter.
* **Last Run time**: This field indicates the last time the Newsletter has been generated so if you add new articles in your Smart-Newsletter, they will be added if they have been created after this date.
* **Generating Mode**:
  * **Wait for the confirmation before sending**: In that case, AcyMailing will generate the Newsletter and send a notification. You will have to manually send or schedule the generated Newsletter in order to send it. This option is very useful in test mode. Please select this option first, we will switch to the other option "Send the generated Newsletter" later.
  * **Send the generated Newsletter**: AcyMailing will generate and send the Newsletter automatically.
* **Send notification to**: Please specify the e-mail address where you want to receive the notification of the Newsletter creation. This is not a mandatory field.

## Choose the frequency of your Smart-Newsletter <a href="#choose-the-frequency-of-your-smart-newsletter" id="choose-the-frequency-of-your-smart-newsletter"></a>

![](/files/-MJSIHBnSWLrr_iaIeVi)

The "Generate Frequency" allows you to choose when your smart-newsletter should generate and send a new newsletter. It has 4 possibilities:

* **As soon as possible**: It will generate a newsletter each time your cron task is triggered (i.e: generally every 15 minutes). Of course, the goal is not to send the same newsletter every 15 minutes but use it with the tag system to send a notification each time a new content is added on your site (articles, blog posts, RSS feeds, [etc...](https://www.acyba.com/acymailing/plugins.html)). To do this, you must set the option "Min. number of items" to "1" and "Filter" to "Only newly created" when [inserting a tag](/old/integration-plugins/installed-with-acymailing/insert-joomla-articles-in-your-newsletter) in your smart-newsletter
* **On the 1st Monday of the month**: You can choose to generate a newsletter on the 1st, 2nd, 3rd or 4th Monday-Sunday of the month, each month with this option
* **Every X Hours/Days/Weeks/Months**: If you want to send an email each week with the new products of your site, you can use this option
* **Every week on Monday-Sunday**: You can choose to generate the newsletter each Mondays and Wednesdays with this option, like in the above screenshot

## Tags

The tags inserted in your Smart-Newsletter will have two functions:

* First the tag will be used to replace the content with the latest one so you can send your new articles/events/products/content...
* But the tag will also be used to allow or not the Newsletter generation. So if the tag is not replaced by at least a certain number of articles, the Newsletter won't be generated and the content will be included in the next generated Newsletter.

Click on the button **Tags**

![](/files/-MJSIJRrPk9Skta4Xee_)

* You can use standard tags in your Smart-Newsletter to include personal information in the generated Newsletter but you can also include content with some specific rules.
* * The plugin used to insert your Joomla articles is the [AcyMailing: Joomla Content Plugin](/old/integration-plugins/installed-with-acymailing/insert-joomla-articles-in-your-newsletter)​
  * Click on the menu **Joomla Content**
  * Click on the tab **Categories**

![](/files/-MJSILTG49wsl2deTt2t)

Auto Content

* Configure the tag the way you want and then click on the button **Insert the tag**
* The same way, you will be able to include your newly created Products, K2 content, Mosets Listings, upcoming events from jCalPRO 2, EventList, jEvents...

## Test your Smart-Newsletter <a href="#test-your-smart-newsletter" id="test-your-smart-newsletter"></a>

At any time you want, you can click on the button "Generate". AcyMailing won't force the Newsletter generation (it will do it only if it was time to do it) but will tell you - for each Smart-Newsletter - when it will be generated and why it won't be generated if it was time to do it.

![](/files/-MJSIObq1b1sdEqfTovK)

test auto-newsletter

If AcyMailing generated a Newsletter from this Smart-Newsletter, you will be able to see it as a scheduled Newsletter in the listing of standard Newsletters.

You don't have to click on the button "Generate". It's something AcyMailing will do automatically with the [cron task](/old/main-pages/configuration/configuration-tabs/cron-task) so you should do it only if you are wondering what's going on.

It requires two triggers from the cron task to generate and send your Newsletter automatically. The first time the cron task triggers your website will generate your Newsletter as a scheduled Newsletter and then the second time it will take care of adding all e-mails in the queue and will start the send process.

## Frequently Asked Questions <a href="#frequently-asked-questions" id="frequently-asked-questions"></a>

### My Smart-Newsletter is generated properly when I click on the Generate button but it does not do the job automatically, why? <a href="#my-smart-newsletter-is-generated-properly-when-i-click-on-the-generate-button-but-it-does-not-do-the" id="my-smart-newsletter-is-generated-properly-when-i-click-on-the-generate-button-but-it-does-not-do-the"></a>

The automatic process requires a cron task. Please make sure [you configured a cron task on our server or on your own server](/old/main-pages/configuration/configuration-tabs/cron-task) and test your cron task to make sure it's working properly.

### The Newsletter is created automatically. But this Newsletter is published and no e-mails are added to the queue, why? <a href="#the-newsletter-is-created-automatically-but-this-newsletter-is-published-and-no-e-mails-are-added-to" id="the-newsletter-is-created-automatically-but-this-newsletter-is-published-and-no-e-mails-are-added-to"></a>

First, make sure your Smart-Newsletter is attached to at least one published list and that this list contains at least one subscriber!

But this case is a normal behaviour if you selected the option **Generating Mode:** **Wait for the confirmation before sending** so you should edit your Smart-Newsletter and make sure you selected the option **Generating Mode:** **Send the generated Newsletter**

![](/files/-MJSIRLm5DE2BWo-fcAJ)

Smart-Newsletter testing mode

### I created a new article but the Newsletter has not been sent, why? <a href="#i-created-a-new-article-but-the-newsletter-has-not-been-sent-why" id="i-created-a-new-article-but-the-newsletter-has-not-been-sent-why"></a>

First of all, you should make sure [your cron task is configured properly and running](/old/main-pages/configuration/configuration-tabs/cron-task).

AcyMailing won't send the Newsletter immediately. AcyMailing needs to be triggered twice by the cron task:

> > * The first time AcyMailing will generate the Newsletter
> > * The second time AcyMailing will send the generated Newsletter
> >
> > &#x20;So if you have a cron frequency of 15 minutes, AcyMailing will send your Newsletter from 15 to 30 minutes after the article creation (if your Smart-Newsletter frequency is 0)

You can add several tags with different categories (or even the same categories). If you do that, the Newsletter will be only generated if each tags meets its minimum number of articles. So if you have two content tags with a minimum set for both but one of them has no new article, then the Newsletter won't be generated. Of course, you can set the minimum to 0 so it won't block the generation.

### Can I add a tag in the Newsletter subject? <a href="#can-i-add-a-tag-in-the-newsletter-subject" id="can-i-add-a-tag-in-the-newsletter-subject"></a>

Yes, you can! That's very useful if you use the Smart-Newsletter as a notification system so you can even add the article title in your Newsletter subject. Simply copy/paste the tag you want to use in your Smart-Newsletter subject and it will do the job.


# Campaigns

&#x20;This documentation will explain to you, step by step, how to create a campaign with follow-up messages (this feature is only in AcyMailing Enterprise).

The objective of this tutorial is to automatically send three messages to the user:

* The first one when he subscribes
* The second one two days after his subscription
* And a third message 30 days after his subscription

## Create a campaign <a href="#create-a-campaign" id="create-a-campaign"></a>

* * Click on the menu **AcyMailing -> Campaign**

![](/files/-MJSIggy8nY9xvyv6fvk)

Campaign Menu

* * Create a new campaign by clicking on the button **New**

![](/files/-MJSIiyEW0OT3Qp5aIbB)

New campaign

* * Enter a **name** for your campaign (this name is only visible on the back-end so you can write anything you want)
  * Enter a **description** (this is only for ease of use when you handle several campaigns)
  * We won't activate the campaign for now and we won't attach it to any list neither so that we can create messages and then publish everything
  * Click on the button **Save** to save your campaign and return to the previous screen.

![](/files/-MJSIlIisAp13nSg9kfp)

Save your campaign

## Add 3 follow-ups to your campaign <a href="#add-3-follow-ups-to-your-campaign" id="add-3-follow-ups-to-your-campaign"></a>

* * Click on the little **new** icon to create your first follow-up message in this campaign

![](/files/-MJSIqR9SR4r2GLJK3m-)

new Follow-up

* * You should now be quite familiar with this interface as it's the same as the Newsletter edition except that you can set up a delay on this e-mail
  * Like when you create a Newsletter, you can change your template by clicking on the Template button, you can add tags to your e-mail, etc.
  * Enter a **Subject**, the **delay 0** (as we want to send it immediately), **publish** this e-mail and then click on the button **Save**.

![](/files/-MJSItM4ERanX7T9GAiP)

First follow-up

* * We are back on our main Campaign interface but this time you can see a new follow-up has been added to the campaign with the delay 0.

![](/files/-MJSIvwSyD8iP5fOOT26)

Followup1 added

* * Repeat the same process and create two more messages with the delay 2 days and 30 days for your campaign.

![](/files/-MJSIzIpHdpy8ftKtjFZ)

3 follow ups added

* At this stage, we have a campaign which is not activated so no e-mail will be sent. This campaign contains 3 messages which will be respectively sent at the subscription date, 2 days after the subscription and 30 days after the subscription of the user.
* In this tutorial we created only 3 messages but you can create as many follow-up messages as you want, there is no limitation on the number of messages you can create in each campaign.

## Attach the campaign to one list <a href="#attach-the-campaign-to-one-list" id="attach-the-campaign-to-one-list"></a>

We will now attach the campaign to one list so if the user subscribes to this list, the campaign will be triggered for this user. And if the user unsubscribes from that list, he will also be removed from the campaign.

* * Click on the name of your campaign
  * You will be redirected to a page where you can edit your campaign.
* * **Attach** your campaign to at least one list (you can attach it to several lists so if the user subscribes to at least one of the attached lists, the campaign will be triggered) and **enable** your campaign

![](/files/-MJSJ5BgeRvLnfQol-6h)

Activate campaign

* **Save** your campaign.
* Your campaign is now activated with 3 follow-up messages. This campaign is attached to at least one list so if a user subscribes to your list, the campaign will be triggered and the three follow-up messages will be added to your queue of messages with different send dates.
* AcyMailing uses a cron system to automatically send the messages from this queue. So you have to make sure your cron task is configured properly otherwise this automatic process won't work and the messages won't be sent. We created an easy interface to let you create a cron task on our own server, just have a look at the tab **Cron** on your AcyMailing Configuration page and click on the button **Create/Edit a cron task** to enable it.

Your campaign is now ready, you don't have to do anything else, AcyMailing will do the job.

## Test the whole process <a href="#test-the-whole-process" id="test-the-whole-process"></a>

Let's test what we just created.

So we will create a new user and subscribe him to the list "Download AcyMailing". As this list is linked to our campaign, the user will be automatically inserted in the campaign and 3 e-mails will be added to the queue with three different send dates. Then, AcyMailing will automatically send e-mails from the queue as it's triggered regularly by the cron.

* * Go to the AcyMailing **Users** page.
  * Click on the **New** button to create a new user

![](/files/-MJSJ7iVOH8zrIl1EZmY)

New user

* * Enter his name, e-mail address and subscribe him to one of your lists. In our example we will subscribe the user to the list "Download AcyMailing" as it's the only one we linked to our campaign.

![](/files/-MJSJ9yvk2-lpIWvZNnv)

User Subscribe

* * Click on the **Save** button
  * The user is now added to our list of users and subscribed to the list "Download AcyMailing". As this list is attached to our campaign, our three e-mails have been added to the queue for this user.
  * Click on the menu **Queue** and you should see three e-mails added for the user you just created.

![](/files/-MJSJCHzvxR16PNheP1V)

Queue

* If not, please make sure your campaign is **enabled** and **attached to one of your lists** and try again.
* If the process works properly until this step but you don't receive your messages automatically, please make sure your cron is working properly. Remember that each message is sent because the cron triggers AcyMailing. So your first e-mail with 0 delay won't be sent immediately. It will be sent as soon as the cron triggers AcyMailing (usually maximum 15 minutes after the user subscription). If you want the first e-mail to be sent immediately on the user subscription and not have this delay, please create a welcome message in your list instead of this first follow-up. The welcome messages are not sent if you create the user from the back-end so you may want to test the process directly from your form subscription on the front-end.

## Frequently Asked Questions <a href="#frequently-asked-questions" id="frequently-asked-questions"></a>

### What does happen if I create a new follow-up message while my campaign already started? <a href="#what-does-happen-if-i-create-a-new-follow-up-message-while-my-campaign-already-started" id="what-does-happen-if-i-create-a-new-follow-up-message-while-my-campaign-already-started"></a>

If you publish a follow-up, you will see this message...

![](/files/-MJSJGr74M8wujsHFA8P)

Message published

There are two links enabling you to add this new follow-up in the queue for your existing users, either for all of them or only the ones created less than X days before (X days is the delay of your follow-up).

For example, I already have an active campaign and many users are already in it. If I create a new follow-up with a delay of 20 days and click on the first link, then this follow-up will be added in the queue for all users subscribed less than 20 days ago to my campaign (so that they will receive it 20 days after they subscribed to the campaign). Users subscribed more than 20 days ago won't receive it in that case. If I click on the second link, all users will receive it regardless their subscription date... so if it's been more than 20 days, they will receive it immediately and if they are in the campaign since less than 20 days then they will receive it 20 days after their subscription.

### What does happen if I change the delay of my follow-up message? <a href="#what-does-happen-if-i-change-the-delay-of-my-follow-up-message" id="what-does-happen-if-i-change-the-delay-of-my-follow-up-message"></a>

If you change the delay of one of your follow-up, you will see this message...

![](/files/-MJSJIrlXuiz9V2FBUVQ)

Changed delay

If this follow-up is already inserted in the queue, you can decide to update the delay for all current users.

That way, if I switch the follow-up delay from 4 days to 3 days and click on that link, current users will receive the message 3 days after their subscription instead of 4.


# Joomla notifications

Since AcyMailing 4.6.0 all paid versions of AcyMailing can replace the Joomla notification messaging system in order to:

* Make them beautiful!
* Modify the content
* Include other elements like your latest 5 Joomla articles thanks to our powerful tag system
* Set the sender information the way you want
* Add attachments if you like...
* Track your notification emails so you know who opened it!

## Access the Joomla notification area <a href="#access-the-joomla-notification-area" id="access-the-joomla-notification-area"></a>

Access the Joomla notifications area via AcyMailing to customize your messages. Click on the **Joomla notifications** menu under the **configuration** one in the AcyMailing component.

![](/files/-MJSJP0qx48svGCaisWj)

Access the joomla notification interface

## Use the AcyMailing message instead of the Joomla one <a href="#use-the-acymailing-message-instead-of-the-joomla-one" id="use-the-acymailing-message-instead-of-the-joomla-one"></a>

AcyMailing already installed all Joomla messages you can customize. To use the AcyMailing version instead of the default Joomla one, you should:

* Enable the **Override Joomla mailing system** plugin via the Acy configuration page

![](/files/-MJSJRO521n_lPYGkS6N)

Publish the Joomla override plugin

* Publish the message you want to use instead of the Joomla one

![](/files/-MJSJTiK7a-JrfH85h-Y)

Publish the message

* That's it! AcyMailing will now take care of this email and it will be automatically tracked.

The texts in the subject and body of emails like "{trans:COM\_USERS\_EMAIL\_ACCOUNT\_DETAILS|param1|param2}" are text that will be taken from your Joomla text files. These are the default texts you would have without override.

Here is an example of our default notification message when the user registers on Joomla:

![](/files/-MJSJVPbcl3Qzr6VsCBZ)

Default notification message

## Available notifications <a href="#available-notifications" id="available-notifications"></a>

We currently override notifications from Joomla!, JomSocial and SEBLOD.

If you want to override the notification from JomSocial, you will need to set JomSocial to sent the text version of emails (JomSocial configuration -> Site -> "HTML Emails" option to NO).

## Custom links <a href="#custom-links" id="custom-links"></a>

By default links in the notifications are created as real links and the text is the URL of the link. You can customize the links by creating your owns. In the href parameter of your link, use {linkX} instead of the {paramX} parameter (X being the number of the parameter). For example, if param3 is a link, you could use this:

```
<a href="{link3}" target="_blank">Click here to proceed</a>
```

## Components we can't override emails from <a href="#components-we-cant-override-emails-from" id="components-we-cant-override-emails-from"></a>

We can't override the emails sent from the following components as we can't identify properly the email, get the data to replace or prevent the sending of the other component email:

* VirtueMart
* Community Builder


# Simple Sending

## Description <a href="#description" id="description"></a>

This feature enables you to send simple mail to a bunch of users (Enterprise only). Emails can be simple or using a template, including tags or not. Using this feature you have to know that no data will be saved on your website, including no statistics.

Please don't use it to send your newsletter to users, use it only as testing purposes.

## How to send an email using Simple Sending feature ? <a href="#how-to-send-an-email-using-simple-sending-feature" id="how-to-send-an-email-using-simple-sending-feature"></a>

![](/files/-MJSJ_9hN8sN4H7HW0HY)

* First select your users with the input at the top of the page. Separate emails using space character.
* Add a content and a subject to your email.
* Press the send button when you have finished.


# Templates

On your website, you probably installed a template so your content is always formatted the same way and respects some graphic rules.

You can do the same thing for a Newsletter so once your own template is created, you will simply add some content in the main area of your template and you're done.

AcyMailing will automatically install 4 templates but you can create as many templates as you want.

## Template listing

You can access the template listing by clicking on the Joomla menu **Components -> AcyMailing -> Templates** or by using the AcyMailing menu **Newsletters -> Templates**.

![](/files/-MJSJfQ2GG1E16WYrj6s)

### Toolbar

![](/files/-MJSJlS_tGSuebnwHrUk)

* **Import** : Enables you to import a template. The template has to be a zip file.
* **Export** : Enables you to export the selected template from the listing.
* **New** : Enables you to create a new template.
* **Edit** : Select a template and then click on this button in order to edit its information.
* **Delete** : Select one or several templates and click on this button in order to completely delete the selected templates.
* **Help** : This button enables you to turn ON/OFF the help section, this screen will appear or disappear.

### Column headers

![](/files/-MJSJqclUXTJj4a2kcZE)

* **#** : An indexing number automatically assigned for ease of reference.
* **Order** : The templates are ordered and you can modify the ordering of the templates.\
  The templates will be displayed following this ordering on the template selection screen.
* **Checkbox** : Check this box to select one or more items. To select all items, check the box in the column heading.\
  After one or more boxes are checked, click on the delete button in order to delete the selected templates.
* **Template Name** : Name of the template so that you can easily identify it.
* **Default** : If you set a PUBLISHED template as DEFAULT, this template will be automatically loaded when you create a new Newsletter.\
  You will still be able to choose another template when you create a Newsletter but the first PUBLISHED and set as DEFAULT template will be automatically loaded.\
  If you do not set any template as DEFAULT, no template will be loaded when you create a Newsletter.
* **Published**: If you don't publish a template, this template won't be displayed in the template selection screen when you write a Newsletter.
* **ID** : This field indicates the ID of the template.

## Template creation

### Toolbar

![](/files/-MJSJtfo3dlx5K1HrFmO)

* **Tags :** This button enables you to choose a tag and include it in your template so that you won't have to include it each time you write your Newsletter.\
  We highly recommend you to INCLUDE AN UNSUBSCRIBE LINK in each template you will create!
* **Send a test** : Send a test of the template to yourself (default value), to an entire Joomla group (Manager, Administrator or Super Administrator) or to any other e-mail address.
* **Save** : Save the template and go back to the templates management.
* **Apply** : Apply the modifications to the current template and stay on the same screen.
* **Cancel** : Return to the previous screen.
* **Help** : This button enables you to turn ON/OFF the help section, this screen will appear or disappear.

### Configure your template

* * First, enter a template name. This name will be used to identify your template but will never be visible for your visitors.
  * Enter a few words in the description field, you can add some HTML code in this area and so display a template thumbnail if you want.
  * You can enter a subject, so when you create a new Newsletter based on this template, the subject of your Newsletter will be automatically filled with the subject defined in your template. This is a non mandatory field which is used to speed up the Newsletter creation but in most cases you won't have to use it.

![](/files/-MJSJwpebqpUO8N4fhiA)

* If you set a **published** template as **default**, this template will be automatically loaded when you create a new Newsletter.\
  You will still be able to choose another template when you create a Newsletter but the first **default published** template will be automatically loaded.\
  If you do not set any template as **default**, no template will be loaded when you create a Newsletter.

### Create your template structure

* If you already created a Joomla template, you probably used a lot of div and refused to insert any table in your template.\
  Nevertheless, for a Newsletter template, your structure should be created with **tables** as it's the only way to display it properly on all mail clients.\
  Forget about float:left, position:absolute... and say hello to table,tr and td!
* Let's create a table structure:
  * First create a div which will encompass your entire Newsletter and centre it on the mail client :

    ```
    <div style="text-align:center;width:100%"> </div>
    ```
  * Then create a table structure inside this div. A classical table structure will be composed of a header, a main area and a footer:

    ```
     
    <!-- This first div encompass your entire Newsletter, you can set the background-color on it -->
    <div style="text-align:center;width:100%;background-color:#dddddd;">
    <!-- this table will enable you to get a centred area on which you will add your header, main content and footer. -->
     <table width="600" cellpadding="0" cellspacing="0" style="background-color:#ffffff;text-align:left;margin:auto;" align="center">
    <!-- then you can add your header -->
     <tr><td>HERE WILL BE MY HEADER</td></tr>
    <!-- your main area -->
     <tr><td>HERE WILL BE MY MAIN CONTENT</td></tr>
    <!-- your footer -->
     <tr><td>HERE WILL BE MY FOOTER</td></tr>
     </table>
    </div>
    ```
  * We set a fixed width to the table, 600px is what's usually used to create newsletter-templates.
* To apply a background-colour to your template, select the colour you want to use using the colour selection.
* This is the default structure most of Newsletters-templates will have but you can of course use the structure you want and copy one of our default Newsletter-template for ease of use.

### Apply some styles to your content

Being compatible with all e-mail clients is a nightmare. Some of them don't accept external stylesheet, others don't accept internal stylesheet...

But one solution is working for all e-mail clients : the inline CSS!\
To facilitate the use of such a method, AcyMailing gives you the possibility to directly write some CSS and AcyMailing will convert your CSS classes or stylesheet into inline CSS.

### Individual styling

![](/files/-MJSK-F8FsMNUH9j2pDB)

* You can set some CSS to each element and this CSS will be added as inline CSS to your Newsletter on the preview screen and during the send process.
* When you insert articles, products, events... using our tag system, AcyMailing will use the style you defined in your template:
  * **Style for the article area** will be used to encompass your article
  * **Style for the article title** will be applied to your content title
  * **Style for the read more link** will be applied to the read more link coming from content inserted via our tag system.\
    If you insert the introduction only of Joomla articles for example.
  * You can also set the style of all your links using the **Style of the links** field

For example, this configuration:

![](/files/-MJSK1jiEQMDGu04WoTn)

Will render:

![](/files/-MJSK3rjjRi7OZKm_1kE)

### Stylesheet

But you can also simply add a stylesheet to your template and this entire Stylesheet will be automatically applied to each of your html element in your Newsletter (as inline CSS).

![](/files/-MJSK64L4-jEV5Z_9YRa)

* This stylesheet interface has been developed with AcyMailing 1.3.0 and is only available if your server uses at least PHP 5 and the PHP DOM Extension is enabled on your server as AcyMailing needs this php library to handle the replacement of your html elements in inline CSS.
* Both interfaces to handle the styles will have the same result but you will have much more flexibility by directly using the stylesheet.
* Please don't use \* and don't add any comments in this area. Only CSS.

### Header

In some cases (generally because of Outlook), you may need to add some specific code to the \<head> part of the sent emails. In this case, you can paste it in the "Header" tab of your templates like in this example:

![](/files/-MJSK8LPSCnau_G3k69z)

Please be careful of what you add in this tab, as AcyMailing doesn't check its content at all (so you may break your template's structure if you insert a bad code).

## Tips

* Outlook 2007 won't display any of your background images so if you add background images, please also make sure you specified a background colour to support Outlook 2007
* Some mail system will apply a default style on any content inserted in a table.\
  We recommend you to define the style applied on your table and div so you will overwrite the style specified by the mail client and make sure the content will be displayed the way you want on every mail client.\
  Example : table,div{ font-family:verdana;font-size:12px;}
* Outlook may not apply the width you set on each column if you don't apply it on all your columns on the current table.
* Hotmail applies a green color to your titles (h2,h3,h4...), you should add a !important to your css to make sure Hotmail won't overwrite your color ( style="color:red !important" )
* Outlook might resize your pictures in a strange way, to avoid this layout issue and keep a good ratio for all your picture, insert the width and the height of each of your pictures directly in their \<img> tag. If you forget to do this, don't worry, AcyMailing will do it for you!
* If you want to create styles that will appear in the style dropdown of the Acymailing editor, you should then create them in the Stylesheet tab and specify the html tag on which the class is meant to apply. For example span.myClass will apply the style only on the selected text, div.myClass will apply the style on all the whole area containing the text. For example:

  ```
  span.myClass{ color:#d1021c; }
  div.anotherClass{ font-size:12px; }
  ```

## Frequently Asked Questions

### I have another template exported from another program, how can I use it in AcyMailing?

First create a zip file of this template (including the pictures) and then [upload it on AcyMailing](/old/main-pages/newsletters/templates/import-a-template).

### I'm testing my Newsletter on Outlook and a different style is applied to the text inside a table, why?

* Outlook applies a style to the text inside your table, that's why the text outside a table is different than the one inside the table.
* To avoid this issue, you should force the style of your content by adding some CSS to your Newsletter-template, for example:

  ```
  table,div{ font-family:Verdana;font-size:12px;}
  ```

### How to apply a colour to all my links?

* You can apply a colour to your links by adding the code color:red; to the field "Style of the links" in your Newsletter-template


# Import a template

## Upload a template <a href="#upload-a-template" id="upload-a-template"></a>

Designing a Newsletter template can be tricky, especially making sure it will be displayed properly on all mail clients.

So it's usually much easier to use an existing Newsletter template structure instead of starting from scratch.

AcyMailing enables you to easily import any template you can [download on our website](https://www.acyba.com/acymailing/templates-pack.html) but also almost any Newsletter template you can find and download on internet (do a quick search on internet with the words "Newsletter template", you should find many results) or you created by yourself with another software.

* Click on the menu "AcyMailing -> Templates".

![](/files/-MJSKHO1E63LJUXdqXDu)

Template menu

* Click on the button "import"

![](/files/-MJSKJc1xFsoZa9UxeK-)

Button upload

* A popup will open and you will be able to browse a zip package and then click on the button upload. AcyMailing will copy all the pictures on your server, extract the CSS, background-colour and other information from the index.html file and create a new AcyMailing template with it.

![](/files/-MJSKLM-i2OlVaMkk5Ag)

Upload template

## Frequently Asked Questions <a href="#frequently-asked-questions" id="frequently-asked-questions"></a>

### I created a template with Dreamweaver, how can I import it in AcyMailing? <a href="#i-created-a-template-with-dreamweaver-how-can-i-import-it-in-acymailing" id="i-created-a-template-with-dreamweaver-how-can-i-import-it-in-acymailing"></a>

First save your template with Dreamweaver in a specific folder.

Then create a zip of this folder and select it on our interface (using the browse button).

### What's the import newsletter-template format? <a href="#whats-the-import-newsletter-template-format" id="whats-the-import-newsletter-template-format"></a>

If you want to create your own template and import it, you should create an index.html file which contains the template html code. Then create a zip of this file and all the necessary pictures and import the zip via our interface. The index.html file can display pictures using relative path, AcyMailing will convert the picture path properly during the import. You can also include a file thumbnail.png in the same directory as your index.html file, it will be used as thumbnail.

Here is the default structure of your index.html :

```
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"><html xmlns="http://www.w3.org/1999/xhtml"><head><meta http-equiv="Content-Type" content="text/html; charset=utf-8" /><title>Newsletter-template TITLE</title><style type="text/css"><!--Your CSS stylesheet here...--></style></head><body>Your html code here...</body></html>
```


# Queue

## Description <a href="#description" id="description"></a>

This screen enables you to see and remove any e-mail which will be sent by AcyMailing.

You can sort your lists by any field, search using the "filter" box and directly delete entries by clicking on the small Delete Icon.

![](/files/-MJSKaQTSEikpY6opfsE)

Queue menu

* **Process :** If you click on this button, AcyMailing will open a popup and you will be able to see all the e-mails ready to be sent.
* **Delete** : If you click on this button, the entire queue will be emptied. If you select a Newsletter in the dropdown and then click on this button, all the e-mails belonging to the selected Newsletter will be removed.
* **Help** : This button enables you to turn ON/OFF the help section, this screen will appear or disappear.

## Column Headers <a href="#column-headers" id="column-headers"></a>

![](/files/-MJSKcDgBhqcgingtH3I)

Queue Columns

* **#** : An indexing number automatically assigned for ease of reference.
* **Send Date** : Official send date of the e-mail. It does not mean the e-mail will be sent at this exact time but this field indicates that from this time, AcyMailing is allowed to send the e-mail.
* **Subject** : Subject of the e-mail which will be sent. You can at any time edit the Newsletter and change anything in it. Those modifications will be passed on to any e-mail of the Newsletter in the queue.
* **User** : Receiver of the e-mail.
* **Priority** : If you use the follow-up autoresponder system and the Newsletter system, AcyMailing will send first the e-mails with the lowest priority number. AcyMailing never sends an e-mail if the send date is not in the past. Nevertheless, in some cases, you can have several Newsletters ready to be sent and some follow-up messages too. Most of mail system won't apply any priority and will send your Newsletter before the follow-up messages (so the receiver may wait several hours before receiving his first follow-up message) but AcyMailing handle that case and will send the follow-up first as it's considered as more time sensitive than a standard Newsletter.
* **Try** : AcyMailing will try to send each e-mail. If an error occurs (for any reason), AcyMailing will keep the e-mail in the queue and will try to send it later. After X tries, AcyMailing will consider the e-mail failed and won't queue the e-mail any more. You can configure those parameters in the AcyMailing Configuration page.
* **Delete** : This is a quick button in order to delete an e-mail sent to a user. Be careful as there is no confirmation message on this button! If you click on it, the selected row will be deleted!
* **Published** : Published indicates the publish field of the Newsletter itself. A non published Newsletter will never be sent so this icon enables you to know if the e-mail will be sent or not.

## Process <a href="#process" id="process"></a>

If you click on the process button, this popup will appear. This is a summary of all e-mails in the queue which are ready to be sent.

If you have a cron task (from AcyMailing Essential) , this cron task will automatically trigger your AcyMailing component and send those messages (batch per batch so it can take time), but you can always decide to manually send those e-mails by clicking on the button "**Send**".

![](/files/-MJSKeA0fqdEfqAXo5bS)

Queue popup


# Statistics

## Open rate <a href="#open-rate" id="open-rate"></a>

### How does it work? <a href="#how-does-it-work" id="how-does-it-work"></a>

When AcyMailing sends an HTML e-mail to your user, it will include in this e-mail a small picture.

The first time this picture is loaded by the receiver, AcyMailing will increment the number of unique open for that Newsletter and the number of times this user opened it.

If this same picture is loaded again, AcyMailing will only increment the number of times this user opened it so the open rate indicates the percentage of users who opened your Newsletter at least one time.

### Is that 100% accurate? <a href="#is-that-100-accurate" id="is-that-100-accurate"></a>

This system only works with HTML e-mails so if you send a plain text messages, your open rate can't be calculated.

Some mail clients won't display pictures by default so the receiver will have to click on the link "Always display pictures from..." to display pictures and get recorded as somebody who opened your Newsletter.

So no, the open rate is not 100% accurate and you should only use it to compare results between your Newsletters.

**Percentage of opened emails:** Great > 30% Good – 15-30% Poor < 15%

### How can I turn it OFF? <a href="#how-can-i-turn-it-off" id="how-can-i-turn-it-off"></a>

The tracking picture is inserted by the plugin "AcyMailing : Statistics Plugin".

You can disable this plugin for the AcyMailing configuration, tab "plugins".

### What does it mean if a user opens it more than one time? <a href="#what-does-it-mean-if-a-user-opens-it-more-than-one-time" id="what-does-it-mean-if-a-user-opens-it-more-than-one-time"></a>

Technically, it means the statistics picture has been loaded more than one time.

So it could be because the user forwarded to another user or simply because he read it several times.

Some mail software have a "preview" system where the message is loaded when the user access his mailbox, that could cause the stat picture to be loaded a lot of times.

### I get 100% open rate a little after sending my newsletter, am I very lucky today or..? <a href="#i-get-100-open-rate-a-little-after-sending-my-newsletter-am-i-very-lucky-today-or" id="i-get-100-open-rate-a-little-after-sending-my-newsletter-am-i-very-lucky-today-or"></a>

100% open rate would be perfect, but I'm sorry that shouldn't be the case.

Since April 2015, a new anti-spam tool (at least on SiteGround) checks every images link to see if it's really an image. Unfortunately, the open statistics in the newsletters are calculated using a link in an image and this tool "Clicks" on this statistic link...

Simply update AcyMailing to its latest version, we already found a workaround!

## Statistics listing <a href="#statistics-listing" id="statistics-listing"></a>

### Description <a href="#description" id="description"></a>

This screen enables you to see the statistics of any e-mail sent by AcyMailing.

![](/files/-MJSKnLmw5JD91dhrNDL)

* **Compare** : If you selected at least 2 newsletters or previously added some, clicking this button will take you to the statistics comparison page
* **Add** : You can add the selected newsletters to the compare tool using this button (useful when selecting newsletters on different pages)
* **Reset** : If you click on this button, it will reset the compare page (so you can select other newsletters)
* **Export** : If you click on this button, you will export the statistics you see on the page
* **Delete** : You can select one or several messages and then click on the delete button in order to delete the statistics of this message. By clicking on the delete button, you won't delete the message but simply the statistics associated to this message.
* **Help** : This button enables you to turn ON/OFF the help section, this screen will appear or disappear.

### Columns <a href="#columns" id="columns"></a>

![](/files/-MJSKtQm2plgdwOzBqpt)

statistics listing

* **Send Date** : Latest send date of the e-mail
* **Subject** : Subject of the e-mail sent. If you click on the subject of the e-mail, a popup will open with some [charts statistics](/old/main-pages/statistics/statistics-charts).
* **E-mail Opens** : Number of e-mails opened by your receivers. The percentage is calculated using the number of e-mails sent in HTML as AcyMailing can not determine the number of e-mails opened for the plain text version. AcyMailing adds a small blank picture in all your HTML Versions in order to determine if the e-mail has been opened or not. Your receivers may open the e-mail but not accept to display pictures, in which case AcyMailing will consider the e-mail as not being opened. This number indicates the MINIMUM number of e-mails read by your receivers, not the real one as AcyMailing cannot track all of them. If you click on the link, you will be redirected to the detailed statistics listing.
* **Efficiency :** The efficiency is the percentage of users who clicked on a link based on the number of users who opened on your Newsletter.
* **Clicked a link** : If you turned on the URL Tracker Plugin, AcyMailing will be able to track all links in your Newsletter. This column indicates you the percentage of users who clicked at least on one link in your Newsletter. This percentage is calculated based on the number of e-mails sent in HTML as AcyMailing only tracks the links in HTML e-mails. This column is only available from AcyMailing Essential. If you click on the link, you will be redirected to the URL Tracker listing.
* **Unsubscribe** : If you included an unsubscribe link in your e-mail, AcyMailing is able to know who unsubscribed from the link in this e-mail. This column is only available from AcyMailing Enterprise.
* **Forwarded** : If you included a "forward to a friend" link in your e-mail, AcyMailing will track the number of users who forwarded your Newsletter. This column is only available from AcyMailing Enterprise.
* **Sent in HTML** : Indicates the number of e-mails sent in HTML format.
* **Sent in Text** : Indicates the number of e-mails sent in Plain text format.
* **Bounces** : Indicates the percentage of bounces for this mailing. A bounce is a notice sent by When the e-mail server receiving the e-mail for the user you sent it to did not accept your email, it sends back a bounce message in order to notify you. This option is only available with AcyMailing Enterprise and only if you configured properly your bounce handling system.
* **Failed** : Indicates how many e-mails could not be sent by AcyMailing.
* **Stats per list** : Display some comparative graphs according to the list it has been sent to. This column is only available from AcyMailing Enterprise.
* **ID** : ID of the e-mail.

### Charts  <a href="#charts" id="charts"></a>

This chart is only available from AcyMailing Enterprise. By clicking on the subject of any e-mail, you will be able to see some charts.

![](/files/-MJSKy0o-mvB3U-BSypV)

## Statistics detailed listing <a href="#statistics-detailed-listing" id="statistics-detailed-listing"></a>

### Description <a href="#description-1" id="description-1"></a>

This screen enables you to see the status of all e-mails sent by AcyMailing. You can order your listing based on any column. You can also filter it with a specific e-mail via the dropdown available on the right. You can also search for a specific user or an e-mail.

![](/files/-MJSL-P2qYvuowdCsQ6l)

Toolbar

* **Export** : This button will export the users you can see on the page.
* **Global Statistics** : Go back to the global statistics screen.
* **Help** : This button enables you to turn ON/OFF the help section, this screen will appear or disappear.

### Columns <a href="#columns-1" id="columns-1"></a>

![](/files/-MJSL1G7Wi5GS_3XFbdn)

Columns

* **Send Date** : Send date of the e-mail.
* **Subject** : Subject of the e-mail sent to the user. You can click on the subject to edit the e-mail itself.
* **User** : Receiver of the e-mail. You can click on the user to edit his profile.
* **Version** : Version sent to the user : HTML or Plain Text.
* **E-mail Opens** : Indicates you if the user opened the e-mail and how many times he opened it. This option can only work with HTML e-mails. Also, if the user didn't accept to display pictures when reading the e-mail, he won't be counted as an opened e-mail.
* **Bounces** : Indicates if the e-mail bounced or not. If the value is superior to 0, it means that the e-mail server receiving the e-mail did not accept it and sent one or several notices back. This column is only available with AcyMailing Enterprise.
* **Delivered** : Indicates if the e-mail has been sent by AcyMailing or not.

## Click tracking  <a href="#click-tracking" id="click-tracking"></a>

All our commercial versions include an url tracker.

You will be able to know the number of clicks per link in your Newsletter.

Using AcyMailing Enterprise, you will even see who clicked on which link for each Newsletter.

The attributes passw, user, subid, key and user\_var(0-9) will be removed from the recorded link in the statistics (so there will not be 3000 links if you sent your newsletter to 3000 users and that there is a different link for each user).

You can use the attribute user\_var(0-9) (user\_var675 for example) in your links, it is an additional attribute unused in AcyMailing (since v4.9.0).

## Statistics calculation <a href="#statistics-calculation" id="statistics-calculation"></a>

Since AcyMailing version 4.9.3, some statistics calculation rules have been updated with a little change in the display. It mainly concerns the percentages. Here is a recapitulation of the rules:

* Open rate: number of unique open / (sent as HTML + sent as text - bounces)
* Clicked a link: number of unique click / (sent as HTML + sent as text - bounces)
* Efficiency: number of unique click / number of unique open
* Unsubscribe: number of unsubscribes / (sent as HTML + sent as text - bounces)
* Sent: sent as HTML + sent as text
* Bounces: number of bounces / number of sent

## Frequently Asked Questions <a href="#frequently-asked-questions" id="frequently-asked-questions"></a>

### My statistics are not working, what can I do? <a href="#my-statistics-are-not-working-what-can-i-do" id="my-statistics-are-not-working-what-can-i-do"></a>

AcyMailing inserts a small picture in your Newsletters to track the open rate.

This picture should be accessible for everybody and you should make sure to click on the button "display pictures from that website" when you received your Newsletter.

* Make sure the default AcyMailing plugins are activated, especially the "AcyMailing Tag : Subscriber information" plugin
* Your website should be online and publicly accessible... If you have a restricted access to your website or if your website is a local one, it won't work. Make sure the option "Site Offline" is disabled on the Joomla configuration page.
* AcyMailing should be attached to a menu with a public access. Please check the menu attached to Acy on the AcyMailing configuration page to make sure it's publicly accessible.
* Do you have sh404SEF installed? If so then we recommend you to edit the sh404SEF configuration and configure it to skip AcyMailing. Then access the sh404SEF urls and delete all urls containing com\_acymailing.
* With AcyMailing v2 we added a column "IP" on the acymailing\_userstats table. You should check the structure of this table via phpMyAdmin to make sure it has been added as it should. If not, that would also prevent the statistics from being recorded. Since AcyMailing 4.7.0 we added an easy verification for that... access the AcyMailing configuration page and click on the button "[check database integrity](/old/main-pages/configuration#database-maintenance)" within the "security" tab.
* Did you customize your .htaccess file? If so, try this url (please enter your own website url!) : <http://www.yourwebsite.com/index.php?option=com\\_acymailing\\&ctrl=statistics> It should display a picture (you won't see much on that screen) but if there is a redirection to another page then the stats won't work and that's probably because you set up some rules in your .htaccess file to redirect to another page.


# Click statistics

## Description <a href="#description" id="description"></a>

This screen enables you to manage the url tracker and see the click statistics.

You can filter your listing by URL or by E-mail.

![](/files/-MJSLJ5MGOxWVUr-u1Qc)

Toolbar

* **Global Statistics** : Go back to the global statistics screen.
* **Help** : This button enables you to turn ON/OFF the help section, this screen will appear or disappear.

## Columns <a href="#columns" id="columns"></a>

![](/files/-MJSLL2n0oyKV76nL_6i)

Columns

* **URL** : Name of the link. If you click on it, you will be redirected to the designated page. If you click on the edit icon, a popup will open enabling you to edit the name of the link for ease of use.
* **Subject** : Subject of the Newsletter where the link is included.
* **Unique Hits** : Number of unique hits for this link and this Newsletter.
* **Total Hits** : Total number of hits for this link and this Newsletter.

## Edit an URL <a href="#edit-an-url" id="edit-an-url"></a>

![](/files/-MJSLMv4YaaV-IjxKsx0)

Popup

* **URL Name** : For ease of use, you can modify the Name of your url so that it will be easy to identify it.
* **URL** : URL of the link.


# Comparison page

## Description <a href="#description" id="description"></a>

This screen enables you to compare from 2 to 5 newsletter statistics previously selected on the global statistics page.

![](/files/-MJSLSg5oebeSXl1VR2G)

Toolbar

* **Export** : This button will export the visible statistics
* **Reset** : This button will empty the compare page and take you to the global statistics page.
* **Cancel** : This button will take you to the global statistics page.
* **Help** : This button enables you to turn ON/OFF the help section, this screen will appear or disappear.

## Content <a href="#content" id="content"></a>

![](/files/-MJSLUi1wjhO8gt8SP0W)

Columns

&#x20;As you can see the shown statistics are the same as in the global statistics page, only the way they are displayed changes so you can easily compare them.

This feature is useful if you want to compare statistics for newsletters that aren't displayed on the same page in the global statistics.


# Statistics charts

## Description <a href="#description" id="description"></a>

This page enables you to generate statistic charts on your lists subscriptions on a specific period and export it as csv.

This feature is available in AcyMailing Essential or higher&#x20;

## How to access this screen <a href="#how-to-access-this-screen" id="how-to-access-this-screen"></a>

In the AcyMailing left menu, click on the "Statistics" then "Charts" menu.

![](/files/-MJSL_sn5pMMT6PEi0xv)

![](/files/-MJSLb_9DqdTUvmozTmT)

You can use this interface to build your Call to Action the way you want.

* **Export**: Export the generated chart data in a csv file using this button
* **Print**: Print the generated chart and a table containing the chart's data with this print button
* **Cancel**: Get back to the subscribers listing
* **Help**: Display this page in your site

## Options <a href="#options" id="options"></a>

![](/files/-MJSLdv8DA2HD5RL4MpW)

&#x20;You can refine the date range and the chart type using those options.

* **Chart type**: Select if you want to generate a column chart or a line chart
* **Date range**: Select or not the date range with the one you want to pick the statistics
* **Interval**: Choose the interval used in the chart generation
* **Add up the results**: Add the previous result in the new one? For example:
  * No: October 145 new subscribers, November 67 new subscribers, December: 75 new subscribers
  * Yes: October 145 subscribers, November 212 subscribers, December: 287 subscribers

Once you selected the options you want, you can click on the "Generate chart" button to see the generated chart.

## Lists <a href="#lists" id="lists"></a>

![](/files/-MJSLfzCjoZ2j2yymmeV)

Select the lists you want to compare, or leave it unchecked to compare all your lists.

You can also check the "Years" option to compare the list subscriptions per year.

## Charts <a href="#charts" id="charts"></a>

There are currently two types of charts. Here is the column chart:

![](/files/-MJSLiMneGfmBa-mGUUs)

And here is the line chart:

![](/files/-MJSLkZxIrE_4eW3ALoT)

Select the lists you want to compare, or leave it unchecked to compare all your lists.

You can also check the "Years" option to compare the list subscriptions per year.

## Export <a href="#export" id="export"></a>

![](/files/-MJSLmnf8HFfJPvOwDz_)

Once your chart is generated, you can export its data by clicking on the "Export Chart" button at the bottom of the page. A text area will appear enabling you to copy the data in csv format. You can also click on the "Export" button in the toolbar to directly download a csv file with this data.


# Configuration

![](/files/-MJSLygr8D18O4rzx2bc)

AcyMailing configuration

## Description <a href="#description" id="description"></a>

This screen enables you to configure AcyMailing.

During the install process, AcyMailing will be automatically configured using your Joomla Configuration but you can modify it at any time.

You will also find a tool to easily publish/unpublish the AcyMailing plugins and add/modify the AcyMailing languages files.

![](/files/-MJSM0_uW03lo7ePTVjK)

Configuration Toolbar

* **Send a test** : Save the configuration page and send a test e-mail to the currently logged in user (you!) using your configuration. This button enables you to make sure you can send e-mails using AcyMailing.
* **Save :** Save the configuration page and return to the AcyMailing Dashboard.
  * **Apply** : Apply the modifications and stay on the same screen.
* **Cancel** : Return to the AcyMailing Dashboard.
* **Help** : This button enables you to turn ON/OFF the help section, this screen will appear or disappear.

## Mail Configuration <a href="#mail-configuration" id="mail-configuration"></a>

### Sender Information <a href="#sender-information" id="sender-information"></a>

![](/files/-MJSMAJA5qv41TP2S_uq)

Mail Sender

* **From Name** : Default "From Name" used in all your Newsletters. You can modify this property for each Newsletter you write.
* **From Address** : Default E-mail address used as "from" in all your Newsletters. You can modify this property for each Newsletter you write.
* **Reply-to Name** : Default "Reply To Name" used in all your Newsletters. You can modify this property for each Newsletter you write.
* **Reply-to Address** : Default E-mail address used as "reply-to" in all your Newsletters. So, if your receivers click on "reply-to" when they read your e-mail, their response will be sent to this e-mail address. You can modify this property for each Newsletter you write. You can add several reply-to address by separating them with a coma and no spaces: This email address is being protected from spambots. You need JavaScript enabled to view it.,This email address is being protected from spambots. You need JavaScript enabled to view it.
* **Bounce Address** : All automatic response will be sent to this e-mail address. This e-mail address won't be visible for your receivers, it's only useful for server processing and will be used to check your spam score, send you the bounce e-mails (address not found, mailbox not available, mailbox full...).

Some servers restrict the use of the "bounce address" parameter to a local e-mail account. So if my website is example.com, I will only be able to send e-mails if my bounce address is This email address is being protected from spambots. You need JavaScript enabled to view it. Please make sure you can still send a test Newsletter after editing this parameter... If you are unsure, just leave this field empty.

* **Add Names** : If this option is turned ON, the sender and receiver name will appear in the sender/receiver information. If this option is turned OFF, only the e-mail address will be visible. For example: Acy will send the message to "Name \<This email address is being protected from spambots. You need JavaScript enabled to view it.>" with the option turned ON whereas it will be sent to "This email address is being protected from spambots. You need JavaScript enabled to view it." with this option turned OFF. This option won't alter your Newsletter body/subject.

### Mail Configuration <a href="#mail-configuration-1" id="mail-configuration-1"></a>

![](/files/-MJSMCkQvmJ6Ikg8RnWE)

Mail Configuration

* **Mailer Method** : Mailer method used to send your e-mails. We recommend the PHP Mail Function but in some cases you might want to use an external SMTP Server (you can even use your own GMail account!). SMTP will be a little bit slower but you might decrease your spam score by using it.
* **Encoding Format** : Encoding format used for all your Newsletters. We recommend 8-Bit to reduce the spam score.
* **Charset** : Charset used for all your Newsletters. We recommend UTF-8 if you send english or international e-mails. We recommend to use the charset used in your country if your business is local.
* **Word Wrapping** : Some servers do not allow you to send e-mails with more than xx characters per line. This parameter enables you to set this limitation.
* **Hostname** : Sets the hostname to use in Message-Id and Received headers and as default HELO string. Leave this field empty if you don't know what is it.
* **Use https urls** : AcyMailing will automatically convert your relative urls into absolute ones. You can configure Acy to use httpS urls or standard http ones. If you turn ON this option, you should make sure your website has an SSL certificate and is able to display httpS links!
* **Embed Images** : Should AcyMailing embed your pictures inside the Newsletter? If so, the send process will take more time but the recipient won't have to download the picture form your website in order to display it. By default, this option is set to NO so the pictures included in your Newsletter will stay on your own website.
* **Embed Attachments** : Should AcyMailing embed your attachments inside the Newsletter? If not, AcyMailing will add a list of attachments with a link to your website in order to download it. If you disable this option, the send process will be much faster as AcyMailing won't send the attachment but a simple link.
* **Send Multiple Part** : Should AcyMailing send multiple part e-mails? If so, AcyMailing will send the text and the html version in the e-mail so that depending on the recipient server, the appropriate version will be opened.
*

### SMTP Configuration <a href="#smtp-configuration" id="smtp-configuration"></a>

![](/files/-MJSMHj7poRx459lpFlT)

SMTP Configuration

* **Server** : Address of the SMTP Server. Example : smtp.gmail.com
* **Port** : Port used to connect to your SMTP Server. Leave this field empty if you don't know which port you should use. (GMail does use the port 465 because it's an SSL method)
* **Secure Method** : Should AcyMailing use an SMTP Secure Connection? For GMail, you should select SSL. This option should only be used if your SMTP server uses a secured sending method.
* **Keep Alive** : Should AcyMailing keep your SMTP Connection opened during the send Process? We recommend to turn ON this option. This option should be turned OFF only if you have problems. If you turn it OFF, AcyMailing will connect to your SMTP server, then send one e-mail and then close the connection. It will need reopen the connection with your SMTP server to send another e-mail so it may consume a lot of time whereas if you turn this option ON, AcyMailing will open the connection with the SMTP server once, send the whole batch of e-mails and then close the connection.
* **Authentication** : If you enter a Username and a Password to connect to your SMTP Server, please turn ON this option.
* **Username** : Username used to connect to your SMTP Server.
* **Password** : Password used to connect to your SMTP Server.

### Test your SMTP Ports <a href="#test-your-smtp-ports" id="test-your-smtp-ports"></a>

![](/files/-MJSMJxkz-emgNhLr7Jq)

Test your SMTP ports

Since some hosting companies block SMTP connexions to external servers, we added a quick test so you can easily see the ports opened on your server and the blocked ones...

Just click on the "What port can I use from my website?" link to trigger that test and Acy will display a list of ports blocked or opened.

A blocked port may be blocked by your own server or by a firewall within your host.

If none of your ports are opened and your host does not want to open any, then you can still use our REST API integration with ElasticEmail.

## Queue Process <a href="#queue-process" id="queue-process"></a>

### Queue process <a href="#queue-process-1" id="queue-process-1"></a>

![](/files/-MJSMNNnrvYzGRRQnxM4)

Queue process

* Please read [this article](/old/main-pages/configuration/configuration-tabs/configure-your-send-process) if you want to know how to configure AcyMailing to stay below your server limitations.
* **Queue Processing** : If you use the "automatic only" sending method, AcyMailing will always use the automatic process and won't even start the manual send process if you send an e-mail from the backend. This option is only available from AcyMailing Essential. If you use our Free version, you won't see this option and the send process can only be triggered manually and run on your own session. Please note that the send frequency should match with your cron frequency. This parameter is only there for security so your website can't be triggered too often.
* **Automatic send process :** Using the automatic send process, AcyMailing will automatically send X e-mails every Y minutes without you having to do anything. The send process will run on the background and not on your own session so you can turn off your computer and let Acy do the job.
* **Manual send process** : Using the manual send process, AcyMailing will send a batch of e-mails, then wait X seconds and send another batch then wait X seconds and ... You can configure the time AcyMailing will wait between two batches. If you select the "Manual Only" option, automatic actions such as sending scheduled Newsletters or follow-up messages won't work.
* **Automatic / Manual** **send process** : If this option is selected, AcyMailing will send the Newsletter using the manual send process unless you schedule it. Follow-up messages will be sent automatically.
* **Maximum Number of Tries** : If AcyMailing cannot send the e-mail after X tries, AcyMailing will delete the e-mail from the queue. Most of the time, that means the e-mail address is not valid so AcyMailing can also execute an action on the subscriber to not send him e-mails any more. This option is different from the bounce handling as it will be only applied if your server refuses to deliver the e-mail, not if the e-mail is delivered but then bounces because the receiver does not exist. Most of the time, the mail server will accept to deliver the email anyway (and so that option is useless) and will then generate a bounce email that Acy can handle with its bounce handling system.
* **Maximum execution time** : Your server may not allow AcyMailing to run for a long time... We display here the default value from your php.ini file and also the one we calculated... Some servers enable us to extend the maximum execution time, others don't... Acy will use this value to end the send process properly before your server stops it badly.
* **Order the send process by** : In addition to the sending date, you can order the send process by subscriber ID asc (1,2,3...), desc (8546,8545,8544...) or randomly (4,684,12...)

### Cron  <a href="#cron" id="cron"></a>

The automatic send process, the Newsletter generation, the Newsletter scheduling and the Follow-ups require a [cron task](/old/main-pages/configuration/configuration-tabs/cron-task). You can either [create a cron task on your own server or use our free service on Acyba.com to create one](/old/main-pages/configuration/configuration-tabs/cron-task). If you don't know how to set up a cron task on your own server or if you cannot make it work on your own server, don't bother with that and simply use [our own free service](/old/main-pages/configuration/configuration-tabs/cron-task).

![](/files/-MJSMQGjRU1eYZkMyvl4)

Cron config

* **Next Run Time** : Next time the Cron task is allowed to run. It does not mean that the cron task will run AcyMailing at this exact time. But it means AcyMailing will accept a cron url if it triggers AcyMailing after this time.
* **Cron URL** : Cron URL to trigger AcyMailing. You should use this URL to create your cron task. You can make sure it's a working url by clicking on the link.
* **Send a report** :When does AcyMailing should send a report?
* **Send the report to** : You can enter one or several e-mail addresses so that AcyMailing will send the report to those users (separate each e-mail address with a comma).
* **Save the report** : Which report should AcyMailing save in the log file? For example, the simple report will tell you "256 emails sent" and the detailed report will tell you "Email XXX successfully sent to XXX, Email XXX successfully sent to YYY, etc..."
* **Save the report to** : Location of the log file.
* **Last Run Time** : Last time AcyMailing executed actions via the cron url.
* **Triggered from the IP** : AcyMailing has been triggered by the following IP.
* **Report** : Latest report generated by AcyMailing.

### Priority <a href="#priority" id="priority"></a>

![](/files/-MJSMSv46gQwqOL1bcvp)

Priority

* **Newsletter priority** : When AcyMailing queue your e-mails, AcyMailing will order them depending on the send date and the priority. So, if you want your Newsletter to be sent immediately, you can set up a lower priority number and it will be sent before the others.
* **Follow-up priority** : Priority for the Follow-up messages. Usually, you want those e-mails to be sent without delay. So they need a lower priority number.
* Priority level 1 is top priority
* Priority level 2 is important
* Priority level 3 is less important

## Subscription <a href="#subscription" id="subscription"></a>

![](/files/-MJSMV-XRETuCnIYrMsC)

Configuration Subscription

### Subscription <a href="#subscription-1" id="subscription-1"></a>

![](/files/-MJSMXfj7ZYa6fVBcfDQ)

Subscription configuration

* **Allow non logged in users** : Do you allow simple visitors to subscribe to your Mailing Lists? If not, only logged in users will be able to subscribe.
* **Require Confirmation** : Should the user click on a confirmation link before being considered as a subscriber? If you require a confirmation, you can edit the confirmation e-mail using the button "Edit Confirmation Email". US and Canadian users: You have to turn ON this option to be [CAN-SPAM](http://en.wikipedia.org/wiki/CAN-SPAM_Act_of_2003) compliant.You can use a confirmation email per subscription form. For this, create a newsletter with the alias "confirmation-module-256" if you want to use it for the module with the ID "256". You can also use "confirmation-menu-438" for the "subscribe/modify your subscription" menu with the ID 438.
* **Auto-subscribe on Joomla registration** : Using the "select" button, you can select the lists you want the user to be automatically subscribed to during the Joomla registration process (or any other component using the standard Joomla User registration system). This option works with the [AcyMailing : auto-subscribe plugin](/old/integration-plugins/installed-with-acymailing/plugin-auto-subscribe-during-joomla-registration) so this plugin has to be enabled if you want it to work.
* **Allow user data modifications without identification** : When your users are not identified by the system, do you allow them to modify their subscription? If you select "No", then an identification message will be sent to the user with a link to enable him to modify his subscription. If you select "Only his subscription" then his subscription will be updated but not his personal data (name, receive html...). If you select "Yes", the subscription and the data will be updated without extra identification.
* **Auto-generate User's name** : When a user subscribes without entering his name (if you removed the name field from the subscription form for example), AcyMailing will automatically generate a name based on his e-mail address if this option is enabled.

### Notifications <a href="#notifications" id="notifications"></a>

![](/files/-MJSM_-Qg8NcXzyrcBNE)

Notification configuration

* **When a new user is created, send an e-mail to** : Send an e-mail to those e-mail addresses each time a new user is created from the front-end. You can edit the notification e-mail by clicking on the button "Edit Notification Email".
* **When a user unsubscribes from a list, send an e-mail to** : Send an e-mail to those e-mail addresses if a user unsubscribes from at least one of your lists (from the module or from the unsubscribe link).
* **When a user unsubscribes from all Lists, send an e-mail to** : Send an e-mail to those e-mail addresses if a user unsubscribes from all your lists (from the unsubscribe link inserted in your Newsletter).
* **When a user refuses to receive e-mails, send an e-mail to** : Send an e-mail to those e-mail addresses if a user refuses to receive messages from your website.
* **When a user submits the subscription form** : Send an e-mail to those e-mail addresses if a user submits the subscription form.
* **When a user submits the menu subscription form** : Send an e-mail to those e-mail addresses if a user submits the subscription form from menu "Subscribe/Modify your subscription".
* **When a user confirms his subscription** : Send an e-mail to those e-mail addresses if a user confirms his subscription.

### Redirections <a href="#redirections" id="redirections"></a>

![](/files/-MJSMc69NQQSYui_ET27)

Configuration Redirections

* **Redirection after subscription** : Enter the url you want the user to be redirected to after he clicked on the subscribe button from the component view interface (accessible via a menu). This redirection does not affect the module subscription. Please edit your module if you want to set a redirection after the module subscription.
* **Redirection after subscription modification** : Enter the url you want the user to be redirected to after he clicked on the modify your subscription button from the component view interface (accessible via a menu or via the "modify your subscription" link inserted in your Newsletter). This redirection does not affect the module subscription. Please edit your module if you want to set a redirection after the module subscription.
* **Redirection after Confirmation** : Enter the url you want the user to be redirected to after he clicked on the confirmation link in the confirmation e-mail. You can use the tags {subid}, {email}, {name} in this url which will be replaced by the ID, email or name of the subscriber. You can set up a custom redirection per subscribed list by editing your language files in the Acy configuration page then adding REDIRECTION\_CONFIRMATION\_LISTID="the link" where "LISTID" is the real list ID.
* **Redirection after Unsubscription** : Enter the url you want the user to be redirected to after he unsubscribes. This redirection URL does not apply to the Module Unsubscription! Please edit the AcyMailing module for that.
* **Allowed domains for the module redirection** : List of domains allowed to be used as redirect url on your module. You can enter as many domains as you want separated by | If you don't want AcyMailing to do a verification on the redirect urls, you can set this option to "all". You only have to fill it for external subscription forms, the redirect url you add to your module will be automatically added anyway.

### Geolocation <a href="#geolocation" id="geolocation"></a>

* You can record [the user location](/old/main-pages/configuration/configuration-tabs/geolocation) with our Enterprise version.

## Interfaces <a href="#interfaces" id="interfaces"></a>

### Messages <a href="#messages" id="messages"></a>

![](/files/-MJSMeXN0NMAx-F7NEvJ)

* **Display a message on subscription** : Should AcyMailing display a confirmation message when the user subscribes on your website?
* **Display a message on confirmation** : Should AcyMailing display a confirmation message when the user confirms his subscription?
* **Display a message on unsubscription** : Should AcyMailing display a confirmation message when the user unsubscribes from your website?
* **Display a message when sending the confirmation e-mail** : Should AcyMailing display a confirmation message when AcyMailing sends the confirmation e-mails?
* **Display a message when sending the welcome e-mail** : Should AcyMailing display a confirmation message when AcyMailing sends one or several welcome e-mails?
* **Display a message when sending the unsubscribe e-mail** : Should AcyMailing display a confirmation message when AcyMailing sends one or several unsubscribe e-mails?

### CSS <a href="#css" id="css"></a>

![](/files/-MJSMgf2rWZcW2VANw-i)

* **Module CSS File** : Select the CSS file used for the AcyMailing module.
* **Component Front-end CSS File** : Select the CSS file used for the AcyMailing component on the front-end.
* **Additional Back-end CSS File** : You can add some CSS rules in addition to the default ones on the Back-end of AcyMailing with this option
* You can edit each CSS file via this interface. Click on the button "Edit" and a popup will load with the existing file. AcyMailing won't apply the modifications on the default one but it will create a custom file and select it so that you won't loose your modifications if you update or upgrade AcyMailing. You will find all the AcyMailing CSS files in the folder media/com\_acymailing/css/.
* **Use Bootstrap on the front-end** : This option will only appear for Joomla 3.x. If your Joomla front-end template does not load the Bootstrap CSS files, then you should turn it OFF.

### Features / tracking / Menu / Editor

![](/files/-MJSMlJOZU2KBFCHVS_p)

* **Enable the Forward capability** : On all our commercial version you can add a "forward to a friend" link in your Newsletter. This option enables you to turn ON/OFF this feature.
* **Use SEF Urls** : When sending a Newsletter from the front-end (via the cron task for example), AcyMailing can transform your links to use SEF ones.
* **Track clicks with:** Enable or disable the click tracking in Acymailing and Google Analytics.
* **Track links for external websites:** Track or not the external websites links (for example if you added a link to google in your newsletter)
* **Menu Linked to AcyMailing** : Select the Menu you want to link to AcyMailing. Users having problems with access levels should select a menu which is opened to non registered users. Please always make sure you select a menu WITHOUT access level on it so that all your users will be able to access the unsubscribe page.
* **Editor** : Select the editor you want to use to edit all your AcyMailing E-mails.

### Archive section <a href="#archive-section" id="archive-section"></a>

AcyMailing enables you to display archive Newsletters on your front-end.

Please create a new Joomla Menu, type "AcyMailing" and select one of the two available menus to display an archive section on your website.

![](/files/-MJSMn94Y1VoD-__CoL8)

Archive section

* **User Comments**: If jComments, jomComment, RSComments, Komento or Disqus is installed on your Joomla website, you should see this option which will enable you to let your users add comments about your Newsletters.
* **Display subject** : By default your Newsletter subject will be displayed at the top of the Newsletter, you can decide to hide it by turning this option off.
* **PDF Icon** : You can add a PDF icon on your archive section so your users will be able to export your plain text version of the Newsletter (only on Joomla 1.5).
* **Print Icon** : You can add a print icon on your archive section so your users will be able to print your Newsletter.
* **Display the list description** : AcyMailing will add your list description on your Newsletter listing, you can remove it with this option.
* **Display table headings** : On the Newsletter listing, AcyMailing will display some headings (subject, send date) that you can remove using this option.
* **Display send-date column** : Do you want AcyMailing to display your Newsletter's send date?
* **Display Filter** : Should AcyMailing display a search box so your users can search in your Newsletters?
* **Open the archive is a popup** : To you want the Newsletter to be opened in a popup instead of inside your Joomla template? This option does not affect the "view it online" link. If you want to change the "view it online" link, then you should access the [website links plugin parameters](/old/integration-plugins/installed-with-acymailing/plugin-website-links).
* **Index/Follow Archive :** Do you want your archived newsletters not to be indexed by search engines (noindex) and that they don't follow the links contained in your newsletter (nofollow)?

### Unsubscribe page <a href="#unsubscribe-page" id="unsubscribe-page"></a>

See [the dedicated page](/old/main-pages/configuration/unsubscribe-page) to learn more about the unsubscribe page

### Front-end edition <a href="#front-end-edition" id="front-end-edition"></a>

AcyMailing Enterprise enables you to [manage your Newsletters from the front-end](/old/public-part-of-your-site/front-end-newsletter-edition).

![](/files/-MJSMqVENm7tbWX5DtfP)

Front end

When you create a Newsletter via the front-end, the default sender information will be applied to this Newsletter.

Nevertheless you can change some options to apply the currently logged in user information in the Newsletter instead of the default ones.

* **Logged-in User as Sender** : Do you want the logged-in user to be specified by default as sender of the Newsletter?
* **Logged-in User as Reply-to** : Do you want the logged-in user to be specified by default as reply-to of the Newsletter?
* **Allow modifications** : Do you allow a user to edit the Newsletter created by another user?
* **Allow post-sent edit** : Do you allow the user to edit the Newsletter after the Newsletter has been sent or scheduled?
* **Delete button behavior** : Should the delete button really delete the user or simply unsubscribe him from the current list.

&#x20;Our footer will be automatically removed from the front-end and from your emails if you use one of our paid versions.

## Security <a href="#security" id="security"></a>

![](/files/-MJSMt8Uy82ecALQjv3M)

Security

### Captcha <a href="#captcha" id="captcha"></a>

* In all our commercial versions, you can add a [captcha to the AcyMailing subscription form](/old/main-pages/configuration/configuration-tabs/captcha)​

### Advanced email verification <a href="#advanced-email-verification" id="advanced-email-verification"></a>

![](/files/-MJSMvaE4XPZIAGi3Ne1)

verif email

* **Check if the domain exists** : If you enable this option, AcyMailing will perform a test on the domain name to make sure the domain exists before allowing the user to subscribe. For example, if a user submits the e-mail address This email address is being protected from spambots. You need JavaScript enabled to view it. then Acy will check if the domain example.com exists and if not, it will not allow the user to subscribe and will ask for a valid e-mail address. This option is turned OFF by default as some hosting companies won't enable you to do this verification but we recommend you to turn it ON and then check again the subscription form to make sure everything is still working fine.
* **BotScout integration** : AcyMailing will connect to BotScout.com to check if the e-mail address or IP used does not belong to a bot. You need to generate a key on their website to use their service.
* **StopForumSpam integration** : AcyMailing will connect to stopforumspam.com to check if the e-mail address or IP used does not belong to a bot.
* **Limit same IP subscriptions** : AcyMailing will limit the subscriptions to maximum 3 per two hours from the same IP.

### Files <a href="#files" id="files"></a>

![](/files/-MJSMy8XpOrQeq1OihI2)

Files

* **Allowed Files** : List of allowed file extensions for the attachments.
* **Upload Folder** : Folder in which the attachments will be uploaded to. Please make sure this folder is writeable otherwise AcyMailing won't be able to upload your files in it.
* **Media Folder** : If you use the AcyEditor, it will display pictures stored in the specified folder. By default it's media/com\_acymailing/upload but you can change it to your "images" folder for example.

  You can customize the upload and media folders. You can make sure each user uses its own folder by adding the code {userid} which will be replaced by the ID of the current user or by using {groupid} which will be replaced by the ID of the user group. You can also use the {groupname} tag for the group name. {listalias} is also available but be careful as the users can change their subscription to the lists. For example: images/pict\_{userid}

We won't let you compromise your website... Some files will still be blocked even if you allow the extension on your configuration.

### Database maintenance  <a href="#database-maintenance" id="database-maintenance"></a>

AcyMailing can handle millions of users but you may store an important amount of data for statistics purpose. AcyMailing enables you to clean up your detailed statistics table automatically. This process is triggered every Sunday via the cron task (the same as for other processes).

![](/files/-MJSN07w-fSMN9eq5jkZ)

Database Maintenance

* **Delete detailed statistics after** : Detailed statistics will be deleted if they have been recorded more than X months ago. Acy will delete statistics such as "This user opened that Newsletter on ..." or "This user clicked on that link from the Newsletter on..."
* **Delete user history after** : The user history will be deleted if the recorded information is more than X months old. This action will delete information from the user profile such as bounce e-mails details, confirmations, forward actions... well, everything you can see under the "history" tab on the user profile. If you set this option to 0, Acy will keep everything and will never delete your history or statistics.
* **Check database integrity** : If you click on this button, AcyMailing will perform a few tests to make sure your database structure is up to date. We may add additional tests in the future. You can safely click on it at any time to check your database structure.

## Plugins <a href="#plugins" id="plugins"></a>

This screen displays the list of plugins used by AcyMailing.

The first listing, "Plugins for the tag system", is a list of plugins called by AcyMailing before sending each message.

As a developer, you can develop new plugins to integrate anything in your Newsletter.

AcyMailing uses the Joomla Plugin System.

The second listing, "Integrations with AcyMailing", is a list of events called by other components which trigger AcyMailing. You can edit the plugin **AcyMailing : (auto)Subscribe during Joomla registration** to display your lists on the Joomla registration page... Please make sure this plugin is always enabled as it handles the synchronisation with your Joomla users.

You can click on each Enabled button in order to publish or unpublish each plugin.

Some plugins have parameters. You can click on the name of the plugin in order to edit those parameters.

If you click on each plugin, you will also see a "**Help**" button at the top of each plugin page so that you can know what each plugin does.

![](/files/-MJSN365FBcHva4FB-9u)

Plugins

## Languages <a href="#languages" id="languages"></a>

This listing displays the list of languages of your website (Front-End). For each language, you can edit the AcyMailing language file.

Most of languages files are included in the package so during the AcyMailing installation process, the language files are automatically installed so you don't have to do anything on your end. Nevertheless some of the languages are not included in the package (we could not include them all, it takes too much space). In that case you should click on the create button and the latest version of this language will be directly loaded from our website. Then you simply have to save the language to have it on your website.

&#x20;Please don't forget to share your translated language files so that we can include them in our next release.

![](/files/-MJSN5sePjVm0-xuVyvt)

Languages

## Frequently Asked Questions <a href="#frequently-asked-questions" id="frequently-asked-questions"></a>

If you use our free version, a "powered by" logo will be inserted at the bottom of your emails.

If you upgrade to one of our paid versions, this logo will be automatically removed.

### Why adding this logo at the bottom of your Newsletters? <a href="#why-adding-this-logo-at-the-bottom-of-your-newsletters" id="why-adding-this-logo-at-the-bottom-of-your-newsletters"></a>

We want to provide a solution for sending Newsletters to all users, to all budgets. Joomla empowers thousands of websites for free and we think all Joomla extensions should have a free version as well. At Acyba, we not only develop and maintain this free version but we also answer all questions on our forum... because if the user has a question, we consider the software has rooms for improvements. So if you have any issue, a member of our team will help you regardless you are using our free version or a paid one. We believe in this philosophy and we still want to provide a free version and continue to support it with the hours of support it takes to our team. To help us maintain this high quality service for absolutely all our users you have two solutions :

* Include our logo in your Newsletters so you help us to promote our extension
* ​[Upgrade to one of our paid versions](https://www.acyba.com/acymailing/features.html) to support our work (and get rid of our logo!)


# Configuration tabs


# Configure your send process

## Introduction

Most of hosting companies (almost all of them) apply some restrictions to the send process so you won't be able to send a lot of e-mails at once (this limitation is usually around 300 e-mails per hour). This article will explain you how AcyMailing sends your e-mails and how you can overcome any server limitation.

First of all, AcyMailing always uses a queue to send your e-mails.\
So, if the message can not be sent immediately (time out, limitation of a shared hosting environment, memory limitation, etc.), AcyMailing will keep it in the queue so you will be able to send it later.\
If you are reading this article because you saw a lot of errors during the send process and the process stopped, don't panic! You will be able to easily resume your send process and you won't loose any message.

In some cases, the mail server does not return a failed status to AcyMailing so AcyMailing will consider that all your e-mails have been sent properly and won't be able to stop the send process automatically. In that case, it's very important to configure AcyMailing to respect your sending limitations.

You can see and manage your queue of messages by clicking on the **queue** menu on the AcyMailing back-end.

## Using AcyMailing Starter (free version)

If you use AcyMailing Starter or our commercial version (without the *Automatic Only* option) and you send a Newsletter, AcyMailing will open a popup and start sending your Newsletter to your users.\
It will send one batch of e-mails then make a pause and then refresh the page and send another batch of e-mails and make a pause and refresh the page... until the end of the process.

![](/files/-MJSNN3v5n0tDWDjyaY-)

If AcyMailing detects errors during the process, it will either automatically refresh the page (to avoid a time out for example) or stop the sending process (if a hosting limitation is detected). In both cases AcyMailing should display you a clear message about what's going on and if AcyMailing stopped the send process, you will be able to resume it by clicking on the **Process** button on the **queue** page.

During the send process, the sending window (the popup) should always stay opened.\
If you close it, AcyMailing will finish the current batch and then stop the send process.\
That's not a problem as you will be able to resume it anyway.\
If you want to be able to log out, turn off your computer and let Acy do the job, you will have to go for one of our paid version.

## Using one of our commercial versions

Using one of our commercial versions (AcyMailing Essential or Enterprise), you will be able to configure AcyMailing to automatically overcome any server limitation and you won't have to keep your internet connection opened during the send process.\
We even recommend you to use this method if you have a dedicated server as it will lower your spam score, it spreads the load on the server and also the traffic that's being generated from the newsletters.

If you use AcyMailing to send e-mails from the front-end, it will always use the Automatic process but you should still configure a cron task to trigger AcyMailing regularly.

* Go on your AcyMailing Configuration page and click on the tab **Queue process**
* Select the option **Queue processing : Automatic Only**

![](/files/-MJSNT2_wtb5gGR0Eg2-)

* Using this option, if you send a Newsletter, AcyMailing won't even start the send process but will simply add all your e-mails in the queue and display you a confirmation message.
* Now we will need a system to automatically trigger AcyMailing and enable it to automatically send your e-mails, this is what we call a **cron task**.\
  So each time AcyMailing will be triggered, it will send X e-mails.\
  That way, you will be able to configure AcyMailing to send 200 e-mails per hour or anything else which suits your hosting limitations.
* The frequency you can see on the automatic send process configuration is a security parameter for AcyMailing.\
  It's set by default to 15 minutes as our own cron service enables you to create a cron task with a 15 minutes frequency.\
  This parameter is only there to avoid having someone else triggering your send process more often than it should be.\
  You should set this parameter with the same value as your cron frequency.
* * On this same "Queue process" tab, you will see below an area "**Cron**"<br>
  * On this interface you will be able to see the last report of the cron task, you will see your Cron URL (which is the url you should trigger every X minutes if you want to create your own cron task), you will see the last run time, etc.
* Now the only thing you have to do is to [configure a cron task](/old/main-pages/configuration/configuration-tabs/cron-task).\
  You can handle it on your own server or you can [let our server do the job for you](/old/main-pages/configuration/configuration-tabs/cron-task#create-your-cron-task-on-our-server) (We created a free and easy service on Acyba.com to avoid you spending time on that part as it can be technical depending on your hosting company).<br>

## Hosting limitations and corresponding AcyMailing configuration

Depending on your hosting limitations, you can optimize the AcyMailing send process.

We recommend you to keep 5% of e-mails for your other components (send passwords, registration confirmation...) so if your limitation is 250 e-mails per hour, you should not use more than 240 e-mails for AcyMailing.

Each batch should not send more than 250 e-mails.\
It's always better to increase your frequency than increasing the number of e-mails per batch.

Here is the optimal configuration you should use based on the hosting company you are using for your website :

| Hosting Company                                             | Limitations                                                                                                                                                                                                            | Send X e-mails every Y minutes                                                                                                   | Configuration / Observation                                                                                                                                                                                                                                                                                                                                                                                                        |
| ----------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| 1and1                                                       | <p>100 per task<br>200 per hour</p>                                                                                                                                                                                    | 95 e-mails / 30 minutes                                                                                                          |                                                                                                                                                                                                                                                                                                                                                                                                                                    |
| Amazon SES                                                  |                                                                                                                                                                                                                        |                                                                                                                                  | <ul><li>Method : SMTP</li><li>Server : email-smtp.us-east-1.amazonaws.com</li><li>Port : 465</li><li>Secure method : SSL</li><li>Authentication : Yes</li><li>Username/Password provided by Amazon SES</li></ul>                                                                                                                                                                                                                   |
| BlueHost                                                    | 150 per hour                                                                                                                                                                                                           | 70 e-mails / 30 minutes                                                                                                          |                                                                                                                                                                                                                                                                                                                                                                                                                                    |
| DreamHost                                                   | 50 per hour                                                                                                                                                                                                            | 45 e-mails / 1 hour                                                                                                              | Do not leave the bounce e-mail address field empty!                                                                                                                                                                                                                                                                                                                                                                                |
| Free.fr                                                     | <p>20 per task<br>100 per hour<br>2000 per week</p>                                                                                                                                                                    | 18 e-mails / 15 minutes                                                                                                          | If you're using your own cron or the manual send process, you can send 15 e-mails every 10 minutes                                                                                                                                                                                                                                                                                                                                 |
| GMail                                                       | <p>100 per hour<br>500 per day</p>                                                                                                                                                                                     | <p>48 e-mails / 30 minutes<br>20 e-mails / 1 hour (>500 users)</p>                                                               | <ul><li>Method : SMTP</li><li>Server : smtp.gmail.com</li><li>Port : 465</li><li>Secure method : SSL</li><li>Authentication : Yes</li><li>Your GMail username/password</li></ul><p><a href="https://support.google.com/mail/answer/78754">GMail says your password is not valid?</a></p>                                                                                                                                           |
| <p>Google Apps<br>for Business<br>or Education editions</p> | 2000 per day                                                                                                                                                                                                           | 80 e-mails / 1 hour                                                                                                              |                                                                                                                                                                                                                                                                                                                                                                                                                                    |
| GoDaddy                                                     | <p>100 per task<br>1000 per day</p>                                                                                                                                                                                    | <p>95 e-mails / 15 minutes<br>40 e-mails / 1 hour (>1000 users)</p>                                                              | <ul><li>Method : SMTP</li><li>Server : relay-hosting.secureserver.net</li><li>Port : 25</li><li>Secure method : No</li><li>Authentication : No</li><li>Your from and reply-to e-mail should belong to your own domain</li></ul>                                                                                                                                                                                                    |
| Goneo                                                       | 250 per hour                                                                                                                                                                                                           | 60 e-mails / 15 minutes                                                                                                          | <ul><li>Method : php Mail Function</li><li>Your from, reply-to and bounce back e-mail addresses should belong to your own domain</li><li>Do not leave the bounce e-mail field empty!</li></ul>                                                                                                                                                                                                                                     |
| GreenGeeks                                                  | 100 per hour by default                                                                                                                                                                                                | 45 e-mails / 30 minutes                                                                                                          |                                                                                                                                                                                                                                                                                                                                                                                                                                    |
| Host Gator                                                  | 500 per hour                                                                                                                                                                                                           | 115 e-mails / 15 minutes                                                                                                         |                                                                                                                                                                                                                                                                                                                                                                                                                                    |
| Host Monster                                                | 500 per hour                                                                                                                                                                                                           | 115 e-mails / 15 minutes                                                                                                         |                                                                                                                                                                                                                                                                                                                                                                                                                                    |
| Hosting 2GO                                                 | 50 per 15 minutes                                                                                                                                                                                                      | 45 e-mails / 15 minutes                                                                                                          |                                                                                                                                                                                                                                                                                                                                                                                                                                    |
| Hotmail                                                     | 100 per day                                                                                                                                                                                                            |                                                                                                                                  | Due to this limitation, you should not use Hotmail as smtp server.                                                                                                                                                                                                                                                                                                                                                                 |
| Locaweb                                                     | 100 per hour                                                                                                                                                                                                           | 45 e-mails / 30 minutes                                                                                                          |                                                                                                                                                                                                                                                                                                                                                                                                                                    |
| Lunarpages                                                  | <p>20 per task<br>600 per hour</p>                                                                                                                                                                                     | 19 e-mails / 15 minutes                                                                                                          | You can use your own cron task to have a better frequency (every 2 minutes)                                                                                                                                                                                                                                                                                                                                                        |
| Lypha                                                       | 2000 per hour                                                                                                                                                                                                          | 400 e-mails / 15 minutes                                                                                                         |                                                                                                                                                                                                                                                                                                                                                                                                                                    |
| Maven Hosting                                               | 500 per hour                                                                                                                                                                                                           | 115 e-mails / 15 minutes                                                                                                         |                                                                                                                                                                                                                                                                                                                                                                                                                                    |
| Netissime                                                   | <p>500 per 15 minutes<br>1000 per day</p>                                                                                                                                                                              | <p>100 e-mails / 15 minutes</p><p>40 e-mails / 1 hour (>1000 users)</p>                                                          |                                                                                                                                                                                                                                                                                                                                                                                                                                    |
| Office 365                                                  |                                                                                                                                                                                                                        |                                                                                                                                  | <ul><li>Method : SMTP</li><li>Server : smtp.office365.com</li><li>Port : 587</li><li>Secure method : TLS</li><li>Authentication : Yes</li><li>Your username/password</li></ul>                                                                                                                                                                                                                                                     |
| One.com                                                     | 25 per 5 minutes                                                                                                                                                                                                       | 24 e-mails / 15 minutes                                                                                                          | You can use your own cron task to have a better frequency (every 5 minutes)                                                                                                                                                                                                                                                                                                                                                        |
| OVH via smtp                                                | <p>100 per hour<br>Pack Perso: 500 per day<br>Pack Pro: 500 per day<br>Pack Business: 1500 per day<br>Pack Premium: 2000 per day</p>                                                                                   | <p>Waits 10s between 2 emails</p><p>20 e-mails / 1 hour<br>20 e-mails / 1 hour<br>48 e-mails / 1 hour<br>80 e-mails / 1 hour</p> | <ul><li>Method : SMTP</li><li>Server : smtp.yourdomain.com</li><li>Port : 587</li><li>Secure method: none</li><li>Authentication : Yes</li><li>Your username/password</li></ul>                                                                                                                                                                                                                                                    |
| OVH via phpMail                                             | <p>The process will be blocked if more than 5% of your messages bounce</p><p>But you can easily unblock it on your account at:<br>Manager v3 > Mutualisé > Récapitulatif > Hébergement > Suivi Emails Automatisés.</p> | 200 e-mails / 1 hour                                                                                                             | <ul><li>Method : php Mail function</li></ul><p>Using this sending method, OVH will overwrite the bounce e-mail address so all delivery failures will be handled by OVH.<br>You could then export the file generated by OVH and import it in Acy using our universal filter plugin but you won't be able to use our automatic bounce handling (you could use the smtp function then... but you will have stronger limitations).</p> |
| PHPNet                                                      | 100 per hour                                                                                                                                                                                                           | 50 e-mails and 2 second pauses between each batch with the manual send process                                                   | E-mails are added to their own queue so you can send as many e-mails as you want and then their server will deliver automatically 100 e-mails per hour                                                                                                                                                                                                                                                                             |
| Rochen                                                      | <p>100 per 10 minutes<br>1000 per day</p>                                                                                                                                                                              | <p>95 e-mails / 15 minutes<br>40 e-mails / 1 hour (>1000 users)</p>                                                              |                                                                                                                                                                                                                                                                                                                                                                                                                                    |
| Site5                                                       | 1000 per hour                                                                                                                                                                                                          | 240 e-mails / 15 minutes                                                                                                         | Your from and bounce e-mail address should belong to your own domain                                                                                                                                                                                                                                                                                                                                                               |
| Siteground                                                  | 400 per hour                                                                                                                                                                                                           | 95 e-mails / 15 minutes                                                                                                          |                                                                                                                                                                                                                                                                                                                                                                                                                                    |
| Techark                                                     | 250 per hour                                                                                                                                                                                                           | 60 e-mails / 15 minutes                                                                                                          |                                                                                                                                                                                                                                                                                                                                                                                                                                    |
| VCServer Network                                            | 100 per hour                                                                                                                                                                                                           | 45 e-mails / 30 minutes                                                                                                          |                                                                                                                                                                                                                                                                                                                                                                                                                                    |
| Webcity                                                     | 20 per 6 minutes                                                                                                                                                                                                       | 19 e-mails / 15 minutes                                                                                                          | You can use your own cron task to have a better frequency (every 8 minutes)                                                                                                                                                                                                                                                                                                                                                        |
| Yahoo                                                       | 100 per hour                                                                                                                                                                                                           | 95 e-mails / 1 hour                                                                                                              |                                                                                                                                                                                                                                                                                                                                                                                                                                    |

\
&#x20;Your Cron frequency and the frequency displayed on the configuration should be the same.\
Please do NOT take this information for granted, as your email account provider or hosting company can change its email policy without any prior notification.\
It is always a good idea to contact your email account provider or hosting company and ask about the email send rate, before proceeding with a mass email campaign.

## Frequently Asked Questions

### I set AcyMailing to send 500 emails every 15 minutes but only 240 emails are sent each time... why?

The number of emails you send each batch depends on your server:\
When your cron task is triggered, AcyMailing will try to send your 500 emails at once.. but every server has a maximum execution time!\
So for example if your server takes 1 second to send each email and its maximum execution time is 240 seconds, it will be able to send maximum 240 emails per batch.\
We usually recommend to not send more than 400 emails per batch, and if you need to send more emails, you can set up [a multiple queue system](/old/developers/multiple-queue-system).\
You can see the maximum execution time of your server in the AcyMailing configuration, tab "Queue process", the "real" value is the one displayed in the "Based on **our** check..." row.

### How many emails can I send with AcyMailing?

It depends on your server...\
If you host your website on a shared plan, then most of them have sending limitations so you will be able to send between 200 and 1000 emails per hour (and you can configure AcyMailing to stay below this limitation... it will send 100 emails every 15 minutes for example).

If you install AcyMailing on your own dedicated server then you can send as many emails as you want...\
Some of our clients use AcyMailing with a mailing list of more than a million users.

You can also plug AcyMailing to an external delivery service so you won't be bothered by your host sending limitations.\
You can plug it to Mandrill, ElasticEmail, SendGrid, Amazon SES and even GMail itself (GMail has its own limitations as well).

### My sending limitations are 300 e-mails per hour and I use your commercial version, how do I configure AcyMailing?

With a limitation of 300 e-mails per hour, we recommend to configure AcyMailing to send 280 e-mails per hour so 70 e-mails every 15 minutes.

* Go on the AcyMailing configuration page, tab "Queue Process" :<br>
  * Queue processing : Automatic Only
  * Send 70 e-mails every 15 minutes
  * Click on the button "Create/Edit your cron task", select the frequency "15 minutes" in the popup and click on the button "save"
* Save the AcyMailing configuration page to apply the changes.

![](/files/-MJSNZP-cA0Mir_LPlr2)

### I don't have any limitation, what configuration do you recommend with your paid version?

Even if you don't have any sending limitation, we don't recommend you to send more than 300 e-mails per batch. Why?

* To reduce the probability to be flagged as a spammer
* To spread the load on the server
* To spread the traffic that's being generated from the newsletters

If you don't mind your send process to take an entire day (or even more), the best configuration is usually to send 120 e-mails every 15 minutes.

* Go on the AcyMailing configuration page, tab "Queue Process" :<br>
  * Queue processing : Automatic Only
  * Send 120 e-mails every 15 minutes
  * Click on the button "Create/Edit your cron task", select the frequency "15 minutes" in the popup and click on the button "save"
* Save the AcyMailing configuration page to apply the changes.

You can increase your number of e-mails per task if you want to speed up the send process and/or create your own cron task with a frequency of 5 minutes.

### Do I have to keep the window open during the send process or can I log out?

It depends on the sending method you're using.

* If you use our free version, you will use the "manual" sending method so if you close the window then the send process will stop.
* If you use our commercial version and use the "automatic only" send process, then AcyMailing will add your e-mails in the queue and take care of the send process using a cron task.\
  So you can log out, turn off your computer and do something else.


# DKIM : DomainKeys Identified Mail

## What's DKIM? <a href="#whats-dkim" id="whats-dkim"></a>

DKIM is a method enabling your receivers to make sure the message they received is coming from your own domain name.

​[DomainKeys Identified Mail on Wikipedia](http://en.wikipedia.org/wiki/DomainKeys_Identified_Mail)​

## Before starting <a href="#before-starting" id="before-starting"></a>

Since AcyMailing 1.7.0, we propose in our commercial versions a way to sign your messages using DKIM (AcyMailing will add a DKIM signature to each message).

If your mail server already handles a DKIM signature or if there is a way to enable this DKIM signature on your server without using the AcyMailing one, then you should NOT use the AcyMailing DKIM signature but configure the one you have on your server.

Cpanel, Plesk, Sendmail, Postfix, QMail will enable you to handle a DKIM signature automatically.

The same way, if you already use an SMTP server which handles DKIM, you should not enable the AcyMailing DKIM signature.

## How does it work? <a href="#how-does-it-work" id="how-does-it-work"></a>

First of all, you will have to generate a public key and a private key.

The private key will be then added to AcyMailing and the public key will be added to your DNS records.

When you send an e-mail, AcyMailing will encode the message using the private key which can be decoded using the public key (publicly visible on your DNS).

![](/files/-MJSNfx4riQ--fAAxssb)

Enable DKIM

## Generate your public and private keys <a href="#generate-your-public-and-private-keys" id="generate-your-public-and-private-keys"></a>

Since AcyMailing 4.1.0, we automatically generate keys during the install process so the only thing you have to do is to add a TXT entry on your DNS with the Key/Value specified on the AcyMailing configuration page.

AcyMailing will automatically use your domain name to create the DKIM. So you should not change the default value displayed in the domain field (it should be your own domain).

![](/files/-MJSNjJAzO-lUZJEpHJV)

Default keys

## Add your DNS record <a href="#add-your-dns-record" id="add-your-dns-record"></a>

You should now add the generated DNS record on your own DNS via your hosting company interface.

Don't forget to increment the number of your DNS zone and to make sure the changes are applied.

If you don't know how to do that, please ask your hosting company to add the provided DNS record.

You may be able to access this kind of interface in which case you should fill each field separately:

![](/files/-MJSNn7e2WYiabXoTIM7)

Add Record

### Add your DKIM DNS entry on directadmin <a href="#add-your-dkim-dns-entry-on-directadmin" id="add-your-dkim-dns-entry-on-directadmin"></a>

> * On DirectAdmin, you should insert your DNS entry on the "TXT" line and then click on the button "Add".

![](/files/-MJSNq87Z67VAcDXrdHM)

DirectAdmin add dns

### Add your DKIM DNS entry on OVH <a href="#add-your-dkim-dns-entry-on-ovh" id="add-your-dkim-dns-entry-on-ovh"></a>

You should not use the "add a DKIM entry" interface on OVH but rather add a simple TXT entry:

* Click on "Domain & DNS" then "Zone DNS"

![](/files/-MJSNshUghTUeioV_aOQ)

OVH DNS

* Add a record "Type TXT"

![](/files/-MJSNvDHJf41bRh6Vpo_)

OVH Txt entry

* Enter the generated entry

![](/files/-MJSNz-4FgeozVgQz-Ng)

DKIM Entry

### Add your DKIM DNS entry on GoDaddy <a href="#add-your-dkim-dns-entry-on-godaddy" id="add-your-dkim-dns-entry-on-godaddy"></a>

* Login to your GoDaddy Control Panel, select your domain and access your Settings -> DNS Manager
* Scroll down to the TXT (Text) area of your DNS and add a new key with
  * Host : acy.\_domainkey
  * TXT Value : v=DKIM;k=rsa;g=\*;s=email...
* Then click on the button "Save Zone File" to apply your newly created entry

![](/files/-MJSO0r9TXO8JmFq7eTg)

Go Daddy DKIM

## Check your DNS record <a href="#check-your-dns-record" id="check-your-dns-record"></a>

Before even trying to send an e-mail, you should make sure your DNS record has been added properly to your website.

Please use the tool at <http://dkimcore.org/tools/keycheck.html> to check it. By default, AcyMailing use "acy" as selector.

![](/files/-MJSO5XbpAgoF32BM9ND)

## Make sure your e-mails are signed <a href="#make-sure-your-e-mails-are-signed" id="make-sure-your-e-mails-are-signed"></a>

> If the previous service returns a success status and you saved your AcyMailing configuration with the DKIM parameters, then your e-mails will be automatically signed!

> ​[You can test it](/old/main-pages/configuration/configuration-tabs/cron-task) by sending an e-mail (from AcyMailing) to This email address is being protected from spambots. You need JavaScript enabled to view it..

![](/files/-MJSOAuvwjvI5GIXs16S)

## How to re-generate your keys <a href="#how-to-re-generate-your-keys" id="how-to-re-generate-your-keys"></a>

GMail recently modified its DKIM verification and will consider a 512bit DKIM key as unsecured.

We added this extra test on our spam test tool and you may see the message "**Your DKIM key is not strong enough**" in which case you should re-generate your keys.

To re-generate your keys with the latest version of AcyMailing, you should:

* Access the AcyMailing configuration page, check the "**Let me enter my own keys**" box.

![](/files/-MJSOFavn56swEQXJ3As)

Regenerate DKIM step 1

* Click on the button "**Apply**" to save the configuration.
* You will now see your keys and you should delete both the public and private keys (select the text inside these areas and delete it).

![](/files/-MJSOHLJWGigHG1FYm7B)

Regenerate DKIM step 2

* Click on the button "**Save**" to save the configuration.
* AcyMailing will now re-generate your keys with 1024bits.

![](/files/-MJSOUmWQmQigey3DTAe)

Regenerate DKIM step 3

* Click again on the save button.

![](/files/-MJSOXaPQxXuVAFgsLbw)

Regenerate DKIM step 4

* Your new keys are now saved and you should now modify your TXT record on your DNS to add the new value.

It takes a few hours for your new DNS entry to be fully propagated... Each time you modify your DNS please wait two hours before doing a new test.

## Your DKIM signature is not valid? <a href="#your-dkim-signature-is-not-valid" id="your-dkim-signature-is-not-valid"></a>

You carefully followed this article but your signature is still not valid?

* You should first make sure your public DKIM key is added to your DNS and is accessible. Please remember it takes time for your DNS to apply modifications, always wait at least 4 hours before doing a new test after modifying your DNS. No need to look somewhere else if your public DKIM key is not valid or not applied, you should focus on that (Did you edit the right DNS? Are the modifications applied?)
* Did you turn ON the option to embed pictures via the Acy configuration page? If so, the DKIM signature may fail, you should turn this option OFF.
* If you added attachments, please remove them, it may be the reason why the signature is not valid.
* In case of your public DKIM key is found on your DNS and appears as a valid key but your signature is still not valid, your mail server may have changed a bit the content of the message after Acy added its signature... and if it's the case, your signature will fail. Most of the time, the mail server changes the encoding format. You should change your encoding format in AcyMailing to **quoted-printable** instead of 8bit to prevent this kind of modification by your server.
* Still not valid? Make sure you don't use special characters in the "From" field.


# External SMTP service

You need to send emails faster? Tired of being labelled like a spammer despite all your honest efforts? Then, simply outsource your delivery to professionals.

Instead of using your own server, AcyMailing can communicate with an external service to deliver your messages! So you don't have to change the way you handle your campaigns, you don't have to change your host, it's just a switch on the AcyMailing configuration page and you're ready to deliver like crazy!

## How fast can I send emails with a provider? <a href="#how-fast-can-i-send-emails-with-a-provider" id="how-fast-can-i-send-emails-with-a-provider"></a>

That depends on what monthly plan you have with your SMTP provider and how many emails you send. This said, you can expect to wait a lot less.

## My emails won't be labelled as spam any more? <a href="#my-emails-wont-be-labelled-as-spam-any-more" id="my-emails-wont-be-labelled-as-spam-any-more"></a>

Well, that's never guaranteed. Spam filters analyse different aspect of your emails in order to validate your newsletters. One of first criteria is to check whether you are sending from a blacklisted server. All professional SMTP providers are white-listed. These services validate your lists and emails when you first join them.

Read more on [avoiding being labelled a spammer](/old/main-pages/newsletters/spam-test) in our documentation.

## How much does it cost? <a href="#how-much-does-it-cost" id="how-much-does-it-cost"></a>

For 5000 emails sent per month, it can be anywhere from $5 to $20. Usually, the more you send, the cheaper it gets. Read more below.

## Which SMTP service to pick? <a href="#which-smtp-service-to-pick" id="which-smtp-service-to-pick"></a>

Acyba has partnered with Elastic Email. You can get a deal by purchasing through this link.

![](/files/-MJSOmKmpvYzFT2zJmMJ)

Our detailed documentation will get you going in no time with these services.

There are plenty of others good delivery services such as Amazon SES or SendGrid which you can integrate with AcyMailing using the smtp sending method.

## Frequently Asked Questions <a href="#frequently-asked-questions" id="frequently-asked-questions"></a>

### I have sending limitations with my hosting company (ie, 400 e-mails per hour), will I be able to send more e-mails using these services? <a href="#i-have-sending-limitations-with-my-hosting-company-ie-400-e-mails-per-hour-will-i-be-able-to-send-mo" id="i-have-sending-limitations-with-my-hosting-company-ie-400-e-mails-per-hour-will-i-be-able-to-send-mo"></a>

Yes. Your own server won't send e-mails any more. E-mails will be delivered by an external server so you won't be under your hosting limitations any more.

### For now AcyMailing sends 200 e-mails every 15 minutes, can I speed up the send process? <a href="#for-now-acymailing-sends-200-e-mails-every-15-minutes-can-i-speed-up-the-send-process" id="for-now-acymailing-sends-200-e-mails-every-15-minutes-can-i-speed-up-the-send-process"></a>

Yes, you can use our [multiple queue system](/old/developers/multiple-queue-system) to handle parallel threads.

### I use an smtp delivery service but Acy does not receive and handle the bounce messages any more? <a href="#i-use-an-smtp-delivery-service-but-acy-does-not-receive-and-handle-the-bounce-messages-any-more" id="i-use-an-smtp-delivery-service-but-acy-does-not-receive-and-handle-the-bounce-messages-any-more"></a>

* **SendGrid** There is an option in SendGrid to redirect the bounce message to another e-mail address so Acy can still handle your bounce messages. Connect to your SendGrid account, Email Reports > Settings > Forward bounces This option enables you to forward bounces to a specific email address. Please check the box below and enter the forwarding email address which should be your AcyMailing bounce address.
* **ElasticEmail** You can specify a forward e-mail address on your ElasticEmail account under the tab "setup" so bounce messages are redirected to another e-mail address.


# Cron task

## What's a cron task and why do I need one? <a href="#whats-a-cron-task-and-why-do-i-need-one" id="whats-a-cron-task-and-why-do-i-need-one"></a>

On all our commercial versions, AcyMailing can execute automatic processes such as sending your messages (automatic send process of batches of e-mails), generating Newsletters (with the Smart-Newsletter), sending your follow-ups (with the campaign system)...

For those actions to be executed, AcyMailing needs to be triggered regularly, and each time AcyMailing is triggered, it will check if some tasks have to be executed and then do what needs to be done.

A cron task is a system which will automatically trigger AcyMailing without any human intervention.

This is a one-time setup... Once done, you won't have to think about it any more and all automatic actions will work.

## Create your cron task on our server <a href="#create-your-cron-task-on-our-server" id="create-your-cron-task-on-our-server"></a>

As some hosting companies don't enable you to create a cron task on your own server and also because some of our users have no clue what's a cron task, we created a cron service and an easy way to add a cron task directly via your AcyMailing configuration!

So, within two clicks, you will be able to create your cron task:

* Go on your AcyMailing configuration page
* Click on the tab **Queue process**

![](/files/-MJSOyKUcQtKQ5VdGGq3)

Create cron

* * On this interface, you can set AcyMailing to send X e-mails every Y minutes using the automatic only send process. Please remember the frequency displayed here is just for security (so that your website won't be triggered too often) but this parameter has no impact on the real cron frequency (they both should have the same value).
  * Click on the button **Create/Edit your Cron task.**
  * A popup will open and you will directly see your cron url added (you don't have to change it!).
  * Make sure the Cron URL is the right one (you should not have to modify this url!)
  * Activate your Cron Task (if you select "Activated : No", Acyba won't trigger your website any more)
  * **Select your frequency** to meet your needs You can select either Every 15 minutes, Every 30 minutes or Every 1 hour.
  * This frequency should be the same as (or bigger than) the one you specified on the "automatic send process" parameters.
  * Click on the **save** button.

![](/files/-MJSP-X5xt18_f_6wkcA)

Create cron

* That's all you have to do and now our server will trigger your AcyMailing components at the specified frequency.
* You have to do this procedure only one time, then you can forget about it!
* On this same popup, you can also see an area Last Report. This area enables you to check if your website has been triggered properly by our server and when. You can see our local time, the next time your website will be triggered and the last report.
* You can now close this popup

## Test your cron task <a href="#test-your-cron-task" id="test-your-cron-task"></a>

* We implemented an easy way for you to check that your cron task is working.
* Go on your AcyMailing configuration page and click on the tab **Queue process**

![](/files/-MJSP1ckYPuIvb93QpsG)

Test your cron

* On the **Report** area, you can see an option to have AcyMailing sending you a report each time it is triggered. So you can turn ON this option and once your done with your tests, you can then turn it Off. If you turn ON this option, then AcyMailing will send you an e-mail each time your website is triggered so it should send you an e-mail every 15 minutes (well, depending on your cron frequency).
* Also, on the **Last Cron** area, you can see the last time your cron has been triggered, who triggered it and the latest report.

## My cron does not work?! <a href="#my-cron-does-not-work" id="my-cron-does-not-work"></a>

**If your cron task is not working, you should:**

* Make sure your website can be triggered via your browser: Click on your cron url. That will trigger it manually via your browser so you will see if this url can be reached or not.
* If you use a third-party SEF component, your website may redirect the current page to the SEF one which will break our own cron service. So you can either configure your SEF component to not transform non-SEF into SEF urls or directly write your sef cron url on our cron interface.
* Make sure your website can be triggered by the outside: If you have an .htaccess with password protection, your website will obviously not accept to be triggered by an anonymous user.
* If you use a security component on your Joomla website, this component might block our cron task. RSFirewall: You should disable the DoS protection from the Components > RSFirewall > Configuration > Active scanner configuration options.
* If you use our own web cron service, you should check that our server is allowed to trigger yours. Our server IP is 178.23.155.178 and we will trigger your server using the domain name <http://yourcrontask.com>
* Our server is located in France... if you use RSFirewall or another security component, please make sure this country is not blocked.
* If your host is SiteGround and you use our own web cron service but get the error "Could not connect to ..." then please contact them with this message and they will be able to unlock the situation: *I'm using a web cron service which triggers my website every 15 minutes. The service is not working any more and it's apparently due to the fact their server has been filtered. Could you please make sure that the server 178.23.155.178 is able to trigger my website? They trigger my site from the domain <http://yourcrontask.com>*
* If you use our own server to trigger your website, please make sure you enabled our server IP to trigger your website every X minutes! (you might block it if you have some security checks on the number of connections per IP)


# Geolocation

## Configure your geolocation account <a href="#configure-your-geolocation-account" id="configure-your-geolocation-account"></a>

![](/files/-MJSPKATnaIC_Xr0XkJi)

Access the AcyMailing configuration, tab "Data collection" to access the Geolocation parameters.

By default none of the option will be selected so AcyMailing will not record the user location.

Most of our users will simply want to select the option "On user creation" to record the user location when he subscribes.

Click on the **IpInfoDB API key** link to be redirected to the IpInfoDB website and create an account there.

Once done, copy your API key in the option and click on the **Test the geolocation** link to make sure everything is working fine.

Once successfully tested, save your AcyMailing configuration page.

Once done, AcyMailing will start collecting geolocation data. To be able to see it on with Google map, you will have to enter your [Google Map API key](https://developers.google.com/maps/documentation/javascript/get-api-key).

{% hint style="warning" %}
Make sure to activate [the Geocoding API](https://stackoverflow.com/questions/32994634/this-api-project-is-not-authorized-to-use-this-api-please-ensure-that-this-api#answer-32998566) when creating your Google Map API
{% endhint %}

## Access the geolocation on the user profile <a href="#access-the-geolocation-on-the-user-profile" id="access-the-geolocation-on-the-user-profile"></a>

If AcyMailing records location for your user, it will display a new tab on the user profile.

Click on the "**geolocation**" tab to visualize the user location. You will also see a table with all location information.

![](/files/-MJSPMvX_xGM8QXiaEWX)

Map on user profile

## Filter your users based on their location <a href="#filter-your-users-based-on-their-location" id="filter-your-users-based-on-their-location"></a>

The main goal to record the user location is actually to use it!

You will see a new filter to select users based on their location.

![](/files/-MJSPPK9Ycw6YyQpWOO4)

Filter based on location

## Enjoy the map on your dashboard <a href="#enjoy-the-map-on-your-dashboard" id="enjoy-the-map-on-your-dashboard"></a>

![](/files/-MJSPU5MYuSGB9W4xUs5)

Dashboard map

If you turn ON the geolocation, AcyMailing will display a map on your AcyMailing dashboard of the latest 100 recorded users.

## Add a tag in your newsletter <a href="#add-a-tag-in-your-newsletter" id="add-a-tag-in-your-newsletter"></a>

![](/files/-MJSPbH5GnsujW9eDTgK)

Geolocation tag

With the geolocation plugin enabled and configured, you are able to insert information related to your users' location in your newsletter. It means that you can for example add the subscriber's city in the email you send and give him a more personal experience.

## Geolocation limitations <a href="#geolocation-limitations" id="geolocation-limitations"></a>

When you open an email in Google mail, pictures are first loaded from Google mail servers to add some security checks. This will change the URL of the pictures and the IP they are seen from. So email opened in Google mail will have a wrong geolocation as the IP used to open the newsletter will be the one of Google mail servers and not the one of the real receiver.


# Captcha

On all our paid versions, you have the possibility to turn on a captcha verification so a picture with characters will be inserted in your AcyMailing subscription forms in order to only allow human subscriptions.

## Captcha configuration <a href="#captcha-configuration" id="captcha-configuration"></a>

You can turn on this verification by going on your **AcyMailing configuration page**, tab **security** and turn on the option **Enable the captcha**

![](/files/-MJSPiLgoBGzQQ0hMslL)

* **Enable the captcha**: this option enables you to turn On or Off the captcha verification
* **Characters\***: list of characters used to create the captcha. AcyMailing will randomly choose some characters in this list. We voluntary already removed some characters to improve the user experience.
* **Security Key\***: if you use the subscription via url and you want to enable the captcha, you will have to add this security key on your subscription via url (by adding the argument seckey=YOUR\_KEY) otherwise the subscription via url won't work. This key is randomly generated during the install process but you can change it if you want.
* **Subscription via the AcyMailing Module\***: The parameters under this section will be applied to your AcyMailing module.
* **Subscription via the AcyMailing Component\***: The parameters under this section will be applied to the component view (if you created a menu linked to AcyMailing), not the module.
* **Number of characters\***: Number of characters displayed in the picture.
* **Height\***: Height of the picture.
* **Width\***: Width of the picture.
* **Background color\***: Color applied to the background. If you leave this field empty, no background color will be applied and you will have a transparent picture.
* **Font color\***: Color applied to the text.

\* Only available for AcyCaptcha

If you turn the captcha on, a picture will be applied to your module and on the component subscription page

![](/files/-MJSPmnuHes_l7gqL7Tz)

![](/files/-MJSPqwu9IkW1RVSkh-i)

You can also customize the colors of your captcha so it fits your website colors

![](/files/-MJSPyOFmISFnoQokMsq)

![](/files/-MJSQ1nFr-XDl8MVaEAh)

## Integration with Google reCAPTCHA <a href="#integration-with-google-recaptcha" id="integration-with-google-recaptcha"></a>

![](/files/-MJSQ5k7uxQOdEx6y5st)

Since AcyMailing 5.2.0, you can use the new Google reCAPTCHA on Joomla 3.X to ease the subscription process of your users. AcyMailing have an integration with the Joomla plugin to import this feature into AcyMailing subscription forms. To enable Google reCAPTCHA please follow this guide :

* Enable the Joomla plugin named : **Captcha - reCaptcha**

![](/files/-MJSQ83ulgAuFDdu_v0c)

* Fill in the information needed in the configuration of this plugin (Site Key ...)

![](/files/-MJSQAGiMckeavKkLQyQ)

* Select reCAPTCHA for the **Enable the captcha dropdown** in AcyMailing configuration

## My captcha does not work... <a href="#my-captcha-does-not-work" id="my-captcha-does-not-work"></a>

### An empty picture is displayed instead of the characters <a href="#an-empty-picture-is-displayed-instead-of-the-characters" id="an-empty-picture-is-displayed-instead-of-the-characters"></a>

Are you using a SEF system with Joomla? If so, please try to turn it off to isolate the issue. Please contact our support team with the url of your subscription form, we will help you to fix that issue! One of the first thing we will do will be to turn ON the Joomla debug mode via the Joomla configuration page and then access the captcha picture again to see if there anything wrong with it...

### The captcha is displayed but when I enter the right code, it says it's invalid <a href="#the-captcha-is-displayed-but-when-i-enter-the-right-code-it-says-its-invalid" id="the-captcha-is-displayed-but-when-i-enter-the-right-code-it-says-its-invalid"></a>

Please access the Joomla configuration and switch the session handler to "None" instead of "Database". In most of cases that will solve the issue with no drawback.

## Use Captcha on the forward feature <a href="#use-captcha-on-the-forward-feature" id="use-captcha-on-the-forward-feature"></a>

If you want to use the captcha on the forward feature (when you insert a forward to a friend link in your newsletter), you can enable it separately with the [forward feature](/old/main-pages/configuration/configuration-tabs/forward-to-a-friend) in the AcyMailing configuration, tab Interfaces.


# Google Analytics

## Description <a href="#description" id="description"></a>

Using AcyMailing you'll be able to extract some data concerning your sending, users subscriptions and import them into Google Analytics automatically. There is two types of data which can be imported into Analytics :

* **Users subscriptions handled by the AcyMailing module** : when one of your user subscribe / unsubscribe using the AcyMailing module, you'll have a new page view on Google Analytics. The page viewed will be subscribe for a subscription and unsubscribe for an unsubscription.
* **Click on your newsletters** : you'll be able to track users which clicked on links contained into your newsletter using UTM tags.

## How to enable Google Analytics tracking ? <a href="#how-to-enable-google-analytics-tracking" id="how-to-enable-google-analytics-tracking"></a>

The subscription tracking is **automatically enabled** when we found the Google Analytics javascript in your page.

To enable the click tracking please go into your AcyMailing configuration (interface tab) and check **Track clicks with Google Analytics**

![](/files/-MJSQFyRfJgO7inyKrZ_)


# Forward to a friend

With all our paid versions, you can include a forward to a friend link in your Newsletter so the user will be redirected to your website and will be able to forward your message to one or more friends.

## Include the "forward to a friend" link in your Newsletter <a href="#include-the-forward-to-a-friend-link-in-your-newsletter" id="include-the-forward-to-a-friend-link-in-your-newsletter"></a>

### Enable that feature on the AcyMailing configuration page <a href="#enable-that-feature-on-the-acymailing-configuration-page" id="enable-that-feature-on-the-acymailing-configuration-page"></a>

You first have to enable that feature in the AcyMailing configuration page.

Access the **Configuration** menu on the AcyMailing back-end component. Click on the tab **Interfaces** and turn ON the option "**Enable the forward to a friend**".

We strongly recommend you to activate the captcha on this feature if you choose to use it to avoid bots spamming through it.

![](/files/-MJSQKg3wIrSbwVeOkuJ)

Forward to a friend configuration

### Insert your "forward to a friend" tag <a href="#insert-your-forward-to-a-friend-tag" id="insert-your-forward-to-a-friend-tag"></a>

Once the feature enabled, you can edit a Newsletter and click on the button "**tags**".

Click on the menu "**Website Links**" and select the **forward to a friend** tag.

This option will be only displayed if you enabled that feature in the AcyMailing configuration page which is only available with our paid versions!

![](/files/-MJSQMeR9tx06jJcY4ES)

Forward to a friend tag

## Configure your "forward to a friend" interface <a href="#configure-your-forward-to-a-friend-interface" id="configure-your-forward-to-a-friend-interface"></a>

If the receiver clicks on your forward to a friend link, he will be redirected to your website with some options.

The receiver will be able to enter his name and e-mail address (they are filled automatically) and add one or more users so he can forward his Newsletter.

He can also add his own message which will be added at the top of the Newsletter.

You can hide some areas of this interface by adding CSS to the AcyMailing component CSS file (which you can edit via the AcyMailing configuration page).

To hide the "add another friend" link, add this CSS:

```
#forward_addfriend{display:none}
```

To hide the user input area (the textarea where the user can enter his own message), add this CSS:

```
#forward_sender_message{display:none}
```

AcyMailing will add a default text at the top of the forwarded Newsletter.

You can customize it by editing your language file (via the AcyMailing configuration page).

The string used is MESSAGE\_TO\_FORWARD and by default contains the tags {user:name}, {user:email} and {forwardmsg} which are the sender name, sender email and custom message the user wrote.

The forward to a friend feature will only be accessible if your Newsletter is published. Don't worry if you get a 404 error when you test it, simply publish your Newsletter and it will do the job. The Newsletter is automatically published when you send it anyway.


# Access level

Using AcyMailing Enterprise you can restrict the access of functionalities. (this feature has been implemented since AcyMailing 1.8.0)

Even if you see all kind of groups on this interface, it does not mean all groups are allowed do execute the corresponding action. For example, an action only available via the back-end such as exporting users will only be accessible for users allowed to log-in on your back-end.

If you want to allow a user group to access a Back-end feature, you'll first have to go in the AcyMailing component's options (the "Option" button at the top of the dashboard) then enable the access to the Back-end

![](/files/-MJSQSVQHTqyVA0PDMvG)

Permissions

## Joomla permissions <a href="#joomla-permissions" id="joomla-permissions"></a>

With the "options" button you can access the Joomla ACL manager for the AcyMailing component.

## Advanced access control level <a href="#advanced-access-control-level" id="advanced-access-control-level"></a>

In addition to the Joomla access level management, you can customize almost all the AcyMailing features' access.

### Users <a href="#users" id="users"></a>

![](/files/-MJSQUdcNtthu_8YBELA)

* **View**: Groups allowed to view subscribers (select them when sending a test message for example).
* **Manage**: Groups allowed to access the subscriber listing and create/edit subscribers.
* **Delete**: Groups allowed to delete subscribers.
* **Export**: Groups allowed to export subscribers.
* **Import**: Groups allowed to import subscribers.

### Lists <a href="#lists" id="lists"></a>

* **Manage**: Groups allowed to access the lists management and create/edit lists.
* **Delete**: Groups allowed to delete lists.
* **Filter**: Groups allowed to access the filters/Actions interface.

### Newsletters <a href="#newsletters" id="newsletters"></a>

* **Manage**: Groups allowed to manage Newsletters (view/create/edit)
* **Delete**: Groups allowed to delete Newsletters from the back-end
* **Send**: Groups allowed to send a Newsletter from the back-end and from the front-end (only if they are allowed to manage the corresponding list on the back-end)
* **Schedule**: Groups allowed to schedule or unschedule a Newsletter via the back-end Groups allowed to schedule or unschedule a Newsletter via the front-end (only if they are allowed to manage the corresponding list on the back-end) Groups allowed to schedule a single Newsletter for a single user
* **Spam test**: Groups allowed to access the spam test in the newsletter preview
* **Copy**: Groups allowed to copy a newsletter in the listing
* **Lists**: Groups allowed to choose the lists the newsletter is attached to
* **Attachments**: Groups allowed to attach files to the newsletter
* **Sender information**: Groups allowed to set specific sender information for a newsletter
* **Metadata**: Groups allowed to set the metadata of the newsletter
* **A/B testing** : Groups allowed to perform a spam test
* **Inbox actions** : Groups allowed to set an inbox action

### Smart-Newsletters <a href="#smart-newsletters" id="smart-newsletters"></a>

* **Manage**: Groups allowed to manage Smart-Newsletters (view/create/edit)
* **Delete**: Groups allowed to delete Smart-Newsletters

### Campaign <a href="#campaign" id="campaign"></a>

* **Manage**: Groups allowed to manage campaigns (view/create/edit)
* **Delete**: Groups allowed to delete campaigns
* **View**: Groups allowed to view and insert tags from the front-end or back-end

### Templates <a href="#templates" id="templates"></a>

* **View**: Groups allowed to select a different template than the default one on the front-end or back-end
* **Manage**: Groups allowed to manage templates (create/edit/import)
* **Delete**: Groups allowed to delete templates
* **Copy**: Groups allowed to copy templates

### Queue <a href="#queue" id="queue"></a>

* **Manage**: Groups allowed to access the queue listing
* **Delete**: Groups allowed to mass delete e-mails from the queue (groups allowed to manage the queue will still be able to delete individual e-mails from the queue)
* **Process**: Groups allowed to process the queue

### Statistics <a href="#statistics" id="statistics"></a>

* **Manage**: Groups allowed to access the statistics
* **Delete**: Groups allowed to delete statistics

### Configuration <a href="#configuration" id="configuration"></a>

* **Manage**: Groups allowed to access the AcyMailing configuration page and the custom fields

### Dashboard <a href="#dashboard" id="dashboard"></a>

* **Manage**: Groups allowed to access the Dashboard

## Reset your permissions <a href="#reset-your-permissions" id="reset-your-permissions"></a>

If you migrated your website from J1.5 to J1.6, you will have to execute this query via phpMyAdmin to reset the ACL configuration:

```
DELETE FROM #__acymailing_config WHERE namekey LIKE "acl_%"
```


# Custom fields

## Introduction <a href="#introduction" id="introduction"></a>

Using AcyMailing Enterprise (this feature has been added to AcyMailing 1.2.0), you can add extra fields to your subscription form, to the user profile on the front-end and on the back-end.

You will then be able to filter your users based on these fields or include these fields in a Newsletter.

You will also be able to import users with those fields and export the extra fields as well.

This system should meet most of your needs and enable you to create personal subscription form.

If you want to personalize more your subscription form, you can still integrate AcyMailing with a Form component using the subscription via URL.

## Create new fields on the AcyMailing User profile <a href="#create-new-fields-on-the-acymailing-user-profile" id="create-new-fields-on-the-acymailing-user-profile"></a>

* Log in on the back-end and access the **AcyMailing Component**
* Click on the menu **Configuration -> Custom Fields** to manage your fields

![](/files/-MJSQkz22TX6kzVAAem2)

* You will be redirected to the custom fields area where you should see three fields by default : name, email and html (which are the fields used to display the name, email and receive html/text option)

![](/files/-MJSQwpbkyyEeogWbQIU)

Extra fields

* Click on the button "**New**" to add a new field

![](/files/-MJSR2cJUEpu5zsvYtr6)

New field

### Create a phone number field <a href="#create-a-phone-number-field" id="create-a-phone-number-field"></a>

* We will create a phone number field so that users may enter their phone number to be contacted

![](/files/-MJSRADAp19UkXzw88AJ)

Field phone

* This field is a "Phone number" input so we selected the Field type "Phone".
* We don't want this field to be required, users may subscribe without entering their phone number
* We want to publish this field and display it on the front-end profile and on the back-end profile
* Click on the button "**Apply**", the field will be saved and you will now see how the field will be displayed on the preview area.
* Once saved, you won't be able to change the **column name** of your field. You can still change its **Label** or any other information.

![](/files/-MJSRD17ZAW4J-Px5qgn)

Phone preview

### Create a Gender field <a href="#create-a-gender-field" id="create-a-gender-field"></a>

* * We will now add a Gender field as our goal is to include in our Newsletter "Hello Mr John..."

![](/files/-MJSRO2ivYfw5ApIqOil)

Title field

* * The Gender field is a single Drop-down.
  * We will make it a require field so if the user didn't select any value, an error message will be displayed
  * We add a series of values (the first option has a title but no value so that if this option is selected, which is the case by default, the form won't be submitted as it's a required field)
  * We click on the "**Apply**" button to check how the field looks like.

![](/files/-MJSRQHZvf6YQMn3L3Q0)

Title field preview

### Create an information field <a href="#create-an-information-field" id="create-an-information-field"></a>

* * We will now create an information field. We will nevertheless make sure this field is published but only displayed on the back-end as our goal is simply to add information about the user if we contact him.

![](/files/-MJSRVmtQ0Xx8YDwE9yl)

Extra fields Info

### Order my fields <a href="#order-my-fields" id="order-my-fields"></a>

* * You should now see your three new fields on the Fields interface and you can change the ordering of your fields to meet your needs.

![](/files/-MJSRZfevlYbX85Rk7qQ)

All extra fields

* We didn't want to display the default field receive Text/HTML on our front-end interface so we unpublished it as you can not delete a core field.

### Group fields by category <a href="#group-fields-by-category" id="group-fields-by-category"></a>

Since Acymailing 4.9.0, you can create a new kind of field: Category. This field type allows you to regroup other fields in a category.

You need first to create your category field, then you will have to assign it in each field you want to put inside this category.

![](/files/-MJSRdo31X4EMEzQauOd)

Category choice

You will see the category regrouping the fields you chose. This category appear in the subscriber profile front and back-end, in the subscription form and in the Acymailing module if in tableless mode. The category will be displayed according to its order for the same level of fields.

![](/files/-MJSRhfDs0lPgNKRi3-T)

Display of a category

## Choose where to display your fields <a href="#choose-where-to-display-your-fields" id="choose-where-to-display-your-fields"></a>

You can choose where to display your fields, either in the field edition or directly in the field listing.

![](/files/-MJSRl3LH8avwml171Ht)

Display location

* **Front-end:**
  * **Form:** display your field on the Acymailing subscription form on the front-end (created via the menu type "Subscribe/Modify your subscription")
  * **Profile:** display your field on the Acymailing user profile accessible from the front-end user management
  * **Listing:** display your field on the user listing on front-end
  * **J! Registration:** display your field on the Joomla user registration form
  * **J! User profile:** display your field on the Joomla user profile
  * **Display Filter:** display this field as a filter in the front-end user management
* **Back-end:**
  * **Profile:** display your field on the Acymailing user profile
  * **Listing:** display your field on the user listing
  * **J! User Profile:** display your field on the Joomla user profile
  * **Display Filter:** display this field as a filter in the user listing on back-end

## Display these fields on the Back-end User profile <a href="#display-these-fields-on-the-back-end-user-profile" id="display-these-fields-on-the-back-end-user-profile"></a>

* Our fields are now added and the published fields will be displayed on the User back-end profile if you selected so.
* The Core fields will be always displayed on the back-end profile even if they are unpublished.
* There is no check on the fields on the back-end so you can really add any value you want and even leave the required fields empty.

![](/files/-MJSRrS-s-4n0ZvbtDky)

Backend profile

## Display these fields on the Front-end User profile <a href="#display-these-fields-on-the-front-end-user-profile" id="display-these-fields-on-the-front-end-user-profile"></a>

* Based on the options you selected, the fields will be added or not to the user profile on the front-end.
* This profile can be accessible when the user clicks on the link "**Modify your subscription**" in the Newsletter or if you display this page to subscribe your users.
* If you only use this page to modify the subscription of the user, you can even remove the e-mail field to not give the possibility to your users to modify their e-mail address.

![](/files/-MJSRuF6neu2Z75hWWLC)

Custom Fields front-end

## Display these fields on the Back-end User Listing <a href="#display-these-fields-on-the-back-end-user-listing" id="display-these-fields-on-the-back-end-user-listing"></a>

* The same way, you can also modify your Back-end User listing to display the information you want.
* The published fields with the option "Back-end Listing" enabled will be displayed on the AcyMailing User listing.
* You will be able to search in the fields and order them the way you want.

![](/files/-MJSRwyOX7Q_hR8Oi8ie)

user listing

## Display these fields on the AcyMailing Module <a href="#display-these-fields-on-the-acymailing-module" id="display-these-fields-on-the-acymailing-module"></a>

* * You probably realized that there is no option on the field interface to add the field on the AcyMailing module. We didn't add it to our interface as you can duplicate the AcyMailing module and each module will be independent so we took the decision to add the field selection on the module parameters themselves.
  * Log in on the back-end and access the Joomla Module manager

![](/files/-MJSRzvx0yxAXBZAnDmI)

Module Manager

* * Edit your AcyMailing module

![](/files/-MJSS1_z-a2DGy34Rd2o)

AcyMailing module

* * You will find a parameter "**Displayed fields**".

![](/files/-MJSS4CR1ylPCbLFrf97)

Field selection module

* * Click on the button "**Select**" to display all your of available fields and select the ones you want to include in your module

![](/files/-MJSS72rIcMafYHscpGT)

Fields selection

* * Select the fields you want to add to your module and then click on the "**Apply**" button.
  * Save your module to see the new fields on your module.

![](/files/-MJSS9kKOviUP4oFTde1)

Module display

* You can off course add any other field and display them the way you want (text outside the field, inside the field...)

## Display these fields on your registration page <a href="#display-these-fields-on-your-registration-page" id="display-these-fields-on-your-registration-page"></a>

You can display the extra fields you created on your Joomla registration page but also on the Virtuemart, Hikashop, CCUsers, AlphaRegistration, Tienda, redShop, ExtendedReg...

You can select which field to display on your registration form directly on the Custom fields listing by enabling the "J! Registration" parameter.

![](/files/-MJSSDgEs6brMkJlbZol)

Custom fields listing

&#x20;You can also do this while editing the custom field.

![](/files/-MJSSGYo6KEg0wAL_Wsi)

Edit a custom field

Go back on your registration form to see the fields.

If you want to add some CSS, access the AcyMailing configuration page, tab **plugins** and edit the **AcyMailing : (auto)Subscribe during Joomla registration** plugin. Then you can add some CSS on the **Custom CSS** area if needed.

![](/files/-MJSSJ-_EJW8uqU-Jg1w)

Registration field example

## Display these fields as filter dropdowns on your subscribers listing page <a href="#display-these-fields-as-filter-dropdowns-on-your-subscribers-listing-page" id="display-these-fields-as-filter-dropdowns-on-your-subscribers-listing-page"></a>

You can display some of your extra fields as filters on your subscribers listing page, either on the Front-end or on the Back-end.

This functionality is only available for fields of type "Radio", "Checkbox", "Simple Dropdown", "Multiple Dropdown", "Date" and "Birthday". Note that if there are a lot of possibilities for the "Date" and "Birthday" fields, Acy will display only the 100 first possible values.

![](/files/-MJSSLeNoCNBHJwSFh5y)

Custom fields as filter

&#x20;Here is an example of field filtering the subscribers in the Back-end subscribers listing:

![](/files/-MJSSOZLWQHtwEwLj7KC)

Filter field Back-end

The filter will be displayed the same way in the Front-end.

## Conditional display <a href="#conditional-display" id="conditional-display"></a>

Since Acymailing 4.9.0, you can display a field depending on the value of one or several other fields. You can only check the value of text, textarea, radio, single dropdown, phone and birthday type fields.

You can add as many conditions as you want choosing the relation (And / Or) to make another condition appear.

![](/files/-MJSSRTYwhW5WIG5FTAK)

Conditional display

When a field is used in a conditional display, the field using it will be listed so you can easily know where it is used. You can directly go edit the field by clicking on its name. You won't be able to delete the field either if it is used in a conditional display. A warning message will remind you of the related fields.

![](/files/-MJSSVV27NmT6txupZpM)

Conditional display used in

## Limiting edition <a href="#limiting-edition" id="limiting-edition"></a>

You can choose whether you want a field to be editable or not on user creation and user modification on the front end.

![](/files/-MJSSYSKTJXZe_veKw2_)

Limiting edition

## ACL <a href="#acl" id="acl"></a>

Since Acymailing 4.9.0, you can set which Joomla group is allowed to access a field on the front-end.

![](/files/-MJSSagQO5fORhS3Upb8)

ACL

## Get some statistics about the custom fields <a href="#get-some-statistics-about-the-custom-fields" id="get-some-statistics-about-the-custom-fields"></a>

If you create a custom field using the type Radio, CheckBoxes or Dropdown, you can see some statistics about it if access your custom field.

![](/files/-MJSSdYEdFzmZdaxuKa_)

Custom Fields Statistics

## Examples <a href="#examples" id="examples"></a>

### Country field <a href="#country-field" id="country-field"></a>

To create a country field, first create a new field in AcyMailing.

Then access your database (using phpMyAdmin for example), select the table "#\_\_acymailing\_fields" and edit the field you just created.

In the textarea "value", copy paste the following code:

```
AFG::AfghanistanALB::AlbaniaDZA::AlgeriaASM::American SamoaAND::AndorraAGO::AngolaAIA::AnguillaATA::AntarcticaATG::Antigua and BarbudaARG::ArgentinaARM::ArmeniaABW::ArubaAUS::AustraliaAUT::AustriaAZE::AzerbaijanBHS::BahamasBHR::BahrainBGD::BangladeshBRB::BarbadosBLR::BelarusBEL::BelgiumBLZ::BelizeBEN::BeninBMU::BermudaBTN::BhutanBOL::BoliviaBIH::Bosnia and HerzegowinaBWA::BotswanaBVT::Bouvet IslandBRA::BrazilIOT::British Indian Ocean TerritoryBRN::Brunei DarussalamBGR::BulgariaBFA::Burkina FasoBDI::BurundiKHM::CambodiaCMR::CameroonCAN::CanadaCPV::Cape VerdeCYM::Cayman IslandsCAF::Central African RepublicTCD::ChadCHL::ChileCHN::ChinaCXR::Christmas IslandCCK::Cocos (Keeling) IslandsCOL::ColombiaCOM::ComorosCOG::CongoCOK::Cook IslandsCRI::Costa RicaCIV::Cote D'IvoireHRV::CroatiaCUB::CubaCYP::CyprusCZE::Czech RepublicDNK::DenmarkDJI::DjiboutiDMA::DominicaDOM::Dominican RepublicTMP::East TimorECU::EcuadorEGY::EgyptSLV::El SalvadorGNQ::Equatorial GuineaERI::EritreaEST::EstoniaETH::EthiopiaFLK::Falkland Islands (Malvinas)FRO::Faroe IslandsFJI::FijiFIN::FinlandFRA::FranceFXX::France, MetropolitanGUF::French GuianaPYF::French PolynesiaATF::French Southern TerritoriesGAB::GabonGMB::GambiaGEO::GeorgiaDEU::GermanyGHA::GhanaGIB::GibraltarGRC::GreeceGRL::GreenlandGRD::GrenadaGUM::GuamGTM::GuatemalaGIN::GuineaGNB::Guinea-BissauGUY::GuyanaHTI::HaitiHMD::Heard and McDonald IslandsHND::HondurasHKG::Hong KongHUN::HungaryISL::IcelandIND::IndiaIDN::IndonesiaIRN::IranIRQ::IraqIRL::IrelandISR::IsraelITA::ItalyJAM::JamaicaJPN::JapanJOR::JordanKAZ::KazakhstanKEN::KenyaKIR::KiribatiPRK::Korea, NorthKOR::Korea, SouthKWT::KuwaitKGZ::KyrgyzstanLAO::LaosLVA::LatviaLBN::LebanonLSO::LesothoLBR::LiberiaLBY::Libyan Arab JamahiriyaLIE::LiechtensteinLTU::LithuaniaLUX::LuxembourgMAC::MacauMKD::MacedoniaMDG::MadagascarMWI::MalawiMYS::MalaysiaMDV::MaldivesMLI::MaliMLT::MaltaMHL::Marshall IslandsMRT::MauritaniaMUS::MauritiusMYT::MayotteMEX::MexicoFSM::MicronesiaMDA::MoldovaMCO::MonacoMNG::MongoliaMNE::MontenegroMSR::MontserratMAR::MoroccoMOZ::MozambiqueMMR::MyanmarNAM::NamibiaNRU::NauruNPL::NepalNLD::NetherlandsANT::Netherlands AntillesNCL::New CaledoniaNZL::New ZealandNIC::NicaraguaNER::NigerNGA::NigeriaNIU::NiueNFK::Norfolk IslandMNP::Northern Mariana IslandsNOR::NorwayOMN::OmanPAK::PakistanPLW::PalauPAN::PanamaPNG::Papua New GuineaPRY::ParaguayPER::PeruPHL::PhilippinesPCN::PitcairnPOL::PolandPRT::PortugalPRI::Puerto RicoQAT::QatarROM::RomaniaRUS::RussiaRWA::RwandaKNA::Saint Kitts and NevisLCA::Saint LuciaVCT::Saint Vincent and the GrenadinesWSM::SamoaSMR::San MarinoSTP::Sao Tome and PrincipeSAU::Saudi ArabiaSEN::SenegalSRB::SerbiaSYC::SeychellesSLE::Sierra LeoneSGP::SingaporeSVK::SlovakiaSVN::SloveniaSLB::Solomon IslandsSOM::SomaliaZAF::South AfricaSGS::South Georgia and the South Sandwich IslandsESP::SpainLKA::Sri LankaSHN::St. HelenaSPM::St. Pierre and MiquelonSDN::SudanSUR::SurinameSJM::Svalbard and Jan Mayen IslandsSWZ::SwazilandSWE::SwedenCHE::SwitzerlandSYR::Syrian Arab RepublicTWN::TaiwanTJK::TajikistanTZA::TanzaniaTHA::ThailandTGO::TogoTKL::TokelauTON::TongaTTO::Trinidad and TobagoTUN::TunisiaTUR::TurkeyTKM::TurkmenistanTCA::Turks and Caicos IslandsTUV::TuvaluUGA::UgandaUKR::UkraineARE::United Arab EmiratesGBR::United KingdomUMI::United States Minor Outlying IslandsUSA::United States of AmericaURY::UruguayUZB::UzbekistanVUT::VanuatuVAT::Vatican City StateVEN::VenezuelaVNM::VietnamVGB::Virgin Islands (British)VIR::Virgin Islands (U.S.)WLF::Wallis and Futuna IslandsESH::Western SaharaYEM::YemenYUG::YugoslaviaZAR::ZaireZMB::ZambiaZWE::Zimbabwe
```

### US States field <a href="#us-states-field" id="us-states-field"></a>

To create a US States field, first create a new field in AcyMailing.

Then access your database (using phpMyAdmin for example), select the table "#\_\_acymailing\_fields" and edit the field you just created.

In the textarea "value", copy paste the following code:

```
AL::AlabamaAK::AlaskaAZ::ArizonaAR::ArkansasCA::CaliforniaCO::ColoradoCT::ConnecticutDE::DelawareDC::District of ColumbiaFL::FloridaGA::GeorgiaHI::HawaiiID::IdahoIL::IllinoisIN::IndianaIA::IowaKS::KansasKY::KentuckyLA::LouisianaME::MaineMT::MontanaNE::NebraskaNV::NevadaNH::New HampshireNJ::New JerseyNM::New MexicoNY::New YorkNC::North CarolinaND::North DakotaOH::OhioOK::OklahomaOR::OregonMD::MarylandMA::MassachusettsMI::MichiganMN::MinnesotaMS::MississippiMO::MissouriPA::PennsylvaniaRI::Rhode IslandSC::South CarolinaSD::South DakotaTN::TennesseeTX::TexasUT::UtahVT::VermontVA::VirginiaWA::WashingtonWV::West VirginiaWI::WisconsinWY::Wyoming
```

We wanted to thanks Jonathan for the list of countries and states.

### Canada Provinces field <a href="#canada-provinces-field" id="canada-provinces-field"></a>

To create a provinces field, first create a new field in AcyMailing.

Then access your database (using phpMyAdmin for example), select the table "#\_\_acymailing\_fields" and edit the field you just created.

In the textarea "value", copy paste the following code:

```
N/A::N/A AB::Alberta BC::British Columbia MB::Manitoba NB::New Brunswick NL::Newfoundland and Labrador NT::Northwest Territories NS::Nova Scotia NU::Nunavut ON::Ontario PE::Prince Edward Island QC::Quebec SK::Saskatchewan YT::Yukon
```

Thank you Mr BlackBoot !

### Brazilian States field <a href="#brazilian-states-field" id="brazilian-states-field"></a>

To create a states field, first create a new field in AcyMailing.

Then access your database (using phpMyAdmin for example), select the table "#\_\_acymailing\_fields" and edit the field you just created.

In the textarea "value", copy paste the following code:

```
AC::Acre AL::Alagoas AP::Amapá AM::Amazonas BA::Bahia CE::Ceará DF::DistritoFederal ES::EspíritoSanto GO::Goiás MA::Maranhão MT::MatoGrosso MS::MatoGrossodoSul MG::MinasGerais PA::Pará PB::Paraíba PR::Paraná PE::Pernambuco PI::Piauí RJ::RiodeJaneiro RN::RioGrandedoNorte RS::RioGrandedoSul RO::Rondônia RR::Roraima SC::SantaCatarina SP::SãoPaulo SE::Sergipe TO:Tocantins
```

Thanks to Bento for providing us with this list.

### Australian States <a href="#australian-states" id="australian-states"></a>

To create a states field, first create a new field in AcyMailing.

Then access your database (using phpMyAdmin for example), select the table "#\_\_acymailing\_fields" and edit the field you just created.

In the textarea "value", copy paste the following code:

```
ACT::Australian Capital Territory NSW::New South Wales NT::Northern Territory QLD::Queensland SA::South Australia TAS::Tasmania VIC::Victoria WA::Western Australia
```

Thank you Geoff !

## Frequently Asked Questions <a href="#frequently-asked-questions" id="frequently-asked-questions"></a>

### How many custom fields can I add? <a href="#how-many-custom-fields-can-i-add" id="how-many-custom-fields-can-i-add"></a>

You can create as many custom fields as you want. You can delete some of them or create new ones when you want...

### How can I translate the inserted fields? <a href="#how-can-i-translate-the-inserted-fields" id="how-can-i-translate-the-inserted-fields"></a>

If the label of the field is in upper-case, then AcyMailing will look for a translation in the language files.

Our language files already contain some translations so you can directly use:

* FIRSTNAMECAPTION (First Name)
* LASTNAMECAPTION (Last Name)
* CITYCAPTION (City)
* COUNTRYCAPTION (Country)
* PHONECAPTION (Phone Number)
* ADDRESSCAPTION (Address)
* BIRTHDAYCAPTION (Birthday)

To translate your own fields, you should:

* Write the label of your field as uppercase (otherwise Acy won't look at your language file to translated it)
* Add your translation in the AcyMailing language file that you can edit from the Acy configuration page. There is a special area there to add your custom translations so they won't be deleted if you update/upgrade.

The same way you can translate each option of your dropdown/radio/checkboxes fields:

For example a "gender" field with the values: Value / Title / GENDER\_SELECT male / GENDER\_MALE female / GENDER FEMALE

&#x20;Write these translations in your AcyMailing language file via the Acy configuration page: GENDER="Gender" GENDER\_SELECT="Please select..." GENDER\_MALE="Mr" GENDER\_FEMALE="Ms" CONFIRM\_MSG\_HELLO\_MALE="Dear Mr" CONFIRM\_MSG\_HELLO\_FEMALE="Dear Ms" CONFIRM\_MSG\_HELLO\_SELECT="Dear"

&#x20;And then in your email you can use the following if-condition-syntax: {if:gender=male}{trans:CONFIRM\_MSG\_HELLO\_MALE} {subtag:title} {subtag:nachname}{/if} {if:gender=female}{trans:CONFIRM\_MSG\_HELLO\_FEMALE} {subtag:title} {subtag:nachname}{/if} {if:gender=select}{trans:CONFIRM\_MSG\_HELLO\_SELECT} {subtag:title} {subtag:nachname}{/if}

### How can I display the user custom fields on the notification message? <a href="#how-can-i-display-the-user-custom-fields-on-the-notification-message" id="how-can-i-display-the-user-custom-fields-on-the-notification-message"></a>

By default, the notification message contains the user name, its e-mail address and its IP. You can add other fields to that message by editing it via the AcyMailing configuration page and add the tag:

{user:COLUMN\_NAME}

So for example if you created a custom field called "country", you should insert the tag {user:country} in the notification message.

Do not use {subtag:country} otherwise the receiver information will be displayed, not the one from your newly created user.


# Bounce Handling

## What's a bounce e-mail? <a href="#whats-a-bounce-e-mail" id="whats-a-bounce-e-mail"></a>

When you send a message to a non-existing e-mail address, you will get an automatic reply saying that this e-mail address does not exist. This is what we call a **bounce e-mail** and this message will be automatically sent to the e-mail address you specified as “**bounce address**” in the AcyMailing configuration page. Depending on your server, this message may not be returned immediately and sometimes it can be sent up to one week after you sent your e-mail.

![](/files/-MJSSoKawHOXDSV2bD6G)

Bounce Example

**AcyMailing Enterprise** is able to handle such messages.

AcyMailing will connect to your mailbox, "read" your messages, determine which e-mail address bounced and automatically execute actions on this wrong receiver such as:

* Delete the user
* Block the user
* Remove the subscription of the user
* Unsubscribe the user
* Subscribe the user to another list

Then AcyMailing can delete the message from your mailbox, save it on the AcyMailing user profile and/or forward it to another e-mail address so that it won't be processed twice.

That way, you will always keep a clean list of subscribers and the non-existing e-mail addresses will be removed from the system.

**We highly recommend you to handle your bounce messages on a dedicated mailbox.** That way, you won’t receive the replies from your subscribers on this same mailbox and you will safely let AcyMailing delete messages from your bounce mailbox. If you don't use a dedicated mailbox, please make sure you don't specify any action on the message for the final action.

## Configure the bounce handling <a href="#configure-the-bounce-handling" id="configure-the-bounce-handling"></a>

Your bounce messages will be automatically sent to the address you specified as “**bounce address**” in the AcyMailing configuration page. This address won’t be visible by the receiver of your message and will only be used to handle bounce messages and automatic replies.

You should specify an e-mail address attached to one of your mailboxes so AcyMailing will be able to connect to it and handle the messages.

Let's now configure the bounce handling. First access the bounce configuration via the AcyMailing back-end menu.

![](/files/-MJSSqZpb7Cicue7NPrw)

Bounce Menu

### Connect to your mailbox <a href="#connect-to-your-mailbox" id="connect-to-your-mailbox"></a>

![](/files/-MJSStYV7hyFS4RrT77l)

Boune configuration

* **Bounce Address** : This field indicates the same e-mail address you specified in the field "Bounce Address" on the "Mail Configuration" tab. It's just there as a reminder as you should configure the system to connect to this e-mail address.
* **Server** : The e-mail server AcyMailing should connect to to handle messages.
* **Port** : Port of your e-mail server. In most cases, it will be 110 for POP3, 143 for IMAP and 993 for IMAP using a secured connection.
* **Connection Method** : Choose the method AcyMailing should use to connect to your mailbox.
* **Secure Method** : You can select a secured method to connect to your e-mail server (if you use GMail, you should select "SSL")
* **Self-Signed Certificates** : Do you want AcyMailing to auto-sign your certificates?
* **Username** : Username used to connect to your e-mail account. In most cases, it will be the same as your bounce address.
* **Password** : Password used to connect to your e-mail account.
* **Connection timeout (seconds)** : Set the maximum number of seconds AcyMailing should try to connect to your e-mail server before stopping. 10 seconds is a good default value.
* **Maximum number of e-mails** : Each time AcyMailing will connect to your mailbox, it will handle a series of e-mails. You can set the maximum number of e-mails AcyMailing will handle at the same time.
* **Enable the Automatic Bounce Handling** : Once tested, you will want this system to run automatically so you can then turn On this option and let Acy do the job.

### Default rules applied to the messages <a href="#default-rules-applied-to-the-messages" id="default-rules-applied-to-the-messages"></a>

The default rules will handle most cases so you should not have to add any other rule.

If the regex matches the message, then AcyMailing will execute the corresponding actions (on the detected subscriber and on the e-mail) and then will handle the next message. If the regex does not match the e-mail, then AcyMailing will try to execute the next rule. It's useless to specify twice the same regex as AcyMailing will stop processing the e-mail as soon as it finds a rule which matches, the final action is only executed if none of the rules can be applied to the message.

![](/files/-MJSSwaWOv1rOWwbrAmE)

Default rules

* The first rule "**Action Required**" will be executed on messages which require an action from you. You will want this kind of message to be manually handled so you should forward them to a webmaster and handle them one by one. This rule will handle all "click here to confirm you're an human" automatic answers or "reply to this Newsletter and leave the subject intact".
* The rule "**Acknowledge of receipt - in subject**" will delete notification message such as "I'm on vacation" or "thank you for your message" on the subject line. We just want to ignore these ones.
* The rule "**Feedback loop**" will handle feedback loops complaints.
* The rule "**Feedback loop - in body**" will handle the previous rule in the body.
* The rule "**Mailbox Full**" will handle messages not delivered because the receiver had his mailbox full. We don't want to immediately block that user so by default AcyMailing will wait 3 soft bounces messages before executing an action on that subscriber.
* The rule "**Blocked by Google Groups**" will handle bounces caused by Google groups blocking
* The rule "**Mailbox does not exist 1**" will handle bounce messages indicating the mailbox could not be reached because it does not exist.
* The rule "**Message blocked by recipient filters**" will handle messages which could not be delivered because your message has been blocked by a filter. By default Acy will forward you these messages so you can investigate the issue.
* The rule "**Mailbox does not exist 2**" will handle bounce messages indicating the mailbox could not be reached because it does not exist.
* The rule "**Domain does not exist**" will handle bounce messages indicating the mailbox could not be reached because the domain name does not exist.
* The rule "**Temporary failures**" will handle other soft bounces such as mailbox temporary unavailable. By default AcyMailing will only execute an action on the subscriber if it receives at least 3 soft bounces from this user.
* The rule "**Failed permanently**" will handle what we call "hard bounces". The mailbox or receiver domain does not exist so we want to immediately block the user to not contact him any more. This rule will handle messages we could not catch with the previous ***Mailbox does not exist*** and ***Domain does not exist*** rules.
* The rule "**Acknowledgement of receipt - in body**" will delete notification message such as "thank you for contacting us..." if it's included in your bounce body. The first ***Acknowledge or receipt - in subject*** rule will only be detected based on the subject line compared to that one which checks the body.
* The F**inal rule** will be executed in case of the message didn't match any of the previous rules. By default we redirect this kind of message to your e-mail address so you may handle it manually or improve the rules so next time it will be handled automatically.

You can modify all our default rules, re-order them, add new ones, delete them... but you don't have to!

By default, users with wrong e-mail addresses will be blocked from AcyMailing but their subscription won't change. That's perfect so you can see who bounced (and unblock it if necessary) and you will still keep track of its old subscription even if he won't receive e-mails any more as he's blocked.

### Create/Modify a rule <a href="#create-modify-a-rule" id="create-modify-a-rule"></a>

99% of bounce messages will be handled by our default rules... You don't have to modify them or create new ones!

You may want to modify a rule or create your own one.

To edit an existing rule, simply click on its name.

To create a new rule, click on the new button on the top right of the bounce handling screen.

![](/files/-MJSSzI9Xx98PFtKeUJM)

New rule

![](/files/-MJST0c5PpveuUayFzb2)

Rule

* **Name** : Name of the rule. It doesn't have any importance, the objective is simply to clearly identify the rule during the process so that you can understand it better.
* **Enabled** : Only enabled rules will be loaded during the bounce handling.
* **Regex** : Regular expression to identify if the current rule applies to the message or not. If the rule matches the message, the action on the subscriber and on the e-mail will be triggered otherwise the next rule will be considered. If the Regex matches the message, no more rule will be triggered.
* **Execute the regex on** : The regex can be executed on the sender information, on the subject and / or on the body of the message.
* **Statistics** : If the rule matches, should AcyMailing flag the message as a bounce message in the statistics?
* **Action on the user** : If the regex matches the message, AcyMailing will try to identify the subscriber and an action will be applied to this subscriber.
  * The following actions on the subscriber will only be executed if AcyMailing received X bounce messages from this user. This option is very useful to handle "soft bounces". If you specify 0 or 1 then the action on the subscriber will be executed immediately. If you specify 2 or more, then Acy won't execute the subscriber action unless it already received X bounce messages from this user which have been considered as bounce message in the statistics (due to the option "statistics : Yes").
  * Delete the user subscription : The user will be removed from all your mailing lists but the user won't be deleted.
  * Unsubscribe the user : The user will be unsubscribed from the mailing lists he was subscribed to.
  * Subscribe the user : The user will be subscribed to the selected list.
  * Block the user : The user will be disabled but his subscription won't be changed. AcyMailing does not send e-mails to a blocked user.
  * Delete the user : The user will be deleted from AcyMailing. AcyMailing does never delete a Joomla User (his subscription will be deleted in AcyMailing but not the user itself if it's a registered one).
* **Action on the e-mail** : If the regex matches the message, an action will be applied to the message itself.
  * Save message in database : The bounce message will be save in the user's history so you may see it on the user profile.
  * Forward the message : The bounce message will be forwarded to the specified e-mail address so that you can handle it manually.
  * Delete the message : The bounce message will be deleted from your mailbox. You should always delete the message from the mailbox unless you're testing the system.

## Process the bounce system <a href="#process-the-bounce-system" id="process-the-bounce-system"></a>

You can either launch the bounce handling manually or use your cron task to automatically trigger it.

* * Go on your AcyMailing bounce configuration page and configure your bounce system as you want.
  * Then, test your configuration by clicking on the button "**Bounce Handling**", AcyMailing will try to connect to your mailbox and return the actual number of messages in your mailbox.

![](/files/-MJST3HvxjvqjxZihT5h)

Test your connection

* * If you don't have error and you have some e-mails in your mailbox, then AcyMailing will display you a message to trigger the real bounce handling.

![](/files/-MJST5cwrKM90E41_0CZ)

Bounce Process

* * Now you successfully tested the whole process, you can configure AcyMailing to do the job automatically using your cron task.

![](/files/-MJST8I0_ESauN6OzuNQ)

auto bounce

* Turn on the option **Enable the Automatic Bounce Handling** and then configure the frequency used to connect to your mailbox. Connecting to your mailbox to handle messages can take some times. We don't recommend you to do it too often (once a day should be enough)

## Test the whole bounce process <a href="#test-the-whole-bounce-process" id="test-the-whole-bounce-process"></a>

The process is simple:

**1.** AcyMailing sends a Newsletter to a wrong e-mail address

**2.** A bounce message is returned by the recipient server saying the e-mail address we try to reach does not exist

**3.** AcyMailing reads this bounce message in your mailbox and applies an action on your subscriber (block him, unsubscribe him, delete him...)

You should test each step to make sure it's working as it should and identifies the problem if there is one:

**1.** Via AcyMailing, send a test Newsletter to a non-existing e-mail address (via the Newsletter-preview screen)

**2.** You should receive a bounce message on your bounce mailbox... Did you? If not, please [check the bounce e-mail address used](/old/main-pages/configuration/bounce-handling).

**3.** Once you see that bounce message in your bounce mailbox, Acy will be able to handle it. Go on the AcyMailing bounce handling and click on the button "bounce handling" to make sure it does.

## POP/IMAP configurations <a href="#pop-imap-configurations" id="pop-imap-configurations"></a>

### 1and1 <a href="#id-1and1" id="id-1and1"></a>

* Server: imap.1and1.com (or imap.1and1.fr)
* Port: 143
* Connection Method: IMAP
* Secure Method: - - -
* Self-signed certificates: No
* Your e-mail account/password

### GMail <a href="#gmail" id="gmail"></a>

If you want to use your GMail account to handle the bounces, you should first enable the IMAP connection on your GMail account settings and then configure AcyMailing:

* Server: imap.gmail.com (if it does not work, you should try with imap.googlemail.com)
* Port: 993
* Connection Method: IMAP
* Secure Method: SSL
* Self-signed certificates: Yes
* Your GMail username/password

If you have an authentication issue with GMail whereas you're absolutely 100% sure about your username and password, please:

* Make sure you enabled the IMAP connection on your GMail account
* Try to unlock your GMail account, sometimes GMail blocks the application: <http://www.google.com/accounts/DisplayUnlockCaptcha>​

Gmail apparently added a security for the Imap connection so if you cannot manage to set the connection up, enable the option "Authorize less secured applications" in the Gmail account's parameters, section "Connection and security".

### GoDaddy <a href="#godaddy" id="godaddy"></a>

* Server: pop.secureserver.net
* Port: 110
* Connection Method: POP3 (without imap extension)
* Secure Method: - - -
* Self-signed certificates: No
* Your e-mail account/password

### OVH <a href="#ovh" id="ovh"></a>

* Server: ns0.ovh.net
* Port: 110
* Connection Method: POP3
* Secure Method: - - -
* Self-signed certificates: No
* Your e-mail account/password

### Office365 <a href="#office365" id="office365"></a>

* Server: outlook.office365.com
* Port: 995
* Connection Method: POP3
* Secure Method: SSL
* Self-signed certificates: Yes
* Your e-mail account/password

## Connection errors <a href="#connection-errors" id="connection-errors"></a>

### The extension "php\_imap.dll" could not be loaded <a href="#the-extension-php_imap-dll-could-not-be-loaded" id="the-extension-php_imap-dll-could-not-be-loaded"></a>

![](/files/-MJSTCoHaKBFxVo0ZuAN)

Imap error

* AcyMailing uses special php functions to connect to your mailbox, it requires the PHP Imap extension to be installed on your server.
* Even if you use the POP3 connection, AcyMailing will need this PHP extension which handles all the communication with your mail server.
* Please enable this extension on your php.ini file or contact your hosting company to enable this extension on your website.
* If you cannot enable this extension, you can use the Connection method : POP3 without IMAP extension, this method has been only developed for users not being able to enable the IMAP PHP extension on their server.

### Certificate failure <a href="#certificate-failure" id="certificate-failure"></a>

![](/files/-MJSTFFv7oI6P6rXx1sF)

Self Signed certificate

* Your mail server apparently need you to sign a certificate to enable you the connection to your mailbox.
* You should turn on the option "**Self-signed Certificates**" and give it a new try.

### ESMTP Exim <a href="#esmtp-exim" id="esmtp-exim"></a>

![](/files/-MJSTI8zD9-_Ocvd2IwH)

Error esmtp exim

* This is a typical error when your website can not connect to your mail server.
* This is not a problem of authentication but really a problem of mail server address or port.
* In our screen-shot, we were using the wrong port. The default port are:
  * 110 for POP3
  * 143 for IMAP
  * 993 for IMAP when using a secured connection

### Invalid Remote Specification <a href="#invalid-remote-specification" id="invalid-remote-specification"></a>

![](/files/-MJSTKTH1-qO3r-DiTC6)

invalid remote specification

The error message "Invalid remote specification" may appear if your php\_imap module has not been compiled with ssl support. You will need to ask your web host to recompile php and add the --with-imap-ssl option to the configure command.

## Frequently Asked Questions <a href="#frequently-asked-questions" id="frequently-asked-questions"></a>

### What happens with auto-reply messages such as “I’m out of the office” or “Thank you for your message” in the bounce handling system? <a href="#what-happens-with-auto-reply-messages-such-as-im-out-of-the-office-or-thank-you-for-your-message-in" id="what-happens-with-auto-reply-messages-such-as-im-out-of-the-office-or-thank-you-for-your-message-in"></a>

The rules won't consider this kind of message as a message indicating that the mailbox does not exist. So no action will be applied to the subscriber and this message will be simply deleted or forwarded to another e-mail address based on the rules configuration.

Sometimes there is a delay and sometimes you will receive the bounce immediately.

When you send a message to a non-existing domain name : joh&#x6E;*@*&#x66;mqlksjdfmlqksdfj.com, your own mail server won't be able to send the message and so you will immediately get a bounce e-mail saying this address does not exist. Depending on your mail server configuration, even this bounce might be delayed if your mail server keeps your message in a queue to try to re-send it later.

But when you send a message to a non-existing user account (but an existing domain name): mfqlkjsdfmlqkjsdmflqjsld&#x66;*@*&#x67;mail.com Then your own mail server is able to deliver your message. And GMail will read your message, try to deliver it to the right person, detect that the account does not exist and then return you a bounce message. Depending on the configuration of the receiver's domain, this action takes some time as some servers double check (sometimes during more than a day) that they really can not deliver your e-mail.

On our own website, when we send Newsletters to all our users, it takes 2 days to handle all the bounces but sometimes we even still receive some of them a week later.

### How can I check the bounce address specified in my Newsletters? <a href="#how-can-i-check-the-bounce-address-specified-in-my-newsletters" id="how-can-i-check-the-bounce-address-specified-in-my-newsletters"></a>

AcyMailing will use the bounce address you specified in your AcyMailing configuration page.

Nevertheless some servers do not allow AcyMailing to set it and another e-mail address will be used so your bounce messages will be sent to this other e-mail address.

To check it, you can do a spam test or test your message on [http://www.mail-tester.com](http://www.mail-tester.com/)​

![](/files/-MJSTNCdzPxZpVbOtetP)

Bounce address

Some mail servers will force this bounce address to another one if you use the PHP Mail Function or an external delivery service. This can be solved by using the SMTP method instead of the PHP Mail Function or by making sure your bounce messages are redirected to your own bounce e-mail address if you use an external delivery service.

### What's the difference between "failed" and "bounced"? <a href="#whats-the-difference-between-failed-and-bounced" id="whats-the-difference-between-failed-and-bounced"></a>

On the statistics page, you will see two columns: failed and bounced.

The two columns indicate two different information.

"Failed" is the number of e-mails AcyMailing or your server refused to send whereas "Bounced" is the number of e-mails your server sent but then a bounce message has been generated and sent back to your mailbox.

### I would like to get back the default bounce rules... how can I do that? <a href="#i-would-like-to-get-back-the-default-bounce-rules-how-can-i-do-that" id="i-would-like-to-get-back-the-default-bounce-rules-how-can-i-do-that"></a>

If you're using our latest version, you can see a button "re-install rules" at the top of the bounce page.

Simply click on it, Acy will delete all your rules and reinstall the default ones.

### The bounce handling system does not work... <a href="#the-bounce-handling-system-does-not-work" id="the-bounce-handling-system-does-not-work"></a>

You have 0% bounce in your statistics and you find it odd?

Here is what you should do:

**1.** Send a spam test via the preview screen and make sure the bounce e-mail address returned by the spam test is the right one! (the one you entered in the Acy configuration page as "bounce address")

If it's not the right one, then two options:

* You use an external delivery service and they handle your bounce messages... you should make sure that this third party also redirects bounce messages to your own mailbox so you can handle them as well
* Your host changes your bounce address into a weird one... Please contact your hosting company to know how you can make sure that messages are sent using the bounce e-mail address you specified!

**2.** Go on the AcyMailing bounce handling system and make sure that you try to connect to the right mailbox. If you have a connection issue then try to fix it. (see above)

**3.** Bounce messages will be redirected to your mailbox and Acy will handle them only if:

* Messages are still in the mailbox!
* If you use Outlook to check that mailbox as well, messages will be downloaded and won't stay on your online mailbox so Acy will not be able to handle bounces at all.
* The bounce messages should be in your main folder! Sometimes your mail client will flag bounce messages as spam... in which case Acy won't be able to handle them any more. Please make sure your messages stay in your main folder and create some rules in your mail client if needed to assure you they are not automatically considered as spam

### I use an smtp delivery service but Acy does not receive and handle the bounce messages any more? <a href="#i-use-an-smtp-delivery-service-but-acy-does-not-receive-and-handle-the-bounce-messages-any-more" id="i-use-an-smtp-delivery-service-but-acy-does-not-receive-and-handle-the-bounce-messages-any-more"></a>

* **SendGrid** There is an option in SendGrid to redirect the bounce message to another e-mail address so Acy can still handle your bounce messages. Connect to your SendGrid account, Email Reports > Settings > Forward bounces This option enables you to forward bounces to a specific email address. Please check the box below and enter the forwarding email address which should be your AcyMailing bounce address.
* **ElasticEmail** You can specify a forward e-mail address on your ElasticEmail account under the menu "SETTINGS" -> "Sending" so bounce messages are redirected to another e-mail address.


# Unsubscribe page

## Unsubscribe screen <a href="#unsubscribe-screen" id="unsubscribe-screen"></a>

You should include the tag {unsubscribe}{/unsubscribe} in all your Newsletters to let your users unsubscribe from your website. The user will be then redirected to a page with three options:

![](/files/-MJSTUAI43h876nAWlRS)

Unsubscribe screen

* **Unsubscribe from this Mailing List**: The user will be unsusbcribed from all lists attached to the current Newsletter.
* **Unsubscribe from all Mailing Lists**: The user will be unsubscribed from all mailing lists but if you create a new mailing list and subscribe the user to it, he will receive your Newsletters.
* **Do not receive any e-mails from this website in the future**: The user will be unsubscribed from all mailing lists and flagged as "does not accept e-mails" so if you create a new mailing list and subscribe this user to it then he won't receive the Newsletters as he will still be marked as "does not accept e-mails".

## Add an unsubscribe link in your Newsletter <a href="#add-an-unsubscribe-link-in-your-newsletter" id="add-an-unsubscribe-link-in-your-newsletter"></a>

* Click on the tags button when editing your Newsletter.
* Select the tag menu "subscription"
* Insert the tag which will be replaced by a valid unsubscribe link

![](/files/-MJSTX8tvmhLscYeEt9N)

Unsub link

## Customize the unsubscribe view via the AcyMailing configuration <a href="#customize-the-unsubscribe-view-via-the-acymailing-configuration" id="customize-the-unsubscribe-view-via-the-acymailing-configuration"></a>

*These options have been implemented since AcyMailing 1.8.4*

On the AcyMailing configuration page, tab "interface", you will find an area where you can customize a few options on this unsubscribe page:

![](/files/-MJSTZDbFe4aYu_yWi3V)

Unsub options

* You can customize the Introduction text and use the tags:
  * {user:name} to display the subscriber name
  * {user:email} to display the subscriber email address
  * {user:*customfield*} to display any other value of the subscriber profile (*customfield* should be replaced by your custom field name)
  * {list:name} to display the list name
* If you disable the unsubscribe options, the user will be unsubscribed from all your lists without having to select this option:

![](/files/-MJSTaMyLSChh4FktfHh)

No unsubscribe option

## Customize the unsubscribe view with some CSS <a href="#customize-the-unsubscribe-view-with-some-css" id="customize-the-unsubscribe-view-with-some-css"></a>

You can extend the view in your own template to modify it the way you want but you can also add some CSS to your own Joomla template to customize the current design:

Each option is included in its own div. You can access each of them with #unsublist\_div , #unsuball\_div , #unsubfull\_div

So if you want to remove both options "unsubscribe from all mailing lists" and "do not receive any e-mail", then you can add this CSS to your [AcyMailing Component front-end CSS file](/old/main-pages/configuration#css): #unsuball\_div, #unsubfull\_div{ display:none }

## Access the unsubscribe reasons <a href="#access-the-unsubscribe-reasons" id="access-the-unsubscribe-reasons"></a>

If you edit the user profile, you can see via the tab "history" the unsubscribe reason for this user.

You can also see them all via the AcyMailing statistics page if you click on the number of unsubscribers.

![](/files/-MJSTchT3USr7mf71VhC)

Unsubcribe reasons

## Edit the unsubscribe survey <a href="#edit-the-unsubscribe-survey" id="edit-the-unsubscribe-survey"></a>

On the AcyMailing configuration page, tab "**interfaces**", you can create your own unsubscribe survey by adding extra reasons and/or by deleting existing reasons.

![](/files/-MJSTelSH_kNPZFzyPdZ)

Unsubscribe survey

Our default reasons are written in uppercase because we will load the translation of this string in the AcyMailing language file. You can see above each field the current translation of that string.

If you don't manage a multilingual website, don't bother with that and directly write your reasons in the fields.

## Direct unsubscribe links <a href="#direct-unsubscribe-links" id="direct-unsubscribe-links"></a>

By default AcyMailing will display an unsubscribe page where the user can select the options he wants and submit his feedback.

If you rather want to have a direct unsubscribe link with no confirmation, you can use this link in your Newsletter and the user will be immediately unsubscribed from all your mailing lists: index.php?subid={subtag:subid|urlencode}\&option=com\_acymailing\&ctrl=user\&task=saveunsub\&key={subtag:key|urlencode}\&mailid={mailid}\&unsuball=1

&#x20;You can also use that one and the user will be unsubscribed from the current mailing list only: index.php?subid={subtag:subid|urlencode}\&option=com\_acymailing\&ctrl=user\&task=saveunsub\&key={subtag:key|urlencode}\&mailid={mailid}\&unsublist=1

And this third link will not only unsubscribe the user but also set him as "do not accept emails" so he will never receive emails from your website even if you create a new fresh list and subscribe him to that newly created list: index.php?subid={subtag:subid|urlencode}\&option=com\_acymailing\&ctrl=user\&task=saveunsub\&key={subtag:key|urlencode}\&mailid={mailid}\&unsuball=1\&refuse=1


# Configure your Subscription Module

During the install process, AcyMailing will automatically install this module so you can display a Newsletter subscription module on your website. The module can appear with a slide effect or in a popup or simply be always visible.

## How to access this screen <a href="#how-to-access-this-screen" id="how-to-access-this-screen"></a>

* Log in on your Joomla back-end and click on the menu "Extensions -> Module Manager"

![](/files/-MJSTnB14tSZ0nhoObtQ)

Access Module

* Click on the module name **AcyMailing Module**, but even before that, you probably want to **enable** this module.

![](/files/-MJSTrZUB1ztowLVqh72)

## Customize your module <a href="#customize-your-module" id="customize-your-module"></a>

You can apply a specific confirmation message for each module in the AcyMailing configuration page, tab "Languages": edit the language file and in the "Custom translations" area, put SUBSCRIPTION\_OK\_MODULE\_IDMODULE="Your custom message". Of course, replace "IDMODULE" by the real Id of the module.

You can also extend our module view in your own template to fully customize it but the easiest way to customize the AcyMailing module is to apply some CSS to it.

You can create your own css file via the AcyMailing configuration page (tab interface) :

![](/files/-MJSTx0SbBwKgxzBmCTQ)

CSS

If you click on the small edit icon, AcyMailing will create a copy of our default css file and let you modify it so you can revert your changes when you want.

We created a series of CSS files ready to be used for the AcyMailing module that you can change on the AcyMailing configuration page.

### Change the style of the subscribe/unsubscribe buttons <a href="#change-the-style-of-the-subscribe-unsubscribe-buttons" id="change-the-style-of-the-subscribe-unsubscribe-buttons"></a>

Both buttons are included in a td class="acysubbuttons" and with a class="button" on it so you can apply some styles via CSS using: td.acysubbuttons .button{...}

You can also add a style on td.acysubbuttons .button:hover to create an effect when the cursor is on the button.

### Examples <a href="#examples-1" id="examples-1"></a>

## Frequently Asked Questions <a href="#frequently-asked-questions" id="frequently-asked-questions"></a>

### Why do I see my own name and e-mail on the module? <a href="#why-do-i-see-my-own-name-and-e-mail-on-the-module" id="why-do-i-see-my-own-name-and-e-mail-on-the-module"></a>

As you're logged in, AcyMailing "recognized" you and displays your own subscription.

There is an option on the AcyMailing Module to not automatically identify the user if you don't want it to happen.

![](/files/-MJSTzwB0JBCItZUN5ZT)

Auto identify logged-in user

### How can I display lists on my module? <a href="#how-can-i-display-lists-on-my-module" id="how-can-i-display-lists-on-my-module"></a>

If you want to display some lists on your module (with checkboxes or dropdown), then you should make sure you didn't select lists for the parameter "**automatically subscribe to**".

The lists you selected for the field "visible lists" will be displayed but only if they are not selected in the "automatically subscribe to" parameter.

![](/files/-MJSU1DVMAJcDGQrIle5)

Visible lists


# Latest Newsletters module

## Description <a href="#description" id="description"></a>

The AcyMailing module enables you to display the latest Newsletters on your website, the same way the mod\_latestnews module would do it for your Joomla Articles.

## Install the module <a href="#install-the-module" id="install-the-module"></a>

* ​
* Log in to your backend and click on the menu "**Extensions -> Install/Uninstall"**.
* Browse for the AcyMailing module you just downloaded and then click on the button "**Upload File & Install**".
* You should now see the AcyMailing Module on your Joomla Module Manager. Don't forget to enable this module.

## Module parameters <a href="#module-parameters" id="module-parameters"></a>

![](/files/-MJSU7FMSp5uNOO7ZRuM)

Params

* **Lists**: Click on the "select" button to select the lists in which AcyMailing will pick up your Newsletters
* **Number of Newsletters**: Specify the number of Newsletters you want to display on the module
* **Ordering**: Select how AcyMailing should order your Newsletters
* **Itemid**: ID of a Joomla menu linked to AcyMailing. Please specify this parameter only if you have access issues, otherwise leave it empty.
* **Display in a popup**: Do you want AcyMailing to open your archive in a popup or inside your Joomla template?
* **Display send date**: Do you want to display the send date on the latest Newsletter module?
* **Display the user's Newsletters**: If the user is logged in, should AcyMailing display the Newsletters the user received?
* **Date format**: Set the date format to display on the module.

## Custom error message <a href="#custom-error-message" id="custom-error-message"></a>

If there are no newsletter to display in the list you chose, you will see this message in the module: "Please make sure you have a published and visible Newsletter attached to your list".

If you want to change this message, you can add a custom translation in the Acymailing configuration, tab Languages by adding this: NO\_LATEST\_NEWSLETTER="Your own message here"

## Example <a href="#example" id="example"></a>

![](/files/-MJSU9CSU2FscHdv0t9u)

Latest News


# Newsletter archive section

## Archive one list <a href="#archive-one-list" id="archive-one-list"></a>

![](/files/-MJSUImBYzDbcPeqCJmE)

Thanks to an AcyMailing menu you can display the name and description of a selected list on a page of your website.

This way users can view all the newsletters you already sent to this list, even if they are not subscribed to it.

In the Joomla menu manager create a new menu and select as a menu item type the AcyMailing menu entitled "Mailing List Archive (single)".

If you manage several lists, do not forget to select the list you want to be displayed.

![](/files/-MJSULO4RGbri4njk1mM)

**You can modify the layout of your archive section in the AcyMailing configuration : "configuration / interfaces / archive section" and check your favourite options.**

![](/files/-MJSUNpHs_0fG37H0wm1)

Since AcyMailing 4.9.0, two fields "Thumbnail" and "Summary" were added to the newsletter's interface. These fields are now displayed in the archive section, but if you want to get back the old way it was displayed, you could edit the "Component Front-end CSS file" option in the AcyMailing configuration page, tab "Interfaces" then add the following CSS code (the table header will not appear):

```
#acyarchivelisting .archiveRow .acyarchivetitle{ display:inline; } #acyarchivelisting .sentondate{ display:inline; float: right; }
```

If you want to display the "Receive via email" checkbox on a new line, you can also add this CSS code in addition to the previous one:

```
#acyarchivelisting .receiveviaemail{ float: left; width: 100%; }
```

## Archive all lists <a href="#archive-all-lists" id="archive-all-lists"></a>

![](/files/-MJSUQOSjwjGd8TShUd5)

The same way you add an AcyMailing menu for the "archive one list" section you can create a section to display all your Lists using the menu entitled "Mailing Lists archive (all)".

This menu enables you to display all your Mailing Lists on your website and the newsletters belonging to them.

![](/files/-MJSUSji2NyxtmCRoIwW)

## Show the latest newsletter <a href="#show-the-latest-newsletter" id="show-the-latest-newsletter"></a>

![](/files/-MJSUUs5t4oY50T-8Rue)

The AcyMailing menu entitled "Latest Newsletter" enables you to display the latest published and visible newsletter on your website.

If you manage several lists, do not forget to select from which list you want to extract the latest newsletter.

![](/files/-MJSUX1AY5cZcv510gj-)

## Show the latest newsletters in a module <a href="#show-the-latest-newsletters-in-a-module" id="show-the-latest-newsletters-in-a-module"></a>

![](/files/-MJSUZGrUeW2dAY9QAls)

You can display a listing of selected newsletters in a module, so that your user can choose the newsletter he wants to read.

This feature is available thanks to an AcyMailing plugin entitled "Latest Newsletters (module)" that you can download in our [plugin section](https://www.acyba.com/en/download/plugins-modules.html).

To configure it, please go to our [detailed documentation](/old/public-part-of-your-site/latest-newsletters-module).

## Frequently Asked Questions <a href="#frequently-asked-questions" id="frequently-asked-questions"></a>

### Why my Newsletter does not appear on my archive section? <a href="#why-my-newsletter-does-not-appear-on-my-archive-section" id="why-my-newsletter-does-not-appear-on-my-archive-section"></a>

For your Newsletter to appear on your archive section you should make sure that:

* Your Newsletter is assigned to the right list. Even if you don't send it, don't forget to assign it to the right list!
* Your Newsletter is published.
* Your Newsletter is set as visible.


# Front-end Newsletter edition

Using AcyMailing Enterprise, you will be able to configure each of your lists and grant access to some group of users or to one specific user so that he will be able to create, edit, preview, test and send Newsletters from the front-end to this list. Your allowed users will even be able to see global statistics from the front-end.

This article will explain you, step by step, how to handle this process.

## Grant access to some Joomla groups or to a specific user <a href="#grant-access-to-some-joomla-groups-or-to-a-specific-user" id="grant-access-to-some-joomla-groups-or-to-a-specific-user"></a>

* * Log in on the back-end and click on the menu **Components -> AcyMailing -> Lists.**
  * Edit one of your lists.
  * There are two ways to give access to some users to manage the list on the front-end, depending on your needs you will either grant these rights to one or several Joomla groups of users but you can also grant these rights to a single user.

![](/files/-MJSUi1yTaONL5bitBrQ)

Group Access

* * **View/Subscription Access**: This option enables you to lock the subscription of your list only to users belonging to one of the selected Joomla group.
  * **Front-end Management**: You can select in this area the Joomla groups of users which will be able to manage your list from the front-end.
  * AcyMailing will also grant this access to the **creator** of your list so if you only want one user to be able to manage your list from the front-end, then change the creator of your list.

![](/files/-MJSUkaay3cLq_G75_H7)

Unique User Access

* Save your list to apply the changes.

## Create or edit a Newsletter from the front-end <a href="#create-or-edit-a-newsletter-from-the-front-end" id="create-or-edit-a-newsletter-from-the-front-end"></a>

* Log in on your front-end using an username which belongs to one of your allowed Joomla Groups or the creator of the list.
* If you browse your lists archive section when you are logged in with a user account able to manage the current list from the front-end, then you will see **add, edit and statistics icons**. You can create a new Joomla Item menu (type AcyMailing) to browse your archive section or directly access index.php?option=com\_acymailing.

![](/files/-MJSUn-0rmRKcTStQh0x)

Front-end archive

* The edit icon enables you to edit your Newsletter.

![](/files/-MJSUuO_VfCxwm94GXaD)

​At the bottom of the page, you will see an icon enabling you to create a Newsletter.

![](/files/-MJSV-1_gcVBPwIATpr6)

Create Newsletter

* If you click on one of these three icons, you will be redirected to the Newsletter edition screen.

![](/files/-MJSV1OaBf8MCA1UVffR)

Toolbar Frontend

* The options you get are similar to the ones displayed on the back-end, you can switch your template, add tags, replace your tags, save your Newsletter and preview it.
* You can write your subject, decide to publish your Newsletter, make it visible, choose to send the HTML or only the text version.
* You can create your HTML version of your Newsletter and your Text version (if you don't want AcyMailing to generate it automatically).

![](/files/-MJSV5M8jIac6hWvlaaa)

​​

* You can then select the receivers of the Newsletter. Only your attached lists will be displayed on this screen. I'm actually allowed to manage two lists from the front-end, that's why there are two lists on this screenshot but each user will have a different list selection depending on his rights.

![](/files/-MJSV93w9L0g-wM1qqud)

Lists selection

* You can attach files to your Newsletter and you can also change your sender information.
* By default, the sender information will be the default ones you specified on your AcyMailing configuration page but you will find an option on your AcyMailing configuration page so that the default sender information are the name and e-mail of the logged in user.

![](/files/-MJSVBYoBIPQtR9701s6)

Default sender

* The option **Allow modifications** indicates if you allow a user to edit a Newsletter created by another user. So if you select "No", only the creator of the Newsletter will be able to modify his Newsletter.
* The option **Allow post-sent edit** indicates if you allow a user to modify the Newsletter after the Newsletter has been sent. So if you select "No", the Newsletter can't be edited via the front-end once sent.

## Test and send a Newsletter from the front-end <a href="#test-and-send-a-newsletter-from-the-front-end" id="test-and-send-a-newsletter-from-the-front-end"></a>

* Click on the button **Preview / Send** when you edit your Newsletter to access the preview screen
* You will see your Newsletter and the automatic text version AcyMailing generated (or the one you wrote).
* Like on your back-end, this interface enables you to send a test of your Newsletter to some users and send it.

![](/files/-MJSVECLd5p7yeFP_J4L)

Preview

* If you click on the send button, AcyMailing will ask you a confirmation and then will queue all your e-mails. AcyMailing does not start the send process on your own session so you can do something else and turn off your computer while AcyMailing will automatically take care of the send process. (this send process requires a cron task that you can easily configure on the AcyMailing configuration page).

## Check the global statistics from the front-end <a href="#check-the-global-statistics-from-the-front-end" id="check-the-global-statistics-from-the-front-end"></a>

* Back on the archive section, you will see a statistic icon near the Newsletter subject for the Newsletter you already sent so that you can follow the send process and the success of your Newsletter via the front-end.

![](/files/-MJSVHA9ttJCIRNvRVkv)

Stats

* If you click on that icon, a popup will open and display you the same chart statistics than the ones you can access from the back-end:

![](/files/-MJSVJbb4G0BBLxdsSYb)

Stats

## Customize the front-end edition <a href="#customize-the-front-end-edition" id="customize-the-front-end-edition"></a>

Using some CSS, you will be able to remove some buttons from the front-end edition to have a cleaner interface.

You should add this CSS at the end of the Component Front-end CSS file. You will find an option on the AcyMailing configuration page to easily edit it (tab "interfaces").

### Edit screen <a href="#edit-screen" id="edit-screen"></a>

By default the front-end edition looks like:

![](/files/-MJSVMIoiUZjqaXOwO0n)

Default Front-end

> * You can remove the template button with the CSS #acybuttontemplate{ display:none }
> * You can remove the tags button with the CSS #acybuttontag{ display:none }
> * You can remove the replace tags button with the CSS #acybuttonreplace{ display:none }
> * You can remove the separator with the CSS #acybuttondivider{ display:none }
> * You can remove the preview button with the CSS #acybuttonpreview{ display:none}
> * You can remove the save button with the CSS #acybuttonsave{ display:none}
> * You can remove the apply button with the CSS #acybuttonapply{ display:none}
> * You can remove the cancel button with the CSS #acybuttoncancel{ display:none}

> **Example** #acybuttontemplate,#acybuttontag,#acybuttonreplace,#acybuttondivider,#acybuttonsave,#acybuttonapply,#acybuttoncancel { display : none} will remove all buttons except the preview one:

![](/files/-MJSVP-9jMu3v9W_Eifb)

Only preview

You can also remove some fields from the front-end edition only by using some CSS:

> * You can remove the alias field with the CSS #aliaskey, #aliasinput{ display:none }
> * You can remove the created date field with the CSS #createdkey, #createdinput{ display:none }
> * You can remove the published field with the CSS #publishedkey, #publishedinput{ display:none }
> * You can remove the visible field with the CSS #visiblekey, #visibleinput{ display:none }
> * You can remove the send html version field with the CSS #sendhtmlkey, #sendhtmlinput{ display:none }
> * You can remove the send date field with the CSS #senddatekey, #senddateinput{display:none}
> * You can remove the sent by field with the CSS #sentbykey, #sentbyinput{display:none}
> * You can remove the summary field with the CSS #summarykey, #summaryinput{display:none}
> * You can remove the thumbnail field with the CSS #picturekey, #pictureinput{display:none}
> * You can remove the language field with the CSS #languagekey, #languageinput{display:none}

> **Example** #aliaskey, #aliasinput, #createdkey, #createdinput, #publishedkey, #publishedinput, #visiblekey, #visibleinput, #sendhtmlkey, #sendhtmlinput, #sentbykey, #sentbyinput, #senddateinput, #summaryfield, #summaryinput, #picturekey, #pictureinput, #languageinput, #languagekey, #summarykey, #senddatekey{ display : none}

> will remove all the options except the subject input:

![](/files/-MJSVV3jcMxvmAL-Te4N)

> * You can remove the attachments tab with the CSS: For J3.x: #mail\_attachments\_tablink{display:none} For J2.5: .mail\_attachments{display:none} For J1.5: #mail\_attachments{display:none}
> * You can remove the sender information tab with the CSS: For J3.x: #mail\_sender\_tablink{display:none} For J2.5: .mail\_sender{ display : none} For J1.5: #mail\_sender{display:none}
> * You can remove the meta tab with the CSS: For J3.x: #mail\_metadata\_tablink{display:none} For J2.5: .mail\_metadata{display:none} For J1.5: #mail\_metadata{display:none}
> * You can remove the inbox action tab with the CSS: For J3.x: #mail\_inboxactions\_tablink{display:none} For J2.5: .mail\_inboxactions{display:none} For J1.5: #mail\_inboxactions{display:none}
> * You can remove the three tab with the CSS: #newsletterparams{display:none}
> * You can remove the text version input (and so force AcyMailing to automatically generate it) with the CSS #textfieldset{ display:none }

> **Example** #newsletterparams{display:none} will remove the Lists, Attachments, Sender information and Meta tabs

![](/files/-MJSVZ-LDFk7R-nKQzmn)

> ​

On the AcyMailing configuration page, there is an "Access Level" tab where you can attach one or several Joomla groups to your features... This area will also enable you to personalize your front-end edition and remove some features (such as the filters for example)

### Preview screen <a href="#preview-screen" id="preview-screen"></a>

The same way you can remove some elements from the preview screen.

By default it looks like:

![](/files/-MJSVfzzP74fF_QQyv9R)

Preview screen

> * You can remove the Schedule button with the CSS #acybuttonschedule, #acybuttonunschedule {display:none}
> * You can remove the Send button with the CSS #acybuttonsend {display:none}
> * You can remove the Spam Test button with the CSS #acybuttonspamtest{display:none}
> * You can remove the Edit button with the CSS #acybuttonedit {display:none}
> * You can remove the Close button with the CSS #acybuttoncancel {display:none}
> * You can remove the Send a test area with the CSS #sendatest {display:none}
> * You can remove the Lists area with the CSS #receiversinfo {display:none}
> * You can remove the preview resize options with the css #acypreview\_resize{display:none}

> **Example** #acybuttonschedule, #sendatest, #receiversinfo {display:none} will remove the send a test / lists areas and the schedule button

![](/files/-MJSVjbUeTceXB9hWIME)

## Frequently Asked Questions <a href="#frequently-asked-questions" id="frequently-asked-questions"></a>

### I have two registered users and two lists, how each user can manage his own list? <a href="#i-have-two-registered-users-and-two-lists-how-each-user-can-manage-his-own-list" id="i-have-two-registered-users-and-two-lists-how-each-user-can-manage-his-own-list"></a>

The owner of the list will be able to manage his list from the front-end regardless to the groups selected on the "Front-end management" option. So you should make sure that each user is set as owner of his list and that the option "None" is selected for the "Front-end management" option so he won't be able to send Newsletter to another list.

### How to have a different template loaded for each user? <a href="#how-to-have-a-different-template-loaded-for-each-user" id="how-to-have-a-different-template-loaded-for-each-user"></a>

* You should create a custom field called "template" (type "text").
* Then edit the user profile and enter the template ID the user wants as default template.
* So if this user creates a Newsletter from the front-end, this template will be loaded by default.

### What's the direct link to create a Newsletter from the front-end? <a href="#whats-the-direct-link-to-create-a-newsletter-from-the-front-end" id="whats-the-direct-link-to-create-a-newsletter-from-the-front-end"></a>

&#x20;You should create a new Joomla menu and select the type AcyMailing : create a Newsletter.

AcyMailing follows the filters defined on the Joomla configuration page. By default registered users are not allowed to add html tags... you may want to change that on the Joomla configuration page, tab "Text filters".

![](/files/-MJSVngwdupn_sF5YJ6J)

Text filters


# Insert your subscription form in your article

You can create a menu which will redirect the user to the main subscription screen and you can publish the AcyMailing module on your website. But sometimes you will find useful to include the AcyMailing module in the middle of an article, this is the easiest way to fully customize a subscription page the way you want.

## Insert your module inside an article with Joomla 2.5 or 3.x <a href="#insert-your-module-inside-an-article-with-joomla-2-5-or-3-x" id="insert-your-module-inside-an-article-with-joomla-2-5-or-3-x"></a>

If you are using Joomla! 2.5 or 3.X, you can include a module in your article using the simple Joomla! "loadmodule" tag feature.

You have to specify the module type and its title in the tag, for example, for this module:

![](/files/-MJSVwyZfwqtguVp68Qv)

The module type will be "mod\_acymailing" (our module's type) and the title will be "AcyMailing Module copy". Here is an example:

![](/files/-MJSVzPFXfrhV9-ZpQAf)

* Enable the "**Content - Load Modules**" Joomla! plugin via the Joomla plugins manager.
* Make sure you didn't forget the capitals in the title, **this is case sensitive**.
* Set the "**Menu assignment**" of your AcyMailing module to "**On All Pages**" and leave the "**Position**" parameter **empty** (so that it will not be displayed on your website except on your article)

## Insert your module inside an article with Joomla 1.5 <a href="#insert-your-module-inside-an-article-with-joomla-1-5" id="insert-your-module-inside-an-article-with-joomla-1-5"></a>

If you are using Joomla! 1.5, then you will have to attach your AcyMailing module to one specific template position and we will insert a tag in your article where you want the module to be displayed using the Joomla! "loadposition" feature.

The plugin loadposition (which is installed by default on Joomla) will then automatically replace your inserted tag by the AcyMailing module.

### Create a specific position in your template <a href="#create-a-specific-position-in-your-template" id="create-a-specific-position-in-your-template"></a>

We will first modify your template XML to add a new position.

That way, we will be sure to add your AcyMailing module to a non used position on your template (otherwise the module could be displayed twice). You can skip this part if you already know one available position on your template.

* * Open the XML file of your default template (you will have to connect to your server via FTP for that) the file path should be: templates/YOUR\_OWN\_TEMPLATE/templateDetails.xml
  * In this file you will see a series of positions.

![](/files/-MJSW15QJHY-f5MfcYN3)

positions template

* We will add a new one so that we can then safely attach the AcyMailing module to this position which is not used:
  * Add the code **newsletterpos** at the end of the list of positions
  * Save your file and upload it back to your server via FTP.

### Set the AcyMailing module to be displayed only on this position <a href="#set-the-acymailing-module-to-be-displayed-only-on-this-position" id="set-the-acymailing-module-to-be-displayed-only-on-this-position"></a>

If you already use the AcyMailing module somewhere, you can duplicate the module (select the module and then click on the button “copy”) to configure it independently from the other one.

* * Edit your AcyMailing module via the Joomla Module Manager

![](/files/-MJSWCE8voODuVJDmQ0T)

Module edit

* * Enable your module
  * The option “Show Title” won't have impact, it's ignored when inserted in an article.
  * Select the menu assignment “All” because we will display this module in your article so we don’t want to display this module based on the selected menu.
  * And then select the position you just created called “newsletterpos”.

![](/files/-MJSWEo0Pzj4cQ6L38SC)

Module config

![](/files/-MJSWHY0TSRU8_z-_vrH)

* Save your module.

### Add a tag in your article which will be replaced by the AcyMailing module <a href="#add-a-tag-in-your-article-which-will-be-replaced-by-the-acymailing-module" id="add-a-tag-in-your-article-which-will-be-replaced-by-the-acymailing-module"></a>

* * Edit one of your Joomla article and then add the tag: **{loadposit**ion newsletterpos}

![](/files/-MJSWK-Y38tG2-IZsNz_)

add tag to article

* * Then save your Joomla article.
  * Joomla will now automatically replace your tag by the modules attached to this position (so the AcyMailing module only).

![](/files/-MJSWN6yZtMBEpwwYAjG)

Content preview

* You can now edit your AcyMailing module and set it up the way you want.
* It’s the method we used to display our download button in the middle of a Joomla article
  * We configured the AcyMailing Module to use the mootools popup effect
  * and we added a picture code in the parameter “Mootools Button Text”

    ```
    <img src="images/mypicture.png" border="0" alt="Download" />
    ```

## Avoid the e-mail cloaking plugin which alters the e-mail address in the input <a href="#avoid-the-e-mail-cloaking-plugin-which-alters-the-e-mail-address-in-the-input" id="avoid-the-e-mail-cloaking-plugin-which-alters-the-e-mail-address-in-the-input"></a>

We recommend you to add the text **{emailcloak=off}** in that article next to the tag to load the module. That way the email cloaking Joomla plugin won't alter the AcyMailing module (otherwise you may see some Javascript code inside the e-mail field if you are logged in)

![](/files/-MJSWPpsTZuPUMYAh2Xi)

Email cloaking issue


# Update AcyMailing 5

{% tabs %}
{% tab title="Joomla" %}
On Joomla you will just have to download the package and install it on your website, it will automatically update it without losing any data:

![](/files/-MJSWYYaAC_IuUai7M4b)

* Browse for your AcyMailing package and then click **Upload & Install**.

![](/files/-MJSW_zoG6SGGm7fQx6Q)

You can also use the Joomla update system for paid versions if you attached your site to your license:

![](/files/-MJSWcuiSbXIDcNIjrVy)

Then click on **Find Update** if they are some check it and click in **Update**

![](/files/-MJSWflrwP3Exxv7DhTl)

{% endtab %}

{% tab title="WordPress" %}
The old version 5 of AcyMailing isn't on the WordPress plugin listing site, which means that it isn't available in the Updates page.

As WordPress doesn't do the plugin update if you try to install the new version over a previous one, you will have to follow these steps:

1. Backup the folder wp-content / plugins / acymailing5 / media / upload /
2. Remove the folder wp-content / plugins / acymailing5 /
3. Install the new version of AcyMailing 5 on your WordPress website, using the Plugins => Add New => Upload Plugin option of WordPress
4. Add back the folder wp-content / plugins / acymailing5 / media / upload /

If you're unsure, you can backup the folder acymailing5 before following these steps.
{% endtab %}
{% endtabs %}


# Your send process is slow?

Your send process is slow and you're wondering why?

## My host has an hourly sending limitation <a href="#my-host-has-an-hourly-sending-limitation" id="my-host-has-an-hourly-sending-limitation"></a>

The only solution to avoid your host sending limitation is to use an other sending server.

### Upgrade to a dedicated server <a href="#upgrade-to-a-dedicated-server" id="upgrade-to-a-dedicated-server"></a>

Shared plans have limitations on the send process but if you upgrade to a dedicated server, you will be able to send as many e-mails as you want...

Please remember your host limits the send process to avoid being blacklisted so if you use your own server, don't forget to not abuse on the number of e-mails you send per hour!

### Use an external delivery service <a href="#use-an-external-delivery-service" id="use-an-external-delivery-service"></a>

No need to change your host, simply go on the AcyMailing configuration page and select the smtp sending method to send via another server.

You can pick up an external delivery service.

## Each message takes 5 seconds to be sent <a href="#each-message-takes-5-seconds-to-be-sent" id="each-message-takes-5-seconds-to-be-sent"></a>

### Do you have a big file attached to your Newsletter? <a href="#do-you-have-a-big-file-attached-to-your-newsletter" id="do-you-have-a-big-file-attached-to-your-newsletter"></a>

If you do, please make sure the option "embed attachments" is set to "No" on the AcyMailing configuration page so instead of embedding the file within the message, AcyMailing will just add a link to this file in your Newsletter.

### Do you have the option "embed pictures" enabled on the AcyMailing configuration page? <a href="#do-you-have-the-option-embed-pictures-enabled-on-the-acymailing-configuration-page" id="do-you-have-the-option-embed-pictures-enabled-on-the-acymailing-configuration-page"></a>

If so, please disable this option... your visitor will still see your pictures inside your Newsletter but instead of sending them within the e-mail, they will stay on your server.

### You're using an SMTP server? <a href="#youre-using-an-smtp-server" id="youre-using-an-smtp-server"></a>

AcyMailing has to connect to this SMTP server each time you deliver a message... it should not take more than 1 second per e-mail.

## You have an old version of AcyMailing 5

In the past, the SEF system or click tracking system were not optimised. Update to the latest version of AcyMailing 5.

If you can't do it, disable the option "Use SEF Urls" in the "Interfaces" tab of the Acy configuration page. You can also temporary disable the click tracking from the "Data collection" tab to see if it has any effect on the sending speed.

## Each message takes 1 second to be sent... but it's still too slow for me! <a href="#each-message-takes-1-second-to-be-sent-but-its-still-too-slow-for-me" id="each-message-takes-1-second-to-be-sent-but-its-still-too-slow-for-me"></a>

If you send via an external SMTP server, the communication with this external server takes time and sending 1 email every second is the standard rate. If you send from your own server, you will send much much faster...

By default AcyMailing uses a single queue system. You can [use our multiple queue system to speed up the send process](/old/developers/multiple-queue-system). You can really send as fast as you want using this system...


# Could not instantiate mail function

This is definitely the most common error message you will get if you have trouble sending e-mails using your server and unfortunately, this error message does not tell you how you can solve the issue.

Technically, the phpMailer library (a famous php library to send e-mails... used by AcyMailing and Joomla) tried to send a message using the php mail() function and the php mail() function returned "false".

## You are on a local server (using WAMP for example) <a href="#you-are-on-a-local-server-using-wamp-for-example" id="you-are-on-a-local-server-using-wamp-for-example"></a>

This kind of web server does not have a mail server so you can't send e-mails from your local server.

What's the solution? Well, you should configure AcyMailing to use an external SMTP server instead of using the php Mail function to test Acy but you can consider it will work on your live server

## Your receiver e-mail address is not valid <a href="#your-receiver-e-mail-address-is-not-valid" id="your-receiver-e-mail-address-is-not-valid"></a>

Your mail server may refuse to deliver your message if the receiver e-mail address is not a valid one... So if you have this "could not instantiate mail function" for only a few of your subscribers, it may just be because their e-mail address is not valid!

## You included a special character in the subject line <a href="#you-included-a-special-character-in-the-subject-line" id="you-included-a-special-character-in-the-subject-line"></a>

Some mail servers will refuse to deliver your message if it contains special characters in the subject such as a quote or a comma or any other kind of special character (ùïä)...

Please create a new Newsletter, specify a standard subject line ("test" for example) and give it a new try.

## You included a special character in the sender/receiver information <a href="#you-included-a-special-character-in-the-sender-receiver-information" id="you-included-a-special-character-in-the-sender-receiver-information"></a>

The same way, some mail server will refuse to deliver your message if the sender information contain special characters.

Please go on the AcyMailing configuration page, turn OFF the option "add Names" and give it a new try.

![](/files/-MJSX7oOgrdJAx-qCCqG)

Add Names option turned OFF

## Your subject line is too long <a href="#your-subject-line-is-too-long" id="your-subject-line-is-too-long"></a>

Some mail server may not authorize you to deliver your message if the subject line is too long...

Change your subject line to a single word to make sure it's not a problem of subjet length.

## The bounce address you specified is not accepted by your server <a href="#the-bounce-address-you-specified-is-not-accepted-by-your-server" id="the-bounce-address-you-specified-is-not-accepted-by-your-server"></a>

Some servers won't accept to deliver your message if you specify a bounce e-mail address. Others will force you to apply a bounce address which belongs to your own domain...

Please go on the AcyMailing configuration page and leave the bounce address field empty.

![](/files/-MJSX9nOCMwXy8urUwIL)

Bounce empty

## You should specify a bounce e-mail address <a href="#you-should-specify-a-bounce-e-mail-address" id="you-should-specify-a-bounce-e-mail-address"></a>

Just like the previous point, some servers will only deliver messages if you specified a bounce e-mail address belonging to your own domain.

If removing the bounce e-mail address didn't work, you should try to add it again and make sure it's a valid e-mail address belonging to your own domain.

## You already sent too many e-mails! <a href="#you-already-sent-too-many-e-mails" id="you-already-sent-too-many-e-mails"></a>

Most of hosting company will allow you send X e-mails per hour. If you go over that limitation, the mail server will refuse to deliver more e-mails and will display this error message. So for example if you successfully sent 480 e-mails and you can't send e-mails any more, then it's probably what happened and you should first wait one hour to deliver more e-mails and also make sure [AcyMailing is configured to stay below your sending limitations](/old/main-pages/configuration/configuration-tabs/configure-your-send-process).

## You send multiple parts... and your host does not like it! <a href="#you-send-multiple-parts-and-your-host-does-not-like-it" id="you-send-multiple-parts-and-your-host-does-not-like-it"></a>

Some hosts won't enable you to send multiple parts... That definitely a parameter we recommend you to keep enabled but you should try to turn it OFF to see if that solves the "could not instantiate mail function" issue. You will find this option under the "Mail Configuration" tab on the AcyMailing configuration page.

## Your host does not allow attachments <a href="#your-host-does-not-allow-attachments" id="your-host-does-not-allow-attachments"></a>

Some hosts will not allow you to send a message with an attachment... so if you have this issue only on Newsletter with attachments, you could turn OFF the option "embed attachments" on the Acy configuration page to make sure Acy will add the file as a link in your message and not as a real attachment.


# Sending issue

If you have a problem to send or receive your e-mails, then this article is for you!

The first thing to do is to go on your AcyMailing configuration page and click on the button "send a test". 99% of the time, if you didn't change your configuration since you installed AcyMailing, this test will be sent properly to your mailbox and you will receive it.

## I don't receive the e-mail sent using the "send a test" button from the AcyMailing configuration page <a href="#i-dont-receive-the-e-mail-sent-using-the-send-a-test-button-from-the-acymailing-configuration-page" id="i-dont-receive-the-e-mail-sent-using-the-send-a-test-button-from-the-acymailing-configuration-page"></a>

If it does not work, the first question to ask you is: "**Is my server able to send e-mails?**"

So the best way to test it is to go on the menu "**Tools -> Mass Mail**", then write few words and send the test to your administrators and super-administrators.

***Did you get that test?***

Joomla offers less options to configure the send process so less chances to make a mistake. But if you can not get it to work with Joomla, you probably won't be able to get it work with AcyMailing neither.

Note that if you're running a local website, you have to configure a mail server as it's not provided by default with systems like WAMP.

If you never sent any email from Joomla, you should contact your host to ask him why you cannot send emails from your site.

*If you cross that line, that means you're able to send and receive an e-mail from the Mass Mail tool in Joomla!*

So back on our AcyMailing configuration page.

If AcyMailing can not send your test, please make sure you use the same configuration in Joomla and in AcyMailing.

If you still can not send your test, you should see some errors on the screen and some tips to try to fix the issue.

*The common mistakes are:*

* You specified a bounce back e-mail address but this bounce back e-mail address does not belong to your server mail domain. (to send e-mails from an external smtp server, your bounce back e-mail should be usually the same as your SMTP username) If you're not sure about your bounce back e-mail address, simply leave the field empty.
* Some mail servers refuse to let you add a name in your sender information so you should turn off the option "**Add Names**".
* AcyMailing sends the test to your current e-mail account (linked to your username), so it should be a valid one!

If you still have errors on the screen when you try to send your test e-mail, go on our forum, write your configuration, the error message and all the tests you did so far so we can help you to solve that.

If you can apparently send the message but you never receive it, first be patient and wait four hours. After these 4 hours if you still didn't get your message, then go on our forum to ask some help and tell us all the tests you did so far.

## I can not send a Newsletter <a href="#i-can-not-send-a-newsletter" id="i-can-not-send-a-newsletter"></a>

If you cannot send a Newsletter, the first thing to do is to make sure you can send and receive the test from the AcyMailing configuration page.

So if you're still reading, that means **you successfully sent and received your test e-mail from the AcyMailing configuration page** but you can not send or receive your real Newsletter.

If so, first we need to understand if AcyMailing can not send it to your mail server, if your mail server can not send it to your mailbox or if you can not receive it.

Create a new Newsletter, switch your template and select "None" so that you will get a newsletter without any content.

Then add some text to it (only text, no picture) and go on your preview page.

Select "send text version", and send you a test.

Then select "send html version" and send you a test.

Did you get your two e-mails?

If you got the text one but not the html one, go on your AcyMailing configuration page, select the options:

* Add Names : No
* Send multiple part : No

![](/files/-MJSX07Z-FpPm8h0c2CV)

Send multiple part disabled

Then select the tab "plugins" and disable the statistics plugin and the url tracker plugin (if you see that one).

Then do the test again.

If you now receive the text and html versions, you can now turn On each option one by one to see the one which is causing the issue.

Still not in your mailbox? Check your trunk folder to see if it's there or not. If so, [follow this procedure to reduce your spam score](/old/main-pages/newsletters/spam-test).

If you can receive your newly created Newsletter in text and html (the one with few strings but no picture) but you still can not send or receive your real Newsletter, then there must be a difference between your two Newsletters. Go on your AcyMailing configuration page and select the options:

* Embed images : No
* Embed attachments : No

Some mail servers won't enable you to send e-mails with special characters in the subject so please remove any characters such as ( , - , )

Give it a new try...

If it still does not work, first be patient and wait four hours. After these 4 hours if you still didn't get your message, then please turn OFF the option "Add Names", "send multiple part" and the statistics plugins (handle click tracking and stats) and then go on our forum to ask some help with the answer of the following questions:

* Can you send/receive a message sent from the mass mail tool using the exact same configuration as in AcyMailing? (the Joomla function)
* Can you send/receive a test sent from the AcyMailing configuration page?
* Can you send/receive a test from a simple Newsletter (which means a Newsletter you created with the subject : test and the body : test) sent as "text" only?
* Can you send/receive a test from a simple Newsletter (the same above) sent as "html" ?
* Can you send/receive a test from your real Newsletter sent as "text" only?
* Can you send/receive a test from your real Newsletter sent as html version?

## Some of my users didn't receive my Newsletter <a href="#some-of-my-users-didnt-receive-my-newsletter" id="some-of-my-users-didnt-receive-my-newsletter"></a>

First it's important to understand why the user didn't receive your Newsletter... Is it because your server didn't send the message or because it didn't arrive in the mailbox?

Please send a test e-mail to this user (via the Newsletter preview screen) so you will see if the e-mail can be sent and received properly.

* If the e-mail is not received via the send a test but you can receive it properly on your own mailbox, that means something is blocking the e-mail on the receiver end and you should probably have a look at the spam filter. If your e-mail is indeed caught by the spam filter, then have a look at our [tips to avoid spam issues](/old/main-pages/newsletters/spam-test).
* If the test e-mail is received properly by the user but during the send process some users don't receive it, then your server probably didn't send the message even if it returned a "success" status to AcyMailing. In that case you should check that you don't go over your hosting sending limitations and [configure AcyMailing to stay under this limitation](/old/main-pages/configuration/configuration-tabs/configure-your-send-process).

## Emails stay in the queue for some users, but they are active and confirmed

If you send emails via the SendGrid SMTP, it may be due to a security tool on your server named "[FKA SMTP Tweak](https://features.cpanel.net/topic/change-fka-smtp-tweak-behavior-to-encourage-correct-user-behavior)", try disabling it and check again if your emails are sent.

## Frequently Asked Questions <a href="#frequently-asked-questions" id="frequently-asked-questions"></a>

### I have 800 users subscribed to my list but AcyMailing only sends e-mails to the first 498 users and then the send process stops, what's going on? <a href="#i-have-800-users-subscribed-to-my-list-but-acymailing-only-sends-e-mails-to-the-first-498-users-and" id="i-have-800-users-subscribed-to-my-list-but-acymailing-only-sends-e-mails-to-the-first-498-users-and"></a>

&#x20;If you successfully sent an important amount of e-mails and suddenly you can not send e-mails any more then it's probably due to your hosting limitation. Most of hosting companies apply a limit on the number of e-mails you can send per hour (300 per hour or 500 per hour) so if you try to send more e-mails, your mail server will refuse to send the rest of your Newsletter and display you error messages. AcyMailing kept all the non-delivered e-mails in the queue so you can resume your send process later. You should [read this article to know how you can spread your send process and avoid this sort of issue](/old/developers/multiple-queue-system). Some servers won't return to AcyMailing any error. They will send the first 500 e-mails but don't deliver the rest. In that case it's even more important to configure AcyMailing to respect your server limitations.

### AcyMailing tells me that the emails are correctly sent, but the emails never arrive <a href="#acymailing-tells-me-that-the-emails-are-correctly-sent-but-the-emails-never-arrive" id="acymailing-tells-me-that-the-emails-are-correctly-sent-but-the-emails-never-arrive"></a>

It's important to understand that AcyMailing does not send your emails: they are sent by the sending method you chose in the configuration. So if this sending method does not tell AcyMailing if there was an issue on the email send, the email is considered as sent. If it's the case, you should change your sending method to an other one (like an SMTP service).

It is also possible that your emails ended up in the SPAM folder, if so, you should [do a SPAM-test](/old/main-pages/newsletters/spam-test) and fix all the found issues.

### AcyMailing tells me the Newsletter will be sent to 35 users but I have 281 users, why? <a href="#acymailing-tells-me-the-newsletter-will-be-sent-to-35-users-but-i-have-281-users-why" id="acymailing-tells-me-the-newsletter-will-be-sent-to-35-users-but-i-have-281-users-why"></a>

Please make sure that:

* Your users are subscribed to at least one of the lists you selected for that Newsletter
* Your users are enabled
* Your users are confirmed (only if you require a confirmation on the AcyMailing configuration page)
* Your users accept to receive messages
* If you added a filter on your Newsletter, please make sure it selects the right users&#x20;

You can use our [filters/actions interface](/old/main-pages/users/mass-actions) to mass confirm, enable or subscribe users to your lists.

### Could not instantiate mail function <a href="#could-not-instantiate-mail-function" id="could-not-instantiate-mail-function"></a>

There are many reasons to get this error message when you try to send a Newsletter... But [they are all listed here](/old/faq/could-not-instantiate-mail-function)!


# Spam issue

Being caught by the spam filter is killing any e-mail marketing campaign.

These are only some advices and in most cases you won't have any issues with the spam filter even if you don't follow them.\
But in case of you are caught by the spam filter we recommend you to have a look at this article!

## Don't spam!

If you use AcyMailing to send Spam e-mails, you will obviously be considered as a spammer.\
If your Newsletter is not appreciated by your receivers, you will be considered as a spammer.

Do never buy a list of e-mails form a third party, they are full of non-valid e-mail address and your campaign will be quickly considered as spam.\
The good point is that you won't interfere with other users using AcyMailing for their campaign.\
Each AcyMailing installation is completely independent and your spam score depends only on your own server and e-mail.

## Optimize your content...

### Add more text than HTML tags

Finding a good balance between your real content and your html tags is really the most important point to don't get flagged as a spammer.

Your real content should represent the main part of your e-mail.

If you add a lot of HTML tags everywhere (tr,td,table,div,p,span...) and you almost don't have any text, your spam score will be increased.

Nevertheless the opposite is also true, if you add only text with some links and don't add any html tags, your spam score will be increased as well.

You should find the good compromise between real content and html tags to don't get caught by the spam filter.

So if you're testing your Newsletter template without real content inside, you have high probability to receive your tests in your junk folder, please make sure you're testing your real Newsletter and not only your template.

### Don't use "spam words"

Make sure you don't insert spam words in your e-mail such as "free", "sex", "pharmacy"...\
Those words usually increase a lot your spam score.

Don't S P A C E out your words, don't put strange letters or characters into your emails.

### Configure or remove the statistics

In order to handle statistics, AcyMailing adds in each e-mail a small blank picture.\
That way AcyMailing will know who opened your e-mail and when.\
But this statistic picture may increase your spam score, especially if the text {Disarmed} is added to your subject each time you send an e-mail.\
If you disable the plugin **AcyMailing : Statistics Plugin**, the picture won't be added any more.

This is definitely not required to not be caught by the spam filter but it might help if you have serious spam issues.

You can also configure your [AcyMailing : Statistics Plugin](/old/integration-plugins/installed-with-acymailing/plugin-statistics) to use your own picture and not a blank one.

On all our commercial versions, AcyMailing automatically tracks your links so you can know who clicked on which link in your Newsletter.\
This system may also increase your spam score so if you have serious spam issues, you should also turn OFF the plugin **AcyMailing : Handle click tracking**.

## Improve your server configuration...

### Spread your send process

Sending 10 000 e-mails in few minutes is not a good idea at all and even if your server is configured properly and your e-mail has a low spam score, you will still be considered as a spammer.

You should spread your send process if you have many e-mails to deliver (for example, send 300 e-mails every 15 minutes).

[Configure your send process](/old/main-pages/configuration/configuration-tabs/configure-your-send-process).

### Make sure your server is not blacklisted

If your server is blacklisted, your e-mail will be considered as a spam e-mail.\
You can make sure your server is not blacklisted on this website : <http://www.mxtoolbox.com/blacklists.aspx>

If you're server is blacklisted, you have two possibilities :

> * Fix it! (usually it's a problem of reverse DNS)
> * Use an external SMTP Server so your e-mails are not sent from your own server any more.

### Make sure your reverse DNS is configured properly

#### What's the reverse DNS?

The DNS enables to locate your server using a domain name : **Domain name -> Server IP**\
A reverse DNS is the opposite. Using your server IP, the reverse DNS should return your domain name : **Server IP -> Domain name**

If both entries match each other, we call it **FCrDNS** ( **forward-confirmed reverse DNS** or **full-circle reverse DNS** ).

Some spam filters check that both entries match and if not, your spam score will be increased.

#### Where should I configure my reverse DNS?

This should be done on your own server, it's not related to AcyMailing.\
Please contact your provider for more information.

#### How can I test my reverse DNS?

You can enter your website IP at <http://www.dnswatch.info/> . Your domain name should appear.\
(You can use the command line *nslookup* too)

For example, if we ping acyba.com, we get the Server IP 188.165.48.68.\
The reverse DNS of 188.165.48.68 returns acyba.com so everything is configured properly.

### Configure your SPF and Sender ID records

* [What's the SPF (Sender Policy Framework)](http://www.openspf.org/Introduction) ?\
  Basically it's a verification on the bounce e-mail address used... It will extract the domain name attached to your bounce e-mail address and make sure that the IP used to deliver the message is allowed to do so by your domain.
* To configure your SPF, you should generate your SPF record with the help of the [openspf](http://www.openspf.org/) website and then include this record at the end of your DNS BIND.
* You can then [test your SPF and Sender ID via the Spam checker](/old/main-pages/newsletters/spam-test) but you can also [check your SPF record here](http://www.kitterman.com/spf/validate.html).
* The sender-id is the exact same thing except it's done on the from e-mail address used and not the bounce e-mail address.

## Improve your message structure...

### Configure your sender information properly

We recommend you to make sure the sender e-mail belongs to the same domain as your bounce back e-mail address.\
They can be different but they should belong to the same domain name.

On Acyba.com, we use the sender : **This email address is being protected from spambots. You need JavaScript enabled to view it.** and the bounce back e-mail address : **This email address is being protected from spambots. You need JavaScript enabled to view it.**\
That way we can handle the bounces on an independent mailbox and not increase our spam score.

Do never remove your default reply-to address!!\
Even if you don't want reply from your customers, specify something like **This email address is being protected from spambots. You need JavaScript enabled to view it.** but don't remove it otherwise you will be flagged as a spammer.

## Test your spam score

All our paid versions include a spam filter test so you can easily [test your Newsletters](/old/main-pages/newsletters/spam-test).

You can also test your Newsletter via [http://www.mail-tester.com](http://www.mail-tester.com/) or using this free service:

Send a test of your Newsletter to: This email address is being protected from spambots. You need JavaScript enabled to view it. and you will get a message (sent to the e-mail address you specified as "reply to address") including the spam report of your Newsletter:

![](/files/-MJSXGCP-0ZKbkytRSAA)

> * **SPF check**: Is your SPF valid? We highly recommend you to make sure it is! This verification is done on the domain name used in your bounced back e-mail address.
> * **DomainKeys check**: this verification is basically the old version of DKIM. Acy does not add DomainKeys on your message, you should see "neutral" here which means there is no positive or negative effect. Your hosting company may validate it... but it's definitely not mandatory.
> * **DKIM check**: All commercial versions of AcyMailing enables you to sign your message with DKIM. Your hosting company may also enable you to automatically sign all messages sent with DKIM.
> * **Sender-ID**: Is your sender-id valid? We highly recommend you to make sure it is! This verification is done on the domain name used in your from e-mail address.
> * ***SpamAssassin check: ham*** means that your e-mail should not be considered as a spam by SpamAssassin but please also make sure that your SpamAssassin score is as low as possibl&#x65;*,* your SpamAssassin score should even be negative!
>   * The first line indicates your spam score: ***Result: ham (-4.6 points, 5.0 required)***\
>     It means our score is -4.6 so the message is not considered as spam as it requires at least 5.0 to be considered as spam.
>   * Bayes spam probability should not be superior to 20%

![](/files/-MJSXI7bZ99ralNP_Nmd)


# Compatibility issues

## Joomla Messaging System <a href="#joomla-messaging-system" id="joomla-messaging-system"></a>

AcyMailing uses the core Joomla messaging system to display messages on your website so if you don't see any message when you subscribe a user, that's probably because your Joomla template does not contain the tag to display Joomla messages: **\<jdoc:include type="message" />**

Please edit the index.php file from your template and make sure the tag \<jdoc:include type="message" /> is added to it. If not, please add it immediately before the tag \<jdoc:include type="component" />

This tag should already be present in all templates.

## Bootstrap <a href="#bootstrap" id="bootstrap"></a>

By default the Boostrap CSS file applies a style to all elements with .modal class. Unfortunately the default Joomla modal system uses that class as well (for links only). Due to this conflict, you may see some floating elements in the middle of your page... You can apply one of these two solutions: 1/ (the best one) Edit the boostrap css file including in your Joomla template and replace .modal{ by div.modal{ so this style will only be applied to div elements. 2/ (the easiest one) Edit the AcyMailing CSS component file via the AcyMailing back-end and add this code at the end of the file:

```
/*Avoid bootstrap issue with .modal*/a.modal{position:static !important;margin:0 !important;width:auto !important;display:inline !important}
```

## AcyMailing plugin: trigger Joomla content plugins <a href="#acymailing-plugin-trigger-joomla-content-plugins" id="acymailing-plugin-trigger-joomla-content-plugins"></a>

Our AcyMailing plugin called "trigger Joomla content plugins" will trigger all other plugins created which are supposed to have actions on your Joomla articles.

Most of them will work just perfectly and so you can use their features in your Newsletter content as well.

But they have not been developed to be triggered from the back-end or for a Newsletter... so some of them will just break your Newsletter and that's why our plugin is not enabled by default.

No problem, just unpublish it if you have some issue and you will be fine!

Here is an example of the preview screen broken by a Joomla content plugin (not sure which one...):

![](/files/-MJSWpBh5i4ZAszh9cmR)

Preview issue

&#x20;Another example with the "Droppics - content" plugin: in the preview screen of the newsletter, the radio buttons will not work and the popup windows will stay empty.

## 1064: SQL error when clicking on the readmore or article link <a href="#id-1064-sql-error-when-clicking-on-the-readmore-or-article-link" id="id-1064-sql-error-when-clicking-on-the-readmore-or-article-link"></a>

This error generally occurs when your Front-end template or a system module/plugin does not handle non-SEF URLs...

The error message is generally "1064 - You have an error in your SQL syntax: check......near ':ARTICLE\_ALIAS' at line 1...."

* You may remove the article and category's aliases from the link and try to access it again to make sure it is your template (...com\_content\&view=article\&id=52&#x34;**:article-alias**\&catid=22&#x38;**:category-alias**...).
* If no error appears when accessing the link without the aliases, that means it is your Front-end template or a system module/plugin, if you can, temporary change your template to see if you still get the issue.
* If the issue disappears when changing your template contact your template's creator and tell him that it does not handle non-SEF URLs as the "id" parameter is not only a number, he will fix it and provide you with a new version
* If the issue appears regardless the used template, you should try to disable one by one your Front modules / system plugins to locate the one responsible of this issue.
* If you can't find what element is causing this issue, post a new topic on [our forum](https://forum.acymailing.com/) and sum up the tests you made so far

## The form could not be submitted ReferenceError: submitacymailingform is not defined <a href="#the-form-could-not-be-submitted-referenceerror-submitacymailingform-is-not-defined" id="the-form-could-not-be-submitted-referenceerror-submitacymailingform-is-not-defined"></a>

This option may occur when you submit the AcyMailing subscription form if the AcyMailing javascript file can't be loaded...

* Please make sure the file <http://yourwebsite.com/media/com\\_acymailing/js/acymailing\\_module.js> can be loaded via your browser... if not, you should make sure your server allows this file to be loaded.
* If you included the AcyMailing subscription module inside an article or another part of your website using the "Modules Anywhere" plugin, please access the AcyMailing module configuration and set the option **Include JS files** to **On the module itself** (this option is within the "advanced" tab)
* The fwSiteOptimizer plugin could apparently cause this issue, you may want to unpublish this plugin.

The anticopy plugin (version 1.8.1 or previous versions) will prevent popup from being displayed properly. The popup will appear for a few second and then will be displayed as a new full windows.

## TinyMCE 3.2.4 <a href="#tinymce-3-2-4" id="tinymce-3-2-4"></a>

With an old version of TinyMCE, the editor may not be loaded when you edit your Newsletter.

You can either change the editor you use via the AcyMailing configuration page (tab "interface") or update TinyMCE to the latest version (by updating Joomla for example).

## JoomFish 2.1.5 -> 2.1.7: 500 - No valid database connection <a href="#joomfish-2-1-5-greater-than-2-1-7-500-no-valid-database-connection" id="joomfish-2-1-5-greater-than-2-1-7-500-no-valid-database-connection"></a>

There is a bug in a recent JoomFish release (in 2.1.5 and 2.1.6) which breaks the nested queries and causes this kind of error message:

![](/files/-MJSWrcxUFI6MqcV6RSN)

JoomFish issue no valid database connection

This bug does not only concern AcyMailing but many other components and the JoomFish forum already wrote a workaround (use mysqli instead of mysql in "Site -> Global Configurations -> Server") but a real fix has been submitted on their forum and implemented in JoomFish 2.1.7, **the solution is to update JoomFish**.

## GuardXT : Warning: include\_once(.../administrator/components/com\_acymailing/helpers/mailer.php) \[function.include-once]: failed to open stream: No such file or directory <a href="#guardxt-warning-include_once-administrator-components-com_acymailing-helpers-mailer-php-function-inc" id="guardxt-warning-include_once-administrator-components-com_acymailing-helpers-mailer-php-function-inc"></a>

GuardXT may rename the mailer.php file into mailer.php\_guardxt which will break AcyMailing.

You should connect via FTP to your website and rename the file administrator/components/com\_acymailing/helpers/mailer.php\_guardxt into mailer.php

## The online version is not displayed properly on your website <a href="#the-online-version-is-not-displayed-properly-on-your-website" id="the-online-version-is-not-displayed-properly-on-your-website"></a>

AcyMailing includes the online version of your Newsletter in an iframe and set automatically its height to make the iframe' structure invisible. This process may not work properly if you did mistakes in your Newsletter such as:

* You included a style="position:absolute" on one of your elements within the Newsletter
* You included a style="height:100%" on one of your elements within the Newsletter

## Front-end edition : the Yes/No buttons and the tabulation system are not working <a href="#front-end-edition-the-yes-no-buttons-and-the-tabulation-system-are-not-working" id="front-end-edition-the-yes-no-buttons-and-the-tabulation-system-are-not-working"></a>

We use the standard Joomla tabulation system, if it's not displayed properly on your website on the front-end, please make sure your Joomla template defines it, the default CSS is:

```
.nav-tabs:before,.nav-tabs:after {    display: table;    content: "";    line-height: 0;}.nav-tabs:after {    clear: both;}.nav-tabs > li {    float: left;}.nav-tabs > li:before {    content: none !important;}.nav-tabs > li > a {    padding-right: 12px;    padding-left: 12px;    margin-right: 2px;    line-height: 14px;}.nav-tabs {    border-bottom: 1px solid #ddd;}.nav-tabs > li {    margin-bottom: -1px;}.nav-tabs > li > a {    padding-top: 8px;    padding-bottom: 8px;    line-height: 18px;    border: 1px solid transparent;    -webkit-border-radius: 4px 4px 0 0;    -moz-border-radius: 4px 4px 0 0;    border-radius: 4px 4px 0 0;}.nav-tabs > li > a:hover,.nav-tabs > li > a:focus {    border-color: #eee #eee #ddd;}.nav-tabs > .active > a,.nav-tabs > .active > a:hover,.nav-tabs > .active > a:focus {    color: #555;    background-color: #fff;    border: 1px solid #ddd;    border-bottom-color: transparent;    cursor: default;}.tab-content > .tab-pane{    display: none;}.tab-content > .active {    display: block;}
```

If the Yes/No buttons are not working properly, please make sure your Joomla template defines the style applied to the bootstrap buttons, the default one is:

```
/* CSS for pretty radio buttons (bootstrap) */.btn-group {    position: relative;    display: inline-block;    *display: inline;    *zoom: 1;    font-size: 0;    vertical-align: middle;    white-space: nowrap;    *margin-left: .3em;}.btn-group:first-child {    *margin-left: 0;}.btn-group + .btn-group {    margin-left: 5px;}.btn-group > .btn {    position: relative;    -webkit-border-radius: 0;    -moz-border-radius: 0;    border-radius: 0;}.btn-group > .btn + .btn {    margin-left: -1px;}.btn-group > .btn,.btn-group > .dropdown-menu,.btn-group > .popover {    font-size: 13px;}.btn-group > .btn:first-child {    margin-left: 0;    -webkit-border-top-left-radius: 4px;    -moz-border-radius-topleft: 4px;    border-top-left-radius: 4px;    -webkit-border-bottom-left-radius: 4px;    -moz-border-radius-bottomleft: 4px;    border-bottom-left-radius: 4px;}.btn-group > .btn:last-child,.btn-group > .dropdown-toggle {    -webkit-border-top-right-radius: 4px;    -moz-border-radius-topright: 4px;    border-top-right-radius: 4px;    -webkit-border-bottom-right-radius: 4px;    -moz-border-radius-bottomright: 4px;    border-bottom-right-radius: 4px;}.btn-group > .btn:hover,.btn-group > .btn:focus,.btn-group > .btn:active,.btn-group > .btn.active {    z-index: 2;}.btn {    display: inline-block;    *display: inline;    *zoom: 1;    padding: 4px 12px;    margin-bottom: 0;    font-size: 13px;    line-height: 18px;    text-align: center;    vertical-align: middle;    cursor: pointer;    color: #333;    text-shadow: 0 1px 1px rgba(255,255,255,0.75);    background-color: #f5f5f5;    background-image: -moz-linear-gradient(top,#fff,#e6e6e6);    background-image: -webkit-gradient(linear,0 0,0 100%,from(#fff),to(#e6e6e6));    background-image: -webkit-linear-gradient(top,#fff,#e6e6e6);    background-image: -o-linear-gradient(top,#fff,#e6e6e6);    background-image: linear-gradient(to bottom,#fff,#e6e6e6);    background-repeat: repeat-x;    filter: progid:DXImageTransform.Microsoft.gradient(startColorstr='#ffffffff', endColorstr='#ffe5e5e5', GradientType=0);    border-color: #e6e6e6 #e6e6e6 #bfbfbf;    *background-color: #e6e6e6;    filter: progid:DXImageTransform.Microsoft.gradient(enabled = false);    border: 1px solid #bbb;    *border: 0;    border-bottom-color: #a2a2a2;    -webkit-border-radius: 4px;    -moz-border-radius: 4px;    border-radius: 4px;    *margin-left: .3em;    -webkit-box-shadow: inset 0 1px 0 rgba(255,255,255,.2), 0 1px 2px rgba(0,0,0,.05);    -moz-box-shadow: inset 0 1px 0 rgba(255,255,255,.2), 0 1px 2px rgba(0,0,0,.05);    box-shadow: inset 0 1px 0 rgba(255,255,255,.2), 0 1px 2px rgba(0,0,0,.05);}.btn:hover,.btn:focus,.btn:active,.btn.active,.btn.disabled,.btn[disabled] {    color: #333;    background-color: #e6e6e6;    *background-color: #d9d9d9;}.btn:active,.btn.active {    background-color: #cccccc \9;}.btn:first-child {    *margin-left: 0;}.btn:hover,.btn:focus {    color: #333;    text-decoration: none;    background-position: 0 -15px;    -webkit-transition: background-position .1s linear;    -moz-transition: background-position .1s linear;    -o-transition: background-position .1s linear;    transition: background-position .1s linear;}.btn:focus {    outline: thin dotted #333;    outline: 5px auto -webkit-focus-ring-color;    outline-offset: -2px;}.btn.active,.btn:active {    background-image: none;    outline: 0;    -webkit-box-shadow: inset 0 2px 4px rgba(0,0,0,.15), 0 1px 2px rgba(0,0,0,.05);    -moz-box-shadow: inset 0 2px 4px rgba(0,0,0,.15), 0 1px 2px rgba(0,0,0,.05);    box-shadow: inset 0 2px 4px rgba(0,0,0,.15), 0 1px 2px rgba(0,0,0,.05);}.btn-primary.active,.btn-warning.active,.btn-danger.active,.btn-success.active,.btn-info.active,.btn-inverse.active {    color: rgba(255,255,255,0.75);}.btn-success {    color: #fff;    text-shadow: 0 -1px 0 rgba(0,0,0,0.25);    background-color: #5bb75b;    background-image: -moz-linear-gradient(top,#62c462,#51a351);    background-image: -webkit-gradient(linear,0 0,0 100%,from(#62c462),to(#51a351));    background-image: -webkit-linear-gradient(top,#62c462,#51a351);    background-image: -o-linear-gradient(top,#62c462,#51a351);    background-image: linear-gradient(to bottom,#62c462,#51a351);    background-repeat: repeat-x;    filter: progid:DXImageTransform.Microsoft.gradient(startColorstr='#ff62c462', endColorstr='#ff51a351', GradientType=0);    border-color: #51a351 #51a351 #387038;    *background-color: #51a351;    filter: progid:DXImageTransform.Microsoft.gradient(enabled = false);}.btn-success:hover,.btn-success:focus,.btn-success:active,.btn-success.active,.btn-success.disabled,.btn-success[disabled] {    color: #fff;    background-color: #51a351;    *background-color: #499249;}.btn-danger {    color: #fff;    text-shadow: 0 -1px 0 rgba(0,0,0,0.25);    background-color: #da4f49;    background-image: -moz-linear-gradient(top,#ee5f5b,#bd362f);    background-image: -webkit-gradient(linear,0 0,0 100%,from(#ee5f5b),to(#bd362f));    background-image: -webkit-linear-gradient(top,#ee5f5b,#bd362f);    background-image: -o-linear-gradient(top,#ee5f5b,#bd362f);    background-image: linear-gradient(to bottom,#ee5f5b,#bd362f);    background-repeat: repeat-x;    filter: progid:DXImageTransform.Microsoft.gradient(startColorstr='#ffee5f5b', endColorstr='#ffbd362f', GradientType=0);    border-color: #bd362f #bd362f #802420;    *background-color: #bd362f;    filter: progid:DXImageTransform.Microsoft.gradient(enabled = false);}.btn-danger:hover,.btn-danger:focus,.btn-danger:active,.btn-danger.active,.btn-danger.disabled,.btn-danger[disabled] {    color: #fff;    background-color: #bd362f;    *background-color: #a9302a;}.btn-danger:active,.btn-danger.active {    background-color: #942a25 \9;}.btn-success:active,.btn-success.active {    background-color: #408140 \9;}.radio.btn-group input[type=radio] {    display: none;}.radio.btn-group > label:first-of-type {    margin-left: 0;    -webkit-border-bottom-left-radius: 4px;    border-bottom-left-radius: 4px;    -webkit-border-top-left-radius: 4px;    border-top-left-radius: 4px;    -moz-border-radius-bottomleft: 4px;    -moz-border-radius-topleft: 4px;}fieldset.radio.btn-group {    padding-left: 0;}
```

## Clean the AcyMailing tables <a href="#clean-the-acymailing-tables" id="clean-the-acymailing-tables"></a>

If you deleted some users directly via your database, you may have some lost entries on the AcyMailing tables and one effect is that it won't display the same number of subscribers on the list listing and on the user listing.

Please access the AcyMailing configuration page, tab "security" and click on the button "Check database integrity". AcyMailing will perform a few tests and clean these "lost entries".

## Allow POST data redirection in htaccess file <a href="#allow-post-data-redirection-in-htaccess-file" id="allow-post-data-redirection-in-htaccess-file"></a>

If you have modified your .htaccess file and some form validations don't work any more, you should modify your rules to replace \[L] flags by \[P] flags.

If the tags inserted in the newsletter are modified and an asterisk is added inside such as this: {\* subtag:...} It means that a plugin from another component is modifying the content of your page.

You should first try to disable the plugin "AcyMailing : trigger Joomla Content plugins". If it doesn't solve the issue, you should search which plugin is responsible for this.

Currently the plugins that have been found linked to this were "User - EasyBlog Users" or "System - JSN Power admin" or plugins from the following component: Mossets tree, No Number or an old version of Simple Image Gallery. We were not able to identify the right plugin for now\... we're working on it to make sure this issue gets solved asap!

## Unable to get the Squeeze page plugin work <a href="#unable-to-get-the-squeeze-page-plugin-work" id="unable-to-get-the-squeeze-page-plugin-work"></a>

If the squeeze box does not show up, that could come from the fact that the JavaScript isn't loaded. Please make sure you don't have the plugin "YT Framework" installed on your site, this plugin prevents Joomla from inserting the scripts (so ours too).

If you have this plugin, but need it for your Front-end template, please contact the YT Framework plugin's creator and ask him to fix the triggered function in this plugin.

## JCE editor styling issue <a href="#jce-editor-styling-issue" id="jce-editor-styling-issue"></a>

If you use the JCE editor and it doesn't display the styles you created in the template edition, then you should go in the global configuration in the JCE administration and change the parameter "Compress CSS" to No.

## My "Send", "Schedule", "ABTesting" and "Spam-test" buttons are not working <a href="#my-send-schedule-abtesting-and-spam-test-buttons-are-not-working" id="my-send-schedule-abtesting-and-spam-test-buttons-are-not-working"></a>

If when you click on these buttons and no popup is displayed, it could come from an issue when you updated Joomla to Joomla 3.4.1.

You should make sure the folder layouts / joomla / modal / is in your site's files, and if not, download the latest version of Joomla and copy this folder to your site.

## Module not working when using the System - NoNumber modals plugin <a href="#module-not-working-when-using-the-system-nonumber-modals-plugin" id="module-not-working-when-using-the-system-nonumber-modals-plugin"></a>

If when you click on the module's button, an empty popup is displayed (or with only the text "Subscribe"), you can try to turn OFF the "ClassNames - Auto-Convert"option in the plugin's configuration and make sure you selected "Popup mode" in the module's configuration.

## Birthday field always displayed in English <a href="#birthday-field-always-displayed-in-english" id="birthday-field-always-displayed-in-english"></a>

Some of our users noticed that the Joomla component Form Maker made the birthday field always display the month names in English. If you have this issue, update the Form Maker component.

## Question marks ( ? ) appear when saving the newsletter <a href="#question-marks-appear-when-saving-the-newsletter" id="question-marks-appear-when-saving-the-newsletter"></a>

Using the Acyeditor, it can happen that some question marks appear on new lines when saving the newsletter. This is linked to a server configuration that do not have the right charset when loading JavaScript files.

The solution is either to change the configuration of your server to set UTF-8 as the default charset or to add a rule in your htaccess file so it will handle it. The rule for the htaccess would be:

## The JCE editor isn't completely shown (only the preview is displayed) <a href="#the-jce-editor-isnt-completely-shown-only-the-preview-is-displayed" id="the-jce-editor-isnt-completely-shown-only-the-preview-is-displayed"></a>

The solution is to disable the RocketLoader on your Cloudflare account for the site experiencing the issue.


# Install / Update issues

## Access Rights

AcyMailing installs files in the following folders. Please first make sure those folders are writeable before trying to install AcyMailing :

* Joomla / Administrator / Components
* Joomla / Components
* Joomla / Media
* Joomla / Modules
* Joomla / Plugins
* Joomla / Plugins / System
* Joomla / Language / en-GB
* Joomla / tmp

For the update process, please make sure the following folders are writeable:

* Joomla / Administrator / Components / com\_acymailing
* Joomla / Components / com\_acymailing
* Joomla / Media / com\_acymailing
* Joomla / Modules / mod\_acymailing
* Joomla / Plugins / acymailing
* Joomla / Plugins / System
* Joomla / Language / en-GB
* Joomla / tmp

If you have errors regarding the copy of files, it's likely to be because of access right issues. You should look at these documentation pages of Joomla:

## Install via FTP

If you have difficulties to install AcyMailing, you may want to try to install it via FTP.\
This way, Joomla won't have to upload the AcyMailing package on your website so the installation will be much faster.

* Extract your AcyMailing package in a folder called "acymailing" on your own computer.

![](/files/-MJkuoLAhUGHxOy6zkxW)

* Open your FTP software (FileZilla for example), connect to your website and upload the folder "acymailing" in the temporary folder of your website : /tmp/

![](/files/-MJkurkwoNxm29o-9-PN)

* Go to your Joomla Installer manager on your website backend and specify the path of your folder in the input "**Install from Directory**" : "\home\\...\tmp\acymailing".

![](/files/-MJkuvCuDBgf1A1pUdzK)

* Click on the button "Install"... the install process should be much faster and will enable you to successfully install AcyMailing.

## Blank page

A blank page does not help us to determine what could be the problem so if you get a blank page (an entire white screen without anything written on it), please make sure that your PHP configuration enables you to see errors and if not, edit your php.ini file and search for the string parameter **display\_errors**.\
This parameter should be turned On : **display\_errors = On**.\
If it's not the case, please edit your php.ini file, modify this line, save your file and then restart your server and try again to install AcyMailing.\
You should not see a blank screen any more and the error message will help us a lot to fix the problem.

You don't have access to your php.ini file?\
Please add this code at the top of your index.php file (front-end or back-end... depending on where you have the blank page) on your website:

Show/Hide php cod

```
 error_reporting(E_ALL);
 ini_set("display_errors", 1); ?>
```

You can also turn ON the Joomla debug mode (Site -> Global Configuration -> System -> Debug System : Yes), it may display an error.

If you can not see any error, please try to install AcyMailing via FTP, it solves more than half of the installation issues.

## -1 - an error has occurred ( It was not possible to copy the selected file. )

![](/files/-MJkuyghRaeIJCOHbrIO)

This error message is displayed when Joomla can not copy a folder from the temp folder to the destination folder.

It's usually because of access rights and you should make sure the AcyMailing folders are writeable (see above).

If it does not solve the issue, please edit the file libraries/joomla/filesystem/folder.php

Around line 93 AND 122, please replace:

Show/Hide php cod

```
return JError::raiseError(-1, JText::_('Copy failed'));
```

by

Show/Hide php cod

```
return JError::raiseError(-1, JText::_('Copy failed').'  '.$sfid.' => '.$dfid);
```

It won't solve the problem but at least if you try to install again AcyMailing, you will see a much better error message telling you what folder is not writeable.\
That way you can move forward by fixing the permission issue on that folder and install again AcyMailing.

This kind of error can be automatically solved by enabling the FTP layer on the Joomla configuration page (or turning it OFF if it was enabled).

## An error has occurred ( Copy failed )

![](/files/-MJkv0zapthLfjB3wDw-)

Same error as above... And to check what's the issue, please edit the file libraries/joomla/filesystem/folder.php

Around line 98 AND 137, please replace:

Show/Hide php cod

```
return JError::raiseError(-1, JText::_('JLIB_FILESYSTEM_ERROR_COPY_FAILED'));
```

by

Show/Hide php cod

```
return JError::raiseError(-1, JText::_('JLIB_FILESYSTEM_ERROR_COPY_FAILED').'  '.$sfid.' => '.$dfid);
```

Then try to install again AcyMailing, you will see a more explicit error message and you can then change the access rights on the destination folder.

## -1 - copy file failed

On J3, you may have the error "copy file failed" when you install an extension.\
Some folders may not have the right access level.\
To know exactly which one, edit the file libraries/joomla/filesystem/folder.php\
Around line 150 AND 104 you will see:

Show/Hide php cod

```
throw new RuntimeException('Copy file failed', -1);
```

Please replace it by:

Show/Hide php cod

```
throw new RuntimeException('Copy file failed from '.$sfid.' to '.$dfid, -1);
```

That won't fix the issue but at least you will know exactly what file is causing the issue and you can then check the access level.

## -1 - cannot create destination folder

On J3, you may have the error "cannot create destination folder" when you install an extension.\
Some folders may not have the right access level.\
To know exactly which one, edit the file libraries / joomla / filesystem / folder.php\
Around line 65 you will see:

Show/Hide php cod

```
throw new RuntimeException('Cannot create destination folder', -1);
```

Please replace it by:

Show/Hide php cod

```
throw new RuntimeException('Cannot create destination folder: '.$dest, -1);
```

That won't fix the issue but at least you will know exactly what folder is causing the issue and you can then check the access level of its parent folder.

## Unable to create the target folder

This error occurs if Joomla can not create a folder.

Please edit the file libraries/joomla/filesystem/folder.php\
Around line 61 you should see:

Show/Hide php cod

```
return JError::raiseError(-1, JText::_('JLIB_FILESYSTEM_ERROR_FOLDER_CREATE'));
```

that you should replace by:

Show/Hide php cod

```
return JError::raiseError(-1, JText::_('JLIB_FILESYSTEM_ERROR_FOLDER_CREATE').' : '.$dest);
```

So next time you try to install Acy, you will get a better error message and you should check why the folder could not be created (usually an access right issue)

JFolder::create: Could not create directory\
Unable to create destination\
Unable to find install package
------------------------------

![](/files/-MJkv7eYtZPIk89qRBN_)

This error can occur if Joomla is not able to copy your package from your computer to your server.

It can be because you don't have enough rights on your tmp folder or because your tmp folder is not the right one.

Please edit the file libraries/joomla/filesystem/folder.php and around line 234 replace:

Show/Hide php cod

```
if (!$ret = @mkdir($path, $mode)) {
 @umask($origmask);
JError::raiseWarning(
 'SOME_ERROR_CODE',
 'JFolder::create: ' . JText::_('Could not create directory'),
 'Path: ' . $path
 );
return false;
 }
```

by:

Show/Hide php cod

```
if (!$ret = mkdir($path, $mode)) {
 umask($origmask);
 JError::raiseWarning(
 'SOME_ERROR_CODE',
 'JFolder::create: ' . JText::_('Could not create directory').' Path: ' . $path.' Your website is installed on: '.JPATH_SITE
 );
 return false;
 }
```

So unfortunately it won't fix the problem but if you reinstall AcyMailing, you will get a much better error message.

## JFolder::create: Path not in open\_basedir paths - Unable to create destination

![](/files/-MJkvBPb5qmollo7vk5c)

This issue usually happens when the "path to temp folder" specified in your Joomla configuration page is not the right one...

This path should be the absolute path to your tmp folder, it should not be an "http\://" link.

You can install AcyMailing via FTP, that will avoid that issue but you can also make sure your path is the right one.

If you don't know the path you should use, you can try with /tmp which will do the job most of the time.

Please enter a package directory\
Unable to find install package
------------------------------

![](/files/-MJkvG5ejQziTGWtgwqK)

This error can happen if you didn't enter a directory (or didn't enter the right one) if you try to install via the FTP method.

Modify the file administrator\components\com\_installer\models\install.php

Around line 177 you should see:

Show/Hide php cod

```
if (!is_dir($p_dir)) {
 JError::raiseWarning('SOME_ERROR_CODE', JText::_('Please enter a package directory'));
 return false;
 }
```

Replace it by:

Show/Hide php cod

```
if (!is_dir($p_dir)) {
 JError::raiseWarning('SOME_ERROR_CODE', JText::_('Please enter a package directory').' | Example : '.JPATH_SITE.DS.'tmp');
 return false;
 }
```

Try to install again... you will get a better error message with the path you should normally use if you install via FTP.

This error may also occur on J2.5, you should edit the file administrator\components\com\_installer\models\install.php

Around line 203 you should see:

Show/Hide php cod

```
if (!is_dir($p_dir)) {
 JError::raiseWarning('', JText::_('COM_INSTALLER_MSG_INSTALL_PLEASE_ENTER_A_PACKAGE_DIRECTORY'));
 return false;
 }
```

Which should be replaced by:

Show/Hide php cod

```
if (!is_dir($p_dir)) {
 JError::raiseWarning('', JText::_('COM_INSTALLER_MSG_INSTALL_PLEASE_ENTER_A_PACKAGE_DIRECTORY').' | Example : '.JPATH_SITE.DS.'tmp');
 return false;
 }
```

## Warning! Failed to move file.

![](/files/-MJkvLRPTqQutWpyuAqE)

Modify the file libraries\joomla\filesystem\file.php

Around line 348, you will see:

Show/Hide php cod

```
JError::raiseWarning(21, JText::_('WARNFS_ERR02'));
```

Replace it by:

Show/Hide php cod

```
JError::raiseWarning(21, JText::_('WARNFS_ERR02').' FROM '.$src.' TO '.$dest);
```

Apply the exact same modification on line 358.

Then try to install again AcyMailing, you will still get an error message but at least you will know what folder is causing the issue so you can check the access right or make sure your tmp folder has the right path.

## Unable to write entry - JInstaller: :Install: Cannot find XML setup file

![](/files/-MJkvOiNHZL6aD6wqLGs)

This error occurs when the package could not be extracted and so the XML file is not found.

The easiest way to avoid that is to [install AcyMailing via FTP](/old/faq/install-update-issues#install-via-ftp).

## Component Install: DB function reports no errors

* JFTP: :delete: Bad response
* JFTP: :delete: Bad response
* Error installing component

![](/files/-MJkvRhyytJSuesU_Xfp)

This error is apparently due to the fact AcyMailing could not be installed properly and there are probably still some instances of AcyMailing on your Extensions Manager.

Please go on your Extensions Manager (click on the menu "Manage"), select AcyMailing (the component) and uninstall it.

Once uninstalled, please access your phpMyAdmin and execute this query (don't forget to replace #\_\_ by your own table prefix):

* DELETE FROM \`#\_\_menu\` WHERE link LIKE '%com\_acymailing%';
* DELETE FROM #\_\_extensions WHERE element = 'com\_acymailing';
* DELETE FROM #\_\_assets WHERE name='com\_acymailing';

Then install AcyMailing again... it should work.

## Error Building Admin Menus

![](/files/-MJkvUU4vGcEk4QO95RH)

AcyMailing will be installed properly but then you won't be able to access it via the components menu on your Joomla back-end.

To fix that, you should uninstall AcyMailing via the Joomla Extensions manager.

Once uninstalled, please access your phpMyAdmin and execute this query (don't forget to replace #\_\_ by your own table prefix):

* DELETE FROM \`#\_\_menu\` WHERE link LIKE '%com\_acymailing%';
* DELETE FROM #\_\_extensions WHERE element = 'com\_acymailing';
* DELETE FROM #\_\_assets WHERE name='com\_acymailing';

Then install AcyMailing again... it should work and you will new see AcyMailing under your component menu.

## JTableMenu::\_getNode Failed

![](/files/-MJkvXsA9_RSd97ljhOA)

AcyMailing will be installed properly but you won't see the admin components menu.

This issue occurs when your menu ID 1 is not in your database any more (for an unknown reason...)

You have to create it back by executing this query on your phpMyAdmin:

```
INSERT INTO `#__menu` (`id` ,`menutype` ,`title` ,`alias` ,`note` ,`path` ,`link` ,`type` ,`published` ,`parent_id` ,`level` ,`component_id` ,`ordering` ,`checked_out` ,`checked_out_time` ,`browserNav` ,`access` ,`img` ,`template_style_id` ,`params` ,`lft` ,`rgt` ,`home` ,`language` ,`client_id` ) VALUES ( '1', '', 'Menu_Item_Root', 'root', '', '', '', '', '1', '0', '0', '0', '0', '0', '0000-00-00 00:00:00', '0', '0', '', '0', '', '0', '0', '0', '*', '0')
```

Then reinstall AcyMailing.

This solution has been found thanks to [this post on the Joomla forum](http://forum.joomla.org/viewtopic.php?t=632543) from Lieven Borms.

## An error has occurred. 404 component not found

![](/files/-MJkvfyhCawFMYcvKzTS)

If after installing AcyMailing you have this "404 component not found" error message, you should first try to clear your cache.

If this is not enough, then it's probably because the extension is not enabled on the Joomla Extensions Manager...\
Access the Joomla Extensions Manager and click on the "Manage" link on the left menu to check the AcyMailing component and make sure the Status is enabled.\
If you see several instances of the AcyMailing Component there, you may want to uninstall all of them, delete the components/com\_acymailing and administrator/components/com\_acymailing folders and then reinstall AcyMailing so you only have a single instance of the AcyMailing component.

![](/files/-MJkvadixAMnizgdR4ih)

## Frequently Asked Questions

### Why don't you improve the install process instead of providing documentation?

All the above issues occur while installing the Extension.

Joomla itself handles that part, not AcyMailing... So the only thing we can do is to provide you with a documentation to help you out.

The Joomla installer could be improved with the above suggestions (and it's improved quite often so don't forget to update your Joomla installation!)


# Installed with AcyMailing


# Insert Joomla articles in your newsletter

## Description <a href="#description" id="description"></a>

The plugin "Joomla content" enables you to include in your Newsletter one or several Joomla Articles.

You will be able to filter and search in your articles, select one or several articles at the same time and then insert them in your Newsletter.

A simple tag will be inserted and you will be able to see the result if you preview your Newsletter.

Once you inserted your tag, you can click on the button "Replace Tags" in order to replace the inserted tag by the corresponding article.

You can also use this plugin to include a series of articles based on some filters (the latest 5 created articles for example) in your Newsletter but also in your Smart-Newsletter.

## Plugin <a href="#plugin" id="plugin"></a>

When writing a Newsletter, click on the **Tags** button to access the AcyMailing tag system and being able to include any content in your Newsletter.

![](/files/-MJbnIxb0HBNPGQAOxex)

### Joomla Content <a href="#joomla-content" id="joomla-content"></a>

Click on one of your articles to select it, you can click again in order to deselect it or click on other articles to add them too.

Once you clicked on one article, you will see the "**insert the tag**" button on the top right of the window. Once you're done, simply click on this button in order to add the tag in your Newsletter editor.

![](/files/-MJbnMvh1ZJ81BqtD-q8)

Plugin Content

* **Display**
  * **Title only** will display the title
  * **Intro Only** will display the title + everything before the read more link
  * **Text** will display the title + everything after the read more link
  * **Full text** will display the title + the entire article
* **Format**: Select the way you want to display the article's main data (title, image and text)
* **Display pictures**: You can choose to display or not the pictures and resize them
* **Clickable title**: Should AcyMailing add a link to your article on its title?
* **Author's name**: display or not the author's name
* **Additional parameters** you can manually add in the tag:
  * **notitle** : the tag will be replaced without adding the title Example: {joomlacontent:151|type:intro|notitle} will be replaced by the introduction of the content ID 151 without the title
  * **noreadmore** : this parameter will force AcyMailing to not add any read more link Example: {joomlacontent:151|type:intro|link|noreadmore} will be replaced by the introduction of the content ID 151 but without read more link
  * **wrap** : If you insert the introduction only, AcyMailing will insert your content before the read-more link. Nevertheless if you want to limit it to the first XX characters anyway, you can specify in your tag the parameter "wrap" with the number of characters you want AcyMailing to insert. Example {joomlacontent:151|type:intro|wrap:200}
  * **readmore** : This parameter enables you to force AcyMailing to use another "read more" text instead of the default one. This parameter can be very useful if you have a multi-lingual website so you can make sure the read more link will be translated in the right language. Example: {joomlacontent:151|type:intro|readmore:Click here to read the full story!}
  * **created** : If you add this parameter to your tag, then the article created date will be displayed. Example: {joomlacontent:151|type:intro|created}
  * **modified** : If you add this parameter to your tag, then the article modified date will be displayed. Example: {joomlacontent:151|type:intro|modified}
  * **dateformat** : If you add the "created" parameter, you can use the "dateformat" parameter to specify the date format you want to use. Example {joomlacontent:151|type:intro|created|dateformat:%m %Y}
  * **itemid** : AcyMailing will automatically attach your read more link to a menu ID. You can nevertheless force AcyMailing to use the one you want if you specify one via the parameter itemid. Example: {joomlacontent:151|type:intro|itemid:22}
  * **autologin** : If you add this parameter, AcyMailing will add the username and encrypted password to the article link so if the user clicks on it, he will be automatically logged if you installed the AutoLogin plugin for Joomla.
  * **jtags** : If you add this hidden parameter, AcyMailing will display the article's tags if any (feature only available for Joomla 3.1.0+)
  * **nomainimage** : If added to a tag, AcyMailing won't display the main picture of the inserted articles Example: {joomlacontent:151| type:intro| nomainimage}

### Categories <a href="#categories" id="categories"></a>

You can include in your Newsletter several articles at the same time. This option can be used for a Newsletter but also for a Smart-Newsletter: select the sections/categories you want to include, then enter a minimum Number of Articles (when the Newsletter should be generated, if there is not enough articles based on the configuration you enter, the Newsletter won't be sent and it will wait until the next generated date) and click on the button **Insert the tag**.

![](/files/-MJbnPe5IVBRPMLT0FNB)

Content categories

* **Columns**: display the articles in one, two or more columns
* **Order by**: order the articles by ID, title, etc...
* **Max. Number of items** : You can choose the number of articles AcyMailing should load from this feed.
* **Min. Number of items** : This option will only be displayed if you access this plugin for a Smart-Newsletter. AcyMailing will only generate your Smart-Newsletter if the minimum number of items found is reached.
* **Filter**: This option will only be displayed if you access this plugin for a Smart-Newsletter. You can choose between "all", "only newly created" or "only newly created or modified".
* Additional parameters:
  * **start** : this parameter enables you to start the selection of articles after the first one. That way you can define different styles for your content. Example: {autocontent:cat27|max:5|order:ordering,ASC|type:intro} will display the first 5 articles from the category 27 {autocontent:cat27|max:8|start:5|order:ordering,ASC|type:intro} will display 8 articles from the category 27 but skip the first 5 articles.
  * **featured** : this parameter enables you to select featured articles (the articles selected to be displayed on the front-end) Using this additional argument, you can create a tag to add all your articles displayed on the front-page: Example: {autocontent:sec0|max:10|order:created,DESC|type:intro|featured} will display the intro of the first 10 articles displayed on your front-page.
  * **nofeatured** : this parameter will only select articles which are not set as "featured".
  * **excludedcats** : This parameter enables you to exclude some categories. Example: {autocontent:|excludedcats:10-23} will display all articles except the one attached to the categories 10 or 23.
  * **subcats** : If you add this parameter, AcyMailing will also automatically select articles added in the sub-categories of the categories you selected (this option does not work with J1.5).
  * **maxcreated** : You can specify a maximum creation date so only articles created before that date will be selected. Example: {autocontent:sec0|maxcreated:2012-02-15} will select only articles created before February, 15 2012
  * **mincreated** : The same way the maxcreated parameter works, you can specify a minimum creation date so only articles created after this date will be selected Example: {autocontent:sec0|mincreated:2012-01-22} will select only articles created after January, 22 2012
  * **access** : If you edit the plugin parameters, you will be able to configure the access level so only public or registered articles will be selected (this option is only available with J1.5). You can overwrite this parameter by entering the access parameter directly in your tag (that will work for all J! version). Enter directly the ID of your access level in the tag using the parameter. Example: {autocontent:sec0|access:1} will select only articles set with the access=1
  * **language** : This parameter enables you to select articles based on its language (this option does not work with J1.5). You can specify several languages if you separate them with a comma. Example: {autocontent:12,13|language:fr-FR} will select only articles from the categories 12 and 13 having the language field set at "fr-FR"
  * **cattitle** : This parameter enables you to add the category title for each group of articles. You should order your articles by category ID to group them by category: Example: {autocontent:12,13|cattitle|order:catid,ASC}
  * **unpublished** : This parameter allows you to insert only unpublished articles in your newsletter
  * catpict : If you use this parameter, AcyMailing will display the category's picture above each group of article. You can also use catmaxwidth and catmaxheight to set some style on this picture. For example: {autocontent:....| catpict| catmaxwidth:250| catmaxheight:200}

### Examples for a Smart-Newsletter <a href="#examples-for-a-smart-newsletter" id="examples-for-a-smart-newsletter"></a>

* If you want your automatic Newsletter to include the introduction text of all newly created articles since the last generated Newsletter :
  * Select the sections/categories you want to include
  * Select display : Intro Only
  * Enter a Minimum Number of Articles so that **if there is no new article, the Newsletter won't be generated**
  * Select the filter : "**Only Newly Created**"
* If you want your automatic Newsletter to always include the 5 latest created articles :
  * Select the sections/categories you want to include
  * Select the display mode
  * Enter a Minimum Number of Articles : 0 (so that the Newsletter will always be generated)
  * Enter a Maximum Number of Articles : 5 (so that AcyMailing will include up to 5 articles in the generated Newsletter)
  * Select the filter : "**All**"
* You can use AcyMailing as a notification system for new content so maximum 1 hour after your article is published on your website, your subscribers will receive a notification :
  * Select the sections/categories you want to include
  * Select the display mode
  * Enter a Minimum Number of Articles : 1 (so that if there is no new article, the Newsletter won't be generated)
  * Select the filter : "**Only Newly Created**"
  * Configure your Smart-Newsletter with the frequency "**every 1 hour**"

## Parameters <a href="#parameters" id="parameters"></a>

![](/files/-MJbnSOS0n5FU-x2e769)

content plugin

![](/files/-MJbnULyOOkwOZ22t362)

Plugin Content Params

* **Custom template** : Click on this button if you want to create a custom template for the plugin's output (you'll find an example at the end of this documentation)
* **Display articles**: This parameter enables you to filter the list of articles in the tag system
  * **All articles**: AcyMailing will display all your articles
  * **Only published articles**: AcyMailing will only display your published articles
* **Front-end** **Access** : Using AcyMailing Enterprise, you can restrict the access to this tag system on the front-end
  * **Display all articles** : all articles will be displayed on the front-end edition (default option)
  * **Display only author's articles** : only author's articles will be displayed on the front-end edition
  * **Don't display this tag system on the front-end** : this plugin won't be displayed on the front-end edition
* **Select articles by meta tags** : AcyMailing is able to filter your content based on the keywords. If you turn ON this option, you will see an additional filter on our tag system so your articles can be filtered by meta tags. Meta tags must be separated by a comma.
* **Act for another component** : By default, article links will be redirected to the Joomla content but you can choose AcyMailing uses other links used by other components.
* **Display** : The default value for the "Display" option in the tag popup
* **Intro Word Wrapping** : If you insert only the introduction, AcyMailing will insert all the text before the "read more" link. But if you didn't insert the read more link in your Joomla Content, AcyMailing will only load the first XX characters of your content. If you specify 0, AcyMailing won't wrap your content and load the entire article if you didn't add the "read more" link.
* **Clickable title** : Default value for this option in the tag popup
* **Author name** : Default value for this option in the tag popup
* **Display pictures** : Default value for this option in the tag popup
* **Max picture width** : If you select the resized option in your tag, AcyMailing will resize your pictures. You can specify the default maximum width displayed in the plugin.
* **Max picture height** : If you select the resized option in your tag, AcyMailing will resize your pictures. You can specify the default maximum height displayed in the plugin.

## Customize your article template <a href="#customize-your-article-template" id="customize-your-article-template"></a>

### Customize your article using some CSS <a href="#customize-your-article-using-some-css" id="customize-your-article-using-some-css"></a>

You can change the styles used for the content 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 article area** will be used to encompass your article
> * **Style for the article title** will be applied to your content 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 **Style of the links** field

![](/files/-MJbnWYZgcLhrYpdU1Ib)

Set styles template

So you can easily customize the look of your article and get something like:

![](/files/-MJbnYNEIlUmoMW9f9wq)

### Create your own template <a href="#create-your-own-template" id="create-your-own-template"></a>

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

Click on **the "Custom template" button** in the plugin's configuration page to create a new template, then enter the layout you want in the appearing popup. If you created a custom template, you will be able to select it with **the "Format" option** the next time you'll insert an article tag.

In this custom template, you can use PHP to access the element $article (which is the article object loaded from the content table) and the element $tag (which contains the information of the current tag used in your Newsletter). You can also access the article's content using this simple syntax: {title}, {introtext}, {link}, ... You can see what data you can access in the variable $varFields:

```
<?php
foreach($varFields as $key => $value){    
    echo '{ '.trim($key, '{}').' } => '.$value.'<br/>';
}
?>
```

You can display:

> * the title of your article: {title}
> * the intro of your article: {introtext}
> * the full content of your article: {fulltext}
> * the url of your article: {link}
> * the image of your article: {picthtml}
> * the formatted creation date: {createddate}
> * the formatted modification date: {modifieddate}

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

> By default AcyMailing uses something like this:

> ```
> <div class="acymailing_content">
>     <a href="{link}" name="content-{id}" target="_blank" >
>         <h2 class="acymailing_title">{title}</h2>
>     </a>
>     {picthtml}{introtext}<br/>
>     {fulltext}
> </div>
> ```


# Plugin : Statistics

## Description <a href="#description" id="description"></a>

This plugin enables you to add a picture in your Newsletter which will handle the statistics (who opened your e-mail, when...).

By default the plugin will add in all your e-mails a little blank picture but you can change the parameters to add your own picture instead of the useless blank one.

## Parameters <a href="#parameters" id="parameters"></a>

![](/files/-MJbng6uEjALh1jj9CdJ)

Stat params

* **Stat picture** : Relative path of the statistic picture on your website. By default it will be a small blank picture. Only PNG format will be accepted.
* **Alt text** : You can define the "alt text" you want, it will be applied to the statistics picture.
* **Stat picture width** : Width of the statistic picture. This width should be modified if you change the statistic picture by your own one.
* **Stat picture height** : Height of the statistic picture. This height should be modified if you change the statistic picture by your own one.
* **Display filter** : By default the statistics filter won't appear when you create a Newsletter. Why? So you don't re-send your Newsletter based on that filter by mistake! If you want to use it, you can turn ON this option.

## Change your statistic picture <a href="#change-your-statistic-picture" id="change-your-statistic-picture"></a>

By default a small invisible blank picture will be added at the end of your e-mail. Nevertheless, for any reason, you might want to change this picture and use your own one.

* Edit the statistics plugin and change the **stat picture** (please remember you can only use PNG images).
* Set the right width and height of your picture in the plugin
* Save the plugin

So now, AcyMailing will add your own picture in all html e-mails sent by AcyMailing.

You can send to yourself a test of your Newsletter to make sure this is done properly.

But you might also want to change the place where the picture is displayed in your Newsletter. For that, you can use the tag **{statpicture}** in your Newsletter and this tag will be replaced by the statistic picture (instead of being added at the end of the e-mail).

For example, on Acyba.com we specified our own picture (Acyba Services) so that when we create a Newsletter, the statistic picture is our own logo.

In some cases you will also want to remove your statistic picture for an important e-mail (that should reduce your spam score). If you want to do that on one specific e-mail without having to turn off the stat plugin, simply add the tag **{nostatpicture}** at the end of your Newsletter.

## Insert statistic charts in your newsletters <a href="#insert-statistic-charts-in-your-newsletters" id="insert-statistic-charts-in-your-newsletters"></a>

With this plugin, you can also insert statistic charts in your newsletters, to send statistic reports to a group of managers for example.

Note that the statistics take some time to be collected (all your users don't open your newsletter a minute after it is sent) so don't send the statistics just after sending the newsletter, you should wait at least 4 days!

![](/files/-MJbniFeJmdLVdkyTLYa)

Tag

* **Graphs**: Select the charts you want to insert in the newsletter
* **Tags**: You can filter the newsletters based on their tags with this option. If you enter two or more tags, it will take the newsletter having at least one of the selected tags.
* **Max. number of newsletters**: you can limit the number of newsletter reports with this option.
* **Order by**: Order the selected newsletters per ID, subject, send date or randomly.

Here is an example of what you could get:

![](/files/-MJbnk62814Yn1jONryO)

Tag

* **Sent**: It will show you the type of email (if you sent it in HTML or in plain text)
* **Status**: It will show you the status of all the sent emails (not opened / opened / bounced / unsubscribed / failed)
* **Devices**: It shows on what device your users opened the newsletter (on a computer or a mobile device) It will also display a chart showing the mobile devices
* **Browsers**: It shows with which browser the users that opened your newsletter used (only for those who opened on a computer)
* **Click Statistics**: A simple chart that shows how many users clicked on at least one link of your newsletter


# Plugin: (auto)Subscribe during Joomla registration

## Description <a href="#description" id="description"></a>

This plugin enables you to automatically synchronize your Joomla Users and your AcyMailing Users.

Using this plugin, the changes made on the Joomla User Profile will be incorporated into the AcyMailing User Profile. For example, if the user changes his e-mail address on his Joomla Profile, his e-mail address will be also changed on his AcyMailing Profile... but AcyMailing will NEVER modify the profile of your Joomla User, the synchronization is done only from Joomla to AcyMailing, not the other way.

This plugin also enables you to automatically subscribe a user to one or several mailing lists during his registration process. If you enable this plugin, users registered via Joomla, VirtueMart, JomSocial... will be automatically added in AcyMailing and subscribed to the selected lists.

This plugin will also enable you to display a list selection on your Joomla registration form so your users can select the lists they want to be subscribed to during the Joomla registration process.

For Community Builder users, please use our [Community Builder Plugin](/old/integration-plugins/user-management/plugin-community-builder) and unpublish this one.

## Moved options <a href="#moved-options" id="moved-options"></a>

### Auto-subscribe to one or more lists <a href="#auto-subscribe-to-one-or-more-lists" id="auto-subscribe-to-one-or-more-lists"></a>

In the AcyMailing configuration, tab "Subscription" you can select one or several lists to be subscribed automatically on AcyMailing user creation:

![](/files/-MJbo4m0iEWtptEkf3tp)

Auto-subscribe to a list

### Display fields on the form <a href="#display-fields-on-the-form" id="display-fields-on-the-form"></a>

&#x20;Since AcyMailing 4.5.0, you can choose what field you want to display on your Joomla registration forms in the custom fields management page:

![](/files/-MJbo74gYcYnHV2odyxZ)

## Parameters <a href="#parameters" id="parameters"></a>

You can edit the parameters of this plugin via the Joomla Plugin Manager or the AcyMailing Configuration page.

![](/files/-MJbo9-L_OwkUMKr0CmE)

registration parameters

![](/files/-MJboAiGxWHWxGzQUH3C)

params

* **Lists displayed on registration form** : You can also decide to display your list on the Joomla registration form so the user will be able to select or not the list during his registration. In that case, please don't add the same lists on the parameter "auto-subscribe to" otherwise the user will be subscribed to the list anyway.
* **Lists checked by default** : You can configure AcyMailing to check the lists displayed on your Joomla registration form or not...
* **Subscribe Caption** : This text will be displayed on your Joomla registration form (if you display some lists). By default the text "Subscribe :" will be displayed in the current language but you can customize it the way you want if needed.
* **Display mode:** You can choose here the way your lists will be displayed
* **Display the lists/fields after** : You can display your lists at the end of the Joomla registration form or just after the field "E-mail".
* **Display the lists/fields after** **(custom)**: You can specify an other field's name so Acy will add the lists below this field. By "field's name", I mean the "name" attribute of the HTML element (if you don't know it, right click on the element then select "Inspect element" to see its "name" attribute at the bottom of your browser).
* **Send notification:** If this option is checked, a second notification will be sent to the administrator in addition to the Joomla's default e-mail.
* **Force double opt-in:** This option force the use of the double opt-in despite the main configuration.
* **Custom CSS**: Allow you to add some CSS code to display the AcyMailing fields in a different way.
* **User deletion behavior**: By default, when the Joomla user is deleted the AcyMailing user is also deleted and this option enables you to avoid deleting the AcyMailing user.
* **Excluded components**: You may have several integrated components on your site but don't necessary want to add the AcyMailing lists on all your components forms. This option enables you to exclude some components from this plugin.
* **Display category name**: Display or not the lists categories above them when added to the Joomla registration form.

Here is how the AcyMailing lists and custom fields are inserted on your Joomla registration form, of course you can customize it using CSS:

![](/files/-MJboClOk2ijPISN6yAP)

after email

### VirtueMart <a href="#virtuemart" id="virtuemart"></a>

If you use this plugin for the VirtueMart registration form, you may want to add this CSS to the CSS area on the plugin parameters to display it properly:

```
.acysubscribe .labelacysubscribe{
    float:left;
    width:30%;
    text-align:right;
    font-weight:bold;
}
.acysubscribe table{
    float:left;
}
```


# Plugin: Call to action

## What's a Call to action? <a href="#whats-a-call-to-action" id="whats-a-call-to-action"></a>

A **call to action** is an instruction to the audience to provoke an **immediate response**, usually using an imperative verb such as "call now", "find out more" or "visit our store today". A great Call-to-Action has to be **outstanding**, extremely clear and visually different from the rest of your text !

Adding a **nice big button** in the email is one of the best weapon to help your users understand what do you expect from them.

## Description <a href="#description" id="description"></a>

This plugin enables you to insert one or several **Call to Action** in your Newsletters. This plugin is already included in AcyMailing Enterprise and Multi-site edition, you simply have to publish it to use it.

## Plugin <a href="#plugin" id="plugin"></a>

![](/files/-MJboJqL8IGkjI1z9FrQ)

You can use this interface to build your Call to Action the way you want.

* **Button text**: The text displayed on your button (mandatory as the link is added on the text)
* **Font color**: The color of the text, you can directly put the color code if you know it or select the right color with the color picker
* **Link**: The link of you button (mandatory)
* **Background Colour**: The colour of your button
* **Width**: The width of the text column (not the entire button)
* **Alignment**: Choose if you want to insert the button on the left, right or center it
* **Left icon**: The icon used on the left of the text
* **Right icon**: The icon used on the right of the text

You can add your own icons in the media/com\_acymailing/plugins/calltoaction/ folder, please make sure to resize your pictures first. (maximum height and width:30px)

Once you click on the "Insert the tag" button, your personalized button will be inserted in your newsletter as you built it:

![](/files/-MJboLosdnLoT2yenDiZ)

You can refine the design by using some CSS rules in the newsletter template you're using. Here are the classes you can use:

* **actionbutton**: This class is added on the parent element of your button
* **toprow**: This class is added on the first line of the table
* **contentrow**: This class is added on the main line of the table (where the content is displayed)
* **bottomrow**: This class is added on the last row of the table

In some mail clients the border radius CSS rule may not be applied (such as Outlook 07 / 10 / 13, Office 365 and Yahoo! mail)

## Parameters <a href="#parameters" id="parameters"></a>

There are currently no parameters for this plugin, simply publish it to be able to use it.


# Plugin: Date - Time

## Description <a href="#description" id="description"></a>

This plugin enables you to include in your Newsletter or any other e-mail a date / time. It can be the current date (during the send process) or the Newsletter global send date and you add or remove some time to that date in order to display the date two days after the send date for example.

## Plugin <a href="#plugin" id="plugin"></a>

When writing a Newsletter (or any other e-mail in AcyMailing...), click on the **Tag** button to access the AcyMailing tag system.

![](/files/-MJboR3dsCNLJX8s1mmX)

Click on one of the format field to directly see the tag inserted in your Newsletter.

You can copy/paste the generated tag in your Text area or even in the Subject of your Newsletter if you want to.

![](/files/-MJboSc2uQl80mls6BjE)

Tag time

You can click on one of the line to insert the time with the corresponding format.

You can modify the inserted tag and apply some extra options:

* **senddate** : By default, AcyMailing will display the current time. You can add this parameter to display the Newsletter send date instead of the current time. Example: {date:1|senddate}
* **add** : You can add X seconds to the current time. For example, if you want to display tomorrow's date, you can use: {date:1|add:86400}
* **remove** : You can remove X seconds to the current time. For example, if you want to display yesterday's date, you can use: {date:1|remove:86400}

You can specify the format you want and Acy will use it to display the date the way you want. For example, {date:%B %d, %Y} will be replaced by June 3, 2013 %B : Full month name %m : Two digit representation of the month %d : Two-digit day of the month (with leading zeros) %Y : Four digit representation for the year %y : Two digit representation of the year (with leading zeros)

## Parameters <a href="#parameters" id="parameters"></a>

There is no parameters for this AcyMailing Plugin.


# GMail Inbox Actions

## What are the Inbox Actions?

Google created this new functionality to enable senders to add actions in the mailboxes so the receivers will be able to achieve an action (activate the account, click on a link) by clicking a button directly in their mailboxes (the button is displayed next to the subject line) without having to open their e-mails.

This feature has been implemented since AcyMailing 4.9.0 and is only available in our **Enterprise version**.

### One click actions

![](/files/-MJbolqZtSdfrAMR9syd)![](/files/-MJbonbpKh0o6_yRTWw9)

This functionality enables you to give the possibility to the receiver to execute an action from his mailbox, for example confirming his subscription.

There are two types of one-click actions:

* You should use the "confirm action" to let your receivers activate their account / confirm their Acy subscription / acknowledge something
* You should use the "save action" to let your receivers validate an action on your site

Both options will achieve the same thing, the difference is only made to help Google understand the goal of your on-click action buttons.&#x20;

### Go-To actions

![](/files/-MJboq0kN68nHEDx0BRd)![](/files/-MJborkvk-l7RhqcRhFo)

This functionality enables you to add a button linked to a page (it will open the link you specify in a new tab).

## Why do I need to be whitelisted?

These functionalities are very attractive, so Google didn't want them to be used by spammers.\
That's why Google decided to enable it only for websites explaining in which cases they would use it (otherwise the button will simply not appear in the receiver's mailbox).

## How do I ask Google to whitelist my website?

There are some rules that you must follow to be compliant with the Google requirements in order to be whitelisted:

* You must have a valid [DKIM](/old/main-pages/configuration/configuration-tabs/configure-your-send-process/dkim-domainkeys-identified-mail) and [SPF](/old/faq/spam-issue#configure-your-spf-and-sender-id-records) (You can always make sure that's the case with our [spam test tool](/old/main-pages/newsletters/spam-test))
* The top-level domain (TLD) of the SPF check or DKIM signature must match the TLD of your From: email address
  * e.g. if you use From: This email address is being protected from spambots. You need JavaScript enabled to view it. the DKIM and SPF must be for bar.com or sub.bar.com
  * Gmail only checks the SPF on the domain used in your bounce back email address. If you only rely on SPF and not DKIM your bounce email address must belong to the same domain as your from email address.
  * To quickly check if your SPF or DKIM settings are correct have a look at their [Email Authentication help article](https://support.google.com/mail/answer/180707?hl=en)
* Consistent history of sending a high volume of mail from your domain (order of hundred emails a day minimum to Gmail) for a few weeks at least
* A very very low rate of spam complaints from users

Once you match these requirements (and only then), create a newsletter, and in the "Inbox actions" tab, write the following data:

![](/files/-MJbouPnNGrBP73MemSs)

In the subject, set "Your site's name - confirmation email", preview the newsletter and send a test to <schema.whitelisting+sample@gmail.com>&#x20;

Once done, fill in the [Google whitelisting request form](https://docs.google.com/forms/d/1PA-vjjk3yJF7MLPOVKbIz3MBfhyma2obS8NIZ0JYx8I/viewform?pli=1). You'll get an answer within a day or two with instructions to finalize the whitelisting process (it may take longer if your newsletter is not in English).


# Plugin: Joomla Module Loader

## Description <a href="#description" id="description"></a>

This plugin enables you to include in your Newsletter a Joomla Module.

Even if you can include absolutely all Joomla Modules, some Joomla Modules won't work in your Newsletter because they use Javascript, Flash or iFrames (these methods are not allowed in an e-mail).

Our plugin to load any Joomla Module in your Newsletter requires the PHP function file\_get\_contents(). You can easily test your PHP configuration to make sure you can use it by editing the plugin and clicking on the **test** button.

This plugin is only available with AcyMailing Enterprise.

## Plugin <a href="#plugin" id="plugin"></a>

You can see a list of available modules. We already removed Joomla's non compatible Modules from this list so if you don't see one module in this listing, that means you can not insert it in your Newsletter.

Click on one of your module to see the tag inserted in your Newsletter.

![](/files/-MJbp9hyhlT_19ctIdDA)

Plugin Module Loader

## Parameters <a href="#parameters" id="parameters"></a>

You can access this plugin parameters from the AcyMailing configuration page, tab "Plugins".

![](/files/-MJbpBlm1PV30r_K0G11)

Params

* We developed two options to load your module so if you can not get it to work with the file\_get\_contents function, you can give it a try with the Curl method.
* You can click on the **test** button to test your php configuration and make sure the plugin will work (don't forget to apply the changes before testing).

If you see this popup, your PHP Configuration is valid and you will be able to use this plugin to load any Joomla Module.

![](/files/-MJbpGAXZrpvxGprmCdH)

Success

Nevertheless, if after 20 seconds the page is still not loaded or you see this error message, you should ask your provider to allow the file\_get\_contents() function at least on your own domain name.

![](/files/-MJbpIJ2SEbavpQC5X3q)

Error

If this plugin does work on localhost, please change your url to 127.0.0.1, and you should be able to test it.

## Working modules <a href="#working-modules" id="working-modules"></a>

The following modules have been tested and can be included in a Newsletter. If your module is not in this list, please give it a try and let us know if it worked or not so that we can add it in the appropriate list.

* mod\_archive
* mod\_banners (flash banners can not work in an e-mail)
* mod\_custom
* mod\_footer
* mod\_jevents\_latest (JEvents Latest Events)
* mod\_latestnews (Latest Articles)
* mod\_mainmenu
* mod\_mostread
* mod\_newsflash
* mod\_random\_image
* mod\_rquotes
* mod\_search
* mod\_section
* mod\_stats
* mod\_we\_ufeed\_display (Ultimate Feed Display)
* mod\_whosonline
* Latest Blogs from MyBlog
* Latest Reviews from JReviews
* Latest Listings from JReviews

### Not working modules <a href="#not-working-modules" id="not-working-modules"></a>

The following modules have been tested and **can not be** included in a Newsletter:

* mod\_acymailing (as it uses JS)
* mod\_gtranslate (as it uses Ajax)
* mod\_login (as it uses a security key)
* mod\_wrapper (as is uses iframe)


# Plugin: Joomla User

## Description <a href="#description" id="description"></a>

This plugin enables you to include in your Newsletter or any other e-mail Joomla Information on the user (Group, Username...).

This plugin only works if all your visitors are linked to a Joomla User! If you allow simple visitors to subscribe to your Mailing Lists, you may have subscribers in AcyMailing which are not registered on your website so this plugin won't be able to replace the information in that case (the tag will be simply ignored and replaced with an empty string).

## Plugin <a href="#plugin" id="plugin"></a>

When writing a Newsletter, click on the **Tag** button to access the AcyMailing tag system and being able to include any personal information in your Newsletter.

![](/files/-MJbpQ_vKAKeFHHLAXQu)

Click on one of the user field to directly see the tag inserted in your Newsletter.

You can copy/paste the generated tag in your Text area or even in the Subject of your Newsletter if you want to.

We voluntarily removed the "password" field for two reasons : First, the password is encrypted in Joomla so it's useless to try to insert it in a Newsletter; Then, because it would weaken the security on your website if the receiver forwards his Newsletter and that's definitely the last thing we want to do.

![](/files/-MJbpVxPLYR-RmmdKJV0)

User Plugin

## Parameters <a href="#parameters" id="parameters"></a>

![](/files/-MJbpYS_8fygCDIRwhyf)

* **Display filter**: Display or not the user filters in the "Filters" part of the newsletter edition page
* **Front-end Access**: You can restrict the access to this plugin on the Front-end using this option

## Frequently Asked Questions <a href="#frequently-asked-questions" id="frequently-asked-questions"></a>

### How can I add the User Password in my Newsletter? <a href="#how-can-i-add-the-user-password-in-my-newsletter" id="how-can-i-add-the-user-password-in-my-newsletter"></a>

You cannot.

The User password is encrypted in your database so even if AcyMailing is technically able to add it in your Newsletter, AcyMailing cannot get the real password (the non-encrypted one). To avoid any surprise using this field, we decided to remove it from the list of available fields. If you want to insert the encrypted password in your Newsletter, you can use the tag {usertag:password}

### I added the tag {usertag:name} but some of my users received their Newsletter with an empty result, why? <a href="#i-added-the-tag-usertag-name-but-some-of-my-users-received-their-newsletter-with-an-empty-result-why" id="i-added-the-tag-usertag-name-but-some-of-my-users-received-their-newsletter-with-an-empty-result-why"></a>

This plugin adds information from the Joomla User table so AcyMailing will be able to add the correct value only if all your users have their AcyMailing account linked to a registered User in Joomla.

You should rather use the **Subscriber** plugin to add the name of your users to be sure that the name will be always populated.

### How can I add the information about the logged in user <a href="#how-can-i-add-the-information-about-the-logged-in-user" id="how-can-i-add-the-information-about-the-logged-in-user"></a>

When doing a manual sending, if you want to add tags about the Joomla user logged in, you should use the extra parameter |info:current For example if you want to have the email of the logged in user, you should use: {usertag:email|info:current}

You should not use this when doing an automatic sending as the automatic process does not have a logged in user.


# Plugin: Manage Subscription

## Description <a href="#description" id="description"></a>

This plugin enables you to include in your Newsletter or any other e-mail a subscription link such as the "Unsubscribe" link, the "Modify your subscription" link or the "Confirm your subscription" link. **We highly recommend you to add at least the Unsubscribe link in all your Newsletters.**

In addition to those links, you can also insert information about the current subscription list and the current newsletter.

## Plugin <a href="#plugin" id="plugin"></a>

Click on one of the three links available and you will see the link selected and the input box at the top of the window should now display the default value for this link.

You can modify this text and then click on the button "**Insert the tag**" on the top of the window.

The tag will be inserted at the cursor's place in your WYSIWYG area. You can copy/paste the generated tag in your Text area if you want to.

If you send (or preview) your Newsletter, this tag will be replaced by a link enabling each of your subscribers to either confirm their subscription (you should only use this tag for the confirmation e-mail... but that can be useful if you want to reconfirm a list of users), modify their subscription or unsubscribe from the current Mailing List.

You can customize the text of the unsubscribe/modify/confirm links and optionally attach those links to a specific AcyMailing menu.

You can also link the unsubscribe/modify/confirm page to a public menu. In case of the modify your subscription link, if you assign it to a menu of this type, then you can set specific configuration for it such as the displayed lists.

![](/files/-MJbpenspWjETC8cyqJR)

Plugin Subscription

## Parameters <a href="#parameters" id="parameters"></a>

![](/files/-MJbpgbjpnH0afXOro84)

Manage subscription parameters

* **Dispaly the unsubscribe page**: Choose if you want to display your site's Front-end template + menus on the unsubscription page or not
* **Add list-unsubscribe header**: Should AcyMailing add the unsubscribe link for list-unsubscribe?
* **List-unsubscribe e-mail**: the list-unsubscribe e-mail
* **Display the modify your subscription**: Choose if you want to display your site's Front-end template + menus on the "modify your subscription" page or not
* **Display the confirmation page**: Choose if you want to display your site's Front-end template + menus on the "modify your subscription" page or not
* **Display filter**: Choose if you want to activate the filters in the "filters" part of the newsletter edition page
* **Front-end Access**: You can restrict the access to this plugin on the Front-end using this option


# Share your Newsletter on social networks

## Description <a href="#description" id="description"></a>

This plugin enables you to add share icons in your Newsletter so your receivers can share your Newsletter on their facebook, twitter, linkedin or google+ accounts.

## Plugin <a href="#plugin" id="plugin"></a>

When you edit your Newsletter, click on the "tags" button and select the "share on..." menu to access this screen.

Simply click on the icon you want to insert in your Newsletter, AcyMailing will automatically generate the right link to share your Newsletter.

All pictures included in the media/com\_acymailing folder are displayed there if they contain the word facebook, linkedin, twitter, hyves or google so if you want to use your own picture, simply add it to the media/com\_acymailing/templates folder and it will be visible there as well.

![](/files/-MJbpt7FWzfGER0SAQAG)

Social network share

## Parameters <a href="#parameters" id="parameters"></a>

![](/files/-MJbpv0Qq80s4KTmJpHY)

Share parameters

* In the plugin parameters (accessible from the AcyMailing configuration page, tab "plugins"), you will find an option so you can choose if the Newsletter is displayed inside your Joomla template with its modules/menus or in a standalone page.

## Force facebook to use the picture you want <a href="#force-facebook-to-use-the-picture-you-want" id="force-facebook-to-use-the-picture-you-want"></a>

Facebook will automatically pick up a picture within your page... it may not be the picture you wanted to share.

To force Facebook to share the picture you want, edit one of your picture and apply the class "**pictshare**" or the id "**pictshare**" to it. AcyMailing will detect it and will add it in your header as og:image


# Plugin: Subscriber

## Description <a href="#description" id="description"></a>

This plugin enables you to include in your Newsletter or any other e-mail receiver's information such as his name, e-mail address, subscription date, IP...

## Plugin <a href="#plugin" id="plugin"></a>

When writing a Newsletter, click on the **Tag** button to access the AcyMailing tag system and being able to include any personal information in your Newsletter.

![](/files/-MJbq3P6bSKzAJnZTc_W)

Click on one of the subscriber field to directly see the tag inserted in your Newsletter.

You can copy/paste the generated tag in your Text area or even in the Subject of your Newsletter if you want to.

![](/files/-MJbq58KyPxjovSqpWhW)

Subscriber Plugin

You can manually add parameters to the inserted tags to change the way the result is displayed, for example {subtag:name|ucfirst}

* **ucfirst** : Uppercase the first character

Example: "joHn" becomes "John"

* **upper** : Uppercase the information

Example: "This email address is being protected from spambots. You need JavaScript enabled to view it." becomes "This email address is being protected from spambots. You need JavaScript enabled to view it."

* **lower** : Inserts the information in lowercase

Example: "This email address is being protected from spambots. You need JavaScript enabled to view it." becomes "This email address is being protected from spambots. You need JavaScript enabled to view it."

* **ucwords** : Uppercase the first character of every word

Example: "joHn doe" becomes "John Doe"

## Parameters <a href="#parameters" id="parameters"></a>

![](/files/-MJbq7RxM0gSt1wznIiT)

* **Display filter**: Activate or not the filters in the "Filters" part of the newsletter edition page
* **Front-end Access**: You can restrict the access to this plugin on the Front-end using this option

## Frequently Asked Questions <a href="#frequently-asked-questions" id="frequently-asked-questions"></a>

### What's the different between the "Subscriber" and the "Joomla User" plugin? <a href="#whats-the-different-between-the-subscriber-and-the-joomla-user-plugin" id="whats-the-different-between-the-subscriber-and-the-joomla-user-plugin"></a>

The information you can add are different, one come from the Joomla User table, the others come from the AcyMailing User table.

&#x20;All Joomla users will have an AcyMailing account but if you handle visitors on AcyMailing, they don't have a Joomla account and so adding tags from the "Joomla User" table won't display any result in that case.

&#x20;If you want to add the name of the user, please always use the "Subscriber" information, not the "Joomla User" ones to be sure that all your subscribers will have a name.


# Plugin: Website Links

## Description <a href="#description" id="description"></a>

This plugin enables you to include links to your website in your Newsletter such as the "**view it in your browser**" or the "**forward to a friend**".

The "forward to a friend" link is only available from AcyMailing Essential and you have to turn the option ON in the AcyMailing Configuration page.

## Plugin <a href="#plugin" id="plugin"></a>

If you click on one of the two links, the default text will be displayed on the input box. You can customize the text as you wish and once you're done, click on the button "**Insert the tag**" in order to see it in your Newsletter Editor. If you send or preview your Newsletter, the tag will be replaced with a link to your online version or to the forward to a friend feature.

![](/files/-MJfGRm5SILd1XNj5Ro-)

Plugin Link

The "forward to a friend" link is only included in our commercial versions and you first have to enable this feature on the AcyMailing configuration page to be able to include this link.

![](/files/-MJfGV05rMBJuafDcm4s)

Config forward

## Parameters <a href="#parameters" id="parameters"></a>

You can access the plugin parameters by editing the plugin "website links" form the AcyMailing configuration page.

![](/files/-MJfGX73fv0Sxfps8yMQ)

Website links plugin

![](/files/-MJfGZ3LCqC0HIzOZNmO)

Website Links params

* **Add Newsletter key :** If your Newsletter can't be accessible from the front-end (option "visible" set to No in your Newsletter or if the list assigned to that Newsletter is not publicly accessible) then the online version link will only work if you include the Newsletter key (this option should be enabled).
* **Add User key :** Do you want the personal tags to be replaced in your online version? If so, you should keep this option enabled. If you turn OFF this option, the user won't see his personal information in the online version.
* **Display the online version** : You can choose to display the online version of your Newsletter inside your standard template or using the template *Component* (so no template). If you choose the template component (No template), the Newsletter will be displayed without any Joomla Module. This option is not used any more as you can select it when inserting the tag.
* **Display the forward version** : You can choose to display the forward version of your Newsletter inside your standard template or using the template *Component* (so no template). If you choose the template component (No template), the Newsletter will be displayed without any Joomla Module. This option is not used any more as you can select it when inserting the tag.
* **Front-end Access**: You can restrict the access to this plugin on the Front-end using this option

There is another solution to keep your standard template but not display the Joomla modules:

* Create a menu item for the AcyMailing component (don't publish it on your website if you don't want to)
* Go on your AcyMailing Configuration page (tab **Interfaces**) and select this menu in the dropdown **Menu linked to AcyMailing**
* Configure all your Joomla modules to not be displayed if this menu is selected (using the **Menu Assignment** option for each published Module in the **Joomla Module manager**)


# AcyMailing plugin : table of contents generator

## Description <a href="#description" id="description"></a>

This plugin is automatically installed with all our versions and enables you to generate a table of contents in your Newsletter.

## Plugin <a href="#plugin" id="plugin"></a>

When creating a Newsletter or a template, click on the "tags" button to access this page.

By default you can insert a table of contents based on your existing anchors (all elements inserted via our tag system have already defined anchors so if you included articles via our tag system, that's the one you should use!).

If you inserted text by yourself, you can configure the table of contents to load elements based on their type (H1,H2...) or based on a defined class.

You can also define a second level to create table of contents with two levels.

![](/files/-MJfGerfFzhxovdsUM_w)

table of contents

## Parameters <a href="#parameters" id="parameters"></a>

If you access the plugin via the AcyMailing configuration page, you will be able to set the default Divider used to display your table of contents.

![](/files/-MJfGgyE0vYNNn42fI6C)

Table of contents parameters


# User management


# Plugin: AltaUserPoints

This plugin enables you to integrate AcyMailing with AltauserPoints. You can download it then install and enable it like a standard Joomla plugin

## Insert AltaUserPoints user information in your Newsletter <a href="#insert-altauserpoints-user-information-in-your-newsletter" id="insert-altauserpoints-user-information-in-your-newsletter"></a>

When creating a Newsletter, click on the button "tags" to access our tag system.

Click on the menu AltaUserPoints to insert user information in your Newsletter such as its number of points.

![](/files/-MJgDE3buBRhEk1J8d4F)

AlphaUserPoints integration

## Add/remove points when the user subscribes/unsubscribes from AcyMailing <a href="#add-remove-points-when-the-user-subscribes-unsubscribes-from-acymailing" id="add-remove-points-when-the-user-subscribes-unsubscribes-from-acymailing"></a>

* The function **plgaup\_com\_acymailing\_subscriptionok** is triggered when the user subscribes to a list.
* The function **plgaup\_com\_acymailing\_subscriptionoff** is triggered when the user unsubscribes from a list.

To enable that feature, you should access AltaUserPoints, create rules for each of these functions and specify the number of points you want to add or remove.

![](/files/-MJgDFpYsKRiz9DKRAa9)

Rule


# Plugin : VirtueMart Checkout Subscription

## Description <a href="#description" id="description"></a>

This plugin enables you to automatically subscribe the user to one or several AcyMailing Lists during the VirtueMart checkout process.

You should use this plugin if you use VirtueMart **without a Joomla user account creation**. If you require an user account creation, you should use our [default registration plugin](/old/integration-plugins/installed-with-acymailing/plugin-auto-subscribe-during-joomla-registration).

Since VM2, the user will only be added to AcyMailing once he confirms his order, not directly after the VirtueMart registration.

This plugin is available on our download section if you purchased at least one commercial version of AcyMailing.

You can configure this plugin via the AcyMailing Configuration page.

![](/files/-MJgDLlYuCRO_zOIDY9m)

vmcheckout plugin

## Parameters <a href="#parameters" id="parameters"></a>

![](/files/-MJgDNUH17AcT0m8fAZ6)

VirtueMart Checkout params

* **Required Field**: You have to select a field in this list of fields displayed on your VirtueMart Registration form. AcyMailing will check this field and if the value corresponding to this field is not empty, the user will be subscribed to the selected lists. This field enables you to display an option on the VirtueMart Registration form so that the user can choose to be subscribed or not to some mailing lists. If you don't want the user to have the choice, please select the field **user\_email** Hereafter we will explain how you can add a checkbox so that the user can choose to subscribe or not to some mailing lists.
* **Subscribe the user to**: Select the lists you want the user to be subscribed to.
* **Send a confirmation e-mail?** & **Subscribe the user as confirmed?** : You can confirm or not your users independently from your global AcyMailing settings.

Don't forget to enable this plugin if you want it to work!

## Add a subscription checkbox on the VirtueMart checkout page <a href="#add-a-subscription-checkbox-on-the-virtuemart-checkout-page" id="add-a-subscription-checkbox-on-the-virtuemart-checkout-page"></a>

This part of the documentation will explain you how to add a subscription option on your VirtueMart Checkout Form. If you don't want the user to have the choice to subscribe or not, don't follow this part of the documentation and simply select the field **user\_email** as **Required field** (in the AcyMailing VirtueMart Checkout Subscription plugin).


# Plugin: CB User

## Description <a href="#description" id="description"></a>

This plugin enables you to include in your Newsletter or any other e-mail User's Information from Communiy Builder.

This plugin is only available from AcyMailing Business on.

This plugin only works if all your visitors are linked to a CB User! If you allow simple visitors to subscribe to your Mailing Lists, you may have subscribers in AcyMailing which are not registered on your website so this plugin won't be able to replace the information in that case (the tag will simply be ignored and replaced with an empty string).

## Plugin <a href="#plugin" id="plugin"></a>

Click on one of the CB user field to directly see the tag inserted in your Newsletter.

You can copy/paste the generated tag in your Text area or even in the Subject of your Newsletter if you want to.

![](/files/-MJgDSPS22So_b-r8F0g)

Plugin CB

## Filter <a href="#filter" id="filter"></a>

With this plugin you can filter your AcyMailing users based on the value of their Community Builder fields.

![](/files/-MJgDUEBWxf7AOPWDsSA)

Plugin CB

## Parameters <a href="#parameters" id="parameters"></a>

![](/files/-MJgDW2triQslE4m2eL2)

Plugin CB

* &#x20;**Front-end Access**: You can restrict the access to this plugin on the Front-end using this option


# Plugin: CJBlog

This plugin enables you to integrate AcyMailing with CJBlog. You can download it then install and enable it like a standard Joomla plugin

## Insert CJBlog user information in your Newsletter <a href="#insert-cjblog-user-information-in-your-newsletter" id="insert-cjblog-user-information-in-your-newsletter"></a>

When creating a Newsletter, click on the button "tags" to access our tag system.

Click on the menu CJBlog to insert user information in your Newsletter such as its number of points.

![](/files/-MJgDbwYG4EVYrzxUuAv)

AlphaUserPoints integration

## Parameters <a href="#parameters" id="parameters"></a>

There are currently no parameters for this plugin, simply install and publish it to use it.


# Plugin: com\_contact

## Description <a href="#description" id="description"></a>

This plugin enables you to filter your AcyMailing subscribers depending on their com\_contact group.

You can also use this plugin to automatically filter your users using our [Cron Task](/old/main-pages/configuration/configuration-tabs/cron-task).

You can download this plugin on our [plugins section](https://www.acyba.com/download/plugins-modules.html#contact), then install and publish it like a standard Joomla plugin.

## Filter <a href="#filter" id="filter"></a>

![](/files/-MJgDff3amlT5KdoYQpe)

&#x20;You can filter your AcyMailing subscribers based on their com\_contact group.

* **com\_contact:** Select the group and if you want to select subscribers in or not in the selected group.

## Parameters <a href="#parameters" id="parameters"></a>

&#x20;There are currently no parameters for this plugin, simply install and publish it.


# Plugin: Community Builder

## Description <a href="#description" id="description"></a>

​![](/files/-MJgDjUdZs4eUM0pYEym)The AcyMailing plugin for Community Builder enables you to add a Mailing list subscription on your Community Builder registration form.

It also enables your users to modify their subscription by editing their profile.

Please make sure you do not display some lists using our ***(auto)Subscribe during the Joomla registration form*** plugin otherwise the selected lists will be unsubscribed instead of subscribed.

## Install the CB plugin for AcyMailing <a href="#install-the-cb-plugin-for-acymailing" id="install-the-cb-plugin-for-acymailing"></a>

* Log in to your backend and click on the menu "**Components -> Community Builder -> Plugin Management**".
* At the bottom of the Plugin Management page of Community Builder, you will see an area enabling you to upload a new plugin.
* Browse for the AcyMailing plugin you just downloaded and then click on the button "**Upload File & Install**".
* In the CB Tab management, publish the new AcyMailing tab
* You should now see the AcyMailing Plugin part of the Community Builder Plugins. Don't forget to publish the AcyMailing plugin.

## Configure the plugin <a href="#configure-the-plugin" id="configure-the-plugin"></a>

![](/files/-MJgDmWffbS9sPOe-MM2)

CB plugin

* **Lists displayed on the registration form** : The selected lists will be displayed on your Registration form. You can easily choose one or several lists using the "select" button which will open a popup and display all your lists.
* **Lists checked by default** : The selected lists will be checked by default. Some countries do not allow you to check lists by default if it's not for "non-profit". This option will let you easily check some lists and not others in order to stay compliant with your local rules.
* **Lists displayed on the user profile** : Select here the lists you want to display on your CB user profile (when the user edits its profile).
* **Update user subscription on registration :** If the user is already subscribed to your lists, should we update the subscription based on the selected lists on the registration form (and so remove the user if he didn't select all your lists) or should we simply add the new lists to its subscription?
* **Fields association :** If you created extra fields in CB and in AcyMailing, you may want the CB value to be automatically applied to your AcyMailing user profile. You can define your rules in this area... The format used is : acymailingfield=cbfield For example, you create an Acy field called "country" and a cb field called "cb\_country", you can write there: country=cb\_country
* **Display Receive HTML/Text** : If you turn Off this field, the option "receive : Html / Text" won't be displayed and the user will be added with the option "receive HTML" ON.
* **Description as an overlay** : You can add the description of the list in an overlay on the visible lists. Be careful! If you turn this option On, you might have conflicts with Internet Explorer and flash.
* **Subscribe Caption** : Text displayed for the subscription field on the CB Registration page. If you leave this field empty, the word "Subscription" will be used from your default language file.

This plugin will add three screens:

* * A list selection on the Community Builder registration page (optional)

![](/files/-MJgDoUXNPx1jLiZMYk5)

cb registration

* * A new tab on the CB User profile to display the subscription

![](/files/-MJgDqNwQv20S1POJoGH)

Profile Show

* A new tab on the CB User profile so the user can manage his subscription

![](/files/-MJgDsJWZkrnyUohYcpx)

CB Edit

## My lists are not displayed on the CB registration form! <a href="#my-lists-are-not-displayed-on-the-cb-registration-form" id="my-lists-are-not-displayed-on-the-cb-registration-form"></a>

If you want to display the Acy lists on the CB registration form, you should make sure that:

* the plugin is enabled (obviously)
* the lists are selected in the plugin (obviously)
* the Acy tab is enabled in the CB tab management page
* your Acy lists are enabled AND visible
* your Acy lists don't have a view/subscribe access level that prevents users from seeing them
* the lists are NOT selected in the option "Auto-subscribe on Joomla registration" in the Acy configuration page, tab "Subscription"

## Frequently Asked Questions <a href="#frequently-asked-questions" id="frequently-asked-questions"></a>

### I published the AcyMailing CB Plugin but the lists are displayed at the top of my registration form, how can I order the lists so they appear at the bottom of my form? <a href="#i-published-the-acymailing-cb-plugin-but-the-lists-are-displayed-at-the-top-of-my-registration-form" id="i-published-the-acymailing-cb-plugin-but-the-lists-are-displayed-at-the-top-of-my-registration-form"></a>

You will be able to order your fields in Community Builder depending on their **position**. Two fields with the same position can be moved and reordered so first, you should set a position to the AcyMailing tab:

Click on the menu **Community Builder -> Tab Management** and edit the AcyMailing plugin. Select the position "Main area" and save the plugin. You can now order your lists at the bottom of the CB registration form by editing the ordering field.


# Plugin: Easy Profile

## Description <a href="#description" id="description"></a>

This plugin enables you to insert users (one by one or by a selection of one or several groups) from Easy Profile in your AcyMailing newsletters.

You can use this plugin with the AcyMailing Smart-Newsletter feature to create a weekly newsletter and automatically send the newly created profiles.

This plugin also enables you to include personal data from Easy Profile in your AcyMailing newsletters so that you can include the Easy Profile avatar of the receiver in your emails for example.

You will also be able to filter users based on their Easy Profile data so you can send a Newsletter to segment of your list based on the Easy Profile information (only to Male for example).

If you own one of the paid versions of AcyMailing, you can download this plugin, then install and publish it like a standard Joomla plugin:

## Plugin <a href="#plugin" id="plugin"></a>

### Single User <a href="#single-user" id="single-user"></a>

![](/files/-MJgDz6ACAgRywowDrKJ)

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

Each user can be selected one by one.

* **Display**: Select the information you want to be displayed in your user's description, you can select core fields and extra fields.
* **Clickable Title**: Make the title (name) clickable (so linked to the user page) or not.
* **Read More**: Add a "read more" link at the end of the user's description (so linked to the user page)
* **Display pictures**: You can decide to display, resize or not display the pictures in your user's description (avatar, image field, image in text field...).
* **Truncate the text after...**: It will truncate the text fields value, keep "0" or empty if you do not want to truncate it
* Additional parameters:
  * **Itemid:** You can specify the itemid used in the links to the user page by adding "|itemid:XXX" in your tag

### Groups <a href="#groups" id="groups"></a>

![](/files/-MJgE0GsNgcy8Xqg89vq)

You can select one or several group and AcyMailing will automatically include the users from the selected groups.

* **Max. Number of items**: The inserted tag will be replaced by a maximum of X users.
* **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 users found is reached.
* **Filter:** You can choose to insert only newly created users (created after the last time the newsletter was generated). This option is only visible if you access this plugin for a Smart-Newsletter
* **Order by**: Order the users by ID, created date, etc...
* **Columns**: Display the users in one, two or more columns

### User fields <a href="#user-fields" id="user-fields"></a>

![](/files/-MJgE2Nd7GkQ9LT2NFVe)

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

## Filters <a href="#filters" id="filters"></a>

![](/files/-MJgE4_bIs3lKbOy7-HA)

&#x20;You can filter your AcyMailing subscribers based on EasyProfile information.

* **Easy Profile fields:** Select the EasyProfile 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 (for the core fields).

## Parameters <a href="#parameters" id="parameters"></a>

![](/files/-MJgE6S1802C6bg_78D-)

* **Display profiles**: This parameter enables you to filter the list of users in the tag system
  * **All profiles**: AcyMailing will display all your users
  * **Only published profiles**: AcyMailing will only display your published users
* **Front-end Access:** You can choose to not display this tag and filter system on the front-end

## Customize your EasyProfile user template <a href="#customize-your-easyprofile-user-template" id="customize-your-easyprofile-user-template"></a>

### Customize your user using some CSS <a href="#customize-your-user-using-some-css" id="customize-your-user-using-some-css"></a>

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 user
> * **Style for the content title** will be applied to your user name
> * **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

![](/files/-MJgE8O4PDNmXJaeAaAF)

Set styles template

### Create your own template <a href="#create-your-own-template" id="create-your-own-template"></a>

You can also modify the way your EasyProfile user is displayed by creating your own template which will be used to render the user. Please follow those instructions, we don't recommend you to modify the EasyProfile 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 **easyprofile.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 user information), the element **$tag** (which contains the information of the current tag used in your Newsletter) and **$link** (the user link)

You can insert the user information using this simple syntax : {firstname}, {email}, or {link}

&#x20;Using all those variables, you can create your own user template.

> Here is an example:

> ```
> <div class="acymailing_content">{avatarhtml}<a href="{link}" target="_blank" ><h2 class="acymailing_title">{firstname} {lastname}</h2></a>Email: {email}<br/>Registered Date: {registerDate}</div>
> ```


# Plugin: EasySocial

## Description <a href="#description" id="description"></a>

This plugin enables you to insert users created with EasySocial in your Newsletters. You can also insert your different available profiles in order to promote your site if you just created it.

You can insert photo albums and events created by your users in your newsletters and auto-newsletters.

You can also insert user fields in the newsletters to personalize it.

If you purchased one of the paid version of AcyMailing, you can download the EasySocial plugin on our [plugins section](https://www.acyba.com/download/plugins-modules.html#easysocial) then install and publish it like a standard Joomla plugin.

Here is an example of inserted album:

![](/files/-MJgEDVbsF4I3WOwz7Hy)

## Plugin <a href="#plugin" id="plugin"></a>

### Users <a href="#users" id="users"></a>

![](/files/-MJgEH-yNf9oz9wP7Pbf)

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

* **Max. Number of items**: The inserted tag will be replaced by a maximum of X users.
* **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 users found is reached.
* **Columns**: display the users in one, two or more columns
* **Filter**: This option will only be displayed if you access this plugin for a Smart-Newsletter. You can set a rule so that only newly created users are added to your Newsletter.
* **Order by**: order the users by ID, name, etc...
* **Profile:** With this option you can filter the inserted users by their EasySocial profile type
* **Clickable Title**: Make the name clickable (so linked to your online version) or not.
* **Read More:** Add a read more button at the end of the user's listing
* **Fields:** Select the fields you want to show in the user's listing. Note that if you selected some fields that the user didn't fill in or field that do not belong to the user's profile type, it will not insert it for this user

### Profiles <a href="#profiles" id="profiles"></a>

![](/files/-MJgEJUV_61wfqGD0C2v)

You can insert with this tab one or several EasySocial profile types so that the receivers can register to your site using EasySocial

* **Max. Number of items**: The inserted tag will be replaced by a maximum of X profiles.
* **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 profiles found is reached.
* **Columns**: display the profiles in one, two or more columns
* **Filter**: This option will only be displayed if you access this plugin for a Smart-Newsletter. You can set a rule so that only newly created profiles are added to your Newsletter.
* **Order by**: order the profiles by ID, title, etc...
* **Truncate the text after...:** Truncate the profile's description or not, keep this option empty if you don't want to truncate it.
* **Clickable Title**: Make the title clickable (so linked to your online version) or not.

### Albums <a href="#albums" id="albums"></a>

![](/files/-MJgEMSwaJpYMm1j5-pz)

You can insert with this tab one or several albums in your newsletters or auto-newsletters

* **Max. Number of items**: The inserted tag will be replaced by a maximum of X albums.
* **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 albums found is reached.
* **Columns**: display the albums in one, two or more columns
* **Filter**: This option will only be displayed if you access this plugin for a Smart-Newsletter. You can set a rule so that only newly created albums are added to your Newsletter.
* **Order by**: order the profiles by ID, title, etc...
* **Display:** Select the information you want to add in the album's listing
* **Clickable Title**: Make the title clickable (so linked to your online version) or not.
* **Read More:** Add a read more button at the end of the album's listing
* **Display pictures:** Choose if you want to display some images of the album and if you want to resize them in the newsletter. If you want to display some images, set how many images maximum you want to insert.
* **Truncate the text after...:** Truncate the album's description or not, keep this option empty if you don't want to truncate it.

### Events <a href="#events" id="events"></a>

![](/files/-MJgEOkwEUohk5ooCTfN)

You can insert with this tab one or several events in your newsletters or auto-newsletters

* **Max. Number of items**: The inserted tag will be replaced by a maximum of X albums.
* **Columns**: display the albums in one, two or more columns
* **From / To:** With these options, you can tell the plugin to insert events starting between two specified dates. If you access this plugin for an auto-newsletter, you can specify two delays: in this example only events starting between 1 week and 5 months after the sending date will be inserted
* **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 profiles by ID, title, etc...
* **Truncate the text after...:** Truncate the event's description or not, keep this option empty if you don't want to truncate it.
* **Display:** Select the information you want to add in the event's listing
* **Clickable Title**: Make the title clickable (so linked to your online version) or not.
* **Read More:** Add a read more button at the end of the event's listing

### User Fields <a href="#user-fields" id="user-fields"></a>

![](/files/-MJgER-MesJ9N5mYk3bu)

You can insert with this tab some user fields taken from EasySocial, it allows you to create customized newsletters for each receivers only by adding one simple tag. Simply select the profile type where the field you want to insert is stored and then click on the field you want to insert.

## Filters <a href="#filters" id="filters"></a>

![](/files/-MJgETCfjfcnYYIFSwtz)

&#x20;With this plugin, you can filter your subscribers based on their EasySocial fields: select the EasySocial profile type, then the field you want to filter with, the operator and finally the value. If there are less than 100 different possible values, there will be some propositions like in this example.

![](/files/-MJgEV8xEv_dRMyYN-B2)

&#x20;Filter your subscribers by their EasySocial profile type and by when they registered.

![](/files/-MJgEX0HHAGziMh16mgz)

&#x20;Filter the subscribers by the groups they belong to. You can specify only the group category like in this example or directly the group itself (in this case the category dropdown will not be used). when clicking on the date fields, an area will appear to help you insert the dates, specific or relative.

## Parameters <a href="#parameters" id="parameters"></a>

![](/files/-MJgEZgqJVWZd-mgLnDh)

* **Front-end Access**: You can choose to hide the EasySocial tab on the Front-end with this option

### Customize your elements using some CSS <a href="#customize-your-elements-using-some-css" id="customize-your-elements-using-some-css"></a>

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 element
> * **Style for the content title** will be applied to your element's 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

![](/files/-MJgEaQ7_HDeG1jVjf7-)

Set styles template

### Create your own template <a href="#create-your-own-template" id="create-your-own-template"></a>

You can also modify the way your EasySocial elements are displayed by creating your own templates which will be used to render the elements. Please follow those instructions, we don't recommend you to modify the EasySocial plugin directly otherwise your changes will be overwritten when you update the plugin. Create your files in the the folder **media** / **com\_acymailing** / **plugins** (if the folder does not exist, please create it first).

The name of the files should be:

* **easysocialuser.php** for the users tags replacement
* **easysocialprofile.php** for the profiles tags replacement
* **easysocialalbum.php** for the albums tags replacement
* **easysocialevent.php** for the events tags replacement

If one of these files is available on your server, AcyMailing will use it and won't use the default one.

On these files you can access the element **$varFields** (which contains all the information you should need) and the element **$tag** (which contains the information of the current tag used in your Newsletter)

You can insert the elements information using this simple syntax : {title}, {description}, ...

Here are some examples:

* Users

> ```
> <div class="acymailing_content easysocial_user"><a href="{link}" name="easysocial-user-{id}" target="_blank" ><h2 class="acymailing_title">{name}</h2></a>E-mail address: {email}<br/> Birthday: {birthday}<br/> EasySocial field: {easysocialfield}<br/> EasySocial field2: {easysocialfield2} </div>
> ```

* Profiles

> ```
> <div class="acymailing_content easysocial_profile"><a href="{link}" name="easysocial-profile-{id}" target="_blank" ><h2 class="acymailing_title">{title}</h2></a>{imagehtml}<br/>{description}<br/> Groups: {groups} </div>
> ```

* Albums

> ```
> <div class="acymailing_content easysocial_album"><a href="{link}" name="easysocial-album-{id}" target="_blank" ><h2 class="acymailing_title">{title}</h2></a> Author: {name}<br/> Created on: {created}<br/>{caption}<br/>{images} </div>
> ```

* Events

> ```
> <div class="acymailing_content easysocial_event"><a href="{link}" name="easysocial-event-{id}" target="_blank" ><h2 class="acymailing_title">{title}</h2></a> Author: {name}<br/>Starting on: {date_start}<br/>Ending on: {date_end}<br/>{description} </div>
> ```


# Plugin: ExtendedReg Profile Information

## Description <a href="#description" id="description"></a>

&#x20;This plug-in enables you to add information of an ExtendedReg profile in your Newsletter.

This plug-in only works if all your users are linked to a Joomla User! If you allow simple visitors to subscribe to your Mailing Lists, you may have subscribers in AcyMailing which are not registered on your website so this plugin won't be able to replace the information in that case (the tag will be simply ignored and replaced with an empty string).

## Plugin <a href="#plugin" id="plugin"></a>

When writing a Newsletter, click on the **Tags** button to access the AcyMailing tag system and being able to include any personal information in your Newsletter.

![](/files/-MJgEjivemMwu4NGSb1j)

Tags button

Click on one of the user field to directly see the tag inserted in your Newsletter.

You can copy/paste the generated tag in your Text area or even in the Subject of your Newsletter if you want to.

![](/files/-MJgEllxbi6IW3p-4-h_)

ExtendedReg fields

A newsletter content as below

```
Did I check "MyField" ? {extendedreg:cf_my_field|type:checkbox|info:sender}
```

```
Which fruits do you eat ? {extendedreg:cf_fruits|type:multicheckbox|info:receiver}
```

Would generate a text like

```
Did I check "MyField" ? No
```

```
Which fruits do you eat ? Apple, Kiwi
```

Some tags parameters are available:

* **part**: "first" or "last" word of a text (e.g. {extendedreg:cf\_mytext|type:text|info:receiver|part:first} )
* **lower**: convert to lower case
* **ucwords**: convert the first letter of every word to upper case
* **ucfirst**: convert the first letter of a sentence to upper case
* **urlencode**: encode a string for use in a url

You can extend this plug-in by writing your custom PHP code in /media/com\_acymailing/plugins/extendedregfield.php

## Filters <a href="#filters" id="filters"></a>

You can filter users based on their ExtendedReg profile.

To do that, go to Acymailing > Lists > Filters and select ExtendedReg in the list of available filters.

![](/files/-MJgEnyuXqke_LejzpTL)

ExtendedReg filter

A list of ExtendedReg fields will appear below. Select the one you want to apply a filter on it.

## Parameters <a href="#parameters" id="parameters"></a>

There is no parameters for this AcyMailing Plugin.


# Plugin: Grumpy Contacts

## Description <a href="#description" id="description"></a>

This plugin enables you to filter your AcyMailing subscribers based on their Grumpy Contact fields and on the categories they belong.

If you own one of our paid versions, you can download this plugin on our [plugins section](https://www.acyba.com/acymailing/plugins.html#grumpycontacts) then install and publish it like a standard Joomla plugin.

## Filters <a href="#filters" id="filters"></a>

![](/files/-MJgEtIWtoOphEwskaFr)

Filter the users based on a specific field created in Grumpy Contacts.

![](/files/-MJgEuwWMmJzZvGu7-OI)

Simply select the subscribers in or not in a Grumpy Contacts category.

## Parameters <a href="#parameters" id="parameters"></a>

There are currently no parameters for this plugin, simply install and publish it.


# Plugin: Ja Job Board

## Description <a href="#description" id="description"></a>

This plugin enables you to filter your AcyMailing subscribers based on their Ja Job Board fields, type and creation/expiry date.

You can download this plugin then install and publish it like a standard Joomla plugin.

## Filters <a href="#filters" id="filters"></a>

![](/files/-MJgEyo88t5XQVquJ0xy)

Filter the users based on if they belong or not to a specific Ja Job Board group.

Filter them on the creation / expiry date. In this example, the filter will take every AcyMailing user which is also in the group "Job Seekers" and created their account between the 23rd June 2015 and today.

![](/files/-MJgF0NKRGAvjfmQPC92)

Filter the Ja Job Board users on their fields. In this example, it will take all Acy users which are not Ja Job Board users.

![](/files/-MJgF1ux6Yx-vbPh0pFb)

This filter is nearly the same, but on the Job Seekers.

## Parameters <a href="#parameters" id="parameters"></a>

There are currently no parameters for this plugin, simply install and publish it.


# Plugin: JomSocial

## Description <a href="#description" id="description"></a>

​![](/files/-MJgF7D8MhH1mrmUwYhC)This plugin enables you to include in your Newsletter or any other e-mail JomSocial Information on the user (Group, Username...).

## Plugin <a href="#plugin" id="plugin"></a>

When writing a Newsletter, click on the **Tag** button to access the AcyMailing tag system and being able to include any personal information in your Newsletter.

![](/files/-MJgF9Fg8BkFG8zSOV_4)

Go to the JomSocial tab. You will see 8 sub-tabs.

### Users <a href="#users" id="users"></a>

The first tab, Users, allows you to insert users from JomSocial.

![](/files/-MJgFCQPL8v2cwjBlBCh)

* **Max. number of items:** Maximum number of users to display
* **Columns:** Number of users on a row
* **Order by:** The order criterion to use. Once the tag generated, it will appear as \[...]|order:,DESC\[...]. You can change the DESC keyword to ASC to reverse the order
* **Number of characters (About Me):** Number of characters to crop the "About me" field to

Regarding the Thumbnail field (= user avatar), here is a description of the available options

* **Resized:** Resizes the image to fit in a box of the specified size (pixels). Keeps the proportions
* **Required:** Ensure that only users with a custom avatar are displayed, not those with the default avatar

![](/files/-MJgFFWSDbnWRV7bhS6h)

If you want to **change the display order** of one of the field (for example, email before karma), just change it in the generated tag.

Thus, |fields:title,karma,email" becomes |fields:title,email,karma

Please note that the "Name" field ("title" in the tag) will always be displayed first, whatever it's position in the tag.

You can choose to not display the first n users by adding **|start:n** to your tag, with n being an integer greater than 0.

This parameter works for all the tabs (Videos, Groups,...).

To not render the labels, add the parameter **|nolabel**. It also works with the other tabs.

Finally, you can define your own template by creating a file named "jomsocialusers.php" in "/media/com\_acymailing/plugins/".

Most of the data you may want is in $user, $juser, $image, $profileLink and $extraFields variables.

For more information, have a look at \_replaceusers() in the plugin's source code.

### Videos <a href="#videos" id="videos"></a>

The second tab, Videos, enables you to insert videos from JomSocial.

![](/files/-MJgFIqsWjUVppAdVfLq)

You can restrict displayed videos to some categories only. To achieve that, select one or more categories in the Categories section.

Top parameters are the same as Users tab.

![](/files/-MJgFL2QBnC6mup3lyoF)

You can define your own template by creating a file named "jomsocialvideos.php" in "/media/com\_acymailing/plugins/".

Most of the data you may want is in $video and $image variables.

For more information, have a look at \_replacevideos() in the plugin's source code.

### Groups <a href="#groups" id="groups"></a>

The third tab, Groups, works the same way as the previous tab. The main difference is it inserts groups instead of videos.

![](/files/-MJgFOKVDqHRmRIf9Sjv)

![](/files/-MJgFQfr0SycyxRdp1AB)

You can define your own template by creating a file named "jomsocialgroups.php" in "/media/com\_acymailing/plugins/".

Most of the data you may want is in $group and $image variables.

For more information, have a look at \_replacegroups() in the plugin's source code.

### Discussions <a href="#discussions" id="discussions"></a>

The fourth tab, Discussions, allows you to insert discussions from JomSocial. It is no different than Groups and Videos tabs, except you cannot restrict discussions by categories.

![](/files/-MJgFTVU9o9Q54h_n1wl)

![](/files/-MJgFVy5Fp6Pa6DOkCbB)

You can define your own template by creating a file named "jomsocialdiscuss.php" in "/media/com\_acymailing/plugins/".

Most of the data you may want is in $discuss and $image variables.

For more information, have a look at \_replacediscuss() in the plugin's source code.

### Events <a href="#events" id="events"></a>

As you can guess, the fifth tab enables you to insert events from JomSocial.

![](/files/-MJgFYiha7OJ-z3J5VkR)

Two new parameters are available

* **Upcoming Events:** When checked, will only display events whose start date is in the future
* **Type:** JomSocial events can be of type User (birthday,...) or Group (meeting,...). The checkboxes let you choose the type(s) to display.

![](/files/-MJgF_iQ4Yc-3PFL-fjg)

You can define your own template by creating a file named "jomsocialevents.php" in "/media/com\_acymailing/plugins/".

Most of the data you may want is in $event and $image variables.

For more information, have a look at \_replaceevents() in the plugin's source code.

### Photo Albums <a href="#photo-albums" id="photo-albums"></a>

The sixth tab can be used to display Photo Albums in a similar way than Users, Videos, Discussions, Groups and Events. No new parameter.

![](/files/-MJgFnVwndOydy1ALkbz)

![](/files/-MJgFekgpWFn8TGu3caN)

You can define your own template by creating a file named "jomsocialalbums.php" in "/media/com\_acymailing/plugins/".

Most of the data you may want is in $album and $image variables.

For more information, have a look at \_replacealbums() in the plugin's source code.

### Photos <a href="#photos" id="photos"></a>

Use this tab when you want to display a list of photos from JomSocial.

![](/files/-MJgFjO_w6RU7Y_uAJLI)

Unlike the previous tabs, you cannot choose to display any field.

If there is a caption, it will be displayed when hovering the image.

![](/files/-MJgFpvJtwXcQS5VtneZ)

You can define your own template by creating a file named "jomsocialphotos.php" in "/media/com\_acymailing/plugins/".

Most of the data you may want is in $link, $onePhoto and $image variables.

For more information, have a look at \_replacephotos() in the plugin's source code.

### User Fields <a href="#user-fields" id="user-fields"></a>

This tab enables you to include in your Newsletter or any other e-mail the User's Information from JomSocial.

It will only works if all your visitors are linked to a JomSocial User! If you allow simple visitors to subscribe to your Mailing Lists, you may have subscribers in AcyMailing which are not registered on your website. Indeed, it will be impossible to replace the information in that case (the tag will simply be ignored and replaced with an empty string).

You can resize thumb and avatar fields by setting parameters maxwidth and maxheight in the tag. For example: {jomsocialfield:avatar|maxwidth:87|maxheight:103}

![](/files/-MJgFsvIwcdfNzeftzvJ)

Click on one of the jomSocial user field to directly see the tag inserted in your Newsletter.

You can copy/paste the generated tag in your Text area or even in the Subject of your Newsletter if you want to.

The fields "**avatar**" and "**thumb**" will be replaced by the avatar picture or the thumbnail avatar picture of the user.

## Filter <a href="#filter" id="filter"></a>

You can set a filter on any information of the JomSocial User profile

![](/files/-MJgFwA7N_LaIK64AUSN)

JomSocial filter

## Styling <a href="#styling" id="styling"></a>

You can style generated elements by putting this rules in your template's stylesheet

### Users <a href="#users-1" id="users-1"></a>

```
/* Table containing a user */.jomsocialuser {}/* Cell containing the user's avatar */.jomsocialuser .figure {}/* Link associated to the avatar */.jomsocialuser .image {}/* Avatar image */.jomsocialuser .figure img {}/* Cell containing every other user's information */.jomsocialuser .figcaption {}/* User name */.jomsocialuser h2 {}/* Attribute xxxxx * with xxxxx in birdthdate, about, address, website, college, graduation, * karma, avatar, email, registerdate, lastvisitdate, views, friends * + custom fields names */.jomsocialuser .xxxxx {}/* Attribute xxxxx title */.jomsocialuser .xxxxx h3 {}
```

### Videos <a href="#videos-1" id="videos-1"></a>

```
/* Table containing a video */.jomsocialvideo {}/* Cell containing the video's screenshot */.jomsocialvideo .figure {}/* Link associated to the screenshot */.jomsocialvideo .image {}/* Video's screenshot */.jomsocialvideo .figure img {}/* Cell containing every other video's information */.jomsocialvideo .figcaption {}/* Video title */.jomsocialvideo h2 {}/* Attribute xxxxx * with xxxxx in description, duration, uploadedby, uploadedon, views, category */.jomsocialvideo .xxxxx {}/* Attribute xxxxx title */.jomsocialvideo .xxxxx h3 {}
```

### Groups <a href="#groups-1" id="groups-1"></a>

```
/* Table containing a group */.jomsocialgroup {}/* Cell containing the group's image */.jomsocialgroup .figure {}/* Link associated to the image */.jomsocialgroup .image {}/* Group's image */.jomsocialgroup .figure img {}/* Cell containing every other group's information */.jomsocialgroup .figcaption {}/* Group name */.jomsocialgroup h2 {}/* Attribute xxxxx * with xxxxx in category, created, membercount, discusscount, wallcount, activitiescount, creator */.jomsocialgroup .xxxxx {}/* Attribute xxxxx title */.jomsocialgroup .xxxxx h3 {}
```

### Discussions <a href="#discussions-1" id="discussions-1"></a>

```
/* Table containing a discussion */.jomsocialdiscuss {}/* Cell containing the discussion's image */.jomsocialdiscuss .figure {}/* Link associated to the image */.jomsocialdiscuss .image {}/* Discussion's image */.jomsocialdiscuss .figure img {}/* Cell containing every other discussion's information */.jomsocialdiscuss .figcaption {}/* Title of the discussion */.jomsocialdiscuss h2 {}/* Attribute xxxxx * with xxxxx in content, lastreplied, created, creator, group, replies */.jomsocialdiscuss .xxxxx {}/* Attribute xxxxx title */.jomsocialdiscuss .xxxxx h3 {}
```

### Events <a href="#events-1" id="events-1"></a>

```
/* Table containing an event */.jomsocialevent {}/* Cell containing the event's image */.jomsocialevent .figure {}/* Link associated to the image */.jomsocialevent .image {}/* Event's image */.jomsocialevent .figure img {}/* Cell containing every other event's information */.jomsocialevent .figcaption {}/* Title of the event */.jomsocialevent h2 {}/* Attribute xxxxx * with xxxxx in description, startdate, enddate, creator, created, * category, ticket, confirmed, maybe, invited, location */.jomsocialevent .xxxxx {}/* Attribute xxxxx title */.jomsocialevent .xxxxx h3 {}
```

### Photo Albums <a href="#photo-albums-1" id="photo-albums-1"></a>

```
/* Table containing an album */.jomsocialalbum {}/* Cell containing the album's image */.jomsocialalbum .figure {}/* Link associated to the image */.jomsocialalbum .image {}/* Album's image */.jomsocialalbum .figure img {}/* Cell containing every other album's information */.jomsocialalbum .figcaption {}/* Title of the album */.jomsocialalbum h2 {}/* Attribute xxxxx * with xxxxx in description, creator, created, group, hits, location */.jomsocialalbum .xxxxx {}/* Attribute xxxxx title */.jomsocialalbum .xxxxx h3 {}
```

### Photos <a href="#photos-1" id="photos-1"></a>

```
/* Table containing a photo */.jomsocialphoto {}/* Cell containing the photo's thumbnail */.jomsocialphoto .figure {}/* Link associated to the thumbnail */.jomsocialphoto .image {}/* Photo's thumbnail */.jomsocialphoto .figure img {}
```

## Parameters <a href="#parameters" id="parameters"></a>

There is no parameters for this AcyMailing Plugin.


# Plugin: JUGA

## Description <a href="#description" id="description"></a>

This plugin enables you to filter your AcyMailing subscribers based on their JUGA groups.

You can download this plugin then install and publish it like a standard Joomla plugin.

## Filters <a href="#filters" id="filters"></a>

![](/files/-MJgG2Qce2sNUZ8OI2ij)

## Parameters <a href="#parameters" id="parameters"></a>

There are currently no parameters for this plugin, simply install and publish it to be able to use it.


# Plugin: K2 Users

## Description <a href="#description" id="description"></a>

​![](/files/-MJgG7wx3KtzapK2_e5a)This plugin enables you to include in your Newsletter or any other e-mail K2 User profile information.

This plugin only works if all your users are linked to a K2 User!

## Plugin <a href="#plugin" id="plugin"></a>

![](/files/-MJgGA3H4swZsDqG-ZN7)

K2 Users plugin

* The tab "image" will be directly replaced by the user avatar

## Filter <a href="#filter" id="filter"></a>

![](/files/-MJgGC7PRk3wUPVc6LDy)

K2 Users plugin

Filter your K2 users based on their K2 group.

## Parameters <a href="#parameters" id="parameters"></a>

There is no parameters for this AcyMailing Plugin.


# Plugin: MightyMembership

## Filter your user based on Mighty Membership subscription plan <a href="#filter-your-user-based-on-mighty-membership-subscription-plan" id="filter-your-user-based-on-mighty-membership-subscription-plan"></a>

Using our Mighty Membership filter plugin, you can filter your users based on their plan in order to subscribe the selected users to your list or execute any other mass action.

You can download the Mighty Membership plugin on our plugin section then install and publish it like a standard Joomla plugin.

![](/files/-MJgGHne4ZRVz22LyllL)

## Case study: create three automatic follow-up (reminders) on plan expiration <a href="#case-study-create-three-automatic-follow-up-reminders-on-plan-expiration" id="case-study-create-three-automatic-follow-up-reminders-on-plan-expiration"></a>

You can combine Mighty Membership and AcyMailing Enterprise (for the auto-filters feature), to create a series of automatic follow-ups messages (reminders) before or after their plan expires.

The purpose of this case study is to explain you how to create three auto-filters in AcyMailing to automatically send an e-mail to the user one month before his plan expires, one week before his plan expires and then a day after his plan expired. This is definitely the best way to make sure your users will renew their subscription to your website.

### Create a message automatically sent one month before the user's subscription expires <a href="#create-a-message-automatically-sent-one-month-before-the-users-subscription-expires" id="create-a-message-automatically-sent-one-month-before-the-users-subscription-expires"></a>

* You should first create a Newsletter which should be published (a non-published Newsletter can't be sent), let's call it "Please renew your subscription".
* Then access the filters interface, select the filter "**Mighty Membership**":
  * Select the right plan (if you want to apply this reminder to one plan only but if you want to set it for all your plans, keep the option "All" selected).
  * Do not enter anything on the created date range (we don't need it)
  * Enter a range for the **Expiry Date**. The automatic filters will be executed only once a day, regardless to the cron frequency. So the range should be a period of one day (24 hours) otherwise the user may receive twice the same reminder. We want to select users if their plan expires in 30 or 31 days in the future. 30 days = 60\*60\*24\*30 = 2592000 seconds 31 days = 60\*60\*24\*31 = 2678400 seconds So the Expiry Date should be between 30 and 31 days in the future: {time}+2592000 < **Expiry Date** < {time}+2678400

![](/files/-MJgGKJnZLdZ7vVlhfRU)

We selected the right users, let's apply an action on these users.

* Select the action "**Add an e-mail in the queue**"
  * Select the Newsletter you create (in our example it's "Please renew your subscription")
  * Enter a send date We could keep the default value **{time}** which means the e-mail will be added in the queue and sent as soon as possible. Nevertheless we will configure the plugin to add the e-mail in the queue but keep it one day in the queue before sending it. Why? Just so that we can see the e-mail in the queue and for testing purpose we can check a few of them to make sure Acy selected the right users based on their Mighty Membership subscription. 1 day = 60\*60\*24\*1 = 86400 seconds We will configure AcyMailing to add the e-mail in the queue with a send date : {time}+86400 Once tested, you can go back to this screen and modify your filter to set it to {time} so that the e-mail gets sent as soon as possible and does not stay in the queue for a day.

cbsubs add queue

* You can now click on the button "Process" to test your filter. AcyMailing will tell you how many e-mails have been added in the queue and you can access the queue listing to check that AcyMailing selected the right users.
* We will now save the filter and configure it to be executed once a day automatically.
* Click on the "**Save**" button
  * Enter a filter name and a description
  * Select the option "**Every day (using the cron task)**" so that the filter is automatically executed once a day. The automatic filters require a cron task to work properly, please don't forget to [create your cron task](/old/main-pages/configuration/configuration-tabs/cron-task) otherwise the process won't work automatically.
  * Publish the filter
* Click again on the "**Save**" button

![](/files/-MJgGM_ctyWDZSpE5onc)

### Create a message automatically sent one week before the user's subscription expires <a href="#create-a-message-automatically-sent-one-week-before-the-users-subscription-expires" id="create-a-message-automatically-sent-one-week-before-the-users-subscription-expires"></a>

Please reproduce exactly the same thing as described above, create another Newsletter and create a new filter with a new expiry range.

We want to send the reminder a week before the user's subscription expires so we will select users if their plan expires between 6 and 7 days.

6 days = 60 \* 60 \* 24 \* 6 = 518400 seconds

7 days = 60 \* 60 \* 24 \* 7 = 604800 seconds

Our filter will select users based on : {time}+518400 < **Expiry Date** < {time}+604800

### Create a message automatically sent one day after the user's subscription expired <a href="#create-a-message-automatically-sent-one-day-after-the-users-subscription-expired" id="create-a-message-automatically-sent-one-day-after-the-users-subscription-expired"></a>

The same way, we will create a filter to select users having a subscription expired a day ago so users with an expiry date between now and one day in the past:

{time}-86400 < **Expiry Date** < {time}


# AlphaUserPoints plugin

This plugin enables you to integrate AcyMailing with AlphauserPoints. You can download it then install and enable it like a standard Joomla plugin

## Insert AlphaUserPoints user information in your Newsletter <a href="#insert-alphauserpoints-user-information-in-your-newsletter" id="insert-alphauserpoints-user-information-in-your-newsletter"></a>

When creating a Newsletter, click on the button "tags" to access our tag system.

Click on the menu AlphaUserPoints to insert user information in your Newsletter such as its number of points.

![](/files/-MJgGTh6KVN-u0jjbgEV)

AlphaUserPoints integration

## Add/remove points when the user subscribes/unsubscribes from AcyMailing <a href="#add-remove-points-when-the-user-subscribes-unsubscribes-from-acymailing" id="add-remove-points-when-the-user-subscribes-unsubscribes-from-acymailing"></a>

* The function **plgaup\_com\_acymailing\_subscriptionok** is triggered when the user subscribes to a list.
* The function **plgaup\_com\_acymailing\_subscriptionoff** is triggered when the user unsubscribes from a list.

To enable that feature, you should access AlphaUserPoints, create rules for each of these functions and specify the number of points you want to add or remove.

![](/files/-MJgGVqYdSaRQ8bnlV0q)

Rule


# Content management


# Plugin : AdsManager

This plugin is included in all AdsManager paid packs.

## Description <a href="#description" id="description"></a>

This plugin enables you to insert Ads (one by one or by a selection on one or several categories) from AdsManager in your Newsletter.

You can also use this plugin to automatically include your newly created (or modified) Adsmanager Ads in an Auto-newsletter or a Newsletter.

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

The Adsmanager plugin has to be installed like a standard Joomla plugin.

## Plugin <a href="#plugin" id="plugin"></a>

### Single Item <a href="#single-item" id="single-item"></a>

![](/files/-MJgIIe05o4ewfa9D57V)

AdsManager Element

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

Each Ad can be selected one by one.

* **Display**:
  * **Title Only**: only the title will be inserted
  * **Text**: only the title,description and images will be inserted
  * **Full Text**: the element will be inserted using the fields of the ad. This view can be customized (see below)
* **Display pictures**: You can decide to display or not this picture in your Newsletter (thumbnail or original image).
* **Clickable Title**: make your title clickable (so linked to your online version) or not.

### Categories <a href="#categories" id="categories"></a>

![](/files/-MJgIMRQkqWeBf7Ok6OZ)

Category selection

You can select one or several Adsmanager categories and AcyMailing will automatically include the AdsManager items belonging to the selected categories.

* **Maximum Number of Articles**: The inserted tag will be replaced by a maximum of X Adsmanager Ads.
* **Minimum Number of Articles**: This option will only be displayed if you access this plugin for a Smart-Newsletter. AcyMailing will only generate your Smart-Newsletter if the minimum number of Adsmanager Ads found is reached.
* **Filter**: This option will only be displayed if you access this plugin for a Smart-Newsletter. You can set a rule so that only newly created or modified Adsmanager ads are added to your Newsletter.

## Parameters <a href="#parameters" id="parameters"></a>

![](/files/-MJgIOoPGCtyrvEu3BBp)

Sobi Params

* **Display articles**: This parameter enables you to filter the list of Adsmanager Ads in the tag system
  * **All articles**: AcyMailing will display all your Adsmanager Ads
  * **Only published articles**: AcyMailing will only display your published Adsmanager Ads
* **Remove javascript**: This option enables you to remove any javascript code included in your Adsmanager Ad as the javascript won't work in most of mail clients.

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 item
> * **Style for the content title** will be applied to your content 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

![](/files/-MJgIR6Kg01EpFYW3Dkf)

Set styles template

Example:

![](/files/-MJgIT-NUxl8LdecD6PT)

Example

### Create your own template <a href="#create-your-own-template" id="create-your-own-template"></a>

You can also modify the way your Adsmanager Ad is displayed by creating your own template which will be used to render the Adsmanager Ad (FULL VIEW). Please follow those instructions, we don't recommend you to modify the adsmanager plugin directly otherwise your changes will be overwritten when you update AcyMailing.

Create a file in the folder **media / com\_acymailing / plugins** (if the folder does not exists, please create it first). The name of the file should be **adsmanager.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 $article (which is the article object loaded from the content table) and the element $tag (which contains the information of the current tag used in your Newsletter)

By default the file should contain:

```
<?php
if(!empty($tag->link)){ 
    $title = '<a href="'.$link.'" '; 
    $title .= 'target="_blank" >'.$styleTitle.$helper->showFieldValue($ad,$fields['ad_headline']).$styleTitleEnd.'</a>'; 
}else{ 
    $title = $styleTitle.$helper->showFieldValue($ad,$fields['ad_headline']).$styleTitleEnd; 
} 
echo '<h2 class="acymailing_title">'.$title.'</h2>'; 
$imgpath = $this->_getimagepath($ad->id,$conf->nb_images,"thumb"); 
echo '<img src="'.$imgpath.'" style="float:right;margin:5px" />'; 
echo $helper->showFieldValue($ad,$fields['ad_text']); 
foreach($fields as $name => $field) { 
    if (($name != 'ad_headline')&&($name != 'ad_text')) echo $helper->showFieldValue($ad,$field); 
}
```


# Plugin: AdsManager (by Heigho)

## Description <a href="#description" id="description"></a>

This plugin enabled you to include AdsManager Items in a Newsletter. It has been developed by Heigho and available as a paid plugin on their website.

This plugin enables you to search in all your Adsmanager items and insert them (one by one or by a selection on one or several categories) in your Newsletter.

You can also use this plugin to automatically include your newly created (or modified) Adsmanager items in an Auto-newsletter or a Newsletter.

It works with both Adsmanager versions, 2.6 and the old one, and you can install in Joomla 1.5 or 1.6 without any problems.

Moreover it allows to translate your ads with JoomFish (for Joomla 1.5) and it loads your Adsmanager CSS style, in this way it maintains your graphical choices and offers a strong coherency between your web-site and your newsletter. It supports five modes to display ads:

* Only Title
* Short mode (Box)
* Simple view
* List/table View
* Details view

## Plugin <a href="#plugin" id="plugin"></a>

### Single Item <a href="#single-item" id="single-item"></a>

![](/files/-MJgIZhLM7UCeQszKWZo)

Each item can be selected one by one.

* **Display**:
  * **Title Only**: only the title will be inserted
  * **Short**: the Ads title, Image, (eventually) price and date will be inserted into a Box.
  * **Simple**: it offers the simplest view of your ad. It inserts the title, the description and the first photo. It is not affected by complicated css styles in order to be compatible with all email clients.
  * **Category View**: the elements will be inserted using the Adsmanager list view of your site.
  * **Details View**: the element will be inserted using the Adsmanager details view.
* **Display pictures**: You can decide to display or not this picture in your Newsletter or display a resized size of it.
* **Title**: make your title visible. If you group by category, it shows category title, otherwise it displays ad title.
* **Clickable Title**: make your title clickable (so linked to your online version) or not.
* **Columns**: allow you to input the columns number for Short/Box mode.
* **Group by Category**: sort and group your ads according to the category they belong to.
* **Language**: if you use Joomfish whit this option you can translate ads in the language selected.

### Categories <a href="#categories" id="categories"></a>

You can select one or several Ads categories and AcyMailing will automatically include the Ads belonging to the selected categories.

![](/files/-MJgIayYmeSzxMFkLXKu)

* **Maximum Number of Articles**: The inserted tag will be replaced by a maximum of X items.
* **Minimum Number of Articles**: 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 items found is reached.
* &#x20;**Order by**: You can order by ID, Title, Expiration Date, Price ( only with default number format: with dot decimal and without commas between every group of thousands!!).
* &#x20;**Filter**: This option will only be displayed if you access this plugin for a Smart-Newsletter. You can set a rule so that only newly created or modified Ads are added to your Newsletter.

## Parameters <a href="#parameters" id="parameters"></a>

![](/files/-MJgIcuvt-JXstXvF9Zj)

* **Display articles**: This parameter enables you to filter the list of Adsmanager items in the tag system
  * **All articles**: AcyMailing will display all your ads
  * **Only published articles**: AcyMailing will only display your published ads
    * ​
* **Remove javascript**: This option enables you to remove any javascript code included in your Adsmanager item as the javascript won't work in most of mail clients.
* **Show date** : enables you to remove date of creation. In “Short” mode: date is displayed at the bottom of the box; “Intro”: in a separate column.
* &#x20;**Show price** : enables you to remove/show price of your ads. If you are using Adsmanager to display announces without price field select “No”.
* &#x20;**Show contact** : enables you to hide contact info in Full view mode.

## Language <a href="#language" id="language"></a>

This plugin is integrated with JoomFish for load into the newsletter your translated Adsmanager ads.

* **Adsmanager 2.5.x** : it loads your translation, but it cannot find few adsmanager constants. Don’t worry the solution is very simple:

1. Go to Adsmanager fields
2. Select default fields (examples: *ad\_headline*, *ad\_price*, *ad\_kindof*) and translate the title into your default Joomla site language. E.g. : *ADSMANAGER\_FORM\_KINDOF -> trasled into “type”;*
3. Please, remember to translate also values fields in “*ad\_kindof*”, e.g.: *ADSMANAGER\_KINDOF2 -> “Carry”*
4. If you have a multi-language website and you are using JoomFish, you should translate also the default fields.

* **Adsmanager 2.6.x**

1. Be sure to have installed both the Joomla admin and the site language translation packs.
2. Control if you have activated them.
3. Install or ri-nominate your Adsmanager file language properly. Please control if your language code in Adsmanager translation is equal to the correspondent language in Joomla!
4. If your problems persist you can try with solution explained some lines before for old version of Adsmanager.

## Style <a href="#style" id="style"></a>

Remember that email isn't the web: CSS and HTML support is far lower for email than it is for the web. Many email clients don't support complex Css Style, so your newletter can be little different from the Preview. Support for even simple CSS varies considerably between clients, and even different versions of the same client. Your beautiful design work might look great in one email client, but chances are when you look at the same work a different email client the results will not be the same. To partially obviate this problem, we applied inline CSS.

We import your Css style in order to realize a layout equivalent to your website and we guarantee the correct functionality of this plugin, but we can't assure you that the newsletter will look like for every email client. This is no an our fault, but a lack of email clients, so you should follow the rules for a good newsletter! Look for some guidelines in internet. Don't worry, the global structure will be maintained intact, only some proprieties like round boxes won't be accepted by every email clients. Moreover we supply with this inconvenient offering you the simple mode view mode and the box mode view.

### Customize your item using some CSS <a href="#customize-your-item-using-some-css" id="customize-your-item-using-some-css"></a>

You can change the styles used for the title and the content area by editing

1. your CSS Adsmanager file (it MUST be placed in “…components/com\_adsmanager/css”)
2. AcyMailing template.

When you change your Adsmanager css file you will modify how your ads will be displayed both in your site and your newsletter! In fact we import your css, so in this way you can maintain your graphical choices. Unfortunately there are some restriction on css due to email clients standards.

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

* **Style for the content area** will be used to encompass your Adsmnager item
* **Style for the content title** will be applied to your content 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
* If you want change Short mode style you can modify the code around line 1100 or you should add some new styles with the correct name in your template (or in stylesheet field). We have used these tags: table.tabBox2 .content1; table.tabBox2 td.uno; table.tabBox2 th; table.tabBox2 div.imgad; table.tabBox2 img.ad ; table.tabBox2 img.icon; table.tabBox2 div.ad; table.tabBox2 div.price; table.tabBox2 div.date

![](/files/-MJgIfjm7uyAVPxFdOB4)

### Create your own template <a href="#create-your-own-template" id="create-your-own-template"></a>

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

Create a file in the folder **media/com\_acymailing/plugins** (if the folder does not exists, please create it first). The name of the file should be **adsmailing.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 *$extravalues\[0]* (which is the ad object loaded from the content table) and the element *$tag* (which contains the information of the current tag used in your Newsletter).

## Recommendations <a href="#recommendations" id="recommendations"></a>

**a)** A web server running PHP 5 is required to run this utility. Your PHP installation must support the DOM extension.

**b)** You should not use advanced css styles proprieties, such as round borders, because many email clients cannot support them. If you would create successful email newsletters that will look good, even in the worst email clients, look for some guidelines in internet.

**c)** The price have to be expressed in the default English format without commas and with dot used to mark the radix point.

**d)** If you have installed Adsmanager and you haven’t modified any files, this plugin should works perfectly. It works correctly also if you have customized only Adsmanager css files. Instead, if you have applied some relevant changes be sure that:

1. The default english language exists
2. Your Acymailing have Emogrifier file (it has been integrated since version 1.5)
3. Your Adsmanager Ads images are stored in *“...images/com\_adsmanager/ads/”*
4. For Adsmanager version < 2.5 : in *…/components/com\_adsmanager/adsmanager.html.php* and precisely into the function *show\_html\_ad()* in the

   &#x20;, the “*default*” case must be exactly the follow row:

   ​![](/files/-MJgIiSPr3kTa_ulfzCW)​
5. In Adsmanager version >=2.6 in the file *components/com\_adsmanager/views/details/tmpl/default.php* you cannot change lines around row 177 :

   ​![](/files/-MJgIk-oqQAWl_9V_Fps)​


# Plugin : Dj-Catalog 2

## Description <a href="#description" id="description"></a>

This plugin enables you to insert products (one by one or by a selection on one or several categories) from Dj-Catalog 2 in your Newsletters.

You can also use this plugin to automatically include your newly created (or modified) products in an Auto-newsletter.

You can search in all your Dj-Catalog 2 products and then click on one of the products to include it in your Newsletter.

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

Your products will look like this in your newsletter :

![](/files/-MJgIqbjAw1aIj-ywiXB)

## Plugin <a href="#plugin" id="plugin"></a>

### Single Product <a href="#single-product" id="single-product"></a>

![](/files/-MJgIt-DuxmFWVMCOZgz)

You can use this interface to insert any Dj-Catalog 2 product in your Newsletter.

Each product can be selected one by one.

* **Display**: select the information to display with the product
* **Custom fields**: select the custom fields you want to be displayed after the product fields
* **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 product (so linked to your online version)
* **Display pictures**: you can decide to display or not the main picture of the product.
* **Truncate the text after...**: it will truncate the product description, keep "0" or empty if you do not want to truncate it
* Additional parameters:
  * **itemid**: it will add the specified itemid in the links

### Categories <a href="#categories" id="categories"></a>

![](/files/-MJgIvXw1vuFSr3c-uNa)

You can select one or several Dj-Catalog 2 categories and AcyMailing will automatically include the products belonging to the selected categories.

* **Max. Number of items**: The inserted tag will be replaced by a maximum of X products.
* **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 products found is reached.
* **Filter**: This option will only be displayed if you access this plugin for a Smart-Newsletter. You can set a rule so that only newly created or modified products are added to your Newsletter.
* **Order by**: order the products by ID, title, etc...
* **Columns**: display the products in one, two or more columns
* Additional parameters:
  * additionalcats: If you add this hidden parameter, Acy will search also in the additional categories and not only the main one. Simply add "|additionalcats" in the generated tag.

## Parameters <a href="#parameters" id="parameters"></a>

![](/files/-MJgIyElojDoYR0I6W1v)

* **Display content**: This parameter enables you to filter the list of Dj-Catalog 2 products in the tag system
  * **All content**: AcyMailing will display all your Dj-Catalog 2 products
  * **Only published content**: AcyMailing will only display your published products

## Customize your Dj-Catalog 2 product template <a href="#customize-your-dj-catalog-2-product-template" id="customize-your-dj-catalog-2-product-template"></a>

### Customize your product using some CSS <a href="#customize-your-product-using-some-css" id="customize-your-product-using-some-css"></a>

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 product
> * **Style for the content title** will be applied to your product 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

![](/files/-MJgJ-AxEmvhdW3ziUZx)

Set styles template

### Create your own template <a href="#create-your-own-template" id="create-your-own-template"></a>

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

Create a file in the the folder **media** / **com\_acymailing** / **plugins** (if the folder does not exist, please create it first). The name of the file should be **djcatalog2.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 product information), the element **$tag** (which contains the information of the current tag used in your Newsletter) and **$link** (the product link)

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

&#x20;Using all those variables, you can create your own product template.

> Here is an example:

> ```
> <div class="acymailing_content">
>     <a href="{link}" target="_blank" >
>         <h2 class="acymailing_title">{name}</h2>
>     </a>
>     <a href="{link}" target="_blank" style="text-decoration:none" >
>         <img src="{image}"/>
>     </a>
>     {description}
>     Price: {price}
> </div>
> ```


# Plugin : Kunena

## Description <a href="#description" id="description"></a>

This plugin enables you to include Kunena content such as latest posts and profile information in your Newsletter or any other e-mail.

The Kunena plugin inserts the public posts, so if your forum or category is only accessible when logged in, you could use this little "trick": Install the Autologin plugin then, in the AcyMailing configuration page tab "Queue Process", [add the autologin parameters on the cron URL](/old/main-pages/configuration/configuration-tabs/cron-task) (with a dummy account of course, not your super admin one).

## Plugin <a href="#plugin" id="plugin"></a>

When writing a Newsletter, click on the **Tags** button to access the AcyMailing tag system and being able to include Kunena data in your Newsletter.

![](/files/-MJgJ4JkA5JwyEKkEexS)

Tag button

Go to the Kunena tab. You will see two subtags.

### Topics <a href="#topics" id="topics"></a>

The first one, **Topics**, allows you to insert latest posts from Kunena forums. To do that, select one or more categories to look into, set the options, then click on the "Insert the Tag" button.

![](/files/-MJgJ6Mh7-HLSnqoLZtN)

* **Display**: Display latest topics (do not display topic responses) or latest posts (display one or more posts per topic)
* **Display pictures:** The icon to insert before a post title
* **Total messages:** Show or hide the total of messages posted in the topic
* **Author name:** Show or hide the name of the person who wrote the post
* **Max. Number of items:** The maximum number of elements to display
* **Min. Number of items** : This option will only be displayed if you access this plugin for a Smart-Newsletter. AcyMailing will only generate your Smart-Newsletter if the minimum number of items found is reached.
* **Created Date:** Time limit beyond which the posts will be ignored

If you want to include posts with restricted access in your newsletter, you will need the associate rights (administrator, moderator of the target categories).

Moreover, you will have to send the newsletter manually (for security reasons).

### Profile information <a href="#profile-information" id="profile-information"></a>

The second tab, Profile information, gives you access to Kunena users profile information. Click on a field to insert it in the newsletter. Each tag will be replaced by the corresponding receiver information.

![](/files/-MJgJ8s7fcnTKwEZSgHD)

## Parameters <a href="#parameters" id="parameters"></a>

![](/files/-MJgJB4mTvgLvMMpMmTG)

* **Maximum length of a subject**: Number of characters beyond which the subject will be cut
* **Maximum length of a message**: Number of characters beyond which the message will be cut
* **Read more link**: Adds a "Read more" button at the end of the messages (in addition to the one added when the text is truncated)
* **Itemid**: You can specify the itemid used in the link to the topics / messages
* **Front-end Access**: You can restrict the access to this plugin on the Front-end

### Styling <a href="#styling" id="styling"></a>

You can change the style of the generated content by settings some CSS rules in your stylesheet ("Stylesheet" tab on the left of your template's edition page).

For example, if you create a newsletter with this template:

![](/files/-MJgJD15tYpzQHYKjqx5)

You will obtain something like this:

![](/files/-MJgJF7E-jCvKonMYgmZ)

Here are the rules available:

```
/* Table wrapping every content from kunena */
.acykunena { } 
/* Subject title + messages count */
.acykunena h2 { } 
/* Subject title */
.acykunena .subject { } 
/* Messages count */
.acykunena h2 span { } 
/* Message header (icon, author, date) */
.acykunena .wrapper { } 
/* Message icon */
.acykunena .icon { } 
/* Message author */
.acykunena .authorname { } 
/* Message creation date */
.acykunena .createddate { } 
/* Message content */
.acykunena .content { }
```

### Create a custom layout <a href="#create-a-custom-layout" id="create-a-custom-layout"></a>

&#x20;You can modify the way the topics / messages are displayed in your newsletters by creating a custom layout for this plugin.

Firstly, create the filte media / com\_acymailing / **plugins / kunenamessage.php**

In this file, you can access the message's properies by using this simple syntax: {subject}, {message}, {url}...

Here is an example of custom template you can use:

```
 <div class="acymailing_content"> 
     <h2 class="title">
         <a href="{url}">{subject}</a>
     </h2> 
     <table>
         <tr>
             <td>{icon}</td>
             <td>{createddate}<br/>
             {message}</td>
         </tr>
     </table> 
 </div> 
```


# Plugin: AdAgency

## Description <a href="#description" id="description"></a>

This plugin enables you to filter your AcyMailing subscribers depending on their AdAgency fields.

You can also use this plugin to automatically filter your users using our [Cron Task](/old/main-pages/configuration/configuration-tabs/cron-task).

Once downloaded, you can install and publish it like a standard Joomla plugin.

## Filter <a href="#filter" id="filter"></a>

![](/files/-MJgJKUini3xxkvm3xrm)

&#x20;You can filter your AcyMailing subscribers based on AdAgency information.

* **Ad Agency:** Select the AdAgency field, the operator then the value. If there are less than 100 possible values, it will show a list of possible values (if you selected '=' or '!=' operator).

## Parameters <a href="#parameters" id="parameters"></a>

&#x20;There are currently no parameters for this plugin, simply install and publish it.


# Plugin: CiviCRM

## Description <a href="#description" id="description"></a>

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](https://www.acyba.com/download/plugins-modules.html#civicrm), then install and publish it like a standard Joomla plugin.

Your events will look like this in your newsletter :

![](/files/-MJgJPIa_OkRjqHYFvvC)

## Plugin <a href="#plugin" id="plugin"></a>

![](/files/-MJgJRXK9mlc7H4VU09F)

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

![](/files/-MJgJTO1Wx5E-cYcI7Q3)

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

### Single Event <a href="#single-event" id="single-event"></a>

![](/files/-MJgJVKng7BbICp_xMv4)

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 <a href="#upcoming-events" id="upcoming-events"></a>

![](/files/-MJgJXZgOiFW40CfhCMM)

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 <a href="#filters" id="filters"></a>

![](/files/-MJgJ_6_gLxCkD6u1SN6)

&#x20;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 <a href="#parameters" id="parameters"></a>

![](/files/-MJgJbIcrBwLU1iqrP6W)

* **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 <a href="#customize-your-civicrm-event-template" id="customize-your-civicrm-event-template"></a>

### Customize your event using some CSS <a href="#customize-your-event-using-some-css" id="customize-your-event-using-some-css"></a>

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

![](/files/-MJgJdcBIV-66zO-FI7v)

Set styles template

### Create your own template <a href="#create-your-own-template" id="create-your-own-template"></a>

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}

&#x20;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>
> ```


# Plugin: Cobalt

## Description <a href="#description" id="description"></a>

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

You can also use this plugin to automatically include the newly created elements in an Auto-newsletter.

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

If you own one of our paid versions, you can download this plugin from our [download area](https://www.acyba.com/acymailing/plugins.html#cobalt) then install and publish it like a standard Joomla plugin.

## Plugin <a href="#plugin" id="plugin"></a>

### Single article <a href="#single-article" id="single-article"></a>

![](/files/-MJgJkJPY-N8xtYbTf9N)

You can use this interface to browse and insert any article in your Newsletter.

Each item can be selected one by one.

* **Display**: Select the information you want to insert in your newsletter
* **Clickable Title**: make the title clickable (so linked to your online version) or not.
* **Read more:** Add or not a read more button at the end of the element
* **Display pictures**: You can decide to display or not the pictures in your Newsletter or resize them
* **Truncate the text...:** Truncate the description or not

### Categories <a href="#categories" id="categories"></a>

![](/files/-MJgJmKv9YmAevguNmQs)

You can select one or several categories and AcyMailing will automatically include the new articles from the selected categories.

* **Columns**: You can decide to display the articles on one or more columns
* **Max. number of items**: The inserted tag will be replaced by a maximum of X articles.
* **Min. number of items**: This option will only be displayed if you access this plugin for a Smart-Newsletter. AcyMailing will only generate your Smart-Newsletter if the minimum number of articles found is reached.
* **Order by**: order the articles by id, title, etc...
* **Filter**: This option will only be displayed if you access this plugin for a Smart-Newsletter. You can choose to insert only newly created or modified articles.
* **Additional parameters:**
  * **featured:** If you add |featured in the generated tag, the plugin will insert only featured elements
  * **nofeatured:** If you add |nofeatured in the generated tag, the plugin will insert only non-featured elements
  * **start:** If you add |start:5 in the generated tag, the plugin will insert elements starting by the 5th result

## Parameters <a href="#parameters" id="parameters"></a>

![](/files/-MJgJoUJBZWMkGe-bTIw)

* **Display records**: This parameter enables you to filter the list of items in the tag system
  * **All records**: AcyMailing will display all your items
  * **Only published records**: AcyMailing will only display your published items
* **Front-end Access**: You can limit the access to this plugin on the Front-end
* **Set your Itemid**: ID of the menu attached to the component, it will be used in the generated links

## Customize your element template <a href="#customize-your-element-template" id="customize-your-element-template"></a>

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

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

Create the custom template as explained [here](/old/developers/customize-the-way-the-content-inserted-in-emails-by-plugins#custom-template), on the created file you can access to the element $varFields that contains all the needed data.

You can display:

* The article's Id: {id}
* The article's name: {title}
* Created date: {ctime}
* Modified date: {mtime}
* The url of your item: {link}
* The custom fields: {My custom field 1} / {My custom field 2} / etc...

Using all those variables, you can create your own template, for example:

```
<div class="acymailing_content"><h2 class="acymailing_title"><a href="{link}" name="cobalt-{id}" target="_blank">{title}</a></h2>{text}{My custom field 1}<br />My custom field 2: {My custom field 2}<br />My custom field 3: {My custom field 3}</div>
```


# plugin: Dj-Classifieds

## Description <a href="#description" id="description"></a>

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

You can also use this plugin to automatically include your newly created items in an Auto-newsletter.

You can search in all your Dj-Classifieds items and then click on one of the items to include it in your Newsletter.

If you purchased at least one commercial version of AcyMailing, you can download this plugin then install and publish it like a standard Joomla plugin.

Here is an example of inserted item:

![](/files/-MJgJtu1xoSgGgEZA0Oa)

## Plugin <a href="#plugin" id="plugin"></a>

### Single Item <a href="#single-item" id="single-item"></a>

![](/files/-MJgJvtrs837IWD7RGt-)

You can use this interface to insert any Dj-Classifieds item in your Newsletter.

Each item can be selected one by one.

* **Display**: Select the information to display with the item
* **Custom Fields:** You can select the custom fields you want to be displayed with the item. No info will be added if the field's value is empty or if the field isn't applied to the item's category
* **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 item (so linked to your online version)
* **Truncate the text after...**: It will truncate the item description, keep "0" or empty if you do not want to truncate it
* **Display pictures**: You can decide to display or not the pictures of the item (main picture and description's pictures).
* Additional parameters:
  * **itemid**: It will add the specified itemid in the links

### Categories <a href="#categories" id="categories"></a>

![](/files/-MJgJxz9lqyCtWevgiYD)

You can select one or several Dj-Classifieds categories and AcyMailing will automatically include the items belonging to the selected categories.

* **Max. Number of items**: The inserted tag will be replaced by a maximum of X items.
* **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 items found is reached.
* **Filter**: This option will only be displayed if you access this plugin for a Smart-Newsletter. You can set a rule so that only newly created items are added to your Newsletter.
* **Order by**: order the items by ID, title, etc...
* **Columns**: display the items in one, two or more columns

## Parameters <a href="#parameters" id="parameters"></a>

![](/files/-MJgK-2XZZFinP8fUMQY)

* **Display articles**: This parameter enables you to filter the list of items in the tag system
  * **All articles**: AcyMailing will display all your items
  * **Only published articles**: AcyMailing will only display your published items
* **Set yout itemid:** You can set here the default itemid used in the item's links
* **Front-end Access**: You can hide this plugin's tab on the Front-end tag's popup

## Customize your Dj-Classifieds item template <a href="#customize-your-dj-classifieds-item-template" id="customize-your-dj-classifieds-item-template"></a>

### Customize your item using some CSS <a href="#customize-your-item-using-some-css" id="customize-your-item-using-some-css"></a>

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 item
> * **Style for the content title** will be applied to your item's 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

![](/files/-MJgK102IqHQ9nOYCp91)

Set styles template

### Create your own template <a href="#create-your-own-template" id="create-your-own-template"></a>

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

Create a file in the the folder **media** / **com\_acymailing** / **plugins** (if the folder does not exist, please create it first). The name of the file should be **djclassifieds.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 item's information), the element **$tag** (which contains the information of the current tag used in your Newsletter) and **$link** (the item's link)

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

&#x20;Using all those variables, you can create your own item template.

> Here is an example:

> ```
> <div class="acymailing_content"><a href="{link}" name="djclassifieds-{id}" target="_blank" ><h2 class="acymailing_title">{name}</h2></a><a href="{link}" target="_blank" style="text-decoration:none" >{imagehtml}</a>{description} Price: {price} {currency}Address: {location}One custom field: {cf|field's label}</div>
> ```


# plugin: EasyBlog

## Description <a href="#description" id="description"></a>

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

You can also use this plugin to automatically include your newly created (or modified) posts in an Auto-newsletter.

You can search in all your EasyBLog posts and then click on one of them to include it in your Newsletter.

You can download this plugin if you own one of the paid versions of Acymailing:

Once downloaded, please then install and publish it like a standard Joomla plugin.

Here is an example of inserted post:

![](/files/-MJgK61o3L-yN6m25l0G)

## Plugin <a href="#plugin" id="plugin"></a>

### Single Post <a href="#single-post" id="single-post"></a>

![](/files/-MJgK84Q2R73b8AnkKXl)

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

Each post can be selected one by one.

* **Display**: select the information to display with the article
  * **Title only** will display the title
  * **Intro Only** will display the title + everything before the read more link
  * **Text** will display the title + everything after the read more link
  * **Full text** will display the title + the entire post
* You can also select the language you want your posts to be translated to (only if you have FaLang or JoomFish installed)
* **Clickable Title**: make your title clickable (so linked to your online version) or not.
* **Author name:** Select if you want to display the author's name just after the post's title
* **Display pictures**: you can decide to display or not the post's pictures.
* Additional parameters:
  * **itemid:** You can specify the itemid used in the links within the post's listing
  * **wordwrap:** You can specify the max number of characters of the post's content, the plugin will add a readmore button if the text is truncated
  * **readmore:** If the text is trucated, you can customize the text included in the read more button, for example: {easyblog:1| type:full| link| pict:0| wordwrap:350| readmore:My read more text}
  * **|type:link:** You can change the parameter "type" value into "link", your tag will only return the post's link
  * **forcereadmore:** By adding "|forcereadmore", you force the plugin to add the read more button, even if it is not needed

### Categories <a href="#categories" id="categories"></a>

![](/files/-MJgKAdGCwTei3RJqnFY)

You can select one or several EasyBlog categories and AcyMailing will automatically include the posts belonging to the selected categories.

* If you have FaLang or JoomFish, you can select the language you want your posts to be translated to, if you don't have FaLang or JoomFish, this option will be used to filter your posts by their attached language
* **Columns**: display the posts in one, two or more columns
* **Team Blogs:** Filter your posts by team blog
* **Bloggers:** You can filter your posts by author
* **Max. Number of items**: The inserted tag will be replaced by a maximum of X posts.
* **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 posts found is reached.
* **Order by**: order the posts by ID, title, etc...
* **Filter**: This option will only be displayed if you access this plugin for a Smart-Newsletter. You can set a rule so that only newly created or modified posts are added to your Newsletter.
* Additional parameters:
  * **excludedcats:** You can override the Excluded cats from the plugin's configuration by adding this hidden parameter, for example: {autoeasyblog:...some.options.....| excludedcats:1,5,7,8,10}
  * **meta:** You can filter the posts by their meta tags, for example: {autoeasyblog:...some.options...| meta:joomla,cms,acymailing}
  * **access:** You can override the Access option from the plugin's configuration by setting this option to "0" or "1"
  * **frontpage:** If this option is set, the plugin will load only featured posts
  * **nofrontpage:** If this option is set, the plugin will not load the featured posts
  * **start:** The plugin will load the results except the X first ones where X is the value you entered

## Parameters <a href="#parameters" id="parameters"></a>

![](/files/-MJgKD-GDkpZIHaWNIN4)

* **Display articles**: This parameter enables you to filter the list of EasyBlog posts in the tag system
  * **All articles**: AcyMailing will display all your posts
  * **Only published articles**: AcyMailing will only display your published posts
* **Itemid:** You can set here the Itemid of the menu attached to your posts, it will be used in the links
* **Content access**: This parameter enables you to filter the EasyBlog posts loaded by a "category" tag
  * **Only public:** AcyMailing will only load only public posts
  * **All:** AcyMailing will load all your posts
* **Max picture height:** This is the default resize height
* **Max picture width:** This is the default resize width
* **Blocked categories:** You can set here the categories you don't want this plugin to load your posts, write the categories id separated by a comma
* **Front-end Access**: you can choose to hide the EasyBlog tab on the Front-end with this option

## Customize your EasyBlog post template <a href="#customize-your-easyblog-post-template" id="customize-your-easyblog-post-template"></a>

### Customize your post using some CSS <a href="#customize-your-post-using-some-css" id="customize-your-post-using-some-css"></a>

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 post
> * **Style for the content title** will be applied to your post 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

![](/files/-MJgKFE8ysRaVIqCS0c9)

Set styles template

### Create your own template <a href="#create-your-own-template" id="create-your-own-template"></a>

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

Create a file in the the folder **media** / **com\_acymailing** / **plugins** (if the folder does not exist, please create it first). The name of the file should be **easyblog.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 post information), the element **$tag** (which contains the information of the current tag used in your Newsletter) and **$link** (the post link)

You can insert the post information using this simple syntax : {title}, {intro} or {content}

&#x20;Using all those variables, you can create your own template.

> Here is an example:

> ```
> <div class="acymailing_content"><a href="{link}" name="easyblog-{id}" target="_blank" ><h2 class="acymailing_title">{title}</h2></a>{picthtml}{intro}<br/>{content}<br/>{authorname}</div>
> ```


# plugin: EasyDiscuss

## Description <a href="#description" id="description"></a>

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

You can also use this plugin to automatically include your newly created (or modified) posts in an Auto-newsletter.

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

If you purchased one of our paid versions of AcyMailing, you can download the EasyDiscuss plugin on our [plugins section](https://www.acyba.com/download/plugins-modules.html#easydiscuss) then install and publish it like a standard Joomla plugin.

Here is an example of inserted post:

![](/files/-MJgKN7XXiWWT8U57jM4)

## Plugin <a href="#plugin" id="plugin"></a>

### Single Post <a href="#single-post" id="single-post"></a>

![](/files/-MJgKP2ptBMNTEG9wwT6)

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

Each post can be selected one by one.

* **Display**: select the information you want to display in the posts's listing
* **Clickable Title**: make your title clickable (so linked to your online version) or not.
* **Read More:** Add a read more button at the end of the post's listing
* **Truncate the text after:** Truncate the post's text after X characters
* **Display pictures**: you can decide to display or not the post's pictures.
* Additional parameters:
  * **itemid:** You can specify the itemid used in the links within the post's listing

### Categories <a href="#categories" id="categories"></a>

![](/files/-MJgKQliy7Ll-2msg5wT)

You can select one or several EasyDiscuss categories and AcyMailing will automatically include the posts belonging to the selected categories.

* **Order by**: order the posts by ID, title, etc...
* **Columns**: display the posts in one, two or more columns
* **Max. Number of items**: The inserted tag will be replaced by a maximum of X posts.
* **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 posts found is reached.
* **Filter**: This option will only be displayed if you access this plugin for a Smart-Newsletter. You can set a rule so that only newly created or modified posts are added to your Newsletter.

## Parameters <a href="#parameters" id="parameters"></a>

![](/files/-MJgKSdOLnMgmpSG8Dvq)

* **Display posts**: This parameter enables you to filter the list of EasyDiscuss posts in the tag system
  * **All posts**: AcyMailing will display all your posts
  * **Only published posts**: AcyMailing will only display your published posts
* **Front-end Access**: you can choose to hide the EasyDiscuss tab on the Front-end with this option

## Customize your EasyDiscuss post template <a href="#customize-your-easydiscuss-post-template" id="customize-your-easydiscuss-post-template"></a>

### Customize your post using some CSS <a href="#customize-your-post-using-some-css" id="customize-your-post-using-some-css"></a>

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 post
> * **Style for the content title** will be applied to your post 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

![](/files/-MJgKUcDu4yqzN_hOJDJ)

Set styles template

### Create your own template <a href="#create-your-own-template" id="create-your-own-template"></a>

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

Create a file in the the folder **media** / **com\_acymailing** / **plugins** (if the folder does not exist, please create it first). The name of the file should be **easydiscuss.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 post information), the element **$tag** (which contains the information of the current tag used in your Newsletter) and **$link** (the post link)

You can insert the post information using this simple syntax : {post|title}, {post|created} or {post|content}

&#x20;Using all those variables, you can create your own template.

> Here is an example:

> ```
> <div class="acymailing_content"><a href="{link}" name="easydiscuss-{post|id}" target="_blank" ><h2 class="acymailing_title">{post|title}</h2></a>Author: {user|nickname}<br />{post|content}</div>
> ```


# Plugin: Emerald

## Description <a href="#description" id="description"></a>

This plugin enables you to filter your AcyMailing subscribers based on their subscription plan status in Emerald.

If you own one of our paid versions, you can download this plugin then install and publish it like a standard Joomla plugin.

## Filters <a href="#filters" id="filters"></a>

![](/files/-MJgK_5q11Fhkr-kHN9B)

Simply select the subscribers in or not in an Emerald subscription plan.

You can filter the users on the status of their subscriptions and on their subscription date / purchase.

In this example, it will select all the AcyMailing subscribers subscribed to the subscription plan 1 that subscribed during the last seven days.

## Parameters <a href="#parameters" id="parameters"></a>

There are currently no parameters for this plugin, simply install and publish it.


# Plugin: EZautos

## Description <a href="#description" id="description"></a>

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

You can also use this plugin to automatically include the newly created items in a smart-newsletter.

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

If you own one of our paid versions, you can download this plugin from our [download area](https://www.acyba.com/acymailing/plugins.html#form2content) then install and publish it like a standard Joomla plugin.

## Plugin <a href="#plugin" id="plugin"></a>

### Single item <a href="#single-item" id="single-item"></a>

![](/files/-MJgKdmiLjLZmL_1_778)

You can use this interface to browse and insert any item in your Newsletter.

Each item can be selected one by one.

* **Display**: Select the information you want to insert in your newsletter
* **Display pictures**: You can decide to display or not the pictures in your Newsletter or resize them

### Categories <a href="#categories" id="categories"></a>

![](/files/-MJgKfxk1Jgn1QAJcgWJ)

You can select one or several categories and AcyMailing will automatically include the new items from the selected categories.

* **Display:** You can filter the items by language on a multilingual site
* **Columns**: You can decide to display the items on one or more columns
* **Order by**: order the items by id, title, etc...
* **Max. number of items**: The inserted tag will be replaced by a maximum of X articles.
* **Make**: You can filter the inserted items by manufacturer
* **Min. number of items**: This option will only be displayed if you access this plugin for a Smart-Newsletter. AcyMailing will only generate your Smart-Newsletter if the minimum number of items found is reached.
* **Filter**: This option will only be displayed if you access this plugin for a Smart-Newsletter. You can choose to insert only newly created or modified items.
* **Additional parameters:**
  * **model:** If you add |model:205 in the generated tag, the plugin will insert only items with the specified model
  * **start:** If you add |start:5 in the generated tag, the plugin will insert elements starting by the 5th result

## Parameters <a href="#parameters" id="parameters"></a>

![](/files/-MJgKiLt-JxRUn7SKkSm)

* **EZ Autos currency:** You can specify the currency that should be used by the plugin

## Customize your element template <a href="#customize-your-element-template" id="customize-your-element-template"></a>

By default, the items will be displayed like this in your newsletters:

![](/files/-MJgKkIniQNBPy27Nn4Q)

If you don't like the way it is displayed, you can change the styles used for the item's title and the item's area by editing the styles in your AcyMailing template.

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

Create the custom template as explained [here](/old/developers/customize-the-way-the-content-inserted-in-emails-by-plugins#custom-template), on the created file you can access to the element $varFields that contains all the needed data.

You can display:

* The item's Id: {autoid}
* The item's name: {modelname}
* The item's manufacturer: {makename}
* The url of your item: {link}

Using all those variables, you can create your own template, for example:

```
<div class="acymailing_content"><h2 class="acymailing_title"><a href="{link}" name="ezautos-{autoid}" target="_blank">{makename} - {modelname}</a></h2>{picture} {smalldesc}<br />{longdesc}<br />{details}Year: {year}</div>
```


# plugin: FLEXIcontent

## Description <a href="#description" id="description"></a>

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

You can also use this plugin to automatically include your newly created (or modified) articles in an Auto-newsletter.

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

You can download the FLEXIcontent plugin then install and publish it like a standard Joomla plugin.

Here is an example of inserted article:

![](/files/-MJgKpJ8vNHkTXoUtmSM)

## Plugin <a href="#plugin" id="plugin"></a>

### Single Article <a href="#single-article" id="single-article"></a>

![](/files/-MJgKrT4b6V-HeBFGCcO)

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

Each article can be selected one by one.

* **Display**: select the information to display with the article
* **Clickable Title**: make your title clickable (so linked to your online version) or not.
* **Truncate the text after...**: it will truncate the article description, keep "0" or empty if you do not want to truncate it
* **Display pictures**: you can decide to display or not the article's pictures.
* **Read More**: add a "read more" link at the end of the article (so linked to your online version)

### Categories <a href="#categories" id="categories"></a>

![](/files/-MJgKtLPytTK_P2fiEMT)

You can select one or several FLEXIcontent categories and AcyMailing will automatically include the articles belonging to the selected categories.

* **Columns**: display the articles in one, two or more columns
* **Max. Number of items**: The inserted tag will be replaced by a maximum of X articles.
* **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 articles found is reached.
* **Order by**: order the articles by ID, title, etc...
* **Filter**: This option will only be displayed if you access this plugin for a Smart-Newsletter. You can set a rule so that only newly created or modified articles are added to your Newsletter.
* Additional parameters:
  * **cattitle:** This parameter enables you to add the category title for each group of articles. You should order your articles by category ID to group them by category. Example: {autoFLEXIcontent:| displays:title| cols:1| order:catid,ASC| cattitle}
  * **featured**: If you add "| featured" in the inserted tag, it will insert only featured articles
  * **nofeatured**: If you add "| nofeatured" in the inserted tag, it will exclude the featured articles
  * **mincreated**: You can add "| mincreated:2016-11-15 18:32:00" in the inserted tag to exclude all articles created before the specified date. You can also use "| mincreated:\[time]-86400" to exclude the articles created before 24h ago (useful when used in a smart-newsletter)
  * **maxcreated**: You can add "| maxcreated:2016-11-15 18:32:00" in the inserted tag to exclude all articles created after the specified date. You can also use "| maxcreated:\[time]-86400" to exclude the articles created in the 24 previous hours (useful when used in a smart-newsletter)

## Parameters <a href="#parameters" id="parameters"></a>

![](/files/-MJgKvr_i61Wzubee4Lx)

* **Display articles**: This parameter enables you to filter the list of FLEXIcontent articles in the tag system
  * **All articles**: AcyMailing will display all your articles
  * **Only published articles**: AcyMailing will only display your published articles
* **Front-end Access**: you can choose to hide the FLEXIcontent tab on the Front-end with this option
* **Set your Itemid:** You can set here the Itemid of the menu attached to your articles, it will be used in the links

## Customize your FLEXIcontent article template <a href="#customize-your-flexicontent-article-template" id="customize-your-flexicontent-article-template"></a>

### Customize your article using some CSS <a href="#customize-your-article-using-some-css" id="customize-your-article-using-some-css"></a>

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 article
> * **Style for the content title** will be applied to your article 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

![](/files/-MJgKxrOld6KLOjcvRW7)

Set styles template

### Create your own template <a href="#create-your-own-template" id="create-your-own-template"></a>

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

Create a file in the the folder **media** / **com\_acymailing** / **plugins** (if the folder does not exist, please create it first). The name of the file should be **flexicontent.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 **$allFields** (which contains all the product information), the element **$tag** (which contains the information of the current tag used in your Newsletter) and **$link** (the article link)

You can insert the article information using this simple syntax : {title}, {introtext} or {fulltext}

&#x20;Using all those variables, you can create your own template.

> Here is an example:

> ```
> <div class="acymailing_content"><a href="{link}" name="flexicontent-{id}" target="_blank" ><h2 class="acymailing_title">{title}</h2></a>{introtext}</div>
> ```


# Plugin: Form2Content

## Description <a href="#description" id="description"></a>

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

You can also use this plugin to automatically include the newly created elements in an Auto-newsletter.

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

You can download this plugin from our [download area](https://www.acyba.com/acymailing/plugins.html#form2content) then install and publish it like a standard Joomla plugin.

## Plugin <a href="#plugin" id="plugin"></a>

### Single article <a href="#single-article" id="single-article"></a>

![](/files/-MJgL1hiOM4hpw1_IINg)

You can use this interface to browse and insert any article in your Newsletter.

Each item can be selected one by one.

* **Display**: Select the information you want to insert in your newsletter
* **Custom Fields:** Select the custom fields you want to display
* **Clickable Title**: make the title clickable (so linked to your online version) or not.
* **Read more:** Add or not a read more button at the end of the element
* **Display pictures**: You can decide to display or not the pictures in your Newsletter or resize them
* **Truncate the text...:** Truncate the description or not
* **Additional parameters:**
  * **itemid:** You can specify the itemid used in the links on the title and readmore link

### Categories <a href="#categories" id="categories"></a>

![](/files/-MJgL3YNx4Ay7FVkvD3_)

You can select one or several categories and AcyMailing will automatically include the new articles from the selected categories.

* **Display:** You can filter the articles by language
* **Content Type:** You can filter the articles by content type with this option
* **Max. number of items**: The inserted tag will be replaced by a maximum of X articles.
* **Min. number of items**: This option will only be displayed if you access this plugin for a Smart-Newsletter. AcyMailing will only generate your Smart-Newsletter if the minimum number of articles found is reached.
* **Order by**: order the articles by id, title, etc...
* **Columns**: You can decide to display the articles on one or more columns
* **Filter**: This option will only be displayed if you access this plugin for a Smart-Newsletter. You can choose to insert only newly created or modified articles.
* **Additional parameters:**
  * **featured:** If you add |featured in the generated tag, the plugin will insert only featured elements
  * **nofeatured:** If you add |nofeatured in the generated tag, the plugin will insert only non-featured elements
  * **start:** If you add |start:5 in the generated tag, the plugin will insert elements starting by the 5th result
  * **unpublished:** If you add this hidden parameter, Acy will also insert unpublished articles

## Parameters <a href="#parameters" id="parameters"></a>

![](/files/-MJgL5TCLeDN5VWLCAe2)

* **Custom template:** You can create a custom plugin template using this button
* **Display content**: This parameter enables you to filter the list of items in the tag system
  * **All content**: AcyMailing will display all your items
  * **Only published content**: AcyMailing will only display your published items
* **Front-end Access**: You can limit the access to this plugin on the Front-end

## Customize your element template <a href="#customize-your-element-template" id="customize-your-element-template"></a>

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

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

Create the custom template as explained [here](/old/developers/customize-the-way-the-content-inserted-in-emails-by-plugins#custom-template), on the created file you can access to the element $varFields that contains all the needed data.

You can display:

* The article's Id: {reference\_id}
* The article's name: {title}
* The url of your item: {link}
* The custom fields: {cf|My custom field 1} / {cf|My custom field 2} / etc...

Using all those variables, you can create your own template, for example:

```
<div class="acymailing_content"><h2 class="acymailing_title"><a href="{link}" name="form2content-{reference_id}" target="_blank">{title}</a></h2>{introtext}{cf|My custom field 1}<br />My custom field 2: {cf|My custom field 2}<br />My custom field 3: {cf|My custom field 3}{readmore}</div>
```


# Plugin: GMapFP

## Description <a href="#description" id="description"></a>

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

You can also use this plugin to automatically include the newly created elements in an Auto-newsletter.

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

If you own one of our commercial versions, you can download this plugin from our [download area](https://www.acyba.com/acymailing/plugins.html#gmapfp) then install and publish it like a standard Joomla plugin.

The elements will look like this by default, and you can of course [fully customize the way it is displayed](/old/developers/customize-the-way-the-content-inserted-in-emails-by-plugins#custom-template):

![](/files/-MJgLAz9GZ592jZE948w)

## Plugin <a href="#plugin" id="plugin"></a>

### Single article <a href="#single-article" id="single-article"></a>

![](/files/-MJgLCprIruudMa-0Baf)

You can use this interface to browse and insert any item in your Newsletter.

Each item can be selected one by one.

* **Display**: Select the information you want to insert in your newsletter
* **Clickable Title**: make the title clickable (so linked to your online version) or not.
* **Truncate the text...:** Truncate the description or not
* **Display pictures**: You can decide to display or not the pictures in your Newsletter or resize them

### Categories <a href="#categories" id="categories"></a>

![](/files/-MJgLEdXRdrWDgcK9c6c)

You can select one or several categories and AcyMailing will automatically include the new items from the selected categories.

* **Columns**: You can decide to display the items on one or more columns
* **Max. number of items**: The inserted tag will be replaced by a maximum of X items.
* **Min. number of items**: This option will only be displayed if you access this plugin for a Smart-Newsletter. AcyMailing will only generate your Smart-Newsletter if the minimum number of items found is reached.
* **Order by**: order the items by id, title, etc...
* **Filter**: This option will only be displayed if you access this plugin for a Smart-Newsletter. You can choose to insert only newly created items.

## Parameters <a href="#parameters" id="parameters"></a>

![](/files/-MJgLGW16rysHPj3c-Zi)

* **Custom template:** You can create a custom plugin template using this button
* **Display articles**: This parameter enables you to filter the list of items in the tag system
  * **All locations**: AcyMailing will display all your items
  * **Only published locations**: AcyMailing will only display your published items
* **Front-end Access**: You can limit the access to this plugin on the Front-end

## Customize your element template <a href="#customize-your-element-template" id="customize-your-element-template"></a>

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

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

Create the custom template as explained [here](/old/developers/customize-the-way-the-content-inserted-in-emails-by-plugins#custom-template), on the created file you can access to the element $varFields that contains all the needed data.

You can display:

* The item's Id: {id}
* The item's name: {nom}
* The description: {intro}
* The image: {imageHTML}
* The url of your item: {link}

Using all those variables, you can create your own template, for example:

```
<div class="acymailing_content"><h2 class="acymailing_title"><a href="{link}" name="gmapfp-{id}" target="_blank">{nom}</a></h2> {imageHTML}{intro}{address}<br />{contact}<br />{horaires_prix}<br />{readmore}</div>
```


# plugin: JoomBlog

## Description <a href="#description" id="description"></a>

​![Acy JoomBlog logo](/files/-MJgLLlrh8uxuxNjpvBp)This plugin enables you to insert posts (one by one or by a selection on one or several categories) from JoomBlog in your Newsletters.

You can also use this plugin to automatically include your newly created (or modified) posts in an Auto-newsletter.

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

If you purchased at least one commercial version of AcyMailing, you can download the JoomBlog plugin then install and publish it like a standard Joomla plugin.

Here is an example of inserted blog:

![](/files/-MJgLNt-izjoJp0xP9nU)

JoomBlog Example

## Plugin <a href="#plugin" id="plugin"></a>

### Single Post <a href="#single-post" id="single-post"></a>

![](/files/-MJgLPxTsrxPoUwvXmom)

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

Each post can be selected one by one.

* **Display**: select the post information you want to be in the newsletter
* **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 post (so linked to your online version)
* **Display pictures**: you can decide to display or not the post pictures
* **Truncate the text after...**: it will truncate the post text, keep "0" or empty if you do not want to truncate it

### Categories <a href="#categories" id="categories"></a>

![](/files/-MJgLRi2umTzz2TQjawr)

You can select one or several JoomBlog categories and AcyMailing will automatically include the posts belonging to the selected categories.

* **Language**: select a language to filter posts by language or keep the default value if you want to display all posts
* **Blog**: filter the posts by blog or keep "All"
* **Columns**: display the posts in one, two or more columns
* **Order by**: order the posts by ID, title, etc...
* **Max. Number of items**: The inserted tag will be replaced by a maximum of X posts.
* **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 posts found is reached.
* **Filter**: This option will only be displayed if you access this plugin for a Smart-Newsletter. You can set a rule so that only newly created or modified posts are added to your Newsletter.

## Parameters <a href="#parameters" id="parameters"></a>

![](/files/-MJgLU0HjBYxyAexFmiR)

JoomBlog parameters

* **Display posts**: This parameter enables you to filter the list of JoomBlog posts in the tag system
  * **All posts**: AcyMailing will display all your posts
  * **Only published posts**: AcyMailing will only display your published posts

## Customize your JoomBlog post template <a href="#customize-your-joomblog-post-template" id="customize-your-joomblog-post-template"></a>

### Customize your post using some CSS <a href="#customize-your-post-using-some-css" id="customize-your-post-using-some-css"></a>

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 post
> * **Style for the content title** will be applied to your post's 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

![](/files/-MJgLVpkJ5HfgT3Gd5H1)

Set styles template

### Create your own template <a href="#create-your-own-template" id="create-your-own-template"></a>

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

Create a file in the the folder **media** / **com\_acymailing** / **plugins** (if the folder does not exist, please create it first). The folder used to be components / com\_acymailing / templates / plugins in older versions. The name of the file should be **joomblog.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 post information), the element **$tag** (which contains the information of the current tag used in your Newsletter) and **$link** (the post link)

You can insert the post information using this simple syntax : {title}, or {description}

&#x20;Using all those variables, you can create your own post template.

> Here is an example:

> ```
> <div class="acymailing_content"> <a href="<?php echo $link; ?>" name="joomblog-{id}" target="_blank" > <h2 class="acymailing_title">{title}</h2> </a> <a href="<?php echo $link; ?>" target="_blank" style="text-decoration:none" ><img src="{defaultimage}" style="float:left;padding:5px;"/></a>'; ?> {introtext}{description}Author : {username}Hits : {hits}</div>
> ```


# plugin: Joomla! Estate Agency (JEA)

## Description <a href="#description" id="description"></a>

This plugin enables you to insert properties (one by one or by a selection on one or several categories) from Joomla! Estate Agency in your Newsletters.

You can also use this plugin to automatically include your newly created (or modified) properties in an Auto-newsletter.

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

If you purchased at least one paid version of AcyMailing, you can download the JEA plugin on our [plugins section](https://www.acyba.com/download/plugins-modules.html#joomlaestateagency) then install and publish it like a standard Joomla plugin.

&#x20;Your properties will look like this in your newsletter :

![](/files/-MJgLa3Ol70n6STiq76-)

## Plugin <a href="#plugin" id="plugin"></a>

### Single Property <a href="#single-property" id="single-property"></a>

![](/files/-MJgLcL0NkDphbeMa5am)

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

Each property can be selected one by one.

* **Display**: select the information to display with the property
* **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 property (so linked to your online version)
* **Display pictures**: you can decide to display or not the property's main picture.
* **Truncate the text after...**: it will truncate the property description, keep "0" or empty if you do not want to truncate it
* Additional parameters:
  * **Itemid:** you can specify the Itemid used in your property's links

### Categories <a href="#categories" id="categories"></a>

![](/files/-MJgLeNHlyMyCdz0nHdu)

You can refine the address so AcyMAiling will automatically get the properties of a specific location.

* **Department/Town/Area:** Select the location you want, or keep the default value to get all your properties
* **Columns**: display the properties in one, two or more columns
* **Max. Number of items**: The inserted tag will be replaced by a maximum of X properties.
* **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 properties found is reached.
* **Order by**: order the properties by ID, created date, etc...
* **Filter**: This option will only be displayed if you access this plugin for a Smart-Newsletter. You can set a rule so that only newly created or modified properties are added to your Newsletter.
* Additional parameters:
  * **agentid**: Add this manually after inserting your tag to filter the inserted content by agend id (the "created by" information). For example: {autojea:.....|agentid:295}

## Parameters <a href="#parameters" id="parameters"></a>

![](/files/-MJgLirlp32wPUT8VsbG)

* **Display properties**: This parameter enables you to filter the list of JEA properties in the tag system
  * **All properties**: AcyMailing will display all your JEA properties
  * **Only published properties**: AcyMailing will only display your published properties
* **Front-end Access:** You can choose to hide this plugin's tab on the front-end's tag popup

## Customize your JEA property template <a href="#customize-your-jea-property-template" id="customize-your-jea-property-template"></a>

### Customize your property using some CSS <a href="#customize-your-property-using-some-css" id="customize-your-property-using-some-css"></a>

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 property
> * **Style for the content title** will be applied to your property 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

![](/files/-MJgLmgC3yQqGkj9W_Qk)

Set styles template

### Create your own template <a href="#create-your-own-template" id="create-your-own-template"></a>

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

Create a file in the the folder **media** / **com\_acymailing** / **plugins** (if the folder does not exist, please create it first). The name of the file should be **jea.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 product information), the element **$tag** (which contains the information of the current tag used in your Newsletter) and **$link** (the product link)

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

&#x20;Using all those variables, you can create your own product template.

> Here is an example:

> ```
> <div class="acymailing_content"><a href="{link}" target="_blank" ><h2 class="acymailing_title">{title}</h2></a><a href="{link}" target="_blank" style="text-decoration:none" >{imagehtml}</a>{description}location: {addressformated}</div>
> ```


# plugin: K2 items

## Description <a href="#description" id="description"></a>

​![](/files/-MJgLvBx5ib9vAtoX6Nj)This plugin enables you to insert items (one by one or by a selection on one or several categories) from K2 in your Newsletter.

You can also use this plugin to automatically include your newly created (or modified) K2 items in an Auto-newsletter or a Newsletter.

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

You can download the K2 plugin on our [plugin section](https://www.acyba.com/download/plugins-modules.html#k2element) then install and publish it like a standard Joomla plugin.

## Plugin <a href="#plugin" id="plugin"></a>

### Single Item <a href="#single-item" id="single-item"></a>

![](/files/-MJgLxlO1k6P-009brnF)

K2 Item

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

Each item can be selected one by one.

* **Display**: select the part of the content you want to display
  * **Title Only**: only the title
  * **Intro Only**: the title and everything before the "read more" link
  * **Text**: the title and everything after the "read more" link
  * **Full text**: the title and the entire content
* **Display pictures**: when creating a K2 item, you can attach a picture to your item. You can decide to display or not this picture in your Newsletter.
* **Clickable Title**: make your title clickable (so linked to your online version) or not.
* Additional parameters:
  * **notitle** : the tag will be replaced without adding the title Example: {k2:151|type:intro|notitle} will be replaced by the introduction of the content ID 151 without the title
  * **readmore** : This parameter enables you to force AcyMailing to use another "read more" text instead of the default one. This parameter can be very useful if you have a multi-lingual website so you can make sure the read more link will be translated in the right language. Example {k2:151|type:intro|readmore:Click here to read the full story!}
  * **created** : If you add this parameter to your tag, then the article created date will be displayed. Example {k2:151|type:intro|created}
  * **itemid** : AcyMailing will automatically attach your read more link to a menu ID. You can nevertheless force AcyMailing to use the one you want if you specify one via the parameter itemid. Example {k2:151|type:intro|itemid:22}
  * **autologin** : If you add this parameter, AcyMailing will add the username and encrypted password to the article link so if the user clicks on it, he will be automatically logged if you installed the [AutoLogin plugin](http://extensions.joomla.org/extensions/access-a-security/site-access/authentication-cloud-based/10508) for Joomla.
  * **customfields** : If you add this parameter, the K2 custom fields will be displayed in your Newsletter (please update to the latest version of our K2 plugin for that as it has been developed on 2012 April, 20)
  * **excludedcf**: If you chosen to display the custom fields, you can add this other hidden parameter to exclude some custom fields by listing their ID separated by a coma, for example: {k2:228|option1:val1|customfields|excludedcf:12,48}
  * **attachments** : If you add this parameter, the K2 attachments will be added to your Newsletter (please update to the latest version of our K2 plugin for that as it has been developed on 2012 April, 20)
  * **dateformat**: You can add "|dateformat:l, d F Y" in the inserted tag to apply your own format on the displayed dates. The format keys can be found [here](http://php.net/manual/en/function.date.php#refsect1-function.date-parameters).

### Categories <a href="#categories" id="categories"></a>

![](/files/-MJgM2zPqv9bC-b1jYkP)

K2 categories

You can select one or several K2 categories and AcyMailing will automatically include the K2 items belonging to the selected categories.

* **Maximum Number of Articles**: The inserted tag will be replaced by a maximum of X K2 items.
* **Minimum Number of Articles**: 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 K2 items found is reached.
* **Filter**: This option will only be displayed if you access this plugin for a Smart-Newsletter. You can set a rule so that only newly created or modified K2 items are added to your Newsletter.
* Additional parameters:
  * **featured** : If you add this parameter, only articles marked as "featured" will be selected Example: {autok2:151|type:intro|featured}
  * **nofeatured** : If you add this parameter, only articles marked as "not featured" will be selected.
  * **tags** : On top of the categories, you can also filter your K2 articles by tags. Each tag should be separated by a comma. If you insert several tags, only articles containing ALL tags will be selected: Example: {autok2:|tags:sport,tennis} This will select all K2 articles attached to the tags sport AND tennis.
  * **start** : Enables you to skip the first X articles and display only the ones after... Example : {autok2:|start:1} will display all K2 articles except the first one.
  * **access** : If you edit the plugin parameters, you will be able to configure the access level so only public or registered articles will be selected (this option is only available with J1.5). You can overwrite this parameter by entering the access parameter directly in your tag (that will work for all J! version). Enter directly the ID of your access level in the tag using the parameter. Example: {autok2:|access:1} will select only articles set with the access=1

## Parameters <a href="#parameters" id="parameters"></a>

![](/files/-MJgM5Pe-paS8Bx2CEup)

K2 parameters

* **Intro Word Wrapping** : If you insert only the introduction, AcyMailing will insert all the text before the "read more" link. But if you didn't insert the read more link in your K2 Content, AcyMailing will only load the first XX characters of your content. If you specify 0 and you didn't add the "read more" link, AcyMailing won't wrap your content and load the entire article.
* **Display articles**: This parameter enables you to filter the list of K2 items in the tag system
  * **All articles**: AcyMailing will display all your K2 items
  * **Only published articles**: AcyMailing will only display your published K2 items
* **Remove javascript**: This option enables you to remove any javascript code included in your K2 item as the javascript won't work in most of mail clients.
* **Content Access** : This option enables you to determine what kind of K2 item access AcyMailing should include when you include K2 items using the categories feature.
* **Max Picture Height** : AcyMailing can automatically resize your pictures. If so, this maximum height will be used.
* **Max Picture Width** : AcyMailing can automatically resize your pictures. If so, this maximum width will be used.
* **Default Itemid** : If you created a menu attached to K2 articles, you can enter the menu ID in this field so Acy will add it to the read more links in order for the user to be redirected to the right page.

## Customize your K2 item template <a href="#customize-your-k2-item-template" id="customize-your-k2-item-template"></a>

### Customize your item using some CSS <a href="#customize-your-item-using-some-css" id="customize-your-item-using-some-css"></a>

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 K2 item
> * **Style for the content title** will be applied to your content 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

![](/files/-MJgM7OIREDvI5gQmm2H)

Set styles template

### Create your own template <a href="#create-your-own-template" id="create-your-own-template"></a>

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

Create a file in the the folder **media / com\_acymailing / plugins** (if the folder does not exists, please create it first). The folder used to be components/com\_acymailing/templates/plugins in older versions. The name of the file should be **k2element.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 $article (which is the article object loaded from the content table) and the element $tag (which contains the information of the current tag used in your Newsletter) You can also include the information you want using a simple tag, for example {title} will insert $article->title

You can display:

> * the title of your item: {title}
> * the intro of your article: {introtext}
> * the full content of your article: {fulltext}
> * the url of your article: {link}
> * the category name of your article: {cattitle}
> * the category alias of your article: {catalias}

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

> Here is an example:

```
<div class="acymailing_content"><a href="{link}" name="k2content-{id}" target="_blank" ><h2 class="acymailing_title">{title}</h2></a>{imageLink}{introtext}<br/>{fulltext}</div>
```


# Plugin: ListBingo

## Description <a href="#description" id="description"></a>

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

You can also use this plugin to automatically include your newly created (or modified) List Bingo items in an Auto-newsletter or a Newsletter.

You can search in all your List Bingo items and then click on one of the item to include it in your Newsletter.

You can download the List Bingo plugin on our [plugin section](https://www.acyba.com/download/plugins-modules.html) then install and publish it like a standard Joomla plugin.

## Plugin <a href="#plugin" id="plugin"></a>

### Single Item <a href="#single-item" id="single-item"></a>

![](/files/-MJgMGNhUm2PGk23krTS)

You can use this interface to insert any List Bingo item in your Newsletter.

Each item can be selected one by one.

* **Display**: select the part of the content you want to display
  * **Title Only**: only the title
  * **Category view**: the title and everything before the "read more" link
  * **Detail view**: the title and the entire content
* **Display pictures**: when creating a List Bingo item, you can attach a picture to your item. You can decide to display or not this picture in your Newsletter.
* **Clickable Title**: make your title clickable (so linked to your online version) or not.
* **Customs Fields**: If you want to display extra fields you put on List Bingo according to your item category.

### Categories <a href="#categories" id="categories"></a>

![](/files/-MJgMIRdxGdLmDQTJpbB)

You can select one or several List Bingo categories and AcyMailing will automatically include the List Bingo items belonging to the selected categories.

* **Maximum Number of Articles**: The inserted tag will be replaced by a maximum of X List Bingo items.
* **Minimum Number of Articles**: 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 List Bingo items found is reached.
* **Filter**: This option will only be displayed if you access this plugin for a Smart-Newsletter. You can set a rule so that only newly created or modified List Bingo items are added to your Newsletter.

## Parameters <a href="#parameters" id="parameters"></a>

![](/files/-MJgMKeyBkhgZm8uUdGZ)

* **Intro Word Wrapping** : If you insert only the introduction, AcyMailing will insert all the text before the "read more" link. But if you didn't insert the read more link in your List Bingo Content, AcyMailing will only load the first XX characters of your content. If you specify 0 and you didn't add the "read more" link, AcyMailing won't wrap your content and load the entire article.
* **Display articles**: This parameter enables you to filter the list of List Bingo items in the tag system
  * **All articles**: AcyMailing will display all your List Bingo items
  * **Only published articles**: AcyMailing will only display your published List Bingo items
* **Remove javascript**: This option enables you to remove any javascript code included in your List Bingo item as the javascript won't work in most of mail clients.
* **Content Access** : This option enables you to determine what kind of List Bingo item access AcyMailing should include when you include List Bingo items using the categories feature.
* **Max picture height / Max picture width** : In case of you selected the resized option, AcyMailing will resize your pictures following the specified max height / width.
* **Menu ID** : ID of the menu attached to the List Bingo component.

## Customize your List Bingo item template <a href="#customize-your-list-bingo-item-template" id="customize-your-list-bingo-item-template"></a>

### Customize your item using some CSS <a href="#customize-your-item-using-some-css" id="customize-your-item-using-some-css"></a>

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 List Bingo item
> * **Style for the content title** will be applied to your content 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

![](/files/-MJgMMPdfHQV6xJfk6IY)

Set styles template

### Create your own template <a href="#create-your-own-template" id="create-your-own-template"></a>

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

Create a file in the the folder **media / com\_acymailing / plugins** (if the folder does not exists, please create it first). The folder used to be components/com\_acymailing/templates/plugins in older versions. The name of the file should be **listbingo.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 $article (which is the article object loaded from the content table) and the element $tag (which contains the information of the current tag used in your Newsletter)

You can display:

> * the title of your item: $article->ads\_title
> * the intro of your article: $article->ads\_description
> * the full content of your article: $article->fulltext
> * the url of your article: $link
> * the price of your item : $article->pricetype & $article->currencycode

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




---

[Next Page](/llms-full.txt/1)