svnmailer.notifier._textmail.TextMailNotifier

Package svnmailer :: Package notifier :: Module _textmail :: Class TextMailNotifier

[show private | hide private]

Class TextMailNotifier

  object --+        
           |        
BaseNotifier --+    
               |    
    TextNotifier --+
                   |
                  TextMailNotifier

Known Subclasses:: SendmailTextMailNotifier, SMTPTextMailNotifier

Bases class for mail notifiers

Method Summary
`tuple`	`_composeMail(self, groupset)` Composes the mail
`tuple` of `list`	`_getMailAdresses(self, groups)` Returns the substituted mail addresses (from/to/reply-to)
`str`	`_getMailSubject(self, groupset)` Returns the subject
`tuple`	`_getPrefixedDirectories(self, changeset)` Returns the longest common directory prefix
`tuple`	`_getPrefixedPaths(self, changeset)` Returns the longest common path prefix
	`_substitute(self, template, group)` Returns a filled template
	`run(self, groupset)` Send notification as mail
	`sendMail(self, sender, to_addr, mail)` Sends the mail
Inherited from TextNotifier
	`__init__(self, settings)` Initialization
`str`	`getDate(self)` Returns the revision date in a human readable format
	`writeContentDiff(self, change)` Writes the content diff for a particular change
`str`	`writeContentDiffAction(self, change)` Writes the content diff action for a particular change
	`writeDiff(self, token, name1, name2, value1, value2, isfile)` Writes a diff
	`writeDiffList(self)` Writes the commit diffs
	`writeMetaData(self)` Writes the commit metadata output
	`writeNotification(self, fp, config, changeset)` Writes the whole diff notification body
	`writePathInfo(self, change)` Writes a short info about the kind of change
	`writePathList(self)` Writes the commit path list
`str`	`writePropertyDiffAction(self, change, name, values, diff_tokens)` Writes the property diff action for a particular change
	`writePropertyDiffs(self, diff_tokens, change)` Writes the property diffs for a particular change
	`writeRevPropData(self)` Writes the revisio property change data
Inherited from BaseNotifier
`tuple` of `svnmailer.util.TempFile`	`dumpContent(self, change, enc)` Dump the two revisions of a particular change
`str`	`getAuthor(self)` Returns the author of the revision
`unicode`	`getContentDiffAction(self, change)` Returns the content diff action for a particular change
`str`	`getContentDiffUrl(self, config, change)` Returns the content diff url for a particular change
`svnmailer.differ.*`	`getDiffer(self)` Returns the initialized differ
`tuple`	`getDiffTokens(self, config)` Returns valid diff tokens and tests
`str`	`getLog(self)` Returns the log entry of the revision
`unicode`	`getPropertyDiffAction(self, values)` Returns the property diff action for a particular change
`svnmailer.util.TempFile`	`getTempFile(self)` Returns an open temporary file container object
`int`	`getTime(self)` Returns the time of the revision in seconds since epoch
`str`	`getUrl(self, config)` Returns the revision URL
`bool`	`isBinaryProperty(self, values)` Returns if the supplied property seems to be binary
`bool`	`isOneLineProperty(self, name, value)` Returns if the supplied property value takes just one line
Inherited from object
	`__delattr__(...)` x.__delattr__('name') <==> del x.name...
	`__getattribute__(...)` x.__getattribute__('name') <==> x.name...
	`__hash__(x)` x.__hash__() <==> hash(x)...
	`__reduce__(...)` helper for pickle...
	`__reduce_ex__(...)` helper for pickle...
	`__repr__(x)` x.__repr__() <==> repr(x)...
	`__setattr__(...)` x.__setattr__('name', value) <==> x.name = value...
	`__str__(x)` x.__str__() <==> str(x)...
Inherited from type
	`__new__(T, S, ...)` T.__new__(S, ...) -> a new object with type S, a subtype of T...

Instance Variable Summary
Inherited from TextNotifier
`list`	`changeset`: The list of changes to process
`svnmailer.settings._GroupSettingsContainer`	`config`: The group config
file like object	`fp`: The file to write to
Inherited from BaseNotifier
`svnmailer.settings.Settings`	`_settings`: The settings to use

Class Variable Summary
`type`	`__implements__` = `svnmailer.notifier._text.TextNotifier`
Inherited from TextNotifier
`str`	`OUTPUT_SEPARATOR`: the separator between headline and diff
`str`	`OUTPUT_SEPARATOR_LIGHT`: the separator between headline and property diff
Inherited from BaseNotifier
`tuple`	`_diffable_tests`: Map `generate_diffs` list entrys to change methods
`unicode`	`ADD`: "add" token
`unicode`	`COPY`: "copy" token
`unicode`	`DELETE`: "delete" token
`unicode`	`MODIFY`: "modify" token
`unicode`	`NONE`: "none" token
`unicode`	`PROPCHANGE`: "propchange" token

Method Details

_composeMail(self, groupset)

Composes the mail

Parameters:: groupset - The groupset to process
(type=list)

Returns:: The senders, the receivers, the mail
(type=tuple)

_getMailAdresses(self, groups)

Returns the substituted mail addresses (from/to/reply-to)

Parameters:: groups - The groups to process
(type=list)

Returns:: The address lists (from, to, reply-to)
(type=tuple of list)

_getMailSubject(self, groupset)

Returns the subject

Parameters:: groupset - The groupset to process
(type=list)

Returns:: The subject line
(type=str)

_getPrefixedDirectories(self, changeset)

Returns the longest common directory prefix

Parameters:: changeset - The change set
(type=list)

Returns:: The common dir and the path list
(type=tuple)

_getPrefixedPaths(self, changeset)

Returns the longest common path prefix

Parameters:: changeset - The change set
(type=list)

Returns:: The common dir and the path list
(type=tuple)

_substitute(self, template, group)

Returns a filled template

run(self, groupset)

Send notification as mail

Overrides:: svnmailer.notifier._base.BaseNotifier.run

sendMail(self, sender, to_addr, mail)

Sends the mail

Parameters:: sender - The mail sender (envelope from)
(type=str); to_addr - The receivers
(type=list); mail - The mail object
(type=_TextMail)

Generated by Epydoc 2.0 on Mon Feb 14 16:49:16 2005

http://epydoc.sf.net