Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Docs regarding email picker #118

Open
wants to merge 4 commits into
base: master
Choose a base branch
from
Open

Docs regarding email picker #118

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
081251b
Docs regarding email picker
safijanet Aug 20, 2024
7fdbd69
Bug fix
safijanet Aug 20, 2024
3594ee2
Bug fixes
safijanet Aug 21, 2024
fc46b03
Minor changes
safijanet Aug 21, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Binary file added ...vuepress/public/.attachments/applications/Controls/emailpickercontrolshared.png
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
231 changes: 211 additions & 20 deletions src/en/developer-guide/applications/controls/emailpicker.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,31 +1,222 @@
---
Author: Jan Losenicky
Author: Safija Hubljar
---

# Email Picker

# Visual Example
Provides features that extend the native Email field control. This includes checking the format of the entered email and also provides an optional verification feature. If verification is enabled, the control will check whether the entered email is verified and the verification status will be displayed directly in the control. Additionally, the control allows the user to initiate the verification process directly through the control if the email is not verified.

![Email Picker Displayed On Form](/.attachments/applications/Controls/emailpickercontrol.png)
![Email Picker Displayed On Form](/.attachments/applications/Controls/emailpickercontrolshared.png)

# Description

This control is used to enter an emails in field. It is checking the format of email and also there is a function to verify the email.
## Bindings

