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 |
subject
this is the subject line. It can contain the placeholders:
IDXEMAIL_NAME
The name of the INTERDBUS segment that you can set via configuration
This parameter is being replaced AFTER you reviewed the email text.
IDXEMAIL_USER
The user name for the login. This is called historically called IDXEMAIL_USER. You can also can use:
IDXEMAIL_LOGIN
this 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.
IDXEMAIL_FOLDER
The folder that the content is in that you send the email for.
email body
The email body can contain the same keywords than the subject line. Additionally it can use the following parameters:
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
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 in the folder that the email is sent about
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_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.
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. Footer information CAN improve handling by some spam filters. Unfortunately they can also have the adverse effect on others.
You can add your company address and contact info here. It will be added to the email you send out.
There used to be an INTERDUBS wide footer before July 22, 2009. Since this collided with some spam filters it has been removed. Should there be one again then clients can disable it by configuring this setting as empty in their segment.
