source: TI03-DataExtractor/branches/old_stuff/dx-webservice/doc/mailUser_module.txt @ 793

Subversion URL: http://proj.badc.rl.ac.uk/svn/ndg/TI03-DataExtractor/branches/old_stuff/dx-webservice/doc/mailUser_module.txt@793
Revision 793, 780 bytes checked in by astephen, 13 years ago (diff)

Put all the old code in the old_stuff branch.

Line 
1Help on module mailUser:
2
3NAME
4    mailUser
5
6FILE
7    /usr/local/dx-0.1.1/mailUser.py
8
9DESCRIPTION
10    mailUser.py
11    ===========
12   
13    Holds the MailUser class used to contact the user via e-mail to
14    inform them of an event.
15
16CLASSES
17    MailUser
18   
19    class MailUser
20     |  MailUser class - sets up a mail message and sends.
21     | 
22     |  Methods defined here:
23     | 
24     |  __init__(self, userEmail, subject)
25     |      __init__ method - takes the recipients e-mail address and mail subject
26     |      as arguments and then sets up the instance variables to be used by the
27     |      sendMail method.
28     | 
29     |  sendMail(self, message)
30     |      sendMail method - takes the message content, compiles the full message
31     |      and mails to user.
32
Note: See TracBrowser for help on using the repository browser.