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 EtherealStyleEmailView
[show private | hide private]
[frames | no frames]

Class EtherealStyleEmailView

     View --+    
            |    
BaseEmailView --+
                |
               EtherealStyleEmailView


Sends out an email in the Ethereal commit message style.

The log message is followed by a list of file deltas. This provides useful change information without blasting the recipient(s) with multimegabyte diffs.

This view has several properties:
  • server (required) - the mail server to relay through
  • subject (required) - the subject line (e.g. "commit: $model.greatestCommonDirectory()"). A list of directories/files will be appended.
  • from (required) - the from email address (e.g. "$model.user@yourdomain.com")
  • to (required) - a comma-separated list of email addresses to send to
  • header (optional) - text to put at the beginning of the email
  • footer (optional) - text to put at the end of the email
  • maxfiles (optional) - the maximum number of files to list
Contributed by Gerald Combs <gerald [AT] ethereal.com>
Method Summary
  __init__(self, name, model)
Initializes the the username to None, header, footer, and rfc_header
  generateBody(self, text)
Return a string for the body of the email
  generateSubject(self, text)
Wrap the subject at 75 characters, and cap it at three lines.
    Inherited from BaseEmailView
  __getitem__(self, name)
Used to get the 'from' attribute (as it is a keyword)
  execute(self)
Sends the email with commit information
    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 username to None, header, footer, and rfc_header

The username is default to None, header to 'This is a multi-part message in MIME format.', footer to '' and rfc_header to the MIME boundary.
Overrides:
commitmessage.views.email.BaseEmailView.__init__

generateBody(self, text)

Returns:
a string for the body of the email

generateSubject(self, text)

Wrap the subject at 75 characters, and cap it at three lines. Append "..." if the subject is truncated.
Overrides:
commitmessage.views.email.BaseEmailView.generateSubject

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