Skip to content

With Web3Mail, users receive email notifications from the authorized apps while the email address data is not known by the apps.

License

Notifications You must be signed in to change notification settings

iExecBlockchainComputing/web3mail-sdk

Repository files navigation

iExec logo

Web3mail

Web3mail offers developers methods to create apps that:

  • enable an entity (such as a (d)app provider or an end-user) to email an Ethereum account holder without knowing her/his email address
  • eliminate the need for end-users to share their email address with multiple third-parties, reducing the risk of data breaches and spam.

Web3mail is composed of 2 methods:

  • fetchMyContacts — that enables an entity to retrieve a list of Ethereum accounts whose owners have authorized the entity to email them
  • sendEmail — that allows an entity to email a user (previously fetched via the fetchMyContacts method) knowing only her/his Ethereum account.

npmlicense

Installation

Web3mail is available as an npm package.

npm:

npm install @iexec/web3mail

yarn:

yarn add @iexec/web3mail

Get started

Browser

import { IExecWeb3mail } from "@iexec/web3mail";

const web3Provider = window.ethereum;
const web3mail = new IExecWeb3mail(web3Provider);

NodeJS

import { IExecWeb3mail, getWeb3Provider } from "@iexec/web3mail";

const { PRIVATE_KEY } = process.env; 

const web3Provider = getWeb3Provider(PRIVATE_KEY);
const web3mail = new IExecWeb3mail(web3Provider);

Documentation

License

This project is licensed under the terms of the Apache 2.0.

About

With Web3Mail, users receive email notifications from the authorized apps while the email address data is not known by the apps.

Resources

License

Code of conduct

Stars

Watchers

Forks

Packages

No packages published