đź“ Open an email client from React Native (for 'magic link' type functionality).
An easy way to open an email app of the user's choice, based on the apps they have installed on their device.
Currently supported apps:
yarn add react-native-email-link
This package works with autolinking on RN>=0.60. If you're using an earlier version of React Native, please install version
1.4.0of the library, or check out the legacy rnpm branch.
As of iOS 9, your app needs to provide the
LSApplicationQueriesSchemeskey inside Info.plist to specify the URL schemes with which the app can interact.
Just put this in your Info.plist depending on which apps you'd like to support. Omitting these might mean that the library can't detect some of the mail apps installed by the user.
LSApplicationQueriesSchemes message readdle-spark airmail ms-outlook googlegmail inbox-gmail ymail superhuman
import { openInbox } from 'react-native-email-link'openInbox()
title
Text for the top of the ActionSheet or Intent.
| Type | Required | Default | | -------- | -------- | --------------- | | string | No | 'Open mail app' |
message
Subtext under the title on the ActionSheet
| Type | Required | Default | Platform | | -------- | -------- | ----------------------------------- | -------- | | string | No | 'Which app would you like to open?' | iOS |
cancelLabel
Text for last button of the ActionSheet.
| Type | Required | Default | Platform | | -------- | -------- | --------- | -------- | | string | No | 'Cancel' | iOS |
removeText
If true, not text will be show above the ActionSheet or Intent. Default value is false.
| Type | Required | Default | | -------- | -------- | -------- | | boolean | No | false |
newTask
If true, the email Intent will be started in a new Android task. Else, the Intent will be launched in the current task.
Read more about Android tasks here.
| Type | Required | Default | Platform | | -------- | -------- | --------- | -------- | | boolean | No | true | Android |
import { openInbox } from 'react-native-email-link'openInbox({ message: 'Whatcha wanna do?', cancelLabel: 'Go back!' })
import { openComposer } from 'react-native-email-link'openComposer()
title
message(iOS only)
cancelLabel(iOS only)
removeText
to
cc(iOS only)
bcc(iOS only)
subject
body
encodeBody
title
Text for the top of the ActionSheet or Intent.
| Type | Required | Default | | -------- | -------- | --------------- | | string | No | 'Open mail app' |
message
Subtext under the title on the ActionSheet.
| Type | Required | Default | Platform | | -------- | -------- | ----------------------------------- | -------- | | string | No | 'Which app would you like to open?' | iOS |
cancelLabel
Text for last button of the ActionSheet.
| Type | Required | Default | Platform | | -------- | -------- | --------- | -------- | | string | No | 'Cancel' | iOS |
removeText
If true, not text will be show above the ActionSheet or Intent. Default value is false.
| Type | Required | Default | | -------- | -------- | -------- | | boolean | No | false |
to
Recipient's email address.
| Type | Required | Default | | -------- | -------- | -------- | | string | No | null |
cc
Email's cc (iOS only).
| Type | Required | Default | | -------- | -------- | -------- | | string | No | null |
bcc
Email's bcc (iOS only).
| Type | Required | Default | | -------- | -------- | -------- | | string | No | null |
subject
Email's subject.
| Type | Required | Default | | -------- | -------- | -------- | | string | No | null |
body
Email's body.
| Type | Required | Default | | -------- | -------- | -------- | | string | No | null |
encodeBody
Apply
encodeURIComponentto the email's body.
| Type | Required | Default | | ------- | -------- | ------- | | boolean | No | false |
import { openComposer } from 'react-native-email-link'openComposer({ to: '[email protected]', subject: 'I have a question', body: 'Hi, can you help me with...' })
This library is developed by Lean Motherfuckers, a tech consulting company like no other.
Contributors: