Formatted Email

A lightning-formatted-email component displays a read-only representation of an email address as a hyperlink using the mailto: URL scheme. Clicking on the email address opens the default mail application for the desktop or mobile device.

This example displays an email address with an email icon. The email address is displayed as the default label.

1<template>
2    <lightning-formatted-email value="hello@example.com">
3    </lightning-formatted-email>
4</template>

This example prevents the display of the email icon.

1<template>
2    <lightning-formatted-email value="hello@example.com" hide-icon>
3    </lightning-formatted-email>
4</template>

Multiple email addresses are supported. The label “Send a group email” is displayed as a hyperlink in this example.

1<template>
2    <lightning-formatted-email
3        value="hello@example.com,email@example.com"
4        label="Send a group email"
5    >
6    </lightning-formatted-email>
7</template>

This example creates an email address with values for cc, subject, and email body. The label is displayed as a hyperlink.

1<template>
2    <lightning-formatted-email
3        value="hello@example.com?cc=email@example.com&subject=My%20subject &body=The%20email%20body"
4        label="Send us your feedback"
5    >
6    </lightning-formatted-email>
7</template>

The LWC Recipes GitHub repository contains code examples for Lightning Web Components that you can test in an org.

For a recipe that uses lightning-formatted-email, see the following components in the LWC Recipes repo.

• c-nav-to-record
• c-wire-get-record-user

Object Reference for the Salesforce Platform: Field Types