/[notice-sender]/trunk/Nos.pm

This is repository of my old source code which isn't updated any more. Go to git.rot13.org for current projects!

Diff of /trunk/Nos.pm

Parent Directory | Revision Log | View Patch Patch

-revision 37 by dpavlin,
Tue May 17 19:15:27 2005 UTC
+revision 43 by dpavlin,
Wed May 18 12:29:35 2005 UTC
 Line 56 
 Create new instance specifing database,
          hash_len => 8,
   );
- Parametar C<hash_len> defined length of hash which will be added to each
+ Parametar C<hash_len> defines length of hash which will be added to each
- outgoing e-mail message.
+ outgoing e-mail message to ensure that replies can be linked with sent e-mails.
  =cut
 Line 87 
 sub new {
  =head2 new_list
- Create new list
+ Create new list. Required arguments are name of C<list> and
+ C<email> address.
   $nos->new_list(
-         list => 'My list",
+         list => 'My list',
          email => 'my-list@example.com',
   );
  Returns ID of newly created list.
+ Calls internally L<_add_list>, see details there.
  =cut
  sub new_list {
-Line 172 
 sub add_member_to_list {
+Line 175 
 sub add_member_to_list {
          return $this_user->id;
  }
+ =head2 list_members
+  my @members = list_members(
+         list => 'My list',
+  );
+ Returns array of hashes with user informations like this:
+  $member = {
+         full_name => 'Dobrica Pavlinusic',
+         email => 'dpavlin@rot13.org
+  }
+ =cut
+ sub list_members {
+         my $self = shift;
+         my $args = {@_};
+         my $list_name = $args->{'list'} || confess "need list name";
+         my $lists = $self->{'loader'}->find_class('lists');
+         my $user_list = $self->{'loader'}->find_class('user_list');
+         my $this_list = $lists->search( name => $list_name )->first || croak "can't find list $list_name\n";
+         my @results;
+         foreach my $user_on_list ($user_list->search(list_id => $this_list->id)) {
+                 my $row = {
+                         full_name => $user_on_list->user_id->full_name,
+                         email => $user_on_list->user_id->email,
+                 };
+                 push @results, $row;
+         }
+         return @results;
+ }
  =head2 add_message_to_list
  Adds message to one list's queue for later sending.
-Line 179 
 Adds message to one list's queue for lat
+Line 225 
 Adds message to one list's queue for lat
   $nos->add_message_to_list(
          list => 'My list',
          message => 'Subject: welcome to list
   This is example message
   ',
   );
-Line 292 
 sub send_queued_messages {
+Line 338 
 sub send_queued_messages {
                                  $m_obj->header_set('From', $from) || croak "can't set From: header";
                                  $m_obj->header_set('To', $to) || croak "can't set To: header";
+                                 $m_obj->header_set('X-Nos-Version', $VERSION);
+                                 $m_obj->header_set('X-Nos-Hash', $hash);
                                  # FIXME do real sending :-)
                                  send IO => $m_obj->as_string;
-Line 364 
 sub inbox_message {
+Line 413 
 sub inbox_message {
                  $user_id = $sent_msg->user_id || carp "no user_id";
          }
- print "message_id: ",($message_id || "not found"),"\n";
          my $is_bounce = 0;
-Line 387 
 print "message_id: ",($message_id || "no
+Line 435 
 print "message_id: ",($message_id || "no
          $this_received->dbi_commit;
+         print "message_id: ",($message_id || "not found")," -- $is_bounce\n";
          warn "inbox is not yet implemented";
  }
-Line 406 
 Create new list
+Line 457 
 Create new list
  Returns C<Class::DBI> object for created list.
+ C<email> address can be with domain or without it if your
+ MTA appends it. There is no checking for validity of your
+ list e-mail. Flexibility comes with resposibility, so please
+ feed correct (and configured) return addresses.
  =cut
  sub _add_list {
-Line 452 
 sub _get_list {
+Line 508 
 sub _get_list {
          return $lists->search({ name => $name })->first;
  }
+ ###
+ ### SOAP
+ ###
+ package Nos::SOAP;
+ use Carp;
+ =head1 SOAP methods
+ This methods are thin wrappers to provide SOAP calls. They are grouped in
+ C<Nos::SOAP> package which is in same F<Nos.pm> module file.
+ Usually, you want to use named variables in your SOAP calls if at all
+ possible.
+ However, if you have broken SOAP library (like PHP SOAP class from PEAR)
+ you will want to use positional arguments (in same order as documented for
+ methods below).
+ =cut
+ my $nos;
+ sub new {
+         my $class = shift;
+         my $self = {@_};
+         bless($self, $class);
+         $nos = new Nos( @_ ) || die "can't create Nos object";
+         $self ? return $self : return undef;
+ }
+ =head2 NewList
+  $message_id = NewList(
+         list => 'My list',
+         email => 'my-list@example.com'
+  );
+ =cut
+ sub NewList {
+         my $self = shift;
+         if ($_[0] !~ m/^HASH/) {
+                 return $nos->new_list(
+                         list => $_[0], email => $_[1],
+                 );
+         } else {
+                 return $nos->new_list( %{ shift @_ } );
+         }
+ }
+ =head2 AddMemberToList
+  $member_id = AddMemberToList(
+         list => 'My list',
+         email => 'e-mail@example.com',
+         name => 'Full Name'
+  );
+ =cut
+ sub AddMemberToList {
+         my $self = shift;
+         if ($_[0] !~ m/^HASH/) {
+                 return $nos->add_member_to_list(
+                         list => $_[0], email => $_[1], name => $_[2],
+                 );
+         } else {
+                 return $nos->add_member_to_list( %{ shift @_ } );
+         }
+ }
+ =head2 ListMembers
+  my @members = ListMembers(
+         list => 'My list',
+  );
+ Returns array of hashes with user informations, see C<list_members>.
+ =cut
+ sub ListMembers {
+         my $self = shift;
+         my $list_name;
+         if ($_[0] !~ m/^HASH/) {
+                 $list_name = shift;
+         } else {
+                 $list_name = $_[0]->{'list'};
+         }
+         return $nos->list_members( list => $list_name );
+ }
+ =head2 AddMessageToList
+  $message_id = AddMessageToList(
+         list => 'My list',
+         message => 'From: My list...'
+  );
+ =cut
+ sub AddMessageToList {
+         my $self = shift;
+         if ($_[0] !~ m/^HASH/) {
+                 return $nos->add_message_to_list(
+                         list => $_[0], message => $_[1],
+                 );
+         } else {
+                 return $nos->add_message_to_list( %{ shift @_ } );
+         }
+ }
+ ###
  =head1 EXPORT
-Line 477 
 at your option, any later version of Per
+Line 660 
 at your option, any later version of Per
  =cut
+;

 Legend:



Removed from v.37
 


changed lines


 
Added in v.43
 Legend:



Removed from v.37
 


changed lines


 
Added in v.43
-Removed from v.37
+Added in v.43

	ViewVC Help
Powered by ViewVC 1.1.26