Access to the e-mailing or LeadPage object

eMailing-/LeadPage template

In an eMailing/LeadPage template, you access the eMailing- or LeadPage object via THIS:

THIS

Article template

From an article you can access the eMailing- or LeadPage object with getNewsletter or getFullNewsletter respectively.

THIS/getNewsletterTHIS/getNewsletter/getFullNewsletter

See also:

• Articles:getNewsletter

eMailing- and LeadPage functions

The e-mailing or LeadPage object provides a range of functions:

getCategoryId

Returns the ID of the system folder where the current e-mail or lead page is located.

THIS/getCategoryId

<div tal:content="THIS/getCategoryId">&nbsp;</div>

<div>1667869/div>

getCategoryContent

Returns the objects that are located in a given system folder.

THIS/getCategoryContent/<sorting>/<id>

<div tal:repeat="object THIS/getCategoryContent/byDescription/1667869" tal:content="object/getDescription">&nbsp;</div>

<div>name article 1</div> <div>name
article 2</div> <div>name article 3</div>
<div>name SVG-graphic 1</div> <div> name
eMailing 1</div>

getCurrentUser

Returns the profile of the recipient or the identified profile.

THIS/getCurrentUser

<div tal:content="THIS/getCurrentUser/getValues/NAME">&nbsp;</div>

<div>Sampleman/div>

getSubjectForCurrentUser

Returns the individualized subject for the current recipient.

THIS/getSubjectForCurrentUser

<div tal:content="THIS/getSubjectForCurrentUser">&nbsp;</div>

<Subject for Mr Max Mustermann

getMandatorId

Returns the client ID.

THIS/getMandatorId

<div tal:content="THIS/getMandatorId">&nbsp;</div>

<div>13683/div>

compareMandatorId

Specifies whether the current TAL script is executed in a given client. For example, if a global e-mail is sent from a local client, getMandatorId returns the ID of the global client.

THIS/getApi/getOwnershipAccessor/compareMandatorId/<id>

<div tal:condition="THIS/getApi/getOwnershipAccessor/compareMandatorId/123456">Script is executed in the searched client</div> <div tal:
condition="not:THIS/getApi/getOwnershipAccessor/compareMandatorId/123456">Script is not executed in the searched client</div>

<div>Script will be executed in the searched client</div>

<div>Script is not executed in the client you are looking for</div>

getContainer

Returns the container with the specified ID.

THIS/getContainer/<id>

<div tal:content="THIS/getContainer/23099936/getAttributeByName/READMORE">&nbsp;</div>

<div>read more

getSmartlink

Returns the Smartlink with the specified ID.

THIS/getSmartlink/<id>

<a tal:repeat="link THIS/getSmartlink/23236717/getLinklist/getLinks" tal:content="link/getText" tal:attributes="href link/getLink" href="#">&nbsp;</a>

<a href="https://scnem.com/slt.php?t=nozc8o.29sf3nf">Example link 1</a> <a href=
"https://scnem.com/slt.php?t=nozce2.2nmrjj8">Example link 2</a> <a href=
"https://scnem.com/slt.php?t=nozce3.9qrr0g">Example link 3</a>

getCurrentDate

Returns the current date.

THIS/getCurrentDate

<div tal:content="THIS/getCurrentDate">&nbsp;</div>

<div>11.10.2019</div>

getNewsletterDate

Returns the date of the last processing of the current eMail or LeadPage.

THIS/getNewsletterDate

<div tal:content="THIS/getNewsletterDate">&nbsp;</div>

<div>11.10.2019</div>

getHTMLAreas

Returns the desired HTML field of the current eMail or LeadPage.

THIS/getHTMLAreas/<n>

<div tal:content="structure THIS/getHTMLAreas/0">&nbsp;</div>

<div><span>content from HTML field 0</span></div>

getInputFields

Returns the desired input field of the current eMail or LeadPage.

THIS/getInputFields/<n>

<div tal:content="THIS/getInputFields/0">&nbsp;</div>

<div>content from input field field 0</div>

getTextAreas

