Login | Register
My pages Projects Community openCollabNet

Welcome to the new Tigris! There have been some changes to the administration of mail lists. Project and list owners should check out the Discussion Services release notes.

Package commitmessage :: Package views :: Module email :: Class BaseEmailView
[show private | hide private]
[frames | no frames]

Class BaseEmailView

View --+
       |
      BaseEmailView

Known Subclasses:
ApacheStyleEmailView, EtherealStyleEmailView, HtmlEmailView, InlineAttachmentEmailView, TigrisStyleEmailView

A basic email implementation for other style-specific email views to extend

Core properties:
  • server (required) - the mail server to relay through
  • subject (required) - the subject line (e.g. "commit: $model.greatestCommonDirectory()")
  • from (required) - the from email address (e.g. "$model.user@yourdomain.com")
  • to (required) - a comma-separated list of email addresses to send to
  • cc (optional) - a comma-separated list of email addresses to cc to
  • header (optional) - text to put at the beginning of the email
  • footer (optional) - text to put at the end of the email
  • username - a SMTP auth username
  • password - a SMTP auth password
  • contenttype - the Content-Type header to use (defaults to: text/plain; charset="iso-8859-1")

Method Summary
  __init__(self, name, model)
Initializes the the SMTP username to None, header to '', and footer to ''
  __getitem__(self, name)
Used to get the 'from' attribute (as it is a keyword)
  execute(self)
Sends the email with commit information
  generateSubject(self, text)
    Inherited from View
  dumpToTestFile(self, text)
Writes out text to a file called SubClassName.txt
  isTesting(self)
Return whether acceptance testing is being performed
  testFilePath(self)
Return the path of the test dump file

Method Details

__init__(self, name, model)
(Constructor)

Initializes the the SMTP username to None, header to '', and footer to ''
Overrides:
commitmessage.model.View.__init__

__getitem__(self, name)
(Indexing operator)

Used to get the 'from' attribute (as it is a keyword)

execute(self)

Sends the email with commit information
Overrides:
commitmessage.model.View.execute

Generated by Epydoc 2.1 on Thu Jan 06 10:30:34 2005 http://epydoc.sf.net