File: module-Mail.html

package info (click to toggle)
cherrypy 0.10-1
  • links: PTS
  • area: main
  • in suites: sarge
  • size: 10,324 kB
  • ctags: 1,759
  • sloc: python: 14,411; sh: 6,915; perl: 2,472; makefile: 76
file content (141 lines) | stat: -rw-r--r-- 5,644 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<html>
<head>
<title>1.1 Mail -- Simple smtplib wrapper to send e-mails.</title>
<META NAME="description" CONTENT="1.1 Mail -- Simple smtplib wrapper to send e-mails.">
<META NAME="keywords" CONTENT="lib">
<META NAME="resource-type" CONTENT="document">
<META NAME="distribution" CONTENT="global">
<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
<link rel="STYLESHEET" href="lib.css" type='text/css'>
<link rel="first" href="lib.html">
<link rel="contents" href="contents.html" title="Contents">

<LINK REL="next" href="module-HttpAuthenticate.html">
<LINK REL="previous" HREF="node3.html">
<LINK REL="up" HREF="node3.html">
<LINK REL="next" href="module-HttpAuthenticate.html">
<meta name='aesop' content='information'>
</head>
<body>
<DIV CLASS="navigation">
<table align="center" width="100%" cellpadding="0" cellspacing="2">
<tr>
<td><A HREF="node3.html"><img src="../icons/previous.gif"
  border="0" height="32"
  alt="Previous Page" width="32"></A></td>
<td><A HREF="node3.html"><img src="../icons/up.gif"
  border="0" height="32"
  alt="Up One Level" width="32"></A></td>
<td><A href="module-HttpAuthenticate.html"><img src="../icons/next.gif"
  border="0" height="32"
  alt="Next Page" width="32"></A></td>
<td align="center" width="100%">CherryPy Standard Library Reference</td>
<td><A href="contents.html"><img src="../icons/contents.gif"
  border="0" height="32"
  alt="Contents" width="32"></A></td>
<td><img src="../icons/blank.gif"
  border="0" height="32"
  alt="" width="32"></td>
<td><img src="../icons/blank.gif"
  border="0" height="32"
  alt="" width="32"></td>
</tr></table>
<b class="navlabel">Previous:</b> <a class="sectref" HREF="node3.html">1. Module list</A>
<b class="navlabel">Up:</b> <a class="sectref" HREF="node3.html">1. Module list</A>
<b class="navlabel">Next:</b> <a class="sectref" href="module-HttpAuthenticate.html">1.2 HttpAuthenticate  </A>
<br><hr>
</DIV>
<!--End of Navigation Panel-->

<H1><A NAME="SECTION003100000000000000000">
1.1 <tt class="module">Mail</tt> -- Simple smtplib wrapper to send e-mails.</A>
</H1>

<P>
This module is a very simple module (the source code is only 20 lines) that allows you to send e-mails from
your CherryPy program.

<P>
The module defines an abstract CherryClass called <tt class="class">Mail</tt>, with one member variable called <var>smtpServer</var> and
one method called <var>sendMail</var>.

<P>
To use it, just derive the <var>Mail</var> CherryClass, set <var>smtpServer</var> in the <var>__init__</var> method, and then
call <var>sendMail</var> to send an e-mail:

<P>
<dl><dt><b><a name="l2h-2"><tt class="member">variable: smtpServer</tt></a></b>
<dd>
String containing the address of the Smtp server
</dl>

<P>
<dl><dt><b><a name="l2h-3"><tt class="function">function: sendMail</tt></a></b>(<var>sender, receiver, bcc, contentType, subject, msg</var>)
<dd>
This functions sends an e-mail according to the parameters. All parameters must be a string. <var>contentType</var> should be
either "text/plain" or "text/html". Depending on <var>contentType</var>, <var>msg</var> should contain either plain text or html text.
This functions uses Python's <var>smtplib</var> library to send the e-mail. It uses the value of <var>smtpServer</var> to send
the email.
</dl>

<P>
<dl><dt><b><a name="l2h-4"><tt class="function">function: sendHtmlMail</tt></a></b>(<var>sender, receiver, bcc, subject, txtmsg, htmlmsg</var>)
<dd>
This functions sends an HTML e-mail according to the parameters. All parameters must be a string.
This functions uses Python's <var>smtplib</var> and <var>MimeWriter</var> modules to send the e-mail. It uses the value of <var>smtpServer</var> to send the email.
</dl>

<P>
Exemple:
<div class="verbatim"><pre>
use Mail
CherryClass MyMail(Mail):
function:
    def __init__(self):
        self.smtpServer='smtp.site.com'
CherryClass Root:
mask:
    def index(self):
        &lt;py-exec="myMail.sendMail('me@site.com', 'you@yourhost.com', '', 'text/plain', 'Hello', 'Hello,\nthis is me')"&gt;
        &lt;html&gt;&lt;body&gt;
            Hi, I just sent an e-mail to you@yourhost.com
        &lt;/body&gt;&lt;/html&gt;
</pre></div>

<DIV CLASS="navigation">
<p><hr>
<table align="center" width="100%" cellpadding="0" cellspacing="2">
<tr>
<td><A HREF="node3.html"><img src="../icons/previous.gif"
  border="0" height="32"
  alt="Previous Page" width="32"></A></td>
<td><A HREF="node3.html"><img src="../icons/up.gif"
  border="0" height="32"
  alt="Up One Level" width="32"></A></td>
<td><A href="module-HttpAuthenticate.html"><img src="../icons/next.gif"
  border="0" height="32"
  alt="Next Page" width="32"></A></td>
<td align="center" width="100%">CherryPy Standard Library Reference</td>
<td><A href="contents.html"><img src="../icons/contents.gif"
  border="0" height="32"
  alt="Contents" width="32"></A></td>
<td><img src="../icons/blank.gif"
  border="0" height="32"
  alt="" width="32"></td>
<td><img src="../icons/blank.gif"
  border="0" height="32"
  alt="" width="32"></td>
</tr></table>
<b class="navlabel">Previous:</b> <a class="sectref" HREF="node3.html">1. Module list</A>
<b class="navlabel">Up:</b> <a class="sectref" HREF="node3.html">1. Module list</A>
<b class="navlabel">Next:</b> <a class="sectref" href="module-HttpAuthenticate.html">1.2 HttpAuthenticate  </A>
<hr>
<span class="release-info">Release 0.10, documentation updated on 19 March 2004.</span>
</DIV>
<!--End of Navigation Panel-->
<ADDRESS>
See <i><a href="about.html">About this document...</a></i> for information on suggesting changes.
</ADDRESS>
</BODY>
</HTML>