ETM-Schurig/etm-powersync-plugins
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Migrate mailnotification plugin documentation

Browse Source
This commit is contained in:
Simon Stürz 2019-06-18 17:29:36 +02:00
parent d992e2de51
commit aa800f70fe
2 changed files with 5 additions and 34 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
mailnotification/README.md Normal file
View File

@ -0,0 +1,5 @@
# Mail notification
The mail notification plugin allows you to send a mail notification from a mail account by performing an action.
> Note: Google mail is currently not supported since that requires OAuth2.0 which is currently a missing feature.

34
mailnotification/devicepluginmailnotification.cpp
View File

@ -20,40 +20,6 @@
* * * *
* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */ * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */
/*!
\page mailnotification.html
\title Mail Notification
\brief Plugin which allows to get mail notification from nymea.
\ingroup plugins
\ingroup nymea-plugins
The mail notification plugin allows you to send a mail notification from a mail
account by performing an \l{Action}.
ATTENTION: The password currently will be saved as plain text in the nymea settings file.
This will be changed soon...
\chapter Supported services
\section2 Yahoo Mail
The Yahoo Mail Notification you can send a mail with your yahoo address to a recipient. The username
is your mail address (e.g. "chuck.norris@yahoo.com"). The recipient will receive the notification
from your yahoo account.
\section2 Custom Mail
With the Custom Mail Notification you can set up a custom SMTP connection. The supported authentication
methods are ["PLAIN", "LOGIN"], the supported encryption methods are ["NONE", "SSL", "TLS"].
\chapter Plugin properties
Following JSON file contains the definition and the description of all available \l{DeviceClass}{DeviceClasses}
and \l{Vendor}{Vendors} of this \l{DevicePlugin}.
For more details how to read this JSON file please check out the documentation for \l{The plugin JSON File}.
\quotefile plugins/deviceplugins/mailnotification/devicepluginmailnotification.json
*/
#include "devicepluginmailnotification.h" #include "devicepluginmailnotification.h"
#include "plugin/device.h" #include "plugin/device.h"