- Name
- Synopsis
- Description
- Usage
- Class Interface
- Instance Interface
- Instance Methods
- Accessors
- repos_path
- revision
- to
- to_regex_map
- to_email_map
- from
- user_domain
- svnlook
- sendmail
- set_sender
- smtp
- charset
- io_layer
- language
- with_diff
- attach_diff
- diff_switches
- reply_to
- add_headers
- subject_prefix
- subject_cx
- strip_cx_regex
- max_sub_length
- max_diff_length
- author_url
- revision_url
- svnweb_url
- viewcvs_url
- verbose
- bondary
- user
- date
- message
- message_size
- subject
- files
- header
- footer
- See Also
- Bugs
- Author
- Copyright and License
Name 
SVN::Notify - Subversion activity notification
Synopsis
Use svnnotify in post-commit:
svnnotify --repos-path "$1" --revision "$2" \
--to developers@example.com [options]
svnnotify --repos-path "$1" --revision "$2" \
--to-cx-regex i10n@example.com=I10N [options]
Use the class in a custom script:
use SVN::Notify;
my $notifier = SVN::Notify->new(%params);
$notifier->prepare;
$notifier->execute;
Description
This class may be used for sending email messages for Subversion repository activity. There are a number of different modes supported, and SVN::Notify is fully subclassable to easily add new functionality. By default, A list of all the files affected by the commit will be assembled and listed in a single message. An additional option allows diffs to be calculated for the changes and either appended to the message or added as an attachment. See the with_diff and attach_diff options below.
Usage
To use SVN::Notify, simply add a call to svnnotify to your Subversion repository's post-commit script. This script lives at the root of the repository directory; consult the documentation in post-commit.tmpl for details. Make sure that you specify the complete path to svnnotify, as well as to svnlook and sendmail in the options passed to svnnotify so that everything executes properly.
Windows Usage
To get SVN::Notify to work properly in a post-commit script, you must set the following environment variables, as they will likley not be present inside Apache:
See http://svn.haxx.se/users/archive-2006-05/0593.shtml for more detailed information on getting SVN::Notify running on Windows. If you have issues with asynchronous execution, try using HookStart.exe (http://www.koders.com/csharp/fidE2724F44EF2D47F1C0FE76C538006435FA20051D.aspx) to run svnnotify.
Class Interface
Constructor
new
my $notifier = SVN::Notify->new(%params);
Constructs and returns a new SVN::Notify object. This object is a handle on the whole process of collecting metadata and content for the commit email and then sending it. As such, it takes a number of parameters to affect that process.
Each of these parameters has a corresponding command-line option that can be passed to svnnotify. The options have the same names as these parameters, but any underscores you see here should be replaced with dashes when passed to svnnotify. Each also has a corresponding single-character option. All of these are documented here.
Supported parameters:
- repos_path
-
svnnotify --repos-path "$PATH"
svnnotify -p "$PATH"The path to the Subversion repository. The path is passed as the first argument when Subversion executes post-commit. So you can simply pass
$1to this parameter if you like. See the documentation in post-commit for details. Required. - revision
-
svnnotify --revision "$REV"
svnnotify -r "$REV"The revision number for the current commit. The revision number is passed as the second argument when Subversion executes post-commit. So you can simply pass
$2to this parameter if you like. See the documentation in post-commit for details. Required. - to
-
svnnotify --to commiters@example.com
svnnotify -t commiters@example.com --to managers@example.comThe address or addresses to which to send the notification email. Can be used multiple times to specify multiple addresses. This parameter is required unless either
to_regex_maporto_email_mapis specified. - to_regex_map
-
svnnotify --to-regex-map translate@example.com=L18N \
-x legal@example.com=LicenseThis parameter specifies a hash reference of email addresses to regular expression strings. SVN::Notify will compile the regular expression strings into regular expression objects, and then send notification messages if and only if the name of one or more of the directories affected by a commit matches the regular expression. This is a good way to have a notification email sent to a particular mail address (or comma-delimited list of addresses) only for certain parts of the subversion tree. This parameter is required unless
toorto_email_mapis specified.The command-line options,
--to-regex_mapand-x, can be specified any number of times, once for each entry in the hash to be passed tonew(). The value passed to the option must be in the form of the key and the value separated by an equal sign. Consult the Getopt::Long documentation for more information.Here's an example complements of Matt Doar of how to use
to_regex_mapto do per-branch matching:author=`svnlook author $REPOS -r $REV`
# The mail regexes should match all the top-level directories
/usr/bin/svnnotify --repos-path "$REPOS" --revision "$REV" \
-x eng-bar@example.com,${EXTRAS}="^Bar" \
-x eng-foo@example.com,${EXTRAS}="^trunk/Foo|^branches/Foo|^tags/Foo" \
-x $author@example.com="^users" --subject-cx - to_email_map
-
svnnotify --to-email-map L18N=translate@example.com \
--to-email-map License=legal@example.comThe inverse of
to_regex_map: The regular expression is the hash key and the email address or addresses are the value. - from
-
svnnotify --from somewhere@example.com
svnnotify -f elsewhere@example.comThe email address to use in the "From" line of the email. If not specified, SVN::Notify will use the username from the commit, as returned by
svnlook info. - user_domain
-
svnnotify --user-domain example.com
svnnotify -D example.netA domain name to append to the username for the "From" header of the email. During a Subversion commit, the username returned by
svnlook infois usually something like a Unix login name. SVN::Notify will use this username in the email "From" header unless thefromparameter is specified. If you wish to have the username take the form of a real email address, specify a domain name and SVN::Notify will append\@$domain_nameto the username in order to create a real email address. This can be useful if all of your committers have an email address that corresponds to their username at the domain specified by theuser_domainparameter. - svnlook
-
svnnotify --svnlook /path/to/svnlook
svnnotify -l /path/to/svnlookThe location of the svnlook executable. If not specified, SVN::Notify will search through the directories in the
$PATHenvironment variable, plus in /usr/local/bin and /usr/sbin, for an svnlook executable. Specify a full path to svnlook via this option or by setting the$SVNLOOKenvironment variable if svnlook isn't in your path or to avoid loading File::Spec.It's important to provide a complete path to svnlook because the environment during the execution of post-commit is anemic, with nary a
$PATHenvironment variable to be found. So if svnnotify appears not to be working at all (and Subversion seems loathe to log when it dies!), make sure that you have specified the complete path to a working svnlook executable. - sendmail
-
svnnotify --sendmail /path/to/sendmail
svnnotify -s /path/to/sendmailThe location of the sendmail executable. If neither the
sendmailnor thesmtpparameter is specified, SVN::Notify will search through the directories in the$PATHenvironment variable, plus in /usr/local/bin and /usr/sbin, for an sendmail executable. Specify a full path to sendmail via this option or by setting the$SENDMAILenvironment variable if sendmail isn't in your path or to avoid loading File::Spec. The same caveats as applied to the location of the svnlook executable apply here. - set_sender
-
svnnotify --set-sender
svnnotify -EUses the
-foption tosendmailto set the envelope sender address of the email to the same address as is used for the "From" header. If you're also using thefromoption, be sure to make it only an email address. Don't include any other junk in it, like a sender's name. Ignored when usingsmtp. - smtp
-
svnnotify --smtp smtp.example.com
The address for an SMTP server through which to send the notification email. If unspecified, SVN::Notify will use sendmail to send the message. If sendmail is not installed locally (such as on Windows boxes!), you must specify an SMTP server.
- smtp_user
-
svnnotify --smtp-user myuser
The user name for SMTP authentication. If this option is specified, SVN::Notify will use Net::SMTP_auth to send the notification message, and will of course authenticate to the SMTP server.
- smtp_pass
-
svnnotify --smtp-pass mypassword
The password for SMTP authentication. Use in parallel with
smtp_user. - smtp_authtype
-
svnnotify --smtp-authtype authtype
The authentication method to use for authenticating to the SMTP server. The available authentication types include "PLAIN", "NTLM", "CRAM_MD5", and others. Consult the Authen::SASL documentation for a complete list. Defaults to "PLAIN".
- charset
-
svnnotify --charset UTF-8
svnnotify -c Big5The character set typically used on the repository for log messages, file names, and file contents. Used to specify the character set in the email Content-Type headers and, when the
languageparemeter is specified, the$LANGenvironment variable when launchingsendmail. Defaults to "UTF-8". - io_layer
-
svnnotify --io-layer raw
svnnotify -o bytesThe Perl IO layer to use for inputting and outputting data. See perlio for details. Defaults to "encoding($charset)". If your repository uses different character encodings,
charsetshould be set to whatever is the most common character encoding, andio_layeris best set toraw, e.g.,--io-layer raw --charset cp850. In that case, some characters might not look right in the commit messaage (because an email can manage only one character encoding at a time), but thensvnnotifywon't get stuck issuing a slew of warnings. - language
-
svnnotify --language fr
svnnotify -g i-klingonThe language typically used on the repository for log messages, file names, and file contents. Used to specify the email Content-Language header and to set the
$LANGenvironment variable to$notify->language . '.' . $notify->charsetbefore executingsendmail. Undefined by default, meaning that no Content-Language header is output and the$LANGenvironment variable will not be set. - with_diff
-
svnnotify --with-diff
svnnotify -dA boolean value specifying whether or not to include the output of
svnlook diffin the notification email. The diff will be inline at the end of the email unless theattach_diffparameter specifies a true value. - attach_diff
-
svnnotify --attach-diff
svnnotify -aA boolean value specifying whether or not to attach the output of
svnlook diffto the notification email. Rather than being inline in the body of the email, this parameter causes SVN::Notify to attach the diff as a separate file, named for the user who triggered the commit and the date and time UTC at which the commit took place. Specifying this parameter to a true value implicitly sets thewith_diffparameter to a true value. - diff_switches
-
svnnotify --diff-switches '--no-diff-added'
svnnotify -w '--no-diff-deleted'Switches to pass to
svnlook diff, such as--no-diff-deletedand--no-diff-added. And who knows, maybe someday it will support the same options assvn diff, such as--diff-cmdand--extensions. Only relevant when used withwith_difforattach_diff. - reply_to
-
svnnotify --reply-to devlist@example.com
svnnotify -R developers@example.netThe email address to use in the "Reply-To" header of the notification email. No "Reply-To" header will be added to the email if no value is specified for the
reply_toparameter. - add_headers
-
svnnotify --add-header X-Approve=letMeIn
Add a header to the notification email message. The header name and its value must be separated by an equals sign. Specify the option multiple times in order to add multiple headers. Headers with the same names are allowed. Not to be confused with the
--headeroption, which adds introductory text to the beginning of the email body. - subject_prefix
-
svnnotify --subject-prefix [Devlist]
svnnotify -P [%d (Our-Developers)]An optional string to prepend to the beginning of the subject line of the notification email. If it contains '%d', it will be used to place the revision number; otherwise it will simply be prepended to the subject, which will contain the revision number in brackets.
- subject_cx
-
svnnotify --subject-cx
svnnotify -CA boolean value indicating whether or not to include a the context of the commit in the subject line of the email. In a commit that affects multiple files, the context will be the name of the shortest directory affected by the commit. This should indicate up to how high up the Subversion repository tree the commit had an effect. If the commit affects a single file, then the context will simply be the name of that file.
- strip_cx_regex
-
svnnotify --strip-cx-regex '^trunk/'
svnnotify --strip-cx-regex '^trunk/' --strip-cx-regex '^branches/'
svnnotify -X '^trunk'
svnnotify -X '^trunk' -X '^branches'One or more regular expressions to be used to strip out parts of the subject context. This can be useful for very deep Subversion trees, where the commits you're sending will always be sent from a particular subtree, so you'd like to remove part of the tree. Used only if
subject_cxis set to a true value. Pass an array reference if callingnew()directly. - no_first_line
-
svnnotify --no-first-line
svnnotify -OOmits the first line of the log message from the subject. This is most useful when used in combination with the
subject_cxparameter, so that just the commit context is displayed in the subject and no part of the log message. - header
-
svnnotify --header 'SVN::Notify is brought to you by Kineticode.
Adds a specified text to each message as a header at the beginning of the body of the message. Not to be confused with the
--add-headeroption, which adds a header to the headers section of the email. - footer
-
svnnotify --footer 'Copyright (R) by Kineticode, Inc.'
Adds a specified text to each message as a footer at the end of the body of the message.
- max_sub_length
-
svnnotify --max-sub-length 72
svnnotify -i 76The maximum length of the notification email subject line. SVN::Notify includes the first line of the commit log message, or the first sentence of the message (defined as any text up to the string ". "), whichever is shorter. This could potentially be quite long. To prevent the subject from being over a certain number of characters, specify a maximum length here, and SVN::Notify will truncate the subject to the last word under that length.
- max_diff_length
-
svnnotify --max-diff-length 1024
The maximum length of the diff (attached or in the body). The diff output is truncated at the last line under the maximum character count specified and then outputs an additional line indicating that the maximum diff size was reached and output truncated. This is helpful when a large diff output could cause a message to bounce due to message size.
- handler
-
svnnotify --handler HTML
svnnotify -H HTMLSpecify the subclass of SVN::Notify to be constructed and returned, and therefore to handle the notification. Of course you can just use a subclass directly, but this parameter is designed to make it easy to just use
SVN::Notify->newwithout worrying about loading subclasses, such as in svnnotify. Be sure to read the documentation for your subclass of choice, as there may be additional parameters and existing parameters may behave differently. - author_url
-
svnnotify --author-url 'http://svn.example.com/changelog/~author=%s/repos'
svnnotify --A 'mailto:%s@example.com'If a URL is specified for this parameter, then it will be used to create a link for the current author. The URL can have the "%s" format where the author's username should be put into the URL.
- revision_url
-
svnnotify --revision-url 'http://svn.example.com/changelog/?cs=%s'
svnnotify -U 'http://svn.example.com/changelog/?cs=%s'If a URL is specified for this parameter, then it will be used to create a link to the Subversion browser URL corresponding to the current revision number. It will also be used to create links to any other revision numbers mentioned in the commit message. The URL must have the "%s" format where the Subversion revision number should be put into the URL.
- svnweb_url
-
svnnotify --svnweb-url 'http://svn.example.com/index.cgi/revision/?rev=%s'
svnnotify -S 'http://svn.example.net/index.cgi/revision/?rev=%s'Deprecated. Use
revision_urlinstead. - viewcvs_url
-
svnnotify --viewcvs-url 'http://svn.example.com/viewcvs/?rev=%s&view=rev'
Deprecated. Use
revision_urlinstead. - ticket_map
-
svnnotify --ticket-map '\[?#\s*(\d+)\s*\]?=http://example.com/ticket?id=%s' \
--ticket-map 'rt=http://rt.cpan.org/NoAuth/Bugs.html?id=%s' \
--ticket-map '\b([A-Z]+-\d+)\b=http://jira/browse/%s'Specifies a mapping between a regular expression and a URL. The regular expression should return a single match to be interpolated into the URL, which should be a
sprintfformat using "%s" to place the match (usually the ticket identifier) from the regex. The command-line option may be specified any number of times for different ticketing systems. To the API, it must be passed as a hash reference.The first example matches "[#1234]" or "#1234" or "[# 1234]". This regex should be as specific as possible, preferably wrapped in "\b" to match word boundaries. If you're using SVN::Notify::HTML, be sure to read its documentation for a different regular expression requirement!
Optionally, the key value can be a placeholder for a regular expession used internally by SVN::Notify to match strings typically used for well-known ticketing systems. Those keys are:
- rt
-
Matches Request Tracker (RT) ticket references of the form "Ticket # 12", "ticket 6", "RT # 52", "rt 52", "RT-Ticket # 213" or even "Ticket#1066".
- bugzilla
-
Matches Bugzilla bug references of the form "Bug # 12" or "bug 6" or even "Bug#1066".
- jira
-
Matches JIRA references of the form "JRA-1234".
- gnats
-
Matches GnatsWeb references of the form "PR 1234".
- rt_url
-
svnnotify --rt-url 'http://rt.cpan.org/NoAuth/Bugs.html?id=%s'
svnnotify -T 'http://rt.perl.org/NoAuth/Bugs.html?id=%s'A shortcut for
--ticket-map 'rt=$url'provided for backwards compatibility. - bugzilla_url
-
svnnotify --bugzilla-url 'http://bugzilla.mozilla.org/show_bug.cgi?id=%s'
svnnotify -B 'http://bugs.bricolage.cc/show_bug.cgi?id=%s'A shortcut for
--ticket-map 'bugzilla=$url'provided for backwards compatibility. - jira_url
-
svnnotify --jira-url 'http://jira.atlassian.com/secure/ViewIssue.jspa?key=%s'
svnnotify -J 'http://nagoya.apache.org/jira/secure/ViewIssue.jspa?key=%s'A shortcut for
--ticket-map 'jira=$url'provided for backwards compatibility. - gnats_url
-
svnnotify --gnats-url 'http://gnatsweb.example.com/cgi-bin/gnatsweb.pl?cmd=view&pr=%s'
svnnotify -G 'http://gnatsweb.example.com/cgi-bin/gnatsweb.pl?cmd=view&pr=%s'A shortcut for
--ticket-map 'gnats=$url'provided for backwards compatibility. - ticket_url
-
svnnotify --ticket-url 'http://ticket.example.com/showticket.html?id=%s'
Deprecated. Use
ticket_map, instead. - ticket_regex
-
svnnotify --ticket-regex '\[?#\s*(\d+)\s*\]?'
Deprecated. Use
ticket_map, instead. - verbose
-
svnnotify --verbose -V
A value between 0 and 3 specifying how verbose SVN::Notify should be. The default is 0, meaning that SVN::Notify will be silent. A value of 1 causes SVN::Notify to output some information about what it's doing, while 2 and 3 each cause greater verbosity. To set the verbosity on the command line, simply pass the
--verboseor-Voption once for each level of verbosity, up to three times. Output from SVN::Notify is sent toSTDOUT. - boundary
-
The boundary to use between email body text and attachments. This is normally generated by SVN::Notify.
- subject
-
The subject of the email to be sent. This attribute is normally generated by
prepare_subject().
Class Methods
content_type
my $content_type = SVN::Notify->content_type;
Returns the content type of the notification message, "text/plain". Used to set the Content-Type header for the message.
register_attributes
SVN::Notify::Subclass->register_attributes(
foo_attr => 'foo-attr=s',
bar => 'bar',
bat => undef,
);
This class method is used by subclasses to register new attributes. Pass in a list of key/value pairs, where the keys are the attribute names and the values are option specifications in the format required by Getopt::Long. SVN::Notify will create accessors for each attribute, and if the corresponding value is defined, it will be used by the get_options() class method to get a command-line option value.
See register_attributes().
get_options
my $options = SVN::Notify->get_options;
Parses the command-line options in @ARGV to a hash reference suitable for passing as the parameters to new(). See "new" for a complete list of the supported parameters and their corresponding command-line options.
This method use Getopt::Long to parse @ARGV. It then looks for a handler option and, if it finds one, loads the appropriate subclass and parsed any options it requires from @ARGV. Subclasses should use register_attributes() to register any attributes and options they require.
file_label_map
my $map = SVN::Notify->file_label_map;
Returns a hash reference of the labels to be used for the lists of files. A hash reference of file lists is stored in the files attribute after prepare_files() has been called. The hash keys in that list correspond to Subversion status codes, and these are mapped to their appropriate labels by the hash reference returned by this method:
{ U => 'Modified Paths',
A => 'Added Paths',
D => 'Removed Paths',
_ => 'Property Changed'
} find_exe
my $exe = SVN::Notify->find_exe($exe_name);
This method searches through the system path, as well as the extra directories /usr/local/bin and /usr/sbin (because they're common paths for svnlook and sendmail for an executable file with the name $exe_name. The first one it finds is returned with its full path. If none is found, find_exe() returns undef.
Instance Interface
Instance Methods
prepare
$notifier->prepare;
Prepares the SVN::Notify object, collecting all the data it needs in preparation for sending the notification email. Really it's just a shortcut for:
$notifier->prepare_recipients;
$notifier->prepare_contents;
$notifier->prepare_files;
$notifier->prepare_subject;
Only it returns after the call to prepare_recipients() if there are no recipients (that is, as when recipients are specified solely by the to_regex_map or to_email_map parameter and none of the regular expressions match any of the affected directories).
prepare_recipients
$notifier->prepare_recipients;
Collects and prepares a list of the notification recipients. The recipients are a combination of the value passed to the to parameter as well as any email addresses specified as keys in the hash reference passed to_regex_map parameter or values passed to the to_email_map parameter, where the corresponding regular expressions stored in the hash matches one or more of the names of the directories affected by the commit.
If the subject_cx parameter to new() has a true value, prepare_recipients() also determines the directory name to use for the context.
prepare_contents
$notifier->prepare_contents;
Prepares the contents of the commit message, including the name of the user who triggered the commit (and therefore the contents of the "From" header to be used in the email) and the log message.
prepare_files
$notifier->prepare_files;
Prepares the lists of files affected by the commit, sorting them into their categories: modified files, added files, and deleted files. It also compiles a list of files wherein a property was set, which might have some overlap with the list of modified files (if a single commit both modified a file and set a property on it).
If the subject_cx parameter was specified and a single file was affected by the commit, then prepare_files() will also specify that file name as the context to be used in the subject line of the commit email.
prepare_subject
$notifier->prepare_subject;
Prepares the subject line for the notification email. This method must be called after prepare_recipients() and prepare_files(), since each of those methods potentially sets up the context for use in the the subject line. The subject may have a prefix defined by the subject_prefix parameter to new(), it has the revision number, it might have the context if the subject_cx specified a true value, and it will have the first sentence or line of the commit, whichever is shorter. The subject may then be truncated to the maximum length specified by the max_sub_length parameter.
execute
$notifier->execute;
Sends the notification message. This involves opening a file handle to sendmail or a tied file handle connected to an SMTP server and passing it to output(). This is the main method used to send notifications or execute any other actions in response to Subversion activity.
output
$notifier->output($file_handle);
$notifier->output($file_handle, $no_headers);
Called internally by execute() to output a complete email message. The file a file handle, so that output() and its related methods can print directly to the email message. The optional second argument, if true, will suppress the output of the email headers.
Really output() is a simple wrapper around a number of other method calls. It is thus essentially a shortcut for:
$notifier->output_headers($out) unless $no_headers;
$notifier->output_content_type($out);
$notifier->start_body($out);
$notifier->output_metadata($out);
$notifier->output_log_message($out);
$notifier->output_file_lists($out);
if ($notifier->with_diff) {
my $diff_handle = $self->diff_handle;
if ($notifier->attach_diff) {
$notifier->end_body($out);
$notifier->output_attached_diff($out, $diff_handle);
} else {
$notifier->output_diff($out, $diff_handle);
$notifier->end_body($out);
}
} else {
$notifier->end_body($out);
}
$notifier->end_message($out);
output_headers
$notifier->output_headers($file_handle);
Outputs the headers for the notification message headers. Should be called only once for a single email message.
output_content_type
$notifier->output_content_type($file_handle);
Outputs the content type and transfer encoding headers. These demarcate the body of the message. If the attach_diff parameter was set to true, then a boundary string will be generated and the Content-Type set to "multipart/mixed" and stored as the boundary attribute.
Arter that, this method outputs the content type returned by content_type(), the character set specified by the charset attribute, and a Content-Transfer-Encoding of "8bit". Subclasses can either rely on this functionality or override this method to provide their own content type headers.
start_body
$notifier->start_body($file_handle);
This method starts the body of the notification message, which means that it outputs the contents of the header attribute, if there are any. Otherwise it outputs nothing, but see subclasses for other behaviors.
output_metadata
$notifier->output_metadata($file_handle);
This method outputs the metadata of the commit, including the revision number, author (user), and date of the revision. If the author_url or revision_url attributes have been set, then the appropriate URL(s) for the revision will also be output.
output_log_message
$notifier->output_log_message($file_handle);
Outputs the commit log message, as well as the label "Log Message".
run_ticket_map
$notifier->run_ticket_map( \&callback, @params );
Loops over the ticket systems you have defined, calling the $callback function for each one, pasing to it the regex, url and @params specified as its parameters.
output_file_lists
$notifier->output_file_lists($file_handle);
Outputs the lists of modified, added, and deleted files, as well as the list of files for which properties were changed. The labels used for each group are pulled in from the file_label_map() class method.
end_body
$notifier->end_body($file_handle);
Closes out the body of the email by outtputing the contents of the footer attribute, if any, and then a couple of newlines. Designed to be called when the body of the message is complete, and before any call to output_attached_diff().
output_diff
$notifier->output_diff($out_file_handle, $diff_file_handle);
Reads diff data from $diff_file_handle and outputs it to to $out_file_handle.
output_attached_diff
$notifier->output_attached_diff($out_file_handle, $diff_file_handle);
Reads diff data from $diff_file_handle and outputs it to to $out_file_handle as an attachment.
end_message
$notifier->end_message($file_handle);
Outputs the final part of the message,. In this case, that means only a boundary if the attach_diff parameter is true. Designed to be called after any call to output_attached_diff().
diff_handle
my $diff = $notifier->diff_handle;
while (<$diff>) { print }
Returns a file handle reference providing access to the the commit diff. It will usually be passed as the second argument to output_diff() or output_attached_diff().
Accessors
repos_path
my $repos_path = $notifier->repos_path;
$notifier = $notifier->repos_path($repos_path);
Gets or sets the value of the repos_path attribute.
revision
my $revision = $notifier->revision;
$notifier = $notifier->revision($revision);
Gets or sets the value of the revision attribute.
to
my $to = $notifier->to;
$notifier = $notifier->to($to);
my @tos = $notifier->to;
$notifier = $notifier->to(@tos);
Gets or sets the list of values stored in the to attribute. In a scalar context, it returns only the first value in the list, for backards compatibility with older versions of SVN::Notify. In list context, it of course returns the entire list. Pass in one or more values to set all of the values for the to attribute.
to_regex_map
my $to_regex_map = $notifier->to_regex_map;
$notifier = $notifier->to_regex_map($to_regex_map);
Gets or sets the value of the to_regex_map attribute, which is a hash reference of email addresses mapped to regular expressions.
to_email_map
my $to_email_map = $notifier->to_email_map;
$notifier = $notifier->to_email_map($to_email_map);
Gets or sets the value of the to_email_map attribute, which is a hash reference of regular expressions mapped to email addresses.
from
my $from = $notifier->from;
$notifier = $notifier->from($from);
Gets or sets the value of the from attribute.
user_domain
my $user_domain = $notifier->user_domain;
$notifier = $notifier->user_domain($user_domain);
Gets or sets the value of the user_domain attribute.
svnlook
my $svnlook = $notifier->svnlook;
$notifier = $notifier->svnlook($svnlook);
Gets or sets the value of the svnlook attribute.
sendmail
my $sendmail = $notifier->sendmail;
$notifier = $notifier->sendmail($sendmail);
Gets or sets the value of the sendmail attribute.
set_sender
my $set_sender = $notifier->set_sender;
$notifier = $notifier->set_sender($set_sender);
Gets or sets the value of the set_sender attribute.
smtp
my $smtp = $notifier->smtp;
$notifier = $notifier->smtp($smtp);
Gets or sets the value of the smtp attribute.
charset
my $charset = $notifier->charset;
$notifier = $notifier->charset($charset);
Gets or sets the value of the charset attribute.
io_layer
my $io_layer = $notifier->io_layer;
$notifier = $notifier->io_layer($io_layer);
Gets or sets the value of the io_layer attribute.
language
my $language = $notifier->language;
$notifier = $notifier->language($language);
Gets or sets the value of the language attribute.
with_diff
my $with_diff = $notifier->with_diff;
$notifier = $notifier->with_diff($with_diff);
Gets or sets the value of the with_diff attribute.
attach_diff
my $attach_diff = $notifier->attach_diff;
$notifier = $notifier->attach_diff($attach_diff);
Gets or sets the value of the attach_diff attribute.
diff_switches
my $diff_switches = $notifier->diff_switches;
$notifier = $notifier->diff_switches($diff_switches);
Gets or sets the value of the diff_switches attribute.
reply_to
my $reply_to = $notifier->reply_to;
$notifier = $notifier->reply_to($reply_to);
Gets or sets the value of the reply_to attribute.
add_headers
my $add_headers = $notifier->add_headers;
$notifier = $notifier->add_headers({
'X-Accept' => [qw(This That)],
'X-Reject' => 'Me!',
});
Gets or sets the value of the add_headers attribute, which is a hash reference of the headers to be added to the email message. If one header needs to appear multiple times, simply pass the corresponding hash value as an array reference of each value for the header. Not to be confused with the header accessor, which gets and sets text to be included at the beginning of the body of the email message.
subject_prefix
my $subject_prefix = $notifier->subject_prefix;
$notifier = $notifier->subject_prefix($subject_prefix);
Gets or sets the value of the subject_prefix attribute.
subject_cx
my $subject_cx = $notifier->subject_cx;
$notifier = $notifier->subject_cx($subject_cx);
Gets or sets the value of the subject_cx attribute.
strip_cx_regex
my $strip_cx_regex = $notifier->strip_cx_regex;
$notifier = $notifier->strip_cx_regex($strip_cx_regex);
my @strip_cx_regexs = $notifier->strip_cx_regex;
$notifier = $notifier->strip_cx_regex(@strip_cx_regexs);
Gets or sets the list of values stored in the strip_cx_regex attribute. In a scalar context, it returns only the first value in the list; in list context, it of course returns the entire list. Pass in one or more values to set all of the values for the strip_cx_regex attribute.
max_sub_length
my $max_sub_length = $notifier->max_sub_length;
$notifier = $notifier->max_sub_length($max_sub_length);
Gets or sets the value of the max_sub_length attribute.
max_diff_length
my $max_diff_length = $notifier->max_diff_length;
$notifier = $notifier->max_diff_length($max_diff_length);
Gets or set the value of the max_diff_length attribute.
author_url
my $author_url = $notifier->author_url;
$notifier = $notifier->author_url($author_url);
Gets or sets the value of the author_url attribute.
revision_url
my $revision_url = $notifier->revision_url;
$notifier = $notifier->revision_url($revision_url);
Gets or sets the value of the revision_url attribute.
svnweb_url
Deprecated. Pleas use revision_url(), instead.
viewcvs_url
Deprecated. Pleas use revision_url(), instead.
verbose
my $verbose = $notifier->verbose;
$notifier = $notifier->verbose($verbose);
Gets or sets the value of the verbose attribute.
bondary
my $bondary = $notifier->bondary;
$notifier = $notifier->bondary($bondary);
Gets or sets the value of the bondary attribute. This string is normally set by a call to output_headers(), but may be set ahead of time.
user
my $user = $notifier->user;
$notifier = $notifier->user($user);
Gets or sets the value of the user attribute, which is set to the value pulled in from svnlook by the call to prepare_contents().
date
my $date = $notifier->date;
$notifier = $notifier->date($date);
Gets or sets the value of the date attribute, which is set to the value pulled in from svnlook by the call to prepare_contents().
message
my $message = $notifier->message;
$notifier = $notifier->message($message);
Gets or sets the value of the message attribute, which is set to an array reference of strings by the call to prepare_contents().
message_size
my $message_size = $notifier->message_size;
$notifier = $notifier->message_size($message_size);
Gets or sets the value of the message_size attribute, which is set to the value pulled in from svnlook by the call to prepare_contents().
subject
my $subject = $notifier->subject;
$notifier = $notifier->subject($subject);
Gets or sets the value of the subject attribute, which is normally set by a call to prepare_subject(), but may be set explicitly.
files
my $files = $notifier->files;
$notifier = $notifier->files($files);
Gets or sets the value of the files attribute, which is set to a hash reference of change type mapped to arrays of strings by the call to prepare_files().
header
my $header = $notifier->header;
$notifier = $notifier->header($header);
Gets or set the value of the header attribute. Not to be confused with the add_headers attribute, which manages headers to be inserted into the notification email message headers.
footer
my $footer = $notifier->footer;
$notifier = $notifier->footer($footer);
Gets or set the value of the footer attribute.
See Also
- SVN::Notify::HTML
- SVN::Notify::HTML::ColorDiff
-
Subclasses SVN::Notify.
- https://sourceforge.net/docs/E09#svn_notify
-
SourceForge.net support for SVN::Notify.
- http://svn.haxx.se/users/archive-2006-05/0593.shtml
-
Tutorial for installing Apache, Subversion, and SVN::Notify on Windows.
Bugs
Please send bug reports to
Author
David Wheeler
Copyright and License
Copyright (c) 2004-2007 Kineticode, Inc. All Rights Reserved.
This module is free software; you can redistribute it and/or modify it under the same terms as Perl itself.
