CSJCurrent en:Email Notifications

Aus Cryptshare Documentation
Wechseln zu:Navigation, Suche



Disabling email notifications on server-side

Usually the Cryptshare Server manages all email communication between the participants of a transfer. However, when developing an own client application for Cryptshare communication it might be desirable to send these notifications from within this client. Therefore Cryptshare allows it to disable the sender and the recipient notification for each transfer.

Disabling the sender notification for a transfer

Transfer transfer = new Transfer();
transfer.setNotifySender(false);
Disabling the recipient notification for a transfer

Transfer transfer = new Transfer();
transfer.setNotifyRecipients(false);

Requesting email templates from the Cryptshare Server

Please also consider the documentation for HTML Email Templates in the Cryptshare Server Documentation.

Developers of a Cryptshare Client Application might want to handle transfer notifications themselves, for instance for an email integration such as Cryptshare for Office 365 & Outlook. In order to still have the same layout and especially the unique information per recipient the API offers the possibility to request the HTML code for the email notification from the server.

client.requestEmailTemplate("<template-name>", <replacements>, <language>, <mailFormat>);


> <template-name> :  The name of the desired email template > <replacements> : Mapping of the placeholders in the template > <language> : The language of the template > <mailFormat> :  The mail format which shall be used. This can either be 'HTML' or 'plain'

Email placeholders

Email placeholders are used to fill in individual information into the templates. This way each email recipient can retrieve an email with unique content, such as the personal download link, name or email address.

Template Snippet with name and email placeholders

[...]

Dear Sir or Madam,

Confidential data has been sent to you by <a href="mailto:$email">$name</a>. [...]

Possible placeholders in email notifications

The following table shows available placeholders in email templates. Placeholders tagged with SENDER are specifically required for the sender template. Placeholders tagged with RECIPIENT are specifically required for the recipient template.

Tag Placeholder Key Description Additional Notes

SENDERRECIPIENT

"baseurl"

The Cryptshare Server URL

i.e. https://server.url.com

RECIPIENT

"subject"

The message subject

RECIPIENT

"message"

The body of the message

SENDERRECIPIENT

"date_1"

The expiration date of the transfer

SENDERRECIPIENT

"list_3"

The list of the files in the transfer

RECIPIENT

"linkref"

The download link for the transfer

SENDERRECIPIENT

"passwordmode"

The type of password mode used for the transfer

Possible values:
  • manual
  • generated
  • none

RECIPIENT

"name"

The name of the sender

RECIPIENT

"phone"

The phone number of the sender

RECIPIENT

"email"

The email address of the sender

SENDERRECIPIENT

"list_1"

List of the recipients addressed in 'To'

SENDERRECIPIENT

"list_2"

List of the recipients addressed in 'Cc'
Please note that the above table only shows the default configuration for Cryptshare emails. Any placeholder can also be used for a different purpose in own templates. Please read the HTML Email Templates in the Cryptshare Server Manual for further details.

How to use email placeholders

#client.requestEmailTemplate() requires a very specific replacement-map in order to get the desired result. The parameter is a set holding instances of type TemplateReplacement. A TemplateReplacement object is basically a key-value wrapper where the key is a specific placeholder and the value can either be a list or a single value. This allows it, to retrieve customized templates per recipient with a single request.

Using placeholders

// <replacements>
Map<Set<String>, Set<TemplateReplacement>> replacements = new HashMap<Set<String>, Set<TemplateReplacement>>();
// <replacementSet>
Set<TemplateReplacement> replacementSet = new HashSet<TemplateReplacement>();
replacementSet.add(new TemplateReplacement("name", "John Adams"));
replacementSet.add(new TemplateReplacement("email", "john.adams@server.com"));

List<String> fileList = new ArrayList<String>();
fileList.add("file_01.txt");
fileList.add("file_02.docx");
replacementSet.add(new TemplateReplacement("list_3", fileList));

List<String> recipientList = new ArrayList<String>();
recipientList.add("recipient1@otherdomain.org");
recipientList.add("recipienr2@otherdomain.com");
replacementSet.add(new TemplateReplacement("list_1", recipientList));

// <identifiers>
Set<String> identifiers = new HashSet<String>();
identifiers.addAll(recipientList);
replacements.put(identifiers, replacementSet);

Map<List<String>, String> mailTemplates = client.requestEmailTemplate("recipient", replacements, new Locale("ja"), EmailFormat.HTML);

Screenshot-1648047342449.png

> <templateName> : The name of the desired email template > <replacements> : Mapping between <identifiers> and <replacementSet> > <identifiers> : Set of email addresses which have a specific <replacementSet> > <replacementSet> : A set of placeholders for <identifiers>

The result object of an email template request

When requesting an email template using #client.requestEmailTemplate() the returned mapping contains a unique template per identifier-set. This means with one request a filled in template can be returned per single recipient or for all recipients together or for a combination of both.

Example: multiple <identifier>-<replacementSet> combinations

// identifiers1: One single recipient, replacementSet1: Set of replacements
replacements.put(identifiers1, replacementSet1);
// identifiers2: Two recipients, replacementSet2: Set of replacements
replacements.put(identifiers2, replacementSet2);
Map<List<String>, String> mailTemplates = client.requestEmailTemplate("recipient", replacements, new Locale("ja"), EmailFormat.HTML);

The above request would return two templates, one for each set of identifiers put into the replacement map both having a different content, meaning the placeholders have been filled in with the contents of replacementSet1, respectively replacementSet2.