kintone SendGrid plug-in

This plug-in enables kintone to send Emails through SendGrid.

Documentation

See here in Japanese.

Usage

1. Make Email templates in SendGrid. Both dynamic and legacy templates are supported.
2. Install this plug-in into your environment.
3. Add this plug-in into kintone apps which send emails from.
4. Set general settings in the SendGrid plug-in.

API Keys

1. Create an API key on the SendGrid web portal.
2. Set the API key into the SendGrid plug-in settings.

Mail settings

1. Enter the From address into the SendGrid plug-in settings.
2. Select the kintone field for the To.

Template settings

1. Select the default template name.

Substitution tags settings and Dynamic template data settings (Optional)

1. Click the [+] button for adding option parameters.
2. Enter the tag which you want to use in the templates.
3. Select the kintone field for the tag.

Requirement

• SendGrid account.
• kintone account.
• Browser
  • Google Chrome
  • Mozzila firefox

Development

1. Cloning the repository to any folder.

$ cd /Path/to/the/folder
$ git clone https://github.com/SendGridJP/kintone-sendgrid-plugin.git

2. Resolving dependencies.

$ cd kintone-sendgrid-plugin
$ npm install

3. Set environment variables for plugin uploader and plugin packer.

# Variables for plugin uploader
export KINTONE_DOMAIN=XXXXXXXX.cybozu.com
export KINTONE_USERNAME=%%KINTONE UERNAME%%
export KINTONE_PASSWORD=%%KINTONE PASSWORD%%
# Variables for plugin packer
export KINTONE_PPK=%%PPK FILE%%.ppk

3. Building a plugin file.

$ npm run build

> kintone-sendgrid-plugin@1.0.0 build /Path/to/the/folder/kintone-sendgrid-plugin
> kintone-plugin-packer ./sendgrid --ppk $KINTONE_PPK

Succeeded: /Path/to/the/folder/kintone-sendgrid-plugin/plugin.zip

4. Uploading the plugin file.

$ npm run upload

> kintone-sendgrid-plugin@1.0.0 upload /Path/to/the/folder/kintone-sendgrid-plugin
> kintone-plugin-uploader --domain $KINTONE_DOMAIN --username $KINTONE_USERNAME --password $KINTONE_PASSWORD plugin.zip

Open https://XXXXXXXX.cybozu.com/login?saml=off
Trying to log in...
Navigate to https://XXXXXXXX.cybozu.com/k/admin/system/plugin/
Trying to upload plugin.zip
plugin.zip をアップロードしました!

5. Creating test data

$ cd test/data
$ ruby make.rb

Licence

MIT

Author

Wataru Sato

Copyright

Kozo Keikaku Engineering Inc.