jasonbellamy / react-mailto Goto Github PK

View Code? Open in Web Editor NEW

26.0 3.0 19.0 10 KB

A react component to create and display a mailto link.

License: MIT License

react-mailto's Introduction

React <Mailto>

A react component to create and display a mailto link.

Getting Started

Install with NPM - npm install --save react-mailto

Usage

var React  = require('react');
var Mailto = require('react-mailto');

var Component = React.createClass({
  render: function () {
    return (
      <Mailto email="[email protected]" obfuscate={true}>
        Email me!
      </Mailto>
    );
  }
});

Options

Property	Type	Argument	Default	Description
email	`string`	`<required>`	`null`	email address of the intended recipient.
obfuscate	`boolean`	`<optional>`	`false`	show the email address in the status bar.
headers	`object`	`<optional>`	`null`	any standard mail header fields. The most commonly-used of these are "subject", "cc", and "body" (which is not a true header field, but allows you to specify a short content message for the new email).

Developing

react-mailto is built using ES6. Run the following task to compile the src/ into dist/.

npm run build

Contributing

In lieu of a formal styleguide, take care to maintain the existing coding style. Add unit tests for any new or changed functionality.

License

react-mailto's People

Contributors

Stargazers

Watchers

Forkers

handtrix ag-teammate chaoli23 getricj gtwilliams03 zachkrall sitch digin-bdx defite slava-v23 renatajdcss jverce y-parede-dev stardigital2022

react-mailto's Issues

Error on React 16

Error on React 16 while running for production mode .
The Error is
Desktop/****/node_modules/react-mailto/dist/react-mailto.js:106
children: _react.PropTypes.node.isRequired,
^

TypeError: Cannot read property 'node' of undefined

Add E-Mail Headers

I would be really nice to allow setting email headers such as cc, body, subject etc.

In addition to the email address, you can provide other information. In fact, any standard mail header fields can be added to the mailto URL you provide. The most commonly-used of these are "subject", "cc", and "body" (which is not a true header field, but allows you to specify a short content message for the new email). Each field and its value is specified as a query term.

https://developer.mozilla.org/de/docs/Web/Guide/HTML/Email_links
https://tools.ietf.org/html/rfc2368

Example

mailto:[email protected]?Subject=react-mailto%20needs%20header&cc=cc%40example.com&bcc=bcc%40example.com&body=This%20is%20just%20an%20example.%20%0AThere%20a%20lot%20more%20headers%20that%20could%20be%20added.

Try Me!

Integration

I suggest to add an headers property.

<Mailto 
  email="[email protected]" 
  headers={{
    bcc: '[email protected]',
    cc: '[email protected]',
    subject: 'someSubject',
    body: 'some body',
    ...
  }}>
  Email me!
</Mailto>

Header

Is it a possible to add attachment in mail?

Email need not be required

Having all recipient's in bcc seems like a fairly common use-case for notices, in which case there need not be anything in the to field.

Warning when on React 15

I'm on React 15.5.4 and I'm getting the following error when using react-mailto:

Warning: Accessing PropTypes via the main React package is deprecated. Use the prop-types package from npm instead.

React 16 solution

Plz remove imports and change with:

import React, { Component } from 'react';
import PropTypes from 'prop-types';

obfuscate doesn't work

<Mailto email="[email protected]" obfuscate>
  Email me!
</Mailto>

returns

<a href="mailto:obfuscated">Email me!</a>

Cannot read property 'node' of undefined

In the react v-16>

103 | }(_react.Component);
104 |
105 | Mailto.propTypes = {

106 | children: _react.PropTypes.node.isRequired,
107 | email: _react.PropTypes.string.isRequired,
108 | headers: _react.PropTypes.object,
109 | obfuscate: _react.PropTypes.bool

shows the error