Dependents:   TimeZoneDemo EthernetJackTestCode MMEx_Challenge ntp_mem ... more

Embed: (wiki syntax)

« Back to documentation index

EmailMessage Class Reference

EmailMessage Class Reference

A simple email message. More...

#include <EmailMessage.h>

Public Member Functions

 EmailMessage ()
 Instantiates the email message.
 ~EmailMessage ()
 Destructor for the email message.
void setFrom (const char *from)
 Set FROM address.
void addTo (const char *to)
 Add TO address to list of recipient addresses.
void clearTo ()
 Clear TO addresses.
int printf (const char *format,...)
 Append text to content of message using printf.
void clearContent ()
 Clear content previously appended by printf.

Friends

class SMTPClient

Detailed Description

A simple email message.

A class to hold the message addresses and content for sending (with SMTPClient).

Definition at line 41 of file EmailMessage.h.


Constructor & Destructor Documentation

EmailMessage (  )

Instantiates the email message.

Definition at line 31 of file EmailMessage.cpp.

~EmailMessage (  )

Destructor for the email message.

Definition at line 34 of file EmailMessage.cpp.


Member Function Documentation

void addTo ( const char *  to )

Add TO address to list of recipient addresses.

Parameters:
host: SMTP server host

Definition at line 41 of file EmailMessage.cpp.

void clearContent (  )

Clear content previously appended by printf.

Definition at line 66 of file EmailMessage.cpp.

void clearTo (  )

Clear TO addresses.

Definition at line 45 of file EmailMessage.cpp.

int printf ( const char *  format,
  ... 
)

Append text to content of message using printf.

Parameters:
format: printf format followed by ... variables

Can be called multiple times to write the message

Definition at line 49 of file EmailMessage.cpp.

void setFrom ( const char *  from )

Set FROM address.

Parameters:
from: email from address

Definition at line 37 of file EmailMessage.cpp.