Login or Register to Ask a Question and Join Our Community

Linux and UNIX Man Pages

Linux & Unix Commands - Search Man Pages

email::messageid(3pm) [debian man page]

Email::MessageID(3pm)					User Contributed Perl Documentation				     Email::MessageID(3pm)

NAME

       Email::MessageID - Generate world unique message-ids.

SYNOPSIS

	 use Email::MessageID;

	 my $mid = Email::MessageID->new->in_brackets;

	 print "Message-ID: $midx0Ax0D";

DESCRIPTION

       Message-ids are optional, but highly recommended, headers that identify a message uniquely. This software generates a unique message-id.

METHODS

   new
	 my $mid = Email::MessageID->new;

	 my $new_mid = Email::MessageID->new( host => $myhost );

       This class method constructs an Email::Address object containing a unique message-id. You may specify custom "host" and "user" parameters.

       By default, the "host" is generated from "Sys::Hostname::hostname".

       By default, the "user" is generated using "Time::HiRes"'s "gettimeofday" and the process ID.

       Using these values we have the ability to ensure world uniqueness down to a specific process running on a specific host, and the exact time
       down to six digits of microsecond precision.

   create_host
	 my $domain_part = Email::MessageID->create_host;

       This method returns the domain part of the message-id.

   create_user
	 my $local_part = Email::MessageID->create_user;

       This method returns a unique local part for the message-id.  It includes some random data and some predictable data.

   in_brackets
       When using Email::MessageID directly to populate the "Message-ID" field, be sure to use "in_brackets" to get the string inside angle
       brackets:

	 header => [
	   ...
	   'Message-Id' => Email::MessageID->new->in_brackets,
	 ],

       Don't make this common mistake:

	 header => [
	   ...
	   'Message-Id' => Email::MessageID->new->as_string, # WRONG!
	 ],

SEE ALSO

       Email::Address, Time::HiRes, Sys::Hostname, perl.

PERL EMAIL PROJECT

       This module is maintained by the Perl Email Project.

       <http://emailproject.perl.org/wiki/Email::MessageID>

AUTHOR

       Casey West, <casey@geeknest.com>.

COPYRIGHT

	 Copyright (c) 2004 Casey West.  All rights reserved.
	 This module is free software; you can redistribute it and/or modify it
	 under the same terms as Perl itself.

perl v5.10.1							    2010-07-15						     Email::MessageID(3pm)

Check Out this Related Man Page

Email::Simple::Header(3pm)				User Contributed Perl Documentation				Email::Simple::Header(3pm)

NAME

       Email::Simple::Header - the header of an Email::Simple message

SYNOPSIS

	 my $email = Email::Simple->new($text);

	 my $header = $email->head;
	 print $header->as_string;

DESCRIPTION

       This method implements the headers of an Email::Simple object.  It is a very minimal interface, and is mostly for private consumption at
       the moment.

METHODS

   new
	 my $header = Email::Simple::Header->new($head, \%arg);

       $head is a string containing a valid email header, or a reference to such a string.  If a reference is passed in, don't expect that it
       won't be altered.

       Valid arguments are:

	 crlf - the header's newline; defaults to CRLF

   as_string
	 my $string = $header->as_string(\%arg);

       This returns a stringified version of the header.

   header_names
       This method returns the unique header names found in this header, in no particular order.

   header_pairs
       This method returns all the field/value pairs in the header, in the order that they appear in the header.

   header
	 my $first_value = $header->header($field);
	 my @all_values  = $header->header($field);

       This method returns the value or values of the given header field.  If the named field does not appear in the header, this method returns
       false.

   header_set
	 $header->header_set($field => @values);

       This method updates the value of the given header.  Existing headers have their values set in place.  Additional headers are added at the
       end.  If no values are given to set, the header will be removed from to the message entirely.

   crlf
       This method returns the newline string used in the header.

PERL EMAIL PROJECT

       This module is maintained by the Perl Email Project

       <http://emailproject.perl.org/>

COPYRIGHT AND LICENSE

       Copyright 2006-2007 by Ricardo SIGNES

       Copyright 2004 by Casey West

       Copyright 2003 by Simon Cozens

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

perl v5.14.2							    2011-12-23						Email::Simple::Header(3pm)
Man Page