Darcs::Notify::Email - Send email notifications when patches are added or removed from a Darcs repo.
use Darcs::Notify; Darcs::Notify->new(Email => { to => ["user1@example.com", "user2@example.com"], smtp_server => "smtp.example.com" }) ->notify;
This module is meant to be passed as a the "Email" option to Darcs::Notify->new. This module sends email notifications of a Darcs repository's new and unpulled patches to a list of recipients using an SMTP server.
Normal users will probably just want to use the command line script darcs-notify, which is a front end to Darcs::Notify::Email.
new()
This is called by Darcs::Notify->new when passed the "Email" hash-style option. The value of the option should be a reference to a hash with the following parameters:
The smtp server to send the emails through. If not specified it defaults to `localhost'.
This is reference to an array of recipient email addresses. This option is required.
$notify->notify()
This function sends the email notifications. It is automatically invoked by Darcs::Notify->notify (assuming the "Email" option was passed to Darcs::Notify->new), so you shouldn't have to call it yourself.
darcs-notify, Darcs::Notify, Darcs::Notify::Base
This library is free software; you can redistribute it and/or modify it under the same terms as Perl itself.
Copyright (C) 2007-2009 David Caldwell
David Caldwell <david@porkrind.org>
To install Darcs::Notify, copy and paste the appropriate command in to your terminal.
cpanm
cpanm Darcs::Notify
CPAN shell
perl -MCPAN -e shell install Darcs::Notify
For more information on module installation, please visit the detailed CPAN module installation guide.