NAME

Mail::TempAddress::Address - object representing a temporary mailing address

SYNOPSIS

        use Mail::TempAddress::Address;
        my $address     =  Mail::TempAddress::Address->new(
                description => 'not my real address',
        );

DESCRIPTION

A Mail::TempAddress::Address object represents a temporary mailing address within Mail::TempAddress. It contains all of the attributes of the address and provides methods to query and to set them. The current attributes are expires and description.

METHODS

• new( %options )

  new() creates a new Mail::TempAddress::Address object. Pass in a hash of attribute options to set them. By default, expires is false and description is empty.

• attributes()

  Returns a reference to a hash of valid attributes for Address objects. This allows you to see which attributes you should actually care about.

• owner()

  Returns the e-mail address of the owner of this Address.

• add_sender( $sender )

  Given $sender, the e-mail address of someone who sent a message to this Address, generates and returns a key for that sender. The key can be used to retrieve the sender's address later.

• get_sender( $key )

  Given $key, returns an e-mail address which has previously sent e-mail to this Address. This method will return a false value if there is no sender associated with the key.

• name( [ $new_name ] )

  Given $new_name, updates the associated name of the Address and returns the new value. If the argument is not provided, returns the current value. You probably don't want to change an existing Address' name.

• expires( [ $new_expires ] )

  Given $new_expires, updates the expires attribute of the Address and returns the new value. If the argument is not provided, returns the current value.

• description( [ $new_description ] )

  Given $new_description, updates the description attribute of the Address and returns the new value. If the argument is not provided, returns the current value.

AUTHOR

chromatic, chromatic@wgz.org.

BUGS

None known.

TODO

No plans. It's pretty nice as it is.

SEE ALSO

Mail::Action::Address, the parent class.

COPYRIGHT

Copyright (c) 2003, chromatic. All rights reserved. This module is distributed under the same terms as Perl itself. How nice.