πŸ“‹ Outlook Add-In (classic): Customizing Download and SubmitBox buttons

This guide shows you how to customize the text and descriptions of the Download, SubmitBox, and Send buttons as well as the blacklist message in FTAPI emails using a central XML configuration file for the Add-In.

Introduction to Customizing

You can customize the text and descriptions of both the "Download" button and the "SubmitBox" button. This customization is performed on a per-language basis in a single configuration file for each language you wish to modify in the application.

Note: The selected language must be officially supported by the Outlook Add-In. Currently, en-US and de-DE are primarily supported.

Configuration file requirements

  1. The configuration file MUST be placed in the user's roaming directory: C:\Users\<Username>\AppData\Roaming\FTAPI\Outlook Add-In\
  2. The configuration file MUST be named exactly defaultbuttontext.xml.
  3. The Name attribute in the <Language> tag must correspond to a valid ISO language code, e.g., <Language Name="en-US">.

Available UI elements for customization

Tag nameDescription
Level1Text and description text of the download button for security level 1
Level2Text and description text of the download button for security level 2
Level3Text and description text of the download button for security level 3
Level4Text and description text of the download button for security level 4
Level4NoAttachmentsText and description text of the button for security level 4 when no attachments were sent with the message
SubmitBoxText and description of the SubmitBox/upload button
SendButtonText and description of the send button
BlacklistMessage text for recipients on the blacklist. The placeholder {0} is replaced with the recipient.

Tip: To include the selected recipient in the description, a placeholder {0} should be inserted at a position within the XML definition.

Example files for rollout

Example 1: Customizing only one security level in English

Here, the administrator decides to customize only the text and description for Level 1 for English-language FTAPI emails:

<?xml version="1.0" encoding="utf-8"?>
<DefaultButtonText xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <Languages>
    <Language Name="en-US">
      <ButtonTexts>
        <TextDescription Name="Level1">
          <Text>L1 Custom Button Text</Text>
          <Description>L1 Custom EN Description for {0}</Description>
        </TextDescription>
      </ButtonTexts>
    </Language>
  </Languages>
</DefaultButtonText>

Example 2: Full customization for German and English

Here, the administrator decides to fully customize all texts and descriptions for both languages according to corporate identity guidelines:

<?xml version="1.0" encoding="utf-8"?>
<DefaultButtonText xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <Languages>
    <Language Name="en-US">
      <ButtonTexts>
        <TextDescription Name="Level1">
          <Text>Download Secure Files</Text>
          <Description>Click to download files sent securely via FTAPI.</Description>
        </TextDescription>
        <TextDescription Name="SubmitBox">
          <Text>Upload to SubmitBox</Text>
          <Description>Click here to securely reply with your files.</Description>
        </TextDescription>
        <TextDescription Name="SendButton">
          <Text>Send Button Text</Text>
          <Description>Description of the send button</Description>
        </TextDescription>
        <TextDescription Name="Blacklist">
          <Text>This recipient is blocked: {0}</Text>
        </TextDescription>
      </ButtonTexts>
    </Language>
    <Language Name="de-DE">
      <ButtonTexts>
        <TextDescription Name="Level1">
          <Text>Sichere Dateien herunterladen</Text>
          <Description>Klicken Sie hier, um die Dateien sicher via FTAPI abzurufen.</Description>
        </TextDescription>
        <TextDescription Name="SubmitBox">
          <Text>In SubmitBox hochladen</Text>
          <Description>Klicken Sie hier, um uns Ihre Dokumente sicher zurΓΌckzusenden.</Description>
        </TextDescription>
        <TextDescription Name="SendButton">
          <Text>Senden-Button Text</Text>
          <Description>Beschreibung des Senden-Buttons</Description>
        </TextDescription>
        <TextDescription Name="Blacklist">
          <Text>Dieser EmpfΓ€nger ist gesperrt: {0}</Text>
        </TextDescription>
      </ButtonTexts>
    </Language>
  </Languages>
</DefaultButtonText>

Related articles

πŸ“‹ Outlook Add-In (classic): Configuration for terminal servers and multi-user environments