cbdavide/kindle

kindle

a command line file pusher for your kindle.

Installation

$ [sudo] npm install kindle -g

Setup Guide

setup your sender's email(SMTP) via $ kindle config --user.mail and $ kindle config --user.password.
setup your sender's email be trusted in Amazon Kindle Dashboard.
push files via command line like $ kindle send mybook.pdf to your @kindle.com email account.
enjoy reading :)

Configs Guide

config sender's email

$ kindle config --user.mail sample@mail.com --user.password pass

configs @kindle.com email

$ kindle config --kindle.mail sample@kindle.com

Example

'use strict'

const kindle = require('../libs/kindle')

kindle.push({
  to: 'sample@kindle.com',
  from: 'sample@mail.com',
  sender: {
    email: 'sample@mail.com',
    password: 'password'
  },
  files: ['./file.mobi'] // file need to be send
})
.then(data => {
  console.log(data)
})
.catch(err => {
  console.log(err)
})

// config a sender's email
kindle.config('sender', {
  email: 'sample@mail.com',
  password: 'pass'
})

// config a receiver's email
kindle.config('mime', 'mail@kindle.com')

// a shortcut to push files quickly,
// by default, it will search emails be configed before.
kindle.push({
  files: ['./file.mobi'] // 需要发送的文件
})
.then(data => {
  console.log(data)
})
.catch(err => {
  console.log(err)
})

Supported File Types:

Microsoft Word (.DOC, .DOCX)
HTML (.HTML, .HTM)
RTF (.RTF)
JPEG (.JPEG, .JPG)
Kindle Format (.MOBI, .AZW)
GIF (.GIF)
PNG (.PNG)
BMP (.BMP)
PDF (.PDF)

Contributing

Fork this repo
Clone your repo
Install dependencies
Checkout a feature branch
Feel free to add your features
Make sure your features are fully tested
Open a pull request, and enjoy <3

MIT license

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

built upon love by docor v0.1.3

cbdavide / kindle