/[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!
ViewVC logotype

Diff of /trunk/Nos.pm

Parent Directory Parent Directory | Revision Log Revision Log | View Patch Patch

revision 50 by dpavlin, Tue May 24 17:04:01 2005 UTC revision 67 by dpavlin, Fri Jul 8 17:00:20 2005 UTC
# Line 16  our @EXPORT_OK = ( @{ $EXPORT_TAGS{'all' Line 16  our @EXPORT_OK = ( @{ $EXPORT_TAGS{'all'
16  our @EXPORT = qw(  our @EXPORT = qw(
17  );  );
18    
19  our $VERSION = '0.4';  our $VERSION = '0.6';
20    
21  use Class::DBI::Loader;  use Class::DBI::Loader;
22  use Email::Valid;  use Email::Valid;
# Line 26  use Email::Auth::AddressHash; Line 26  use Email::Auth::AddressHash;
26  use Email::Simple;  use Email::Simple;
27  use Email::Address;  use Email::Address;
28  use Mail::DeliveryStatus::BounceParser;  use Mail::DeliveryStatus::BounceParser;
29    use Class::DBI::AbstractSearch;
30    use Mail::Alias;
31    use Cwd qw(abs_path);
32    
33    
34  =head1 NAME  =head1 NAME
# Line 39  Nos - Notice Sender core module Line 42  Nos - Notice Sender core module
42    
43  =head1 DESCRIPTION  =head1 DESCRIPTION
44    
45  Core module for notice sender's functionality.  Notice sender is mail handler. It is not MTA, since it doesn't know how to
46    receive e-mails or send them directly to other hosts. It is not mail list
47    manager because it requires programming to add list members and send
48    messages. You can think of it as mechanisam for off-loading your e-mail
49    sending to remote server using SOAP service.
50    
51    It's concept is based around B<lists>. Each list can have zero or more
52    B<members>. Each list can have zero or more B<messages>.
53    
54    Here comes a twist: each outgoing message will have unique e-mail generated,
55    so Notice Sender will be able to link received replies (or bounces) with
56    outgoing messages.
57    
58    It doesn't do much more than that. It B<can't> create MIME encoded e-mail,
59    send attachments, handle 8-bit characters in headers (which have to be
60    encoded) or anything else.
61    
62    It will just queue your e-mail message to particular list (sending it to
63    possibly remote Notice Sender SOAP server just once), send it out at
64    reasonable rate (so that it doesn't flood your e-mail infrastructure) and
65    track replies.
66    
67    It is best used to send smaller number of messages to more-or-less fixed
68    list of recipients while allowing individual responses to be examined.
69    Tipical use include replacing php e-mail sending code with SOAP call to
70    Notice Sender. It does support additional C<ext_id> field for each member
71    which can be used to track some unique identifier from remote system for
72    particular user.
73    
74    It comes with command-line utility C<sender.pl> which can be used to perform
75    all available operation from scripts (see C<perldoc sender.pl>).
76    This command is also useful for debugging while writing client SOAP
77    application.
78    
79  =head1 METHODS  =head1 METHODS
80    
# Line 74  sub new { Line 109  sub new {
109                  user            => $self->{'user'},                  user            => $self->{'user'},
110                  password        => $self->{'passwd'},                  password        => $self->{'passwd'},
111                  namespace       => "Nos",                  namespace       => "Nos",
112  #               additional_classes      => qw/Class::DBI::AbstractSearch/,                  additional_classes      => qw/Class::DBI::AbstractSearch/,
113  #               additional_base_classes => qw/My::Stuff/,  #               additional_base_classes => qw/My::Stuff/,
114                  relationships   => 1,                  relationships   => 1,
115          ) || croak "can't init Class::DBI::Loader";          ) || croak "can't init Class::DBI::Loader";
# Line 87  sub new { Line 122  sub new {
122    
123  =head2 new_list  =head2 new_list
124    
125  Create new list. Required arguments are name of C<list> and  Create new list. Required arguments are name of C<list>, C<email> address
126  C<email> address.  and path to C<aliases> file.
127    
128   $nos->new_list(   $nos->new_list(
129          list => 'My list',          list => 'My list',
130          from => 'Outgoing from comment',          from => 'Outgoing from comment',
131          email => 'my-list@example.com',          email => 'my-list@example.com',
132            aliases => '/etc/mail/mylist',
133            archive => '/path/to/mbox/archive',
134   );   );
135    
136  Returns ID of newly created list.  Returns ID of newly created list.
137    
138  Calls internally L<_add_list>, see details there.  Calls internally C<_add_list>, see details there.
139    
140  =cut  =cut
141    
# Line 108  sub new_list { Line 145  sub new_list {
145          my $arg = {@_};          my $arg = {@_};
146    
147          confess "need list name" unless ($arg->{'list'});          confess "need list name" unless ($arg->{'list'});
148          confess "need list email" unless ($arg->{'list'});          confess "need list email" unless ($arg->{'email'});
149    
150            $arg->{'list'} = lc($arg->{'list'});
151            $arg->{'email'} = lc($arg->{'email'});
152    
153          my $l = $self->_get_list($arg->{'list'}) ||          my $l = $self->_get_list($arg->{'list'}) ||
154                  $self->_add_list( @_ ) ||                  $self->_add_list( @_ ) ||
# Line 118  sub new_list { Line 158  sub new_list {
158  }  }
159    
160    
161    =head2 delete_list
162    
163    Delete list from database.
164    
165     my $ok = delete_list(
166            list => 'My list'
167     );
168    
169    Returns false if list doesn't exist.
170    
171    =cut
172    
173    sub delete_list {
174            my $self = shift;
175    
176            my $args = {@_};
177    
178            croak "need list to delete" unless ($args->{'list'});
179    
180            $args->{'list'} = lc($args->{'list'});
181    
182            my $lists = $self->{'loader'}->find_class('lists');
183    
184            my $this_list = $lists->search( name => $args->{'list'} )->first || return;
185    
186            $this_list->delete || croak "can't delete list\n";
187    
188            return $lists->dbi_commit || croak "can't commit";
189    }
190    
191    
192  =head2 add_member_to_list  =head2 add_member_to_list
193    
194  Add new member to list  Add new member to list
# Line 126  Add new member to list Line 197  Add new member to list
197          list => "My list",          list => "My list",
198          email => "john.doe@example.com",          email => "john.doe@example.com",
199          name => "John A. Doe",          name => "John A. Doe",
200            ext_id => 42,
201   );   );
202    
203  C<name> parametar is optional.  C<name> and C<ext_id> parametars are optional.
204    
205  Return member ID if user is added.  Return member ID if user is added.
206    
# Line 139  sub add_member_to_list { Line 211  sub add_member_to_list {
211    
212          my $arg = {@_};          my $arg = {@_};
213    
214          my $email = $arg->{'email'} || croak "can't add user without e-mail";          my $email = lc($arg->{'email'}) || croak "can't add user without e-mail";
215          my $name = $arg->{'name'} || '';          my $name = $arg->{'name'} || '';
216          my $list_name = $arg->{'list'} || croak "need list name";          my $list_name = lc($arg->{'list'}) || croak "need list name";
217            my $ext_id = $arg->{'ext_id'};
218    
219          my $list = $self->_get_list($list_name) || croak "list $list_name doesn't exist";          my $list = $self->_get_list($list_name) || croak "list $list_name doesn't exist";
220    
# Line 164  sub add_member_to_list { Line 237  sub add_member_to_list {
237                  $this_user->update;                  $this_user->update;
238          }          }
239    
240            if (defined($ext_id) && ($this_user->ext_id || '') ne $ext_id) {
241                    $this_user->ext_id($ext_id);
242                    $this_user->update;
243            }
244    
245          my $user_on_list = $user_list->find_or_create({          my $user_on_list = $user_list->find_or_create({
246                  user_id => $this_user->id,                  user_id => $this_user->id,
247                  list_id => $list->id,                  list_id => $list->id,
# Line 191  Returns array of hashes with user inform Line 269  Returns array of hashes with user inform
269          email => 'dpavlin@rot13.org          email => 'dpavlin@rot13.org
270   }   }
271    
272  If list is not found, returns false.  If list is not found, returns false. If there is C<ext_id> in user data,
273    it will also be returned.
274    
275  =cut  =cut
276    
# Line 200  sub list_members { Line 279  sub list_members {
279    
280          my $args = {@_};          my $args = {@_};
281    
282          my $list_name = $args->{'list'} || confess "need list name";          my $list_name = lc($args->{'list'}) || confess "need list name";
283    
284          my $lists = $self->{'loader'}->find_class('lists');          my $lists = $self->{'loader'}->find_class('lists');
285          my $user_list = $self->{'loader'}->find_class('user_list');          my $user_list = $self->{'loader'}->find_class('user_list');
# Line 215  sub list_members { Line 294  sub list_members {
294                          email => $user_on_list->user_id->email,                          email => $user_on_list->user_id->email,
295                  };                  };
296    
297                    my $ext_id = $user_on_list->user_id->ext_id;
298                    $row->{'ext_id'} = $ext_id if (defined($ext_id));
299    
300                  push @results, $row;                  push @results, $row;
301          }          }
302    
# Line 237  Delete member from database. Line 319  Delete member from database.
319    
320  Returns false if user doesn't exist.  Returns false if user doesn't exist.
321    
322    This function will delete member from all lists (by cascading delete), so it
323    shouldn't be used lightly.
324    
325  =cut  =cut
326    
327  sub delete_member {  sub delete_member {
# Line 246  sub delete_member { Line 331  sub delete_member {
331    
332          croak "need name or email of user to delete" unless ($args->{'name'} || $args->{'email'});          croak "need name or email of user to delete" unless ($args->{'name'} || $args->{'email'});
333    
334            $args->{'email'} = lc($args->{'email'}) if ($args->{'email'});
335    
336          my $key = 'name';          my $key = 'name';
337          $key = 'email' if ($args->{'email'});          $key = 'email' if ($args->{'email'});
338    
# Line 258  sub delete_member { Line 345  sub delete_member {
345          return $users->dbi_commit || croak "can't commit";          return $users->dbi_commit || croak "can't commit";
346  }  }
347    
348    =head2 delete_member_from_list
349    
350    Delete member from particular list.
351    
352     my $ok = delete_member_from_list(
353            list => 'My list',
354            email => 'dpavlin@rot13.org',
355     );
356    
357    Returns false if user doesn't exist on that particular list.
358    
359    It will die if list or user doesn't exist. You have been warned (you might
360    want to eval this functon to prevent it from croaking).
361    
362    =cut
363    
364    sub delete_member_from_list {
365            my $self = shift;
366    
367            my $args = {@_};
368    
369            croak "need list name and email of user to delete" unless ($args->{'list'} && $args->{'email'});
370    
371            $args->{'list'} = lc($args->{'list'});
372            $args->{'email'} = lc($args->{'email'});
373    
374            my $user = $self->{'loader'}->find_class('users');
375            my $list = $self->{'loader'}->find_class('lists');
376            my $user_list = $self->{'loader'}->find_class('user_list');
377    
378            my $this_user = $user->search( email => $args->{'email'} )->first || croak "can't find user: ".$args->{'email'};
379            my $this_list = $list->search( name => $args->{'list'} )->first || croak "can't find list: ".$args->{'list'};
380    
381            my $this_user_list = $user_list->search_where( list_id => $this_list->id, user_id => $this_user->id )->first || return;
382    
383            $this_user_list->delete || croak "can't delete user from list\n";
384    
385            return $user_list->dbi_commit || croak "can't commit";
386    }
387    
388  =head2 add_message_to_list  =head2 add_message_to_list
389    
390  Adds message to one list's queue for later sending.  Adds message to one list's queue for later sending.
# Line 283  sub add_message_to_list { Line 410  sub add_message_to_list {
410    
411          my $args = {@_};          my $args = {@_};
412    
413          my $list_name = $args->{'list'} || confess "need list name";          my $list_name = lc($args->{'list'}) || confess "need list name";
414          my $message_text = $args->{'message'} || croak "need message";          my $message_text = $args->{'message'} || croak "need message";
415    
416          my $m = Email::Simple->new($message_text) || croak "can't parse message";          my $m = Email::Simple->new($message_text) || croak "can't parse message";
# Line 352  sub send_queued_messages { Line 479  sub send_queued_messages {
479    
480          my $arg = {@_};          my $arg = {@_};
481    
482          my $list_name = $arg->{'list'} || '';          my $list_name = lc($arg->{'list'}) || '';
483          my $driver = $arg->{'driver'} || '';          my $driver = $arg->{'driver'} || '';
484          my $sleep = $arg->{'sleep'};          my $sleep = $arg->{'sleep'};
485          $sleep ||= 3 unless defined($sleep);          $sleep ||= 3 unless defined($sleep);
# Line 363  sub send_queued_messages { Line 490  sub send_queued_messages {
490          if (lc($driver) eq 'smtp') {          if (lc($driver) eq 'smtp') {
491                  $email_send_driver = 'Email::Send::SMTP';                  $email_send_driver = 'Email::Send::SMTP';
492                  @email_send_options = ['127.0.0.1'];                  @email_send_options = ['127.0.0.1'];
493            } else {
494                    warn "dumping all messages to STDERR\n";
495          }          }
         warn "using $driver [$email_send_driver]\n";  
