NAME

WebService::NFSN::Email - Access NFSN email forwarding

VERSION

This document describes version 1.03 of WebService::NFSN::Email, released April 30, 2014 as part of WebService-NFSN version 1.03.

SYNOPSIS

use WebService::NFSN;

my $nfsn = WebService::NFSN->new($USER, $API_KEY);
my $email = $nfsn->email($DOMAIN);
$email->setForward(forward => 'name',
                   dest_email => 'to@example.com');

DESCRIPTION

WebService::NFSN::Email provides access to NearlyFreeSpeech.NET's email forwarding API. It is only useful to people who have NearlyFreeSpeech.NET's email forwarding service.

INTERFACE

$email = $nfsn->email($DOMAIN)

This constructs a new Email object for the specified $DOMAIN (like 'example.com'). Equivalent to $email = WebService::NFSN::Email->new($nfsn, $DOMAIN).

Properties

None.

Methods

$email->listForwards()

Returns a hash reference listing all forwarding instructions for this domain. For each entry, the key is the username and the value is the forwarding address for that name. The special username * represents the "Everything Else" entry.

$email->removeForward(forward => $NAME)

Removes forwarding instructions from "$NAME\@$DOMAIN".

$email->setForward(forward => $NAME, dest_email => $TO)

This method is used to create a new email forward or update an existing one. $NAME is only the username component, so if you have example.com and you want to set up an email forward for forwarding testuser@example.com to realuser@example.net then you would pass testuser as $NAME and realuser@example.net as $TO.

If $NAME already had a forwarding address, it will be overwritten with the new $TO.

To cause an email address to bounce, forward it to bounce@nearlyfreespeech.net. To cause it to be silently discarded, forward it to discard@nearlyfreespeech.net.

SEE ALSO

WebService::NFSN

AUTHOR

Christopher J. Madsen <perl AT cjmweb.net>

Please report any bugs or feature requests to <bug-WebService-NFSN AT rt.cpan.org> or through the web interface at http://rt.cpan.org/Public/Bug/Report.html?Queue=WebService-NFSN.

You can follow or contribute to WebService-NFSN's development at https://github.com/madsen/webservice-nfsn.

COPYRIGHT AND LICENSE

This software is copyright (c) 2014 by Christopher J. Madsen.

This is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself.

DISCLAIMER OF WARRANTY

BECAUSE THIS SOFTWARE IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY FOR THE SOFTWARE, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES PROVIDE THE SOFTWARE "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE SOFTWARE IS WITH YOU. SHOULD THE SOFTWARE PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, REPAIR, OR CORRECTION.

IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR REDISTRIBUTE THE SOFTWARE AS PERMITTED BY THE ABOVE LICENSE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE THE SOFTWARE (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A FAILURE OF THE SOFTWARE TO OPERATE WITH ANY OTHER SOFTWARE), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.