How to create an e-mail signature?

 

pdf Download this document as PDF

 

Here you will find instructions for running the software Covum Mailsignatur.

  1. How the software works – a general description
    1. Which prerequisites are needed?
    2. Which parameters are there?
    3. Which files I have to edit?
  2. Installation, licensing and configuration
    1. Download and installation
    2. Including the license file
    3. Configuration
      1. Configuration of Users.xml
      2. Configuration of Static.xml
      3. Structure and syntax of the template file
  3. Create new templates
  4. Configuration as single-user solution with the XML file
  5. Configuration as network solution
  6. Graphical editor for Static.xml and Users.xml
    1. Fileoperations: parallel opening of Users.xml and Static.xml (list mode)
    2. Fileoperations: separate opening of Users.xml or Static.xml (file mode)
    3. Saving
    4. Editing of Users.xml
    5. Editing of Static.xml
    6. Test run

1. How the software works – a general description

Covum Mailsignatur generates centrally Microsoft Outlook signatures for all your employees.

1.1. Which prerequisites are needed?

  1. Windows 2000 upwards: Covum Mailsignatur works with Windows Version 2000 upwards.
  2. .Net Framework Version 2.0 upwards: Ensure that Microsoft .Net Framework 2.0 is installed on all computers which use Covum Mailsignatur.
    Therefore, you click on Start -> Settings -> System control -> Software.
    You should have an entry “Microsoft .Net Framework 2.0” in the list. If there is no entry, the required .Net Framework version on the Microsoft website can be downloaded and installed free of charge.
  3. Microsoft Outlook 2000 upwards: Guarantee that you use Microsoft Outlook Version 2000 upwards.
    Click on the question mark (?) on the right side of the upper menu bar in your Microsoft Outlook mask and then on “Info about Microsoft Outlook”. The entry Microsoft Outlook 2000 or 2003 must be visible in the list.

1.2. Which parameters are there?

Software will get started with the following parameters:

 

CovumMailsignatur.exe [ini file]

You can specify a path and filename as [ini file]. By default the “CovumMailsignatur.ini” in the directory “Templates” is used.

1.3. Which files I have to edit?

Covum Mailsignatur has 3 configuration files:

  1. Users.xml: If you want to provide a standardized signature to all your employees without using Windows Active Directory,
    you have to use this file.
    It is an XML file, wherein you can define new elements inside the tag <user>. Here dynamic user data can be administrated. Dynamic data are
    user information that are different for every user, such like last name, first name, telephon number, e-mail.
  2. In Static.xml you can manage statical data, that are equal for all users, such like disclaimer, name of chairman, trade register. Use this file if you want to generate several signatures, e.g. in different languages or with different disclaimer.
  3. In the folder “Templates” default templates exist for your e-mail signature in two formats: TEXT and HTML.
    The content of the templates can be inserted manually or by referencing from the Users.xml configuration file and the Static.xml configuration file.
    You can customize the files or generate new templates.
  4. Finally you define the basic settings in the CovumMailsignatur.ini, e.g. which templates are provided for your users in Outlook.

HINT: To edit the XML files please use a text editor (e.g. notepad) or an html editor of your own choice.
Please take care of the correct XML syntax! You can edit HTML files by an html editor or a text editor.
HINT 1: The templates are only examples. We assume no liability for accuracy and completeness of the specifications.

2. Installation, licensing and configuration

2.1. Download and installation

Download the software as zip file. Extract the included files into a directory of your choice on your hard disc, e.g. C:\Program Files\mailsignature.

2.2. Including the license file

License information are stored in the file “CovumMailsignatur.lic”. Please don’t delete or change this file!
After ordering a version liable to pay costs you get the software with a four weeks valid license file. After that time an
unlimited license file will be required.
After the complete payment of the software you get an unlimited license file.
Copy the new license file in the program directory. Though the old license file can be replaced.

2.3. Configuration

2.3.1 Configuration of Users.xml

Without using active directory, please save all users data in the file Users.xml.
The following picture shows how the Users.xml file may appear.
(Login is the Windows login or the Windows active directory login).
Screenshot
Inside the tag <user> you can define own elements, e.g.:
Screenshot
Disposing Windows active directory, please use the following syntax: –ldap:AttributName–, e.g.
–ldap:givenName–.
 
In active directory user attributes are administrated by the domain administrator.
Please contact the administrator to clarify which attributes are used in your active directory.
 
Some important attributes:

  • sn: last name
  • givenName: first name
  • mail: e-mail address
  • personalTitle: personal title
  • title: title
  • telephoneNumber: telefone number
  • facsimileTelephoneNumber: facsimile number
  • mobile: mobile phone number
  • street or streetAddress: street
  • postalCode: postal code
  • l: city

Download a list of further attributes as pdf file

2.3.2 Configuration of Static.xml

In Static.xml you can define data which are equal for all users, e.g. disclaimer, name of chairman, trade register.
As in Users.xml you may define new elements inside the tag <static> in this file.
 
The following picture shows how Static.xml may look like:

Screenshot

2.3.3 Structure and syntax of a template file

The signature itself will be defined in a template file. According to the requirements you can use templates in HTML or TXT format.
Though data of Users.xml and Static.xml will be used.
The following picture shows the structure of a template file in HTML format.
 
