Email Configuration

This section covers how to configure the email server as well as the sending of emails to users and administrators.

To configure the email server, complete the following tasks.

  1. From the installation directory, locate the common.xml file in the conf folder.

  2. Locate the XML element email.

    Copy 
    <email>
        <type>SMTP</type>
        <hostname>smtp.wanadoo.fr</hostname>
        <from>pkirenewal_dma_TEST@hidglobal.com</from>
        <emailUser sendEmail="true">
        <subject>Your device needs to be updated</subject>
        <messageTemplate>
    Dear user,
    You are receiving this email because one of the certificates stored in your device is about to expire.
    To renew this certificate, please login to the User Portal web server and follow the process to update your device.
    https://mtpsmdasrv2.mtpsmda2.hidglobal.com:32456/aims/enterprise/user.
        </messageTemplate>
        </emailUser>
        <emailAdministrator sendEmail="true">
        <to> john.doe@hidglobal.com</to>
        <renewalSubject>PKI Renewal Report(s)</renewalSubject>
        <administrationSubject>PKI AdministrationReports</administrationSubject>
    <updateSubject>PKI Update Reports</updateSubject>
        </emailAdministrator>
    </email>

  3. Modify the XML element hostname so that it matches the hostname of your SMTP server.

  4. Save and close the file to save your configuration changes.

To configure the sending of email to users when an applications update request is posted, complete the following tasks.

  1. Locate the XML element emailUser.

    Copy 
    <emailUser sendEmail="true">
        <subject>Your device needs to be updated</subject>
        <messageTemplate>
    Dear user,
    You are receiving this email because one of the certificates stored into your device is about to expire.
    To renew this certificate please login to the User Portal web server and follow the process to update your device.
    https://mtpsmdasrv2.mtpsmda2.activcard.com:32456/aims/enterprise/user.
        </messageTemplate>
    </emailUser>

  2. To configure the sending of emails to users, set the sendEmail attribute to true. To configure not to send emails to users, set the sendEmail attribute to false.

  3. Configure the XML elements subject and messageTemplate to suit your specific needs.

  4. Save and close the file to save your configuration changes.

To configure the sending of email to administrators when a batch has been posted, complete the following tasks.

  1. Locate the XML element emailAdministrator.

    Copy 
    <emailAdministrator sendEmail="true">
        <to>john.doe@hidglobal.com</to>
        <renewalSubject>PKI Renewal Report(s)</renewalSubject>
        <administrationSubject>PKI Administration Reports</administrationSubject>
    <updateSubject>PKI Update Reports</updateSubject>
    </emailAdministrator>

  2. To configure the sending of emails to administrators, set the sendEmail attribute to true. Otherwise, set the sendEmail attribute to false (emails not sent to administrators).

  3. Configure the to XML element with the email address of the administrators. You can add multiple email addresses, separated by a comma.

  4. Configure the XML elements renewalSubject for a renewal batch or administrationSubject for an administration batch or updateSubject for an update batch to suit your specific needs.

  5. Save and close the file to save your configuration changes.