Gyepi Sam > Mail-Verp-0.05 > Mail::Verp

Download:
Mail-Verp-0.05.tar.gz

Dependencies

Annotate this POD

CPAN RT

Open  0
View/Report Bugs
Module Version: 0.05   Source   Latest Release: Mail-Verp-0.06

NAME ^

Mail::Verp - encodes and decodes Variable Envelope Return Paths (VERP) addresses.

SYNOPSIS ^

  use Mail::Verp;
 
  #Using class methods

  #Change separator to something else
  Mail::Verp->separator('+');

  #Create a VERP envelope sender of an email to recipient@example.net.
  my $verp_email = Mail::Verp->encode('sender@example.com', 'recipient@example.net');

  #If a bounce comes back, decode $verp_email to figure out
  #the original recipient of the bounced mail.
  my ($sender, $recipient) = Mail::Verp->decode($verp_email);
 
 
  #Using instance methods

  my $verp = Mail::Verp->new(separator => '+');

  #Create a VERP envelope sender of an email to recipient@example.net.
  my $verp_email = $verp->encode('sender@example.com', 'recipient@example.net');

  #Change separator back to default.
  $verp->separator('-');

  #Decode a bounce
  my ($sender, $recipient) = $verp->decode($verp_email);

ABSTRACT ^

Mail::Verp encodes and decodes Variable Envelope Return Paths (VERP) email addresses.

DESCRIPTION ^

Mail::Verp encodes the address of an email recipient into the envelope sender address so that a bounce can be more easily handled even if the original recipient is forwarding their mail to another address and the remote Mail Transport Agents send back unhelpful bounce messages. The module must also be used to decode bounce recipient addresses.

FUNCTIONS ^

new()

Primarily useful to save typing. So instead of typing Mail::Verp you can say my $x = Mail::Verp->new; then use $x whereever Mail::Verp is usually required.

Accepts an optional separator argument for changing the separator. my $x = Mail::Verp->new(separator => '+');

encode(LOCAL-ADDRESS, REMOTE-ADDRESS)

Encodes LOCAL-ADDRESS, REMOTE-ADDRESS into a verped address suitable for use as an envelope, return, address. It may also be useful to use the same address in Errors-To and Reply-To headers to compensate for broken Mail Transport Agents.

Uses current separator value, which defaults to hyphen '-', but can be changed using the separator accessor.

decode(VERPED-ADDRESS)

Decodes VERPED-ADDRESS into its constituent parts. Returns LOCAL-ADDRESS and REMOTE-ADDRESS in list context, REMOTE-ADDRESS in scalar context. Returns VERPED-ADDRESS if the decoding fails.

Uses current separator value.

EXPORT

None.

SEE ALSO ^

DJ Bernstein details verps here: http://cr.yp.to/proto/verp.txt.

Sam Varshavchik proposes an encoding here: http://www.courier-mta.org/draft-varshavchik-verp-smtpext.txt.

AUTHOR ^

Gyepi Sam <gyepi@cpan.org>

COPYRIGHT AND LICENSE ^

Copyright 2003 by Gyepi Sam

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

syntax highlighting: