Skip to content

Latest commit

 

History

History
69 lines (43 loc) · 1.93 KB

README.md

File metadata and controls

69 lines (43 loc) · 1.93 KB
Raw

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.