David Caldwell > Darcs-Notify-2.0.1 > Darcs::Notify::Email

Download:
Darcs-Notify-2.0.1.tar.gz

Dependencies

Annotate this POD

CPAN RT

Open  0
View/Report Bugs
Source  

NAME ^

Darcs::Notify::Email - Send email notifications when patches are added or removed from a Darcs repo.

SYNONPSIS ^

 use Darcs::Notify;
 Darcs::Notify->new(Email => { to => ["user1@example.com",
                                      "user2@example.com"],
                               smtp_server => "smtp.example.com" })
     ->notify;

DESCRIPTION ^

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.

FUNCTIONS ^

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:

smtp_server => "smtp.example.com"

The smtp server to send the emails through. If not specified it defaults to `localhost'.

to => ["email@example.com", "email2@example.com"]

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.

SEE ALSO ^

darcs-notify, Darcs::Notify, Darcs::Notify::Base

COPYRIGHT ^

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

AUTHOR ^

David Caldwell <david@porkrind.org>

syntax highlighting: