PluginMailEncryptionRetVal (formcycle: bom 8.2.0 API)

java.lang.Object
- de.xima.fc.plugin.models.retval.mail.PluginMailEncryptionRetVal

All Implemented Interfaces:

IPluginReturnValue, IPluginMailEncryptionRetVal
```
public class PluginMailEncryptionRetVal
extends Object
implements IPluginMailEncryptionRetVal
```
A POJO data class that for the return value of the mail encryption plugin. An instance of this class holds the certificate provided by the plugin.

Author:

XIMA MEDIA GmbH

- Constructor Summary
  
  Constructors
  Constructor Description
  
  PluginMailEncryptionRetVal(X509Certificate certificate)
- Method Summary
  
  All Methods Instance Methods Concrete Methods
  Modifier and Type Method Description
  
  X509Certificate getCertificate()
  This should return the certificate to be used for encrypting the email.
  - Methods inherited from class java.lang.Object
    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - PluginMailEncryptionRetVal
```
public PluginMailEncryptionRetVal(X509Certificate certificate)
```
    Parameters:
    
    certificate - The certificate to be returned by the plugin.
- Method Detail
  - getCertificate
```
public X509Certificate getCertificate()
```
    Description copied from interface: IPluginMailEncryptionRetVal
    
    This should return the certificate to be used for encrypting the email. The email is sent to the email address as specified by the IPluginMailEncryptionParams that were passed to the plugin.
    
    Specified by:
    
    getCertificate in interface IPluginMailEncryptionRetVal
    
    Returns:
    
    X509 Certificate The certificate to be used for sending an encrypted email. May return null if no certificate was found. In this case, other certificate providers are searched for a certificate.