IPluginMailEncryption (formcycle: bom 8.1.2 API)

All Superinterfaces:: IFCPlugin, INamedUiElement, INameProviding, ITransferable, Serializable

public interface IPluginMailEncryption extends IFCPlugin

Interface for plugins of type email encryption. A email encryption plugin provides an certificate for sending an encrypted email.

Author:: XIMA MEDIA GmbH

Field Summary

Fields inherited from interface de.xima.fc.plugin.interfaces.IFCPlugin
CONFIG_FILENAME

Fields inherited from interface de.xima.fc.interfaces.INamedUiElement
ATTR_DISPLAY_NAME

Fields inherited from interface de.xima.fc.entities.interfaces.INameProviding
ATTR_NAME, COL_NAME
Method Summary

Modifier and Type

Method

Description

IPluginMailEncryptionRetVal

findCertificateForMail(IPluginMailEncryptionParams mailEncryptionParams)

The main method of this plugin.

Methods inherited from interface de.xima.fc.plugin.interfaces.IFCPlugin
getDescription, getDescription, getDisplayName, getName, initialize, initPlugin, install, shutdown, shutdown, uninstall, validateConfigurationData

Method Details
- findCertificateForMail
  
  IPluginMailEncryptionRetVal findCertificateForMail(IPluginMailEncryptionParams mailEncryptionParams) throws FCPluginException
  
  The main method of this plugin. This method is called when an email needs to be encrypted. The mail address is passed to this method, and this plugin should return the certificate to be used for that email address.
  
  Parameters:
  
  mailEncryptionParams - Data this plugin may make use of. Contains the email address for which a certificate is required.
  
  Returns:
  
  The X509Certificate to be used for sending an encrypted email to the given email address. You may return null if no certificate was found for the email address. In this case, other plugins and certificate providers are searched for a certificate.
  
  Throws:
  
  FCPluginException - May be thrown when this plugin cannot perform the search for the certificate. When you throw this (or any other) exception, the email encryption process will continue to search for another plugin that can provide the certificate.