As visible in the next picture, data of Users.xml and Static.xml are inserted as –users:elementName– und –static:elementName– in the template file.
Disposing Windows active directory the attributes are addressed with –ldap:attributName–. In HTML you can use HTML format.
 
The following example Limited_Company.HTM shows the possible appearance of an HTML template.
Screenshot
After finishing the editing of Users.xml, Static.xml and Template.html or Template.txt
please run the program “CovumMailsignatur.exe”. You will get following answer:
Screenshot
You define the available templates in the file “CovumMailsignatur.ini”.
Please edit the following entry:

 

# Welche der gefunden Templates werden tatsächlich verwendet?
# --- EN ---
# Which templates are actually used?
SignaturTemplates = AG, GmbH, Limited_Company

Register the name of the templates which should be used, seperated by comma.
If you specified multiple templates in “CovumMailsignatur.ini”, your user may choose a suitable template in Microsoft Outlook:
Screenshot
The result shows the selected signature at the end of the mail.

3. Create new templates

The following templates of legal company forms are already available for your e-mail signature
(respectively in HTML and TXT format). They are located in directory “Templates”:

  • Limited Company
  • AG
  • GbR
  • GmbH
  • GmbH_Co_KG
  • Kaufmann
  • Kleingewerbe
  • OHG

Additional you are able to generate an arbitrary number of templates meeting your own requirements.
You determine the available templates in the file “CovumMailsignatur.ini”.
Please edit the following entry:

 

# Welche der gefunden Templates werden tatsächlich verwendet?
# --- EN ---
# Which templates are actually used?
SignaturTemplates = AG, GmbH, Limited_Company

Register the name of the templates which should be used, seperated by comma.

4. Configuration as single-user solution with the XML file

  1. Downloading and extracting software
    Download the software as zip file. Extract the included files into a directory of your choice on your hard disc, e.g. C:\Program Files\mailsignature.
  2. Specification of signature content / adapting templates
    Change into the exctracted directory and then into the directory “Templates”. Open a suitable template file in any TXT or HTML editor.
    Customize the content and save the file.
  3. Running “CovumMailsignatur.exe”
    Now you have to double click the file “CovumMailsignatur.exe” in the same directory.
    Ready!

5. Configuration as network solution

Using the specified procedure below you centrally can administrate the signature templates for all users.
First you save the software on a network share available for all user, e.g.

 

\\server\software\CovumMailsignatur 

The file “CovumMailsignatur.cmd” located in the main directory calls CovumMailsignatur from a network drive:

Open the file in any text editor (e.g. notepad) and replace all text passages “\\server\software\CovumMailsignatur” with the UNC path of your current installation directory.
Now open the file “CovumMailsignatur.ini” in the directory “Templates” and fit the path to the directory “Templates”:

 

# Pfad zu den Signatur-Templates
# Wenn der Wert der Variablen leer ist, wird ".\Templates\" angenommen.
# --- EN ---
# Path to signature templates
# In case of an empty value the default is ".\Templates\".
PathToTemplates = \\server\Software\CovumMailsignatur\Templates

Now the user can execute the script “CovumMailsignatur.cmd” manually.
In case of running registration procedure it is possible to execute the script like:

 

call \\Server\software\CovumMailsignatur\CovumMailsignatur.cmd 

This guarantees that all users take the latest signature at every time.

6. Graphical editor for Static.xml and Users.xml

Covum Mailsignatur offers you a graphical editor for editing the configuration files Users.xml and Static.xml.

6.1. Fileoperations: parallel opening of Users.xml and Static.xml (list mode)

By default users and statics are stored with defined file names Users.xml respectively Static.xml in a common directory, where
Covum Mailsignatur can use them.
Both the icon “Öffnen” as well as the corresponding menu item offer the selection of a directory for parallel loading both files into two tabs. Files can be edited and saved by their default file names.
Screenshot paralleles Oeffnen des Users.xml und Static.xml

6.2. Fileoperations: separate opening of Users.xml or Static.xml (file mode)

Alternatively the menu item “Öffne Datei” offers loading and editing users or statics as single file. In that case file name can be choosen. It is useful for inspecting and re-establishing automatical backups.
Screenshot separates Oeffnen des Users.xml und Static.xml

6.3. Saving

In list mode both tabs for users and statics will get stored together by file names Users.xml and Static.xml in the same directory.
In file mode both tabs for users and statics will get stored individually. It is possible to rename the files, but Covum Mailsignatur only uses Users.xml and Static.xml.
In both cases security backups will be generated, named by “Kopie von …”.

6.4. Editing of Users.xml

The left tab is designated for editing user data in Users.xml as described in 2.3.1. The left side lists all existing users, on the right side it is possible to insert the elements of the selected user.
For deleting an element you have to mark the whole row and press the Del-key. The topmost entry “<profil>” contains all existing users fields for filling with default values for new users.
For renaming or initial generation the prospective user name should be supplied.

6.5. Editing of Static.xml

The right tab provides editing of Static.xml as described in 2.3.2. For deleting an element you have to mark the whole row and press the Del-key.

6.6. Test run

Covum Mailsignatur can be started by icon or menu item “Testlauf”. So new signatures will be generated using edited files.
Please notice, it only works with file names Users.xml and Static.xml and no other paths as defined in “CovumMailsignatur.ini” are used.