Changeset 1011 for trunk/LATMOS-Accounts/lib

Timestamp:

05/21/12 19:37:04 (12 years ago)

Author:

nanardon

Message:

• Add documentation to LATMOS::Accounts::Mail

Location:

trunk/LATMOS-Accounts/lib/LATMOS/Accounts

Files:

• Bases/Sql/DataRequest.pm (modified) (1 diff)
• Mail.pm (modified) (3 diffs)
• Maintenance.pm (modified) (4 diffs)

trunk/LATMOS-Accounts/lib/LATMOS/Accounts/Bases/Sql/DataRequest.pm

@@ -284 +284 @@
 
     if ($lamail->process(
-        {}, # no variables
         \%mail,
         )) {

trunk/LATMOS-Accounts/lib/LATMOS/Accounts/Mail.pm

@@ -10 +10 @@
 use FindBin qw($Bin);
 use Sys::Hostname;
+
+=head1 NAME
+
+    LATMOS::Accounts::Mail - Send mail using Template
+
+=head1 SYNOPSIS
+
+    use LATMOS::Accounts::Mail;
+    # Prepare the mail
+    my $mail = LATMOS::Accounts::Mail->new(
+        $la,
+        'foo.mail',
+        {
+            'Subject' => 'a mail',
+        }
+    );
+    # Send it
+    $mail->process({}, { to => 'dest@domain' });
+
+=head1 FUNCTIONS
+
+=cut
+
+=head2 LATMOS::Accounts::Mail->new($la, $template, $header)
+
+Create a new C<LATMOS::Accounts::Mail> object. C<$la> is a reference to
+a C<LATMOS::Accounts> object, C<$template> is the name of the template to use,
+C<$header> is a hashref containing default mail header to use when sending mail.
+
+=cut
 
 sub new {
@@ -32 +62 @@
 }
 
+=head2 $lamail->process($headers, $vars)
+
+Process the template as mail body and send the mail.
+
+C<$headers> is a hashref to header to use to send the mail (See
+L<Mail::Sendmail>.
+
+C<$var> is a hashref to be used by L<Template>.
+
+=cut
+
 sub process {
-    my ($self, $vars, $headers) = @_;
+    my ($self, $headers, $vars) = @_;
+
+    $vars ||= {};
 
     my $message;
@@ -79 +122 @@
 }
 
+=head1 SEE ALSO
+
+L<Template>, L<Mail::Sendmail>
+
+=head1 AUTHOR
+
+Thauvin Olivier, E<lt>olivier.thauvin@latmos.ipsl.fr<gt>
+
+=head1 COPYRIGHT AND LICENSE
+
+Copyright (C) 2012 by Thauvin Olivier
+
+This library is free software; you can redistribute it and/or modify
+it under the same terms as Perl itself, either Perl version 5.10.0 or,
+at your option, any later version of Perl 5 you may have available.
+
+=cut
+
 1;

trunk/LATMOS-Accounts/lib/LATMOS/Accounts/Maintenance.pm

@@ -110 +110 @@
         );
         my $message;
-        if ($lamail->process($user, \%mail)) {
+        if ($lamail->process(\%mail, $user)) {
             la_log(LA_NOTICE, "Expiration mail for %s (%s) sent to %s; cc %s",
                 $user->{obj}->id,
@@ -132 +132 @@
                 my %mail = (
                 );
-                if ($summail->process({}, {
+                if ($summail->process({
                     Subject => 'LATMOS account expiration summary',
                     To => $self->val('_default_', 'expire_summary_to'),
@@ -185 +185 @@
         );
         $mail{to} = $options{to} || $mail;
-        if ($lamail->process($managers{$oman->id}, \%mail)) {
+        if ($lamail->process(\%mail, $managers{$oman->id})) {
             la_log(LA_NOTICE,
                 "Expired account reminder mail for %s sent to %s (cc: %s) for %s",
@@ -223 +223 @@
                     $self, \join('', @summary), {}
                 );
-                if ($summail->process({}, \%mail)) {
+                if ($summail->process(\%mail)) {
                     la_log(LA_NOTICE, "Expiration summary mail sent to %s",
                         $self->val('_default_', 'expire_summary_to'),