![Email Picker Displayed On Form](/.attachments/applications/Controls/emailpickerverifying.png)
<table>
<thead>
<tr>
<th>Property Name</th>
<th>Description</th>
<th>Of Type</th>
<th>Input</th>
<th>Output</th>
<th>Usage</th>
<th>Required</th>
</tr>
</thead>
<tbody>
<tr>
<td>data</td>
<td>Binding field containing array of e-mail objects.</td>
<td>
<p><code>SingleLine.Text</code></p>
<td>
<p style="width: 220px"><code>[
{
</br>
"asyncJobInstanceId": null,
</br>
"status": "unverified",
</br>
"verifiedOn": null
</br>
"lastVerifiedEmail":"[email protected]"
}
]
</code></p>
</td>
<td><p><code>[{"email":"[email protected]",</br>"status":"unverified"}]</code></p>
<p><code>undefiend</code></p></td>
<td><code>bound</code></td>
<td><code>true</code></td>
</tr>
<tr>
<td>entityName</td>
<td><p style="width: 180px">Entity name of the record the EmailPicker is on. Required if verification feature is on.</p></td>
<td><code>SingleLine.Text</code></td>
<td>
<code>account</code>
</td>
<td>N/A</td>
<td><code>input</code></td>
<td><code>false</code></td>
</tr>
<tr>
<td>recordId</td>
<td>Primary key of the record the EmailPicker is on. Required if verification feature is on.</td>
<td><code>SingleLine.Text</code></td>
<td>
<code>5b34e4fd-a937-ef11-8409-0022489d8923</code>
</td>
<td>N/A</td>
<td><code>input</code></td>
<td><code>false</code></td>
</tr>
<tr>
<td>contactSuggestionFetchXml</td>
<td>FetchXml that will replace default for filtering contact email suggestions.</td>
<td><code>SingleLine.Text</code></td>
<td>
<p> <code>&lt;fetch&gt;
&lt;entity name="contact"&gt;
&lt;attribute name="firstname" /&gt;
&lt;attribute name="lastname" /&gt;
&lt;attribute name="emailaddress1" /&gt;
&lt;filter&gt;
&lt;condition attribute="emailaddress1" operator="like" value="{{text}}%" /&gt;
&lt;/filter&gt;
&lt;link-entity name="talxis_connection" from="talxis_record1id" to="contactid"&gt;
&lt;attribute name="talxis_record1id" /&gt;
&lt;filter type="and"&gt;
&lt;condition attribute="talxis_interceptor_placeholder" operator="ne" value="$contactsInAccount$" /&gt;
&lt;/filter&gt;
&lt;/link-entity&gt;
&lt;/entity&gt;
&lt;/fetch&gt;</code></p>
</td>
<td>N/A</td>
<td><code>input</code></td>
<td><code>false</code></td>
</tr>
<tr>
<td>accountSuggestionFetchXml</td>
<td>FetchXml that will replace default for filtering account email suggestions.</td>
<td><code>SingleLine.Text</code></td>
<td>
<p> <code>&lt;fetch&gt;
&lt;entity name="account"&gt;
&lt;attribute name="emailaddress1"/&gt;
&lt;attribute name="name"/&gt;
&lt;filter&gt;
&lt;condition attribute="emailaddress1" operator="like" value="{{text}}%"/&gt;
&lt;/filter&gt;
&lt;order attribute="emailaddress1"/&gt;
&lt;/entity&gt;
&lt;/fetch&gt;</code></p>
</td>
<td>N/A</td>
<td><code>input</code></td>
<td><code>true</code></td>
</tr>
<tr>
<td>minEmailCount</td>
<td>Field that represents the number of required emails.</td>
<td><code>Whole.None</code></td>
<td>
<p><code>2</code></p>
</td>
<td>N/A</td>
<td><code>input</code></td>
<td><code>false</code></td>
</tr>
<tr>
<td>maxEmailCount</td>
<td>Field that represents the maximum number of emails that can be inputted.</td>
<td><code>Whole.None</code></td>
<td>
<p> <code>5</code></p>
</td>
<td>N/A</td>
<td><code>input</code></td>
<td><code>false</code></td>
</tr>
<tr>
<td>minVerifiedCount</td>
<td>Field that represents the number of emails required to be verified</td>
<td><code>Whole.None</code></td>
<td>
<p<code>3</code></p>
</td>
<td>N/A</td>
<td><code>input</code></td>
<td><code>false</code></td>
</tr>
<tr>
<td>verificationFeature</td>
<td>Enable the functionality for verification email.</td>
<td>
<p><code>Enum</code></p></td>
<td><p><code>0</code></p>
<p><code>1</code></p></td>
<td>N/A</td>
<td><code>input</code></td>
<td><code>true</code></td>
</tr>
<tr>
<td>emailEdit</td>
<td>Enable the email editing.</td>
<td><code>Enum</code></td>
<td>
<p><code>0</code></p>
<p<code>1</code></p>
</td>
<td>N/A</td>
<td><code>input</code></td>
<td><code>false</code></td>
</tr>
<tr>
<td>emailSuggestions</td>
<td>Enable suggest emails from existing accounts and contacts.</td>
<td><code>Enum</code></td>
<td>
<p><code>false</code></p>
<p<code>true</code></p>
</td>
<td>N/A</td>
<td><code>input</code></td>
<td><code>false</code></td>
</tr>
<tr>
<td>clickToCopyEnabled</td>
<td>Enable click to copy button.</td>
<td><code>Enum</code></td>
<td>
<p><code>false</code></p>
<p<code>true</code></p>
</td>
<td>N/A</td>
<td><code>input</code></td>
<td><code>false</code></td>
</tr>
<tr>
<td>plainEmail</td>
<td>Binding field returning first email from `E-mail Data Field` in plain text.</td>
<td><p><code>SingleLine.Email</code></p>
<p><code>SingleLine.Text</code></p>
</td>
<td>
<p><code>[email protected]</code></p>
</td>
<td><code>[email protected]</code></td>
<td><code>bound</code></td>
<td><code>false</code></td>
</tr>
</tbody>
</table>

# Binding Field
## Changelog

Control can be binded to any field on form of type SingleLine.Text.

# Inputs

- Min Mail Count - Minimum of emails imputed
- Max Mail Count - Maximum of emails that can be imputed
- Verification Feature
- Disabled (default)
- Enabled

Using Verifying
- Entity Name - Entity name of the record the EmailPicker is on. Required if verification feature is enabled.
- Record Id - Primary key of the record the EmailPicker is on. Required if verification feature is enabled.
<h2>2024-08-16</h2>
<h3> Changed</h3>
<ul>
<li>Changed PCF to use latest shared component</li>
</ul>