Ricardo SIGNES > Email-Simple-2.203 > Email::Simple::Header

Download:
Email-Simple-2.203.tar.gz

Dependencies

Annotate this POD

Website

View/Report Bugs
Module Version: 2.203   Source  

NAME ^

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

VERSION ^

version 2.203

SYNOPSIS ^

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

  my $header = $email->header_obj;
  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 a list of the unique header names found in this header, in no particular order.

header_pairs

  my @pairs = $header->header_pairs;
  my $first_name  = $pairs[0];
  my $first_value = $pairs[1];

This method returns a list of all the field/value pairs in the header, in the order that they appear in the header. (Remember: don't try assigning that to a hash. Some fields may appear more than once!)

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.

AUTHORS ^

COPYRIGHT AND LICENSE ^

This software is copyright (c) 2003 by Simon Cozens.

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

syntax highlighting: