Email template

From Wikanual

INTERDUBS makes it very easy to send email notifications to your clients. The content of the email message can always be altered just before it gets send. It also is possible to change the defaults for these messages. Aside from this reference documentation there is also a page that explains how to change the email template.

Mail contents are controlled via the configuration variables subject and email body. The look and feel of Html_email is controlled by additional keywords.

Contents 1 subject and mail body 1.1 IDXEMAIL_NAME 1.2 IDXEMAIL_USER 1.3 IDXEMAIL_LOGIN 1.4 IDXEMAIL_PATH 1.5 IDXEMAIL_FOLDER 1.6 IDXEMAIL_PARENTFOLDER 1.7 IDXEMAIL_TOPFOLDER 2 email body 2.1 IDXEMAIL_ALLRECIPIENTS 2.2 IDXEMAIL_URL 2.3 IDXEMAIL_PASSWORD 2.4 IDXEMAIL_LINK 2.5 IDXEMAIL_XML 2.6 IDXEMAIL_FILES 2.7 IDXEMAIL_RFILES 2.8 IDXEMAIL_JOBNAME 2.9 IDXEMAIL_FROM 2.10 IDXEMAIL_DISPLAYFROM 2.11 IDXEMAIL_REPLYTO 2.12 IDXEMAIL_TO 2.13 IDXEMAIL_DISPLAYTO 2.14 IDXEMAIL_FOOTER 2.15 IDXEMAIL_FIRSTNAME 2.16 IDXDROPIFHIDEPARENT 3 html email body 3.1 Links 3.2 _LINK_START_WILL_BE_HERE_ 3.3 _LINK_END_WILL_BE_HERE_ 4 Appended Information 4.1 Company Email Footer 4.2 INTERDUBS email footer

subject and mail body

The email subject line can contain the following placeholders. They are also valid in the email body:

IDXEMAIL_NAME

The name of the INTERDBUS segment. You can set this via configuration. It usually also appears in the title of the browser.

IDXEMAIL_USER

The user name for the login. This is called historically called IDXEMAIL_USER. You can also can use:

IDXEMAIL_LOGIN

which is the same as the IDXEMAIL_USER

IDXEMAIL_PATH

The path of the folder that you send the email for. The path elements are being separated with a space. Other format would be possible. Please get in touch you would need this to be different.

IDXEMAIL_FOLDER

The name of the folder that you send the email for.

IDXEMAIL_PARENTFOLDER

The name of the folder that contains the folder that you send the email for.

If you have your content in a folder:

/foo/bar/example

Then

IDXEMAIL_FOLDER shows example

and

IDXEMAIL_PARENTFOLDER shows bar

IDXEMAIL_TOPFOLDER

The name of the top most folder in the hierarchy:

In the example

/foo/bar/example

IDXEMAIL_TOPFOLDER

will show

foo

email body

The email body can contain the same keywords than the subject line. Additionally it can use the following parameters:

IDXEMAIL_ALLRECIPIENTS

This optional keyword will get replaced by a text indicating who received the email. Should you email to

[email protected]
[email protected]

then this would get replaced by

This link has been sent to [email protected],[email protected]

When an email is being sent to only one person then no text will be displayed.

If this keyword is not present and an email is being sent to multiple people the system will add the text

emails were sent to: [email protected],[email protected]

in the end of the email text.

IDXEMAIL_URL

The url of the login screen. When people should sign in via user name and password then this would be the right link.

IDXEMAIL_PASSWORD

The password for the login

IDXEMAIL_LINK

A direct link to bypass the log in procedure. Clients will be directed straight to the content. For html email there are also the _LINK_START_WILL_BE_HERE_ and _LINK_END_WILL_BE_HERE_ keywords. See below for details.

IDXEMAIL_XML

This will points to the rss feed for this login.

IDXEMAIL_FILES

The list of files and folders directly in the folder that the email is sent about

IDXEMAIL_RFILES

The list of all files and sub folders inside the folder that the email is sent about. This lists all files in folders as well.

IDXEMAIL_JOBNAME

The name of the job that the login is contained in. An empty string if the login is not assigned to a job.

IDXEMAIL_FROM

The From email address. This is usually the segment name @interdubs.com to appease spam filters. Your email address is usually set as the Reply To (see below address). The settings of From and ReplyTo can be set in the mail form.

IDXEMAIL_DISPLAYFROM

The name displayed of the email address. Usually the first and last name.

IDXEMAIL_REPLYTO

The ReplyTo email. Which is usually the email configured for the login.

IDXEMAIL_TO

The email that you send the email to.

This parameter is being replaced AFTER you reviewed the email text.

IDXEMAIL_DISPLAYTO

The displayed name of the email recipient.

This parameter is being replaced AFTER you reviewed the email text.

IDXEMAIL_FOOTER

The default behavior is that INTERDUBS will append the content of the two configurations

company email footer

and then the

interdubs email footer

Currently the second one is empty. System announcements could appear here. Setting it to empty will mute it.

If you a keyword IDXEMAIL_FOOTER in your email template then INTERDUBS will place the footers where the keyword is instead of the end. This works for the email text as well as for the HTML email template.

IDXEMAIL_FIRSTNAME

The first name of the email recipient. Derived from the display name of the email.

This parameter is being replaced AFTER you reviewed the email text.

IDXDROPIFHIDEPARENT

If you start a link with the keyword

IDXDROPIFHIDEPARENT

then this line will only be displayed if the setting

hide link to partent folder

is disabled.

html email body

INTERDUBS also allows to send out html email. The actual framework of the email can be configured via the HTML email body configuration. The text will appear where this configurations contains the IDXHTMLEMAIL_BODY keyword. HTML email also allow the use additional keywords that allow for more specific formatting. The colors for text, background and links are being derived from the three respective configuration parameters.

Links

Text that starts with http:// or https:// in an HTML email will be considered to a link. The so called anchor text (the words that you click on) will be the actual link by default. This is informative, similar to text email but also not as pretty as it can be.

_LINK_START_WILL_BE_HERE_

In the text template you can use the _LINK_START_WILL_BE_HERE_ to designate where the direct link to the content will start. The link color comes from the configuration paramater. This keyword is visible in clear text in the text template. It will be replaced after the the email editor has been closed and before the email will be sent out.

_LINK_END_WILL_BE_HERE_

The keyword _LINK_END_WILL_BE_HERE_ will end the link, but behaves otherwise the same than _LINK_START_WILL_BE_HERE_.

Appended Information

INTERDUBS can add footer information to the email. Please note that this information will not be displayed in step2 of the email process. Also have a look at IDXEMAIL_FOOTER on this page for ways how to locate the HTML footer not in the end of the file.

Company Email Footer

You can add your company address and contact info here. It will be added to the email you send out.

INTERDUBS email footer

There used to be an INTERDUBS wide footer before July 22, 2009. It has been removed. Should there be one again, then clients can disable it by configuring this setting as empty for their segment.