Windows Virtual Shields for Arduino
Public Member Functions | List of all members
Email Class Reference

#include <Email.h>

Inherits Sensor.

Public Member Functions

 Email (const VirtualShield &shield)
 Initializes a new instance of the Email class. More...
 
int send (String to, String subject, String message, String cc=(const char *) 0, String attachment=(const char *) 0)
 Initiates an email. More...
 
void onJsonReceived (JsonObject &root, ShieldEvent *shieldEvent) override
 Event called when a valid json message was received. Consumes the proper values for this sensor. More...
 
- Public Member Functions inherited from Sensor
 Sensor (const VirtualShield &shield, const char sensorType)
 Initializes a new instance of the Sensor class. More...
 
int start (double delta=0, long interval=0)
 Starts the sensor, triggered when longer than the interval and larger than the delta. More...
 
virtual int stop ()
 Stops this sensor. More...
 
int get ()
 Gets a single, current sensor reading. More...
 
int getOnChange (double delta=0)
 Requests a single reading when more than the delta beyond the current reading. More...
 
bool isUpdated ()
 Determines whether this sensor has an updated value. Resets to false after this call. More...
 
int writeAll (const char *serviceName, EPtr values[], int count, Attr extraAttributes[]=0, int extraAttributeCount=0)
 Writes all EPtr values to the communication channel. More...
 
int sensorAction (SensorAction sensorAction, double delta=0, long interval=0) const
 Sends the specific action to start/stop/get/onChange the sensor using a delta and interval. More...
 
virtual bool isEvent (const char *tag, const char *action, ShieldEvent *shieldEvent)
 Determines whether the specified shieldEvent matches the tag and action. More...
 
virtual bool isEvent (int id, const char *action, ShieldEvent *shieldEvent)
 Determines whether the specified shieldEvent matches the id and action. More...
 
void setOnEvent (void(*onEvent)(ShieldEvent *shieldEvent))
 
int sendStop (const char *serviceName)
 

Additional Inherited Members

- Public Attributes inherited from Sensor
void(* onEvent )(ShieldEvent *shieldEvent)
 
VirtualShieldshield
 
ShieldEvent recentEvent
 
const char sensorType
 
bool isRunning = false
 
- Protected Attributes inherited from Sensor
bool _isUpdated = false
 

Constructor & Destructor Documentation

Email::Email ( const VirtualShield shield)

Initializes a new instance of the Email class.

Parameters
shieldThe shield.

Member Function Documentation

void Email::onJsonReceived ( JsonObject &  root,
ShieldEvent shieldEvent 
)
overridevirtual

Event called when a valid json message was received. Consumes the proper values for this sensor.

Parameters
rootThe root json object.
shieldEventThe shield event.

Reimplemented from Sensor.

int Email::send ( String  to,
String  subject,
String  message,
String  cc = (const char *)0,
String  attachment = (const char *)0 
)

Initiates an email.

Parameters
toTo email address.
subjectThe subject.
messageThe message.
ccThe cc email address.
attachmentThe attachment url.
Returns
The id of the message. Negative if an error.

The documentation for this class was generated from the following files: