From aa800f70fe64a28c980c3343a5b7eca19c2e459d Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Simon=20St=C3=BCrz?= Date: Tue, 18 Jun 2019 17:29:36 +0200 Subject: [PATCH] Migrate mailnotification plugin documentation --- mailnotification/README.md | 5 +++ .../devicepluginmailnotification.cpp | 34 ------------------- 2 files changed, 5 insertions(+), 34 deletions(-) create mode 100644 mailnotification/README.md diff --git a/mailnotification/README.md b/mailnotification/README.md new file mode 100644 index 00000000..73ab1d05 --- /dev/null +++ b/mailnotification/README.md @@ -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. diff --git a/mailnotification/devicepluginmailnotification.cpp b/mailnotification/devicepluginmailnotification.cpp index 15fcc3f3..7776b91f 100644 --- a/mailnotification/devicepluginmailnotification.cpp +++ b/mailnotification/devicepluginmailnotification.cpp @@ -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 "plugin/device.h"