Package de.xima.fc.plugin.models.params.mail

Class PluginMailEncryptionParams

java.lang.Object

de.xima.fc.plugin.models.params.mail.PluginMailEncryptionParams

All Implemented Interfaces:

IPluginParameters, IPluginMailEncryptionParams, Serializable

public class PluginMailEncryptionParams
extends Object
implements IPluginMailEncryptionParams

Data class that holds the data for the IPluginMailEncryptionParams that are passed to the plugin method.

Author:

XIMA MEDIA GmbH

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor	Description
PluginMailEncryptionParams(String mailAddress, Mandant client)	Creates a new mail encryption parameter instance with the given email address and client.

Method Summary

Modifier and Type	Method	Description
Mandant	getClient()	An email is usually sent in a certain context, such as during a workflow action.
String	getMailAddress()	A mail address (string converted) to obtain a certificate for

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

PluginMailEncryptionParams

public PluginMailEncryptionParams(String mailAddress,
                                  Mandant client)

Creates a new mail encryption parameter instance with the given email address and client.

Parameters:

mailAddress - The mail address for which a certificate is required.

client - The current client, ie. the context in which the email is sent.

Method Detail

getMailAddress

public String getMailAddress()

Description copied from interface: IPluginMailEncryptionParams

A mail address (string converted) to obtain a certificate for

Specified by:

getMailAddress in interface IPluginMailEncryptionParams

Returns:

Mail address

getClient

public Mandant getClient()

Description copied from interface: IPluginMailEncryptionParams

An email is usually sent in a certain context, such as during a workflow action. This returns the client the user, workflow action etc. belongs to.

Specified by:

getClient in interface IPluginMailEncryptionParams

Returns:

The current client, ie. the context in which the email is sent. null if no client exists, eg. when sending a system email.