Skip site navigation (1)Skip section navigation (2)

FreeBSD Manual Pages

  
 
  

home | help
Email::MIME::RFC2047::UserbContributed Perl DoEmail::MIME::RFC2047::Mailbox(3)

NAME
       Email::MIME::RFC2047::Mailbox - MIME encoded mailboxes

VERSION
       version 0.97

SYNOPSIS
	   use Email::MIME::RFC2047::Mailbox;

	   my $mailbox = Email::MIME::RFC2047::Mailbox->parse($string);
	   print $mailbox->name,    "\n";
	   print $mailbox->address, "\n";

	   my $mailbox = Email::MIME::RFC2047::Mailbox->new(
	       name    => $name,
	       address => $address,
	   );
	   $email->header_set('To', $mailbox->format());

DESCRIPTION
       This module handles RFC 2822 "mailbox"es.

CLASS METHODS
   parse
	   my $mailbox = Email::MIME::RFC2047::Mailbox->parse($string, [$decoder])

       Parse a RFC 2822	"mailbox". Returns a Email::MIME::RFC2047::Mailbox
       object.	$decoder is an optional	Email::MIME::RFC2047::Decoder. If it
       isn't provided, a new temporary decoder is used.

CONSTRUCTOR
   new
	   my $mailbox = Email::MIME::RFC2047::Mailbox->new(
	       name    => $name,
	       address => $address,
	   );

       Creates a new Email::MIME::RFC2047::Mailbox object, optionally with a
       display name $name and an email address $address.

METHODS
   name
	   my $name = $mailbox->name;
	   $mailbox->name($new_name);

       Gets or sets the	display	name of	the mailbox.

   address
	   my $address = $mailbox->address;
	   $mailbox->address($new_address);

       Gets or sets the	email address of the mailbox.

   format
	   my $string =	$mailbox->format([$encoder]);

       Returns the formatted mailbox string for	use in a message header.

       $encoder	is an optional Email::MIME::RFC2047::Encoder object used for
       encoding	display	names with non-ASCII characters. If it isn't provided,
       a default UTF-8 encoder will be used.

AUTHOR
       Nick Wellnhofer <wellnhofer@aevum.de>

COPYRIGHT AND LICENSE
       This software is	copyright (c) 2017 by Nick Wellnhofer.

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

perl v5.32.0			  2017-07-31  Email::MIME::RFC2047::Mailbox(3)

NAME | VERSION | SYNOPSIS | DESCRIPTION | CLASS METHODS | CONSTRUCTOR | METHODS | AUTHOR | COPYRIGHT AND LICENSE

Want to link to this manual page? Use this URL:
<https://www.freebsd.org/cgi/man.cgi?query=Email::MIME::RFC2047::Mailbox&sektion=3&manpath=FreeBSD+12.2-RELEASE+and+Ports>

home | help