TF Mail Documentation

This documentation guides you on how to use TF Mail Joomla extension for Joomla. This extension is used for email marketing and automation with Joomla websites.

1. Users

User Subscribe: Users can be subscribed through Joomla module, menu link or back-end. If user already exists or unsubscribed, the profile of the user is updated. The user will also be subscribed to campaigns (if not already joined).

User Unsubscribe: When a user unsubscribes, the user is marked unsubscribed, any emails in the queue are deleted, and any campaigns user is subscribed to are deleted.

2. Mails / Newsletters

Click "New" to create a newsletter. Title is the subject of the email and description is the body of the email.

Type of Emails

  1. Newsletter: It is simple email you can send one time.
  2. Campaign: These can be used by campaigns.
  3. Automation: It is automated email than can be sent repeatedly at a given frequency.
  4. Distribution: These emails are generated by email distribution system. You are not required to select this.
  5. Other: These emails can be used by other components.

Attachment: Optionally, select a file to attach with the email. You can specify the folder in the configuration.

Text Message: If left empty, it will be automatically generated.

Users: By default, the newsletter will be sent to all your users. You can add filters here to send the newsletter to specific users.

Sending Options: Here, you can set the send date, priority, and frequency (for automation type) of the newsletter. You can schedule the newsletter at a later date to be automatically sent by cron job. 

You can use following tags in the title or subject of email:

  • {NAME}
  • {EMAIL}
  • {DATE}

You use following tags in the description or body of email:

  • {MODIFY}
  • {UNSUB}
  • {USER}
  • {DATE}
  • {TOC}

How to Insert Joomla Article (JA)?

{JA <joomla_article_id> <I or F> <Y or N>}

  • I if for intro text with Read More link; F is for full text
  • Y for adding full text image; N for not adding any image

For example: {JA 26 I Y} will insert intro text of Joomla article with ID 26 with image.

How to Insert User Information?

{USER <field_name>}

For example, {USER name} will insert name of the user. {USER email} will insert email of the user. Similarly, you can use any field.

3. Queue

When you send any mail or newsletter, it is added to the queue. Click on 'Process' button to send newsletters in the queue to your subscribers. You can automate this using cron job. You can also set the number of emails to send at one time in the configuration.

How Queue Works?

  1. It gets an email and user from the queue based on the priority, send date, and user id.
  2. It send the email to the user.
  3. If the mail is sent, then it deletes the mail from the queue and adds to the statistics.

How Send Process Works?

  1. It gets "from details" (name and email) from the component configuration or global configuration.
  2. It gets "reply to" and "return path" emails from the component configuration.
  3. It gets recipient from the user details.
  4. It prepares the subject and body of email before sending (Pre-Send Process).
  5. It adds any attachment to the email and list unsubscribe header.
  6. It sets html email, encoding and charset.
  7. Finally, the mail is sent to the user!

How Pre Send Works?

  1. If the text version of email is empty, then it sets the text version.
  2. It adds footer to mail body from the configuration.
  3. It replaces name, email and date tags in the subject.
  4. It replaces certain tags in the mail body.
  5. It convert relative URLs to Absolute URLs
  6. It add utm parameters to the links
  7. It adds code to track email opens
  8. It replaces any characters in the body
  9. It adds html tag

4. Campaigns

Campaigns are series of newsletters that can be sent manually or automatically when a user subscribes or modifies profile. Before creating a campaign, you need to add one or more newsletters of the type "Campaign".

Title and Description are displayed on the frontend in the campaigns list.

Newsletters: Add the newsletters along with the delay (in days). For example, for the first newsletter, you can set 0 to send immediately, then 3 to send after 3 days of user subscription, and so on.

Users: By default, the campaigns are sent to all your users. You can add filters here to send the campaigns to specific users.

Sending Options: Here, you can set the priority, and whether to trigger the campaign on user subscription or modification or both.

Subscribers: Here, you can see users subscribed to the campaign. Once subscribed, a user cannot be subscribed again. This is to prevent sending repeat emails. You can also delete all subscriptions for the campaign.

5. Automation

Creates newsletters automatically based on the set frequency. You can insert Joomla articles in the newsletters. Settings are available in the configuration.

Joomla Category: {JC 13 3} - This will insert introduction text of 2 articles from category with ID 13.

6. Distributions

The distribution system can read any email inbox and then create the newsletter automatically.

7. Statistics

This screen lists all the newsletters sent, along with tracking opens.

8. Bounces

You can automatically mark the users disabled using Bounce Handling feature. In the configuration, add the return path email where you want to get bounce emails. Then under the Bounces tab, enter the mail server, username, and password of this email address.

Now, click "Bounce Handling".

9. Links

You can add same links to multiple emails.

10. Configuration

Self explanatory

11. Email Sending Process

There are various steps and processes before the extension sends email to the subscribers. You can configure these in the component configuration.

  1. Set from details (name and email) from the component configuration or global configuration
  2. Set reply-to-email and return path from the component configuration
  3. Set recipient email (user or subscriber's email)
  4. Prepare email subject from the saved newsletter subject
    1. Replace formats in the email subject - Name, Email and Date
  5. Prepare email body from the saved newsletter body
    1. Add footer to email body from the configuration
    2. Replace formats in the email body - Unsubscribe Link, Profile Modify Link, Custom Link, User Information, Date, Joomla Articles, table of Contents
    3. Convert Relative URLs to Absolute URLs for anchors and images
    4. Add UTM parameters
    5. Add code to track email opens
    6. Replace texts defined in the configuration
    7. Add html tag
  6. Add attachments to email
  7. Add List-Unsubscribe Header
  8. Set html, encoding, charset
Star InactiveStar InactiveStar InactiveStar InactiveStar Inactive