Returns the desired text field of the current emailing or lead page.

THIS/getTextAreas/<n>

<div tal:content="structure quotenltobr:THIS/getTextAreas/0">&nbsp;</div>

<div>content from text field 0.<br /> even more
content from text field 0.</div>

getContentContainer

Returns the content container from the template of the current e-mailing or lead page.

THIS/getContentContainer

<div tal:content="THIS/getContentContainer/getAttributeByName/READMORE">&nbsp;</div>

<div>multi-read

hasArticleInAnySlot

Indicates whether an article is contained in any slot of the current e-mail or LeadPage.

THIS/hasArticleInAnySlot

<div>articles are available</div>

<eMailing or LeadPage is empty

getFilledSlots

Returns all slots of the current eMail or LeadPage that contain articles.

THIS/getFilledSlots

<div tal:repeat="slot THIS/getFilledSlots" tal:content="slot/countArticles">&nbsp;</div>

<div>4/div> div> div>6/div>

hasSelectedArticle

Indicates whether the current e-mail or the LeadPage was called with an article. This is the case if the landing page of the template is called up.

THIS/hasSelectedArticle

<div tal:condition="THIS/hasSelectedArticle">article is selected</div> <div tal:
condition="not:THIS/hasSelectedArticle">article is not selected</div>

<div>article is selected</div>

<div>article is not selected</div>

getSelectedArticle

Returns the selected article if the landing page of the current eMailing or lead page was called.

THIS/getSelectedArticle

<div tal:content="THIS/getSelectedArticle/getHeadline">&nbsp;</div>

<div>heading article 1</div>

hasSlot

Specifies whether the slot you are looking for is available in the current e-mail or the lead page.

THIS/hasSlot<n>

<div tal:condition="THIS/hasSlot0">Slot 0 is present</div> <div tal:
condition="not:THIS/hasSlot0">Slot 0 is not present</div>

<div>slot 0 is present</div>

<div>Slot 0 is not available</div>

getSlot

Delivers the slot you are looking for.

THIS/getSlot<n>

<div tal:content="THIS/getSlot0/countArticles">&nbsp;</div>

<div>4/div>

hasSlots

Specifies whether any slot exists in the current e-mail or the LeadPage.

THIS/hasSlots

<div tal:condition="THIS/hasSlots">Slots are available</div> <div tal:
condition="not:THIS/hasSlots">Slots are not available</div>

<div>Slots are available</div>

<div>Slots are not available</div>

getSlots

Delivers the slot you are looking for.

THIS/getSlots/<n>

<div tal:content="THIS/getSlots/0/countArticles">&nbsp;</div>

<div>4/div>

countSlots

Returns the number of slots in the current e-mail or lead page.

THIS/countSlots

<div tal:content="THIS/countSlots">&nbsp;</div>

<div>1/div>

getBrowser

Returns the browser with which the current e-mail or lead page is displayed.

THIS/getBrowser

<div tal:content="THIS/getBrowser/getName">&nbsp;</div>

<div>chrome/div>

isAnyHTMLMode

Specifies whether the current e-mail or LeadPage is displayed in any HTML-based mode.

THIS/isAnyHTMLMode

<div>HTML view/div>

<div>no HTML view/div>

isAppendMode

Indicates whether the current e-mail or lead page is currently displayed in the visual editor.

THIS/isAppendMode

<div>view in the visual editor</div>

<div>view not in visual editor</div>

isEmailMode

Specifies whether the current e-mail or the LeadPage is output in an e-mail.

THIS/isEmailMode

<div>Output in e-mailing div>/div>

<div> no output to e-mailing div>/div>

isFacebookMode

Indicates whether the current e-mail or the LeadPage is displayed on Facebook.

THIS/isFacebookMode

<div>advertisement on Facebook/div>

<div>Don't display on Facebook/div>

isLPMode

Specifies whether the current e-mail or the LeadPage is displayed on a landing page.

THIS/isLP mode

<div>display on landing page/div> 

<div>Display not on landing page</div> 

getIsPdfMode

