/ 
Email-ExactTarget-1.2.1
River stage zero No dependents
/ Email::ExactTarget::SubscriberOperations

NAME

Email::ExactTarget::SubscriberOperations

VERSION

Version 1.2.1

SYNOPSIS

# Create a new subscriber operations object
my $subscriber_operations = $exact_target->subscriber_operations();

my $subscribers;
eval
{
	$subscribers = $subscriber_operations->retrieve(
		'email' => [ qw( test@test.invalid foo@bar.invalid ) ],
	);
};
warn "Retrieving the subscribers failed: $@" if $@;

METHODS

new()

Creates a new SubscriberOperations object, requires an Email::ExactTarget object to be passed as parameter.

my $subscriber_operations = Email::ExactTarget::SubscriberOperations->new( $exact_target );

Note that this is not the recommended way of creating a SubscriberOperations object. If you are writing a script using this distribution, you should use instead:

my $subscriber_operations = $exact_target->subscriber_operations();

exact_target()

Returns the main Exact Target object.

my $exact_target = $subscriber_operations->exact_target();

create()

Creates a new subscriber in ExactTarget's database using the staged changes on the subscriber objects passed as parameter.

$subscriber_operations->create(
	\@subscribers
);

update_or_create()

Creates a new subscriber in ExactTarget's database using the staged changes on the subscriber objects passed as parameter. If the subscriber already exists in the database, updates it.

$subscriber_operations->update_or_create(
	\@subscribers
);

update()

Applies to ExactTarget's database any staged changes on the subscriber objects passed as parameter.

$subscriber_operations->update(
	\@subscribers
);

retrieve()

Retrieves from ExactTarget's database the subscribers corresponding to the unique identifiers passed as parameter.

my @subscriber = $subscriber_operations->retrieve(
	'email' => [ $email1, $email2 ],
);

pull_list_subscriptions()

Pulls from ExactTarget's database the list subscriptions for the arrayref of subscribers passed as parameter.

$subscriber_operations->pull_list_subscriptions(
	$subscribers
);

INTERNAL FUNCTIONS

_update_create()

Internal. Updates or create a set of subscribers.

$subscriber_operations->_update_create(
	'subscribers' => \@subscriber,
	'soap_action' => 'Update',
	'soap_method' => 'UpdateRequest',
);

$subscriber_operations->_update_create(
	'subscribers' => \@subscriber,
	'soap_action' => 'Create',
	'soap_method' => 'CreateRequest',
);

_soap_format_lists()

Formats the lists subscription changes passed as a hashref for inclusion in the SOAP messages.

my $soap_lists = $self->_soap_format_lists( $lists );

See http://wiki.memberlandingpages.com/API_References/Web_Service_Guide/_Technical_Articles/Managing_Subscribers_On_Lists.

_soap_format_attributes()

Formats the attributes passed as a hashref for inclusion in the SOAP messages.

my $soap_attributes = $self->_soap_format_attributes( $attributes );

AUTHOR

Guillaume Aubert, <aubertg at cpan.org>.

BUGS

Please report any bugs or feature requests to bug-email-exacttarget at rt.cpan.org, or through the web interface at http://rt.cpan.org/NoAuth/ReportBug.html?Queue=Email-ExactTarget. I will be notified, and then you'll automatically be notified of progress on your bug as I make changes.

SUPPORT

You can find documentation for this module with the perldoc command.

perldoc Email::ExactTarget::SubscriberOperations

You can also look for information at:

ACKNOWLEDGEMENTS

Thanks to ThinkGeek (http://www.thinkgeek.com/) and its corporate overlords at Geeknet (http://www.geek.net/), for footing the bill while I eat pizza and write code for them!

COPYRIGHT & LICENSE

Copyright 2009-2012 Guillaume Aubert.

This program is free software; you can redistribute it and/or modify it under the terms of the Artistic License.

See http://dev.perl.org/licenses/ for more information.