Home

 

Customizing e-mail templates

You can customize the e-mails that Files sends when a file is shared, or when a user asks to be e-mailed about new file comments or edits.

Each template is an XML file with two <qkr:body> sections, one for plain text e-mails (<qkr:body mime-type="text/plain">) and one for HTML e-mails (<qkr:body mime-type="text/html">). Each <qkr:body> section has variables, such as {notification.home.url} that are populated by the server. For example, the e-mail notifying people that a file has been edited contains a variable with the name of the user who edited the file: {notification.media.editor.name}. The server provides the user name.

You can edit the plain text or HTML, and the server populates the variables with values appropriate to the e-mail.

  1. Start the wsadmin client.

  2. Access the Files configuration files...

  3. Network deployment:

    If you are asked to select a server, you can select any server.

  4. Check out the Files configuration files...

    FilesConfigService.checkOutConfig("<working_directory>", "cell_name", includeEmailTemplates = "true")

    where:

    • <working_directory> is the temporary working directory to which the configuration XML and XSD files are copied. The files are kept in this working while you make changes to them.

    • cell_name is the name of the WebSphere Application Server cell hosting the Lotus Connections feature. This argument is required even in stand-alone deployments. If you do not know the cell name, do one of the following to determine it:

      • Stand-alone deployment: Look at the name after the following in the file system: 

          WAS_HOME\profiles\profile_name\config\cells\

    • Network deployment: Type the following command while in the wsadmin command processor: 

        print AdminControl.getCell()

  5. includeEmailTemplates must be set to "true" to check out the e-mail templates along with the configuration files. This is set to "false" by default.

    For example: 

      FilesConfigService.checkOutConfig("/opt/my_temp_dir", "CommServerNode01Cell", includeEmailTemplates = "true")

  6. Edit any of the following templates:

    Template Description

    commentAddMail_language.xml

    E-mail sent when a comment is made on a file and the user has requested to be notified of comments.

    Users can request comment notification by opening the file page, clicking More actions > Set e-mail notifications, and then selecting I want to receive an e-mail when new comments are made on this file.

    mediaEditMail_language.xml

    E-mail sent when an edit is made to a file and the user has requested to be notified of edits.

    Users can request edit notification by opening the file page, clicking More actions > Set e-mail notifications, and then selecting I want to receive an e-mail when this file changes.

    shareMail_language.xml

    E-mail sent to a user when a file has been shared with them.

    The language part of the filename represents the language version of the file, for example the English version of the commentAddMail file is commentAddMail_en.xml.

  7. Check in the changed configuration property keys using the following wsadmin client command: 

      FilesConfigService.checkInConfig()

  8. To exit the wsadmin client, type exit at the prompt.

  9. Stop and restart the server hosting the Files feature.


Administer Files

 

Related tasks

Start the wsadmin client

+

Search Tips   |   Advanced Search