Indicates whether the current e-mail or lead page is currently displayed as PDF.

THIS/getIsPdfMode

<div>Display as PDF</div>

<div>Display not as PDF</div>

isSocialMode

Indicates whether the current e-mail or the LeadPage is displayed in a social network.

THIS/isSocialMode

<div>advertisement in social network/div>

<div>advertisement not in social network/div>

isTextMode

Specifies whether the current e-mail or the LeadPage is displayed in a plain text e-mail.

THIS/isTextMode

<div>display in text-only e-mail</div>

<div>Display not in text-only email/div>

isWebMode

Specifies whether the current e-mail or the LeadPage is displayed in a browser.

THIS/isWebMode

<div>display in browser/div>

<div>Display not in browser</div>

getExternalXml

Returns the XML object that was stored in the eMailing/LeadPage configuration.

THIS/getExternalXml

<div tal:content="THIS/getExternalXml/SomeNode">&nbsp;</div>

<Contents of a node

hasExternalXML

Checks if there is an XML object stored in the eMailing/LeadPage configuration.

THIS/hasExternalXml

<div tal:condition="THIS/hasExternalXML">&nbsp;

<div tal:content="THIS/getExternalXml/SomeNode">&nbsp;

<Contents of a node

Slot functions

The slot object itself provides a number of functions:

hasArticles

Indicates whether the current slot contains an article.

<slot>/hasArticles

<div tal:condition="THIS/getSlots/0/hasArticles">Slot 0 contains articles</div> <div tal:
condition="not:THIS/getSlots/0/hasArticles">Slot 0 is empty</div>

<div>slot 0 contains article</div>

<div>slot 0 is empty</div>

getArticles

Returns the articles of the current slot.

<slot>/getArticles

<div tal:repeat="articleRef THIS/getSlots/0/getArticles" tal:content="articleRef/getArticle/getHeadline">&nbsp;</div>

<Heading Article 1/div> Heading
Article 2/div> Heading Article 2/div> Heading
Article 3/div> Heading Article 4/div> Heading Article 4/div>

hasOneArticle

Specifies whether the current slot has exactly one

<slot>/hasOneArticle

<div>A article/div>

<div>more or less than one article div>

hasMoreThanOneArticle

Specifies whether the current slot contains more than one article.

<slot>/hasMoreThanOneArticle

<div>More than one article div>

<div>one or no article

countArticles

Returns the number of items in the current slot.

<slot>/countArticles

<div tal:content="THIS/getSlots/0/countArticles">&nbsp;</div>

<div>4/div>

getArticlesInTwoColumns

Returns the articles of the current slot in a 2-column list.

<slot>/getArticlesInTwoColumns

 <table> <tbody>
<tr tal
:repeat="column THIS/getSlots/0/getArticlesInTwoColumns"> <td tal:
repeat="article column" tal:content="article/getArticle/getHeadline">&nbsp;</td> </tr> </tbody> </table> 

<table> <tbody>
<tr> <td>heading

article 1</td> <td>heading article
2</td> </tr>

   <Heading
Article 3 Heading
Article
4 Heading
Article 4 

getArticlesInColumns

Returns the articles of the current slot in a multi-column list.

<slot>/getArticlesInColumns/<n>

<table> <tbody>
<tr tal:
repeat="row THIS/getSlots/0/getArticlesInColumns/3"> <td tal:
repeat="article row" tal:content="article/getArticle/getHeadline">&nbsp;</td> </tr> </tbody> </table> 

<table> <tbody>
<tr> <td>heading

article 1</td> <td>heading article
2</td> <td>heading article 3</td> </tr>


   <Heading
Article 4 Head ing
Article
5 Heading Article


6 Heading Article
6 

renderWithTemplate

Is provided by the article reference object and returns the HTML of an article, based on the specified article template.

<article>/renderWithTemplate/<id>

<div tal:content="structure THIS/getSlots/0/getArticles/0/renderWithTemplate/23168342">&nbsp;</div>

<Div div div div div h1 headline article 1 h1 p...