Skip to content

Commit

Permalink
mail: readme
Browse files Browse the repository at this point in the history
  • Loading branch information
Koushik Dutta authored and Koushik Dutta committed Jul 1, 2023
1 parent 33477fd commit d9dccf3
Show file tree
Hide file tree
Showing 3 changed files with 289 additions and 343 deletions.
18 changes: 6 additions & 12 deletions plugins/smtp/README.md
Original file line number Diff line number Diff line change
@@ -1,15 +1,9 @@
# @scrypted/smtp
# Mail Server (SMTP) Triggers for Scrypted

## npm commands
* npm run scrypted-webpack
* npm run scrypted-deploy <ipaddress>
* npm run scrypted-debug <ipaddress>
The SMTP plugin can be used to create email address that can be used to turn Scrypted devices on and off when it receives mail.

## scrypted distribution via npm
1. Ensure package.json is set up properly for publishing on npm.
2. npm publish
This plugin is typically used in conjuction with the Dummy Switch plugin, and a camera that can send mail on motion.

## Visual Studio Code configuration

* If using a remote server, edit [.vscode/settings.json](blob/master/.vscode/settings.json) to specify the IP Address of the Scrypted server.
* Launch Scrypted Debugger from the launch menu.
1. Use the Dummy Switch Plygin to create a Dummy Switch activated motion sensor.
2. Enable SMTP/Mail on the Dummy Switch and set up the inbox.
3. Configure the camera to send mail to that mail address ie, camera@server-ip.
Loading

0 comments on commit d9dccf3

Please sign in to comment.