How it works¶

Lime Newsletter uses the following limetypes:

Name	Optional	Description
Mailing	No	The main type which contains the subject, sendout link, statistic link and relations to recipients etc.
Mailing Recipient	No	Consists of the relation to the Related limetype for the recipient of the email (person, company etc). This is where the statistics like linkclicks, openings and other recipient statuses are displayed. A mailing recipient will also contain the relation to the marketing activity participant
Marketing Activity (Campaign)	No*	Acts as a "parent" to one or more mailings, the participants of the campaign will be transformed into mailing recipients. This is where consent types are defined if consents are used.
Participant	No*	Used for connecting a Related limetype to a mailing recipient.
Consent type	Yes	A consent type can be used to control whether a recipient should receive an email or not. Every recipient needs to have an approved consent for this type to get the email.
Consent	Yes	An approved consent of the specified type is required to be added to the Related limetype connected to the campaign participant if the campaign has a consent type specified.
Link click	Yes	Whenever a recipient clicks a link in a sent email a linkclick will be created which contains more details about the clicked link.
Email opening	Yes	When a recipient opens a sent email an email opening will be created which contains details about the opened email.

Info

* Lime Newsletter can be used without Marketing Activities and Participants if you do not need to use Consent and Consent Types

Usage¶

There are three different flows for initiating email sendouts with lime-newsletter:

Sending to the participants of a Marketing ActivitySending to limeobjects matching a filterUsing the "Create Mailing" action

The Marketing Activity flow should be used if you are going to use Consent Types and Consents to handle your recipients

Organizing your email send-outs¶

You can send different kinds of emails (e.g newsletters, product information and agreement renewals). In order to distinguish between them in Lime CRM you should have one consent type for each kind of email activity.

You can then map a consent type to one or more publications in Lime Marketing. So if you have a consent type called "product information" in Lime CRM, you can map that to the publications "Product A customers" and "Product B customers".

1. Create a Marketing Activity¶

Start out by creating a new Marketing Activity in Lime CRM and set the campaign type to "Mailing". Remember to select which consent type to use.

create-campaign

Add participants to the campaign, by default the person limetype is configured to be the "Related limetype" for participants and recipients but this can be configured in Lime Admin. Make sure that your participants have an approved consent for the consent type connected to the campaign.

2. Design your email¶

Create a new mailmessage in your publication in Lime Marketing.

create-mailmessage

Use an existing template and adjust the content using the editor

design-mailmessage

Object content¶

If you want to fetch data from Lime CRM into the content of a newsletter you can use the objectcontent integration. You can insert any data from a lime object as long as it's accessible from a lime-query.

objectcontent-config

First you need to configure the addon configuration in Lime Admin according to the instructions here. Then you create a content block in Lime Marketing by going to Archive -> Content blocks. Create a new content block and make sure to include the queryname from your configuration. Read more about object content here

Finally you insert the content block into the editor and search for your matching lime objects.

objectcontent-editor

You will be able to preview the data before inserting it in the mail content. Possible errors will also be displayed in this state.

objectcontent-validation-error

In your email content you will now see the Lime CRM data. You can style how the data is displayed with the help of Vue, HTML and CSS.

objectcontent-content

When you are satisfied with your content go to the "Recipients" tab in the editor.

3. Fetch recipients¶

Click the "Add recipient lists" button. A dialog will open where you can select your Lime CRM integration.

To use your Marketing Activity as the recipient list you will find it by scrolling the list or searching for the name: select-marketing-activity

When you have selected your Marketing Activity you click "Add selected lists"

View the import result¶

After importing your list from Lime CRM (applies for both campaigns and filters) you will see an overview of the imported data. This summary contains the number of imported recipients, as well as clickable lists of all email addresses that were not imported and the reason for them not being imported.

import-result

Info

If you are using the "Not sent due to..." feature, recipients on the: bounce, opt-out, total opt-out and shared blocklist will be imported here but they will not receive the email.

Invalid and duplicate addresses will always be removed.

4. Send¶

After adding recipients, head over to the "Send" tab in the editor where you can choose to send the email immediately or schedule it. When the email is sent, a mailing and a list of recipients will be created in Lime CRM. The mailing will get the status "sent" and statistics will be added to the recipients as they open and click links in the message.

5. Follow up on statistics¶

For each mailing that is sent to a marketing activity a record is created in the Mailing tab in Lime CRM. A mailing could look something like this:

campaign-mailings

Opening the mailing card will show you the Subject, Send time, Sendout link and Statistics link on the overview tab

sent-mailing

All mailing recipients will appear in the recipients tab and a status field will display the sendout status of the recipient.

mailing-recipients

Bounces¶

When Newsletter encounters problems sending email to an address, the recipient will receive the Bounced status. If the problem is permanent (e.g the email address no longer exists) the Email hard bounce field will be updated on the person in Lime CRM if it has been configured.

person_bounce

Not sent status¶

If a recipient did not receive the mailing it might be because they have previously bounced, opted-out or is on the shared blocklist. For these cases you will be able to see the reason why the mailmessage was not sent to the recipient.

not_sent_due_to

If the "not-sent" reason is either not sent due to previous bounce or not sent due to address being blocked the Email hard bounce field will be updated on the related person of the recipient.

Link clicks¶

If the recipient clicks a link in the email a Link click card will be created in Lime connected to the Mailing and configured recipient (e.g. Person or Company). It is then possible to get a simple overview of all link clicks for your mailing or for a specific person. A link click contains information about the click like URL, name and click-time. It is also possible to add a value and category to your link.

linkclicks

Mail openings¶

When an email is opened by a recipient and the emailopeningenabled field in the configuration is set to True a Mail opening will be added to the Mailing and the Person connected to the recipient. The mail opening contains a timestamp of the opening.

mailopenings

Opt in and out¶

The integration handles opt-in and opt-out events coming from Lime Marketing by using consents in Lime. If the consenttype mapping is set up, the consents will control who is transferred to Lime Marketing when importing recipients to an email. Only approved consents for the marketing activity's specified consent type will be synced. Otherwise all participants from the marketing activity in Lime will be synced.

The following rules apply to opt-in:

If a person opts in to a publication configured in consenttype mappings those consents are updated/created and approved is checked.
If an unknown email opts in to a publication configured in optinsettings - a limeobject of your choice is created. If this feature is not active, an event will be published to the Lime CRM event queue containing the opt-in information.

And these are the rules for opt-out:

If person.totaloptout is checked - that person is not transferred to Lime Marketing.
If marketing activity.consenttype is set - only persons with an approved consent of that type is transferred to Lime Marketing and any opt-out data in Lime Marketing is removed for those persons. Lime is the master of consents.
If a person opts out from a publication configured in consenttypemappings - that/those consents are updated/created and approved is unchecked.
If a person opts out from a publication not configured in consenttypemappings but the marketing activity is using a consenttype - that consent is updated/created and approved is unchecked.
If a person does a total opt out in Lime Marketing, all the configured consenttypes are updated/created and approved is unchecked - person.totalopout is also set if that exists.

The Filter flow allows you to quickly send a mailing to everyone who matches a filter in Lime CRM without having to manually import the objects to a Marketing Activity first.