@emailjs/react-native/README.md

EmailJS helps to send emails directly from your code. Official EmailJS SDK for React Native

# Official EmailJS SDK for React Native

SDK for [EmailJS.com](https://www.emailjs.com) customers.
\
Use you EmailJS account for sending emails.

[![codecov](https://codecov.io/gh/emailjs-com/emailjs-react-native/branch/main/graph/badge.svg)](https://codecov.io/gh/emailjs-com/emailjs-react-native)
[![npm version](https://img.shields.io/npm/v/@emailjs/react-native.svg)](https://www.npmjs.com/package/@emailjs/react-native)

## Disclaimer

This is the SDK for **React Native** only, otherwise use

- [Browser SDK](https://www.npmjs.com/package/@emailjs/browser)
- [Flutter SDK](https://pub.dev/packages/emailjs)
- [Node.js SDK](https://pub.dev/packages/@emailjs/nodejs)
- [REST API](https://www.emailjs.com/docs/rest-api/send/)

## Links

[Official SDK Docs](https://www.emailjs.com/docs)

## Intro

EmailJS helps to send emails directly from your code.
No large knowledge is required – just connect EmailJS to one of the supported
email services, create an email template, and use our SDK
to trigger an email.

## Usage

Install EmailJS SDK using [npm](https://www.npmjs.com/):

```bash
$ npm install @emailjs/react-native
```

With Expo CLI:

```bash
$ npx expo install @emailjs/react-native
```

The package uses `@react-native-async-storage/async-storage` for the storage
(for the rate limit feature)

**_Note_**: By default, API requests are disabled for non-browser applications.
You need to activate them through [Account:Security](https://dashboard.emailjs.com/admin/account/security).

## FAQ

#### API calls are disabled for non-browser applications

You need to activate API requests
through [Account:Security](https://dashboard.emailjs.com/admin/account/security).

## Examples

### ECMAScript modules

**send email**

```js
import emailjs from '@emailjs/react-native';

const templateParams = {
  name: 'James',
  notes: 'Check this out!',
};

emailjs
  .send('YOUR_SERVICE_ID', 'YOUR_TEMPLATE_ID', templateParams, {
    publicKey: 'YOUR_PUBLIC_KEY',
  })
  .then(
    (response) => {
      console.log('SUCCESS!', response.status, response.text);
    },
    (err) => {
      console.log('FAILED...', err);
    },
  );
```

**init (optional)**

```js
import emailjs from '@emailjs/react-native';

// set Public Key as global settings
emailjs.init({
  publicKey: 'YOUR_PUBLIC_KEY',
});

emailjs.send('YOUR_SERVICE_ID', 'YOUR_TEMPLATE_ID').then(
  (response) => {
    console.log('SUCCESS!', response.status, response.text);
  },
  (err) => {
    console.log('FAILED...', err);
  },
);
```

**await/async with EmailJS error handler**

```js
import emailjs, { EmailJSResponseStatus } from '@emailjs/react-native';

try {
  await emailjs.send(
    'YOUR_SERVICE_ID',
    'YOUR_TEMPLATE_ID',
    {},
    {
      publicKey: 'YOUR_PUBLIC_KEY',
    },
  );
  console.log('SUCCESS!');
} catch (err) {
  if (err instanceof EmailJSResponseStatus) {
    console.log('EMAILJS FAILED...', err);
    return;
  }

  console.log('ERROR', err);
}
```

### CommonJS modules

**send email**

```js
const emailjs = require('@emailjs/react-native');

var templateParams = {
  name: 'James',
  notes: 'Check this out!',
};

emailjs
  .send('YOUR_SERVICE_ID', 'YOUR_TEMPLATE_ID', templateParams, {
    publicKey: 'YOUR_PUBLIC_KEY',
  })
  .then(
    function (response) {
      console.log('SUCCESS!', response.status, response.text);
    },
    function (err) {
      console.log('FAILED...', err);
    },
  );
```