https://github.com/inukshuk/arkivo-mailer

An Arkivo mailer plugin
https://github.com/inukshuk/arkivo-mailer

Last synced: 4 months ago
JSON representation

An Arkivo mailer plugin

• Host: GitHub
• URL: https://github.com/inukshuk/arkivo-mailer
• Owner: inukshuk
• License: agpl-3.0
• Created: 2015-04-19T18:12:55.000Z (over 10 years ago)
• Default Branch: master
• Last Pushed: 2016-02-25T13:05:07.000Z (over 9 years ago)
• Last Synced: 2025-02-26T20:05:49.721Z (8 months ago)
• Language: JavaScript
• Size: 26.4 KB
• Stars: 0
• Watchers: 3
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
arkivo-mailer

=============

[![Build Status](https://travis-ci.org/inukshuk/arkivo-mailer.svg?branch=master)](https://travis-ci.org/inukshuk/arkivo-mailer)

[![Coverage Status](https://coveralls.io/repos/inukshuk/arkivo-mailer/badge.svg)](https://coveralls.io/r/inukshuk/arkivo-mailer)

An [Arkivo](https://github.com/inukshuk/arkivo) plugin to send

Zotero attachments by e-mail.

Quickstart

----------

Install `arkivo` and `arkivo-mailer` with NPM:

    $ npm install arkivo arkivo-mailer

Needless to say, you can also install both modules globally.

Add a minimal configuration file, e.g., `config/default.json`:

    {

      "arkivo": {

        "plugins": [ "arkivo-mailer" ]

      }

    }

You can also configure the plugin's default settings in your

config file:

    {

      "arkivo": {

        "plugins": [ "arkivo-mailer" ],

        "mailer": {

          "from": "arkivo@zotero.org",

          "subject": "Arkivo Update",

          "mimetypes" [

            "application/pdf"

          ]

        }

      }

    }

For more configuration options, please consult Arkivo's

[documentation](https://github.com/inukshuk/arkivo#configuration).

Now you start your Arkivo service:

    $ $(npm bin)/arkivo up

To ensure that the mailer plugin has been loaded, you can

check the output of:

    $ $(npm bin)/arkivo-plugins list