496    
497          my $lists = $self->{'loader'}->find_class('lists');          my $lists = $self->{'loader'}->find_class('lists');
498          my $queue = $self->{'loader'}->find_class('queue');          my $queue = $self->{'loader'}->find_class('queue');
# Line 396  sub send_queued_messages { Line 524  sub send_queued_messages {
524                          if ($sent->search( message_id => $m->message_id, user_id => $u->user_id )) {                          if ($sent->search( message_id => $m->message_id, user_id => $u->user_id )) {
525                                  print "SKIP $to_email message allready sent\n";                                  print "SKIP $to_email message allready sent\n";
526                          } else {                          } else {
527                                  print "=> $to_email\n";                                  print "=> $to_email ";
528    
529                                  my $secret = $m->list_id->name . " " . $u->user_id->email . " " . $m->message_id;                                  my $secret = $m->list_id->name . " " . $u->user_id->email . " " . $m->message_id;
530                                  my $auth = Email::Auth::AddressHash->new( $secret, $self->{'hash_len'} );                                  my $auth = Email::Auth::AddressHash->new( $secret, $self->{'hash_len'} );
# Line 422  sub send_queued_messages { Line 550  sub send_queued_messages {
550                                  $m_obj->header_set('X-Nos-Hash', $hash);                                  $m_obj->header_set('X-Nos-Hash', $hash);
551    
552                                  # really send e-mail                                  # really send e-mail
553                                    my $sent_status;
554    
555                                  if (@email_send_options) {                                  if (@email_send_options) {
556                                          send $email_send_driver => $m_obj->as_string, @email_send_options;                                          $sent_status = send $email_send_driver => $m_obj->as_string, @email_send_options;
557                                  } else {                                  } else {
558                                          send $email_send_driver => $m_obj->as_string;                                          $sent_status = send $email_send_driver => $m_obj->as_string;
559                                  }                                  }
560    
561                                  $sent->create({                                  croak "can't send e-mail: $sent_status\n\nOriginal e-mail follows:\n".$m_obj->as_string unless ($sent_status);
562                                          message_id => $m->message_id,                                  my @bad = @{ $sent_status->prop('bad') };
563                                          user_id => $u->user_id,                                  croak "failed sending to ",join(",",@bad) if (@bad);
564                                          hash => $hash,  
565                                  });                                  if ($sent_status) {
566                                  $sent->dbi_commit;  
567                                            $sent->create({
568                                                    message_id => $m->message_id,
569                                                    user_id => $u->user_id,
570                                                    hash => $hash,
571                                            });
572                                            $sent->dbi_commit;
573    
574                                            print " - $sent_status\n";
575    
576                                    } else {
577                                            warn "ERROR: $sent_status\n";
578                                    }
579    
580                                  if ($sleep) {                                  if ($sleep) {
581                                          warn "sleeping $sleep seconds\n";                                          warn "sleeping $sleep seconds\n";
# Line 457  Receive single message for list's inbox. Line 599  Receive single message for list's inbox.
599          message => $message,          message => $message,
600   );   );
601    
602    This method is used by C<sender.pl> when receiving e-mail messages.
603    
604  =cut  =cut
605    
606  sub inbox_message {  sub inbox_message {
# Line 467  sub inbox_message { Line 611  sub inbox_message {
611          return unless ($arg->{'message'});          return unless ($arg->{'message'});
612          croak "need list name" unless ($arg->{'list'});          croak "need list name" unless ($arg->{'list'});
613    
614            $arg->{'list'} = lc($arg->{'list'});
615    
616          my $this_list = $self->_get_list($arg->{'list'}) || croak "can't find list ".$arg->{'list'}."\n";          my $this_list = $self->_get_list($arg->{'list'}) || croak "can't find list ".$arg->{'list'}."\n";
617    
618          my $m = Email::Simple->new($arg->{'message'}) || croak "can't parse message";          my $m = Email::Simple->new($arg->{'message'}) || croak "can't parse message";
# Line 484  sub inbox_message { Line 630  sub inbox_message {
630          my $hash;          my $hash;
631    
632          foreach my $a (@addrs) {          foreach my $a (@addrs) {
633                  if ($a->address =~ m/\+([a-f0-9]{$hl})@/) {                  if ($a->address =~ m/\+([a-f0-9]{$hl})@/i) {
634                          $hash = $1;                          $hash = $1;
635                          last;                          last;
636                  }                  }
# Line 508  sub inbox_message { Line 654  sub inbox_message {
654                  my $users = $self->{'loader'}->find_class('users');                  my $users = $self->{'loader'}->find_class('users');
655                  my $from = $m->header('From');                  my $from = $m->header('From');
656                  $from = $1 if ($from =~ m/<(.*)>/);                  $from = $1 if ($from =~ m/<(.*)>/);
657                  my $this_user = $users->search( email => $from )->first;                  my $this_user = $users->search( email => lc($from) )->first;
658                  $user_id = $this_user->id if ($this_user);                  $user_id = $this_user->id if ($this_user);
659          }          }
660    
# Line 545  sub inbox_message { Line 691  sub inbox_message {
691    
692  Beware of dragons! You shouldn't need to call those methods directly.  Beware of dragons! You shouldn't need to call those methods directly.
693    
694    
695    =head2 _add_aliases
696    
697    Add new list to C</etc/aliases> (or equivavlent) file
698    
699     my $ok = $nos->add_aliases(
700            list => 'My list',
701            email => 'my-list@example.com',
702            aliases => '/etc/mail/mylist',
703            archive => '/path/to/mbox/archive',
704    
705     );
706    
707    C<archive> parametar is optional.
708    
709    Return false on failure.
710    
711    =cut
712    
713    sub _add_aliases {
714            my $self = shift;
715    
716            my $arg = {@_};
717    
718            croak "need list and email options" unless ($arg->{'list'} && $arg->{'email'});
719    
720            my $aliases = $arg->{'aliases'} || croak "need aliases";
721    
722            unless (-e $aliases) {
723                    warn "aliases file $aliases doesn't exist, creating empty\n";
724                    open(my $fh, '>', $aliases) || croak "can't create $aliases: $!";
725                    close($fh);
726                    chmod 0777, $aliases || warn "can't change permission to 0777";
727            }
728    
729            my $a = new Mail::Alias($aliases) || croak "can't open aliases file $aliases: $!";
730    
731            my $target = '';
732    
733            if (my $archive = $arg->{'archive'}) {
734                    $target .= "$archive, ";
735    
736                    if (! -e $archive) {
737                            warn "please make sure that file $archive is writable for your e-mail user (defaulting to bad 777 permission for now)";
738    
739                            open(my $fh, '>', $archive) || croak "can't create archive file $archive: $!";
740                            close($fh);
741                            chmod 0777, $archive || croak "can't chmod archive file $archive to 0777: $!";
742                    }
743            }
744    
745            # resolve my path to absolute one
746            my $self_path = abs_path($0);
747            $self_path =~ s#/[^/]+$##;
748            $self_path =~ s#/t/*$#/#;
749    
750            $target .= qq#| cd $self_path && ./sender.pl --inbox="$arg->{'list'}"#;
751    
752            unless ($a->append($arg->{'email'}, $target)) {
753                    croak "can't add alias ".$a->error_check;
754            }
755    
756            return 1;
757    }
758    
759  =head2 _add_list  =head2 _add_list
760    
761  Create new list  Create new list
# Line 553  Create new list Line 764  Create new list
764          list => 'My list',          list => 'My list',
765          from => 'Outgoing from comment',          from => 'Outgoing from comment',
766          email => 'my-list@example.com',          email => 'my-list@example.com',
767            aliases => '/etc/mail/mylist',
768   );   );
769    
770  Returns C<Class::DBI> object for created list.  Returns C<Class::DBI> object for created list.
# Line 569  sub _add_list { Line 781  sub _add_list {
781    
782          my $arg = {@_};          my $arg = {@_};
783    
784          my $name = $arg->{'list'} || confess "can't add list without name";          my $name = lc($arg->{'list'}) || confess "can't add list without name";
785          my $email = $arg->{'email'} || confess "can't add list without e-mail";          my $email = lc($arg->{'email'}) || confess "can't add list without e-mail";
786            my $aliases = lc($arg->{'aliases'}) || confess "can't add list without path to aliases file";
787    
788          my $from_addr = $arg->{'from'};          my $from_addr = $arg->{'from'};
789    
790          my $lists = $self->{'loader'}->find_class('lists');          my $lists = $self->{'loader'}->find_class('lists');
791    
792            $self->_add_aliases(
793                    list => $name,
794                    email => $email,
795                    aliases => $aliases,
796            ) || croak "can't add alias $email for list $name";
797    
798          my $l = $lists->find_or_create({          my $l = $lists->find_or_create({
799                  name => $name,                  name => $name,
800                  email => $email,                  email => $email,
# Line 594  sub _add_list { Line 814  sub _add_list {
814  }  }
815    
816    
817    
818  =head2 _get_list  =head2 _get_list
819    
820  Get list C<Class::DBI> object.  Get list C<Class::DBI> object.
# Line 611  sub _get_list { Line 832  sub _get_list {
832    
833          my $lists = $self->{'loader'}->find_class('lists') || confess "can't find lists class";          my $lists = $self->{'loader'}->find_class('lists') || confess "can't find lists class";
834    
835          return $lists->search({ name => $name })->first;          return $lists->search({ name => lc($name) })->first;
836  }  }
837    
838  ###  ###
# Line 638  methods below). Line 859  methods below).
859    
860  my $nos;  my $nos;
861    
862    
863    =head2 new
864    
865    Create new SOAP object
866    
867     my $soap = new Nos::SOAP(
868            dsn => 'dbi:Pg:dbname=notices',
869            user => 'dpavlin',
870            passwd => '',
871            debug => 1,
872            verbose => 1,
873            hash_len => 8,
874            aliases => '/etc/aliases',
875     );
876    
877    =cut
878    
879  sub new {  sub new {
880          my $class = shift;          my $class = shift;
881          my $self = {@_};          my $self = {@_};
882    
883            croak "need aliases parametar" unless ($self->{'aliases'});
884    
885          bless($self, $class);          bless($self, $class);
886    
887          $nos = new Nos( @_ ) || die "can't create Nos object";          $nos = new Nos( @_ ) || die "can't create Nos object";
# Line 653  sub new { Line 894  sub new {
894    
895   $message_id = NewList(   $message_id = NewList(
896          list => 'My list',          list => 'My list',
897            from => 'Name of my list',
898          email => 'my-list@example.com'          email => 'my-list@example.com'
899   );   );
900    
# Line 661  sub new { Line 903  sub new {
903  sub NewList {  sub NewList {
904          my $self = shift;          my $self = shift;
905    
906            croak "self is not Nos::SOAP object" unless (ref($self) eq 'Nos::SOAP');
907    
908            my $aliases = $self->{'aliases'} || croak "need 'aliases' argument to new constructor";
909    
910          if ($_[0] !~ m/^HASH/) {          if ($_[0] !~ m/^HASH/) {
911                  return $nos->new_list(                  return $nos->new_list(
912                          list => $_[0], email => $_[1],                          list => $_[0], from => $_[1], email => $_[2],
913                            aliases => $aliases,
914                  );                  );
915          } else {          } else {
916                  return $nos->new_list( %{ shift @_ } );                  return $nos->new_list( %{ shift @_ }, aliases => $aliases );
917          }          }
918  }  }
919    
920    
921    =head2 DeleteList
922    
923     $ok = DeleteList(
924            list => 'My list',
925     );
926    
927    =cut
928    
929    sub DeleteList {
930            my $self = shift;
931    
932            if ($_[0] !~ m/^HASH/) {
933                    return $nos->delete_list(
934                            list => $_[0],
935                    );
936            } else {
937                    return $nos->delete_list( %{ shift @_ } );
938            }
939    }
940    
941  =head2 AddMemberToList  =head2 AddMemberToList
942    
943   $member_id = AddMemberToList(   $member_id = AddMemberToList(
944          list => 'My list',          list => 'My list',
945          email => 'e-mail@example.com',          email => 'e-mail@example.com',
946          name => 'Full Name'          name => 'Full Name',
947            ext_id => 42,
948   );   );
949    
950  =cut  =cut
# Line 686  sub AddMemberToList { Line 954  sub AddMemberToList {
954    
955          if ($_[0] !~ m/^HASH/) {          if ($_[0] !~ m/^HASH/) {
956                  return $nos->add_member_to_list(                  return $nos->add_member_to_list(
957                          list => $_[0], email => $_[1], name => $_[2],                          list => $_[0], email => $_[1], name => $_[2], ext_id => $_[4],
958                  );                  );
959          } else {          } else {
960                  return $nos->add_member_to_list( %{ shift @_ } );                  return $nos->add_member_to_list( %{ shift @_ } );
# Line 702  sub AddMemberToList { Line 970  sub AddMemberToList {
970    
971  Returns array of hashes with user informations, see C<list_members>.  Returns array of hashes with user informations, see C<list_members>.
972    
973    Returning arrays from SOAP calls is somewhat fuzzy (at least to me). It
974    seems that SOAP::Lite client thinks that it has array with one element which
975    is array of hashes with data.
976    
977  =cut  =cut
978    
979  sub ListMembers {  sub ListMembers {
# Line 715  sub ListMembers { Line 987  sub ListMembers {
987                  $list_name = $_[0]->{'list'};                  $list_name = $_[0]->{'list'};
988          }          }
989    
990          return $nos->list_members( list => $list_name );          return [ $nos->list_members( list => $list_name ) ];
991  }  }
992    
993    
994    =head2 DeleteMemberFromList
995    
996     $member_id = DeleteMemberFromList(
997            list => 'My list',
998            email => 'e-mail@example.com',
999     );
1000    
1001    =cut
1002    
1003    sub DeleteMemberFromList {
1004            my $self = shift;
1005    
1006            if ($_[0] !~ m/^HASH/) {
1007                    return $nos->delete_member_from_list(
1008                            list => $_[0], email => $_[1],
1009                    );
1010            } else {
1011                    return $nos->delete_member_from_list( %{ shift @_ } );
1012            }
1013    }
1014    
1015    
1016  =head2 AddMessageToList  =head2 AddMessageToList
1017    
1018   $message_id = AddMessageToList(   $message_id = AddMessageToList(
Legend:
Removed from v.50  
changed lines
  Added in v.67
  ViewVC Help
Powered by ViewVC 1.1.26