/[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 71 by dpavlin,
Mon Aug 22 19:25:24 2005 UTC
+revision 74 by dpavlin,
Wed Aug 24 17:19:16 2005 UTC
 Line 16 
 our @EXPORT_OK = ( @{ $EXPORT_TAGS{'all'
  our @EXPORT = qw(
  );
- our $VERSION = '0.6';
+ our $VERSION = '0.7';
  use Class::DBI::Loader;
  use Email::Valid;
 Line 62 
 encoded) or anything else.
  It will just queue your e-mail message to particular list (sending it to
  possibly remote Notice Sender SOAP server just once), send it out at
  reasonable rate (so that it doesn't flood your e-mail infrastructure) and
- track replies.
+ keep track replies.
- It is best used to send smaller number of messages to more-or-less fixed
+ It is best used to send small number of messages to more-or-less fixed
  list of recipients while allowing individual responses to be examined.
  Tipical use include replacing php e-mail sending code with SOAP call to
  Notice Sender. It does support additional C<ext_id> field for each member
 Line 72 
 which can be used to track some unique i
  particular user.
  It comes with command-line utility C<sender.pl> which can be used to perform
- all available operation from scripts (see C<perldoc sender.pl>).
+ all available operation from scripts (see C<sender.pl --man>).
  This command is also useful for debugging while writing client SOAP
  application.
 Line 120 
 sub new {
  }
- =head2 new_list
+ =head2 create_list
  Create new list. Required arguments are name of C<list>, C<email> address
  and path to C<aliases> file.
-  $nos->new_list(
+  $nos->create_list(
          list => 'My list',
          from => 'Outgoing from comment',
          email => 'my-list@example.com',
 Line 139 
 Calls internally C<_add_list>, see detai
  =cut
- sub new_list {
+ sub create_list {
          my $self = shift;
          my $arg = {@_};
 Line 158 
 sub new_list {
  }
- =head2 delete_list
+ =head2 drop_list
  Delete list from database.
-  my $ok = delete_list(
+  my $ok = drop_list(
          list => 'My list'
          aliases => '/etc/mail/mylist',
   );
 Line 171 
 Returns false if list doesn't exist.
  =cut
- sub delete_list {
+ sub drop_list {
          my $self = shift;
          my $args = {@_};
 Line 267 
 List all members of some list.
          list => 'My list',
   );
- Returns array of hashes with user informations like this:
+ Returns array of hashes with user information like this:
   $member = {
          name => 'Dobrica Pavlinusic',
 Line 939 
 sub new {
  }
- =head2 NewList
+ =head2 CreateList
-  $message_id = NewList(
+  $message_id = CreateList(
          list => 'My list',
          from => 'Name of my list',
          email => 'my-list@example.com'
 Line 949 
 sub new {
  =cut
- sub NewList {
+ sub CreateList {
          my $self = shift;
          my $aliases = $nos->{'aliases'} || croak "need 'aliases' argument to new constructor";
          if ($_[0] !~ m/^HASH/) {
-                 return $nos->new_list(
+                 return $nos->create_list(
                          list => $_[0], from => $_[1], email => $_[2],
                          aliases => $aliases,
                  );
          } else {
-                 return $nos->new_list( %{ shift @_ }, aliases => $aliases );
+                 return $nos->create_list( %{ shift @_ }, aliases => $aliases );
          }
  }
- =head2 DeleteList
+ =head2 DropList
-  $ok = DeleteList(
+  $ok = DropList(
          list => 'My list',
   );
  =cut
- sub DeleteList {
+ sub DropList {
          my $self = shift;
          my $aliases = $nos->{'aliases'} || croak "need 'aliases' argument to new constructor";
          if ($_[0] !~ m/^HASH/) {
-                 return $nos->delete_list(
+                 return $nos->drop_list(
                          list => $_[0],
                          aliases => $aliases,
                  );
          } else {
-                 return $nos->delete_list( %{ shift @_ }, aliases => $aliases );
+                 return $nos->drop_list( %{ shift @_ }, aliases => $aliases );
          }
  }
 Line 1020 
 sub AddMemberToList {
  Returns array of hashes with user informations, see C<list_members>.
- Returning arrays from SOAP calls is somewhat fuzzy (at least to me). It
- seems that SOAP::Lite client thinks that it has array with one element which
- is array of hashes with data.
  =cut
  sub ListMembers {
-Line 1084 
 sub AddMessageToList {
+Line 1080 
 sub AddMessageToList {
          }
  }
+ =head1 UNIMPLEMENTED FUNCTIONS
+ This is a stub for documentation of unimplemented functions.
+ =head2 MessagesReceived
+  my @result = MessagesReceived(
+         list => 'My list',
+         email => 'jdoe@example.com',
+  );
+ You can specify just C<list> or C<email> or any combination of those.
+ It will return array of hashes with following structure:
+  {
+         id => 42,                       # unique ID of received message
+         list => 'My list',              # useful only of filtering by email
+         ext_id => 9999,                 # ext_id from message user
+         email => 'jdoe@example.com',    # e-mail of user
+         bounced => 0,                   # true value if message is bounce
+         date => '2005-08-24 18:57:24',  # date of recival in ISO format
+  }
+ =head2 MessagesReceivedByDate
+ =head2 MessagesReceivedByDateWithContent
+ =head2 ReceivedMessasgeContent
+ Return content of received message.
+  my $mail_body = ReceivedMessageContent( id => 42 );
+ =cut
  ###
+ =head1 NOTE ON ARRAYS IN SOAP
+ Returning arrays from SOAP calls is somewhat fuzzy (at least to me). It
+ seems that SOAP::Lite client thinks that it has array with one element which
+ is array of hashes with data.
  =head1 EXPORT
  Nothing.

 Legend:



Removed from v.71
 


changed lines


 
Added in v.74
 Legend:



Removed from v.71
 


changed lines


 
Added in v.74
-Removed from v.71
+Added in v.74

	ViewVC Help
Powered by ViewVC 1.1.26