source: products/vendor/Products.MailHost/current/src/Products/MailHost/help/Mail-Host.stx @ 3356

Last change on this file since 3356 was 3356, checked in by fenix, 8 years ago

Load 2.13.1 into vendor/Products.MailHost?/current.

File size: 1.6 KB
Line 
1MailHost: Sends mail through an SMTP server.
2
3  MailHosts allow you to send mail via the Simple Mail Transfer
4  Protocol (SMTP).
5
6  This object can be used deliver mail by the <dtml-sendmail> tag
7  or via the send() and simple_send() methods.
8
9    'send(messageText, mto=None, mfrom=None, subject=None, encode=None)'
10
11      Sends an email message where the messageText is an rfc822 formatted
12      message. This allows you complete control over the message headers,
13      including setting any extra headers such as Cc: and Reply-To:.
14      The arguments are:
15
16        messageText -- The mail message. It can either be a rfc822
17        formed text with header fields, or just a body without any
18        header fields. The other arguments given will override the
19        header fields in the message, if they exist.
20
21        mto -- A commaseparated string or list of recipient(s) of the message.
22
23        mfrom -- The address of the message sender.
24
25        subject -- The subject of the message.
26
27        encode -- The rfc822 defined encoding of the message.  The
28        default of 'None' means no encoding is done.  Valid values
29        are 'base64', 'quoted-printable' and 'uuencode'.
30
31    'simple_send(self, mto, mfrom, subject, body)'
32
33      Sends a message. Only To:, From: and Subject: headers can be set.
34      Note that simple_send does not process or validate its arguments
35      in any way.
36      The arguments are:
37
38        mto -- A commaseparated string of recipient(s) of the message.
39
40        mfrom -- The address of the message sender.
41
42        subject -- The subject of the message.
43
44        body -- The body of the message.
45
Note: See TracBrowser for help on using the repository browser.