Email::Folder - read all the messages from a folder as Email::Simple objects

<!DOCTYPE html> <html lang="en-US"> <head> <title>Email::Folder - read all the messages from a folder as Email::Simple objects - metacpan.org</title> <link rel="preload" as="fetch" href="/account/login_status" crossorigin="anonymous" /> <link href="/assets/style-XFEQ536G.css" rel="stylesheet" type="text/css"> <script src="/assets/main-WXBSEDQJ.js" type="module"></script> <link rel="alternate" type="application/rss+xml" title="Recent CPAN Uploads of Email-Folder - MetaCPAN" href="/dist/Email-Folder/releases.rss" /> <link rel="canonical" href="https://metacpan.org/pod/Email::Folder" /> <meta name="description" content="read all the messages from a folder as Email::Simple objects" /> <meta name="viewport" content="width=device-width, initial-scale=1, maximum-scale=5"> <link rel="shortcut icon" href="/static/icons/favicon.ico"> <link rel="apple-touch-icon" sizes="152x152" href="/static/icons/apple-touch-icon.png"> <link rel="search" href="/static/opensearch.xml" type="application/opensearchdescription+xml" title="MetaCPAN"> <script async src="https://perl-ads.perlhacks.com/perl-ads.js"></script> <script async src="https://www.googletagmanager.com/gtag/js?id=G-E82Q2V8LVD"></script> <meta property="og:site_name" content="MetaCPAN" /> <meta name="twitter:site" content="@metacpan" /> <meta property="og:type" content="article" /> <meta name="twitter:card" content="summary" /> <meta property="og:url" content="https://metacpan.org/pod/Email::Folder" /> <meta property="og:title" content="Email::Folder" /> <meta property="og:description" content="read all the messages from a folder as Email::Simple objects" /> <meta property="og:image" content="https://metacpan.org/static/images/dots.png" /> </head> <body> <nav class="navbar navbar-default" role="navigation"> <div class="header-logo-large hidden-xs"> <a href="/" tabindex="0"> <svg class="logo" aria-label="MetaCPAN"> <use class="logo" href="/static/images/metacpan-logo.svg#logo" /> </svg> </a> </div> <div class="header-logo-icon visible-xs"> <a href="/"> <svg class="logo" aria-label="MetaCPAN"> <use class="logo" href="/static/images/metacpan-logo.svg#dots" /> </svg> </a> </div> <ul class="nav navbar-nav menu-items hidden-xs hidden-sm"> <li><a href="/about">About</a></li> <li><a href="/about/sponsors">Sponsor</a></li> <li><a href="https://grep.metacpan.org/">grep::cpan</a></li> <li><a href="/recent">Recent</a></li> <li><a href="/about/faq">FAQ</a></li> <li><a href="/tools">Tools</a></li> <li><a href="https://fastapi.metacpan.org/">API</a></li> </ul> <ul class="nav navbar-nav navbar-right"> <button type="button" class="searchbar-btn visible-xs visible-sm"> <i class="fa fa-search button-fa-icon"></i> </button> <form action="/search" class="searchbar-form visible-md visible-lg search-form form-horizontal"> <input type="hidden" name="size" id="metacpan_search-size" value="20"> <div class="form-group"> <div class="search-group"> <i class="fa fa-search"></i> <input type="text" name="q" placeholder="Search the CPAN" size="41" autocorrect="off" autocapitalize="off" spellcheck="false" id="metacpan_search-input" class="form-control" value=""> </div> </div> </form> <li class="icon-slidepanel visible-xs visible-sm"> <button data-toggle="slidepanel" data-target=".slidepanel"> <span class="button-fa-icon"> <i class="fa fa-bars slidepanel-open"></i> <i class="fa fa-times slidepanel-close"></i> </span> </button> </li> <li class="dropdown login-dropdown show-logged-in"> <button type="button" class="dropdown-toggle" data-toggle="dropdown"> <i class="fa fa-user button-fa-icon logged-in-icon" aria-hidden="true"></i> <i class="fas fa-chevron-down"></i> </button> <ul class="dropdown-menu"> <li><a href="/account/identities">Identities</a></li> <li><a href="/account/profile">Profile</a></li> <li><a href="/account/favorite/list">Favorites</a></li> <li> <a href="#" type="button" class="logout-button"> Logout </a> </li> </ul> </li> <li class="dropdown login-dropdown show-logged-out"> <button type="button" class="dropdown-toggle" data-toggle="dropdown"> <i class="fa fa-user button-fa-icon avatar-placeholder" aria-hidden="true"></i> <i class="fas fa-chevron-down"></i> </button> <ul class="dropdown-menu"> <li> <a href="/login/github"> <i class="fab fa-github fa-fw"></i> GitHub </a> </li> <li> <a href="/login/twitter"> <i class="fab fa-twitter fa-fw"></i> Twitter </a> </li> <li> <a href="/login/google"> <i class="fab fa-google fa-fw"></i> Google </a> </li> </ul> </li> <li class="dropdown login-dropdown hide-logged-in hide-logged-out"> <button> <i class="fa fa-user button-fa-icon" aria-hidden="true"></i> </button> </li> </ul> </nav> <div class="page-content "> <div id="perl-ad-target" class="top-notify-banner perl-ad-target"> </div> <nav class="sidebar"> <div class="slidepanel"> <ul class="nav-list "> <li class="nav-header no-margin-top"> <div class="ttip" data-toggle="tooltip" data-placement="bottom" title="The date that this version of Email-Folder was released."> <span class="relatize">05 Mar 2016 20:30:15 UTC</span> </div> </li> <li> Distribution: <a href="/dist/Email-Folder">Email-Folder</a> </li> <li> Module version: 0.860 </li> <li> <a data-keyboard-shortcut="g s" href="/dist/Email-Folder/source/lib/Email/Folder.pm">Source</a> (<a href="/dist/Email-Folder/source/lib/Email/Folder.pm?raw=1">raw</a>) </li> <li> <a data-keyboard-shortcut="g b" href="/dist/Email-Folder/source/lib/Email">Browse</a> (<a href="/dist/Email-Folder/source/lib/Email?raw=1">raw</a>) </li> <li> <a data-keyboard-shortcut="g c" href="/dist/Email-Folder/changes">Changes</a> </li> <li> <a rel="noopener nofollow" class="nopopup" href="https://github.com/Perl-Email-Project/Email-Folder">Homepage</a> </li> <li> <a class="nopopup" href="/dist/Email-Folder/contribute">How to Contribute</a> </li> <li> <a rel="noopener nofollow" data-keyboard-shortcut="g r" href="https://github.com/Perl-Email-Project/Email-Folder">Repository</a> </li> <li> <a rel="noopener nofollow" data-keyboard-shortcut="g i" href="https://github.com/Perl-Email-Project/Email-Folder/issues">Issues</a> </li> <li> <a rel="noopener nofollow" href="http://matrix.cpantesters.org/?dist=Email-Folder+0.860" title="Matrix">Testers</a> <span title="(pass / fail / na)">(<a rel="noopener nofollow" href="https://www.cpantesters.org/distro/E/Email-Folder.html?oncpan=1&distmat=1&version=0.860&grade=2" style="color: #090">60</a> / <a rel="noopener nofollow" href="https://www.cpantesters.org/distro/E/Email-Folder.html?oncpan=1&distmat=1&version=0.860&grade=3" style="color: #900">0</a> / <a rel="noopener nofollow" href="https://www.cpantesters.org/distro/E/Email-Folder.html?oncpan=1&distmat=1&version=0.860&grade=4">0</a>)</span> </li> <li> <a rel="noopener nofollow" href="http://cpants.cpanauthors.org/release/PALI/Email-Folder-0.860">Kwalitee</a> </li> <li> <div class="ttip" data-toggle="tooltip" data-placement="bottom" title="The # people with an indexing permission on Email-Folder who have released something to CPAN in the last 2 years (i.e. the # people likely able to release critical fixes in a timely manner)"> Bus factor: 2 </div> </li> <li> <a rel="noopener nofollow" href="http://cpancover.com/latest/Email-Folder-0.860/index.html">84.79% Coverage </a> </li> <li> License: perl_5 </li> <li class="nav-header">Activity</li> <li> <div class="activity-graph"> <img src="/dist/Email-Folder/activity.svg?res=month" /> <div class="comment">24 month</div> </div> </li> <li class="nav-header">Tools</li> <li> <a itemprop="downloadUrl" href="https://cpan.metacpan.org/authors/id/P/PA/PALI/Email-Folder-0.860.tar.gz"> Download (<span itemprop="fileSize">47.08KB</span>)</a> </li> <li> <a href="https://explorer.metacpan.org/?url=%2Fmodule%2FPALI%2FEmail-Folder-0.860%2Flib%2FEmail%2FFolder.pm"> MetaCPAN Explorer </a> </li> <li> <a href="/dist/Email-Folder/permissions"> Permissions </a> </li> <li> <a href="/dist/Email-Folder/releases.rss"> Subscribe to distribution </a> </li> <li> <button class="btn btn-link" data-toggle="modal" data-target="#metacpan_install-instructions-dialog"> Install Instructions </button> </li> <li> <form action="/search"> <input type="hidden" name="q" value="dist:Email-Folder"> <input type="search" name="q" placeholder="Search distribution" class="form-control tool-bar-form"> <input type="submit" style="display: none"> </form> </li> <li> <form action="https://grep.metacpan.org/search"> <input type="hidden" name="qd" value="Email-Folder"> <input type="hidden" name="source" value="metacpan"> <input type="search" name="q" placeholder="grep distribution" class="form-control tool-bar-form"> <input type="submit" style="display: none"> </form> </li> <li class="version-jump"> <select class="select-navigator form-control tool-bar-form"> <option disabled selected>Jump to version</option> <option disabled value="/release/PALI/Email-Folder-0.860/view/lib/Email/Folder.pm" >0.860 (PALI on 2016-03-05)</option> <option value="/release/RJBS/Email-Folder-0.859/view/lib/Email/Folder.pm" >0.859 (RJBS on 2014-09-16)</option> <option value="/release/RJBS/Email-Folder-0.858/view/lib/Email/Folder.pm" >0.858 (RJBS on 2014-01-07)</option> <option value="/release/SIMONW/Email-Folder-0.85/view/lib/Email/Folder.pm" >0.85 (SIMONW on 2006-04-04)</option> <option value="/release/SIMONW/Email-Folder-0.84/view/lib/Email/Folder.pm" >0.84 (SIMONW on 2004-12-17)</option> <option value="/release/RCLAMP/Email-Folder-0.83/view/lib/Email/Folder.pm" >0.83 (RCLAMP on 2004-05-09)</option> <optgroup label="BackPAN">' <option value="/release/RJBS/Email-Folder-0.857/view/lib/Email/Folder.pm" >0.857 (RJBS on 2013-08-05)</option> <option value="/release/RJBS/Email-Folder-0.856/view/lib/Email/Folder.pm" >0.856 (RJBS on 2013-08-05)</option> <option value="/release/RJBS/Email-Folder-0.855/view/lib/Email/Folder.pm" >0.855 (RJBS on 2009-07-27)</option> <option value="/release/RJBS/Email-Folder-0.854/view/lib/Email/Folder.pm" >0.854 (RJBS on 2007-12-24)</option> <option value="/release/RJBS/Email-Folder-0.853/view/lib/Email/Folder.pm" >0.853 (RJBS on 2007-03-23)</option> <option value="/release/RJBS/Email-Folder-0.852/view/lib/Email/Folder.pm" >0.852 (RJBS on 2006-08-22)</option> <option value="/release/RJBS/Email-Folder-0.851/view/lib/Email/Folder.pm" >0.851 (RJBS on 2006-08-01)</option> <option value="/release/RCLAMP/Email-Folder-0.82/view/lib/Email/Folder.pm" >0.82 (RCLAMP on 2004-03-23)</option> <option value="/release/RCLAMP/Email-Folder-0.8/view/lib/Email/Folder.pm" >0.8 (RCLAMP on 2003-05-29)</option> <option value="/release/RCLAMP/Email-Folder-0.7/view/lib/Email/Folder.pm" >0.7 (RCLAMP on 2003-05-27)</option> <option value="/release/RCLAMP/Email-Folder-0.6/view/lib/Email/Folder.pm" >0.6 (RCLAMP on 2003-05-11)</option> <option value="/release/RCLAMP/Email-Folder-0.5/view/lib/Email/Folder.pm" >0.5 (RCLAMP on 2003-04-29)</option> <option value="/release/RCLAMP/Email-Folder-0.4/view/lib/Email/Folder.pm" >0.4 (RCLAMP on 2003-04-24)</option> <option value="/release/RCLAMP/Email-Folder-0.3/view/lib/Email/Folder.pm" >0.3 (RCLAMP on 2003-04-22)</option> <option value="/release/RCLAMP/Email-Folder-0.2/view/lib/Email/Folder.pm" >0.2 (RCLAMP on 2003-04-22)</option> <option value="/release/SIMONW/Email-Folder-0.1/view/lib/Email/Folder.pm" >0.1 (SIMONW on 2003-04-15)</option> </optgroup> </select> </li> <li class="version-diff"> <select class="select-navigator form-control tool-bar-form"> <option disabled selected>Diff with version</option> <option disabled value="/release/PALI/Email-Folder-0.860/diff/PALI/Email-Folder-0.860/lib/Email/Folder.pm" >0.860 (PALI on 2016-03-05)</option> <option value="/release/PALI/Email-Folder-0.860/diff/RJBS/Email-Folder-0.859/lib/Email/Folder.pm" >0.859 (RJBS on 2014-09-16)</option> <option value="/release/PALI/Email-Folder-0.860/diff/RJBS/Email-Folder-0.858/lib/Email/Folder.pm" >0.858 (RJBS on 2014-01-07)</option> <option value="/release/PALI/Email-Folder-0.860/diff/SIMONW/Email-Folder-0.85/lib/Email/Folder.pm" >0.85 (SIMONW on 2006-04-04)</option> <option value="/release/PALI/Email-Folder-0.860/diff/SIMONW/Email-Folder-0.84/lib/Email/Folder.pm" >0.84 (SIMONW on 2004-12-17)</option> <option value="/release/PALI/Email-Folder-0.860/diff/RCLAMP/Email-Folder-0.83/lib/Email/Folder.pm" >0.83 (RCLAMP on 2004-05-09)</option> <optgroup label="BackPAN">' <option value="/release/PALI/Email-Folder-0.860/diff/RJBS/Email-Folder-0.857/lib/Email/Folder.pm" >0.857 (RJBS on 2013-08-05)</option> <option value="/release/PALI/Email-Folder-0.860/diff/RJBS/Email-Folder-0.856/lib/Email/Folder.pm" >0.856 (RJBS on 2013-08-05)</option> <option value="/release/PALI/Email-Folder-0.860/diff/RJBS/Email-Folder-0.855/lib/Email/Folder.pm" >0.855 (RJBS on 2009-07-27)</option> <option value="/release/PALI/Email-Folder-0.860/diff/RJBS/Email-Folder-0.854/lib/Email/Folder.pm" >0.854 (RJBS on 2007-12-24)</option> <option value="/release/PALI/Email-Folder-0.860/diff/RJBS/Email-Folder-0.853/lib/Email/Folder.pm" >0.853 (RJBS on 2007-03-23)</option> <option value="/release/PALI/Email-Folder-0.860/diff/RJBS/Email-Folder-0.852/lib/Email/Folder.pm" >0.852 (RJBS on 2006-08-22)</option> <option value="/release/PALI/Email-Folder-0.860/diff/RJBS/Email-Folder-0.851/lib/Email/Folder.pm" >0.851 (RJBS on 2006-08-01)</option> <option value="/release/PALI/Email-Folder-0.860/diff/RCLAMP/Email-Folder-0.82/lib/Email/Folder.pm" >0.82 (RCLAMP on 2004-03-23)</option> <option value="/release/PALI/Email-Folder-0.860/diff/RCLAMP/Email-Folder-0.8/lib/Email/Folder.pm" >0.8 (RCLAMP on 2003-05-29)</option> <option value="/release/PALI/Email-Folder-0.860/diff/RCLAMP/Email-Folder-0.7/lib/Email/Folder.pm" >0.7 (RCLAMP on 2003-05-27)</option> <option value="/release/PALI/Email-Folder-0.860/diff/RCLAMP/Email-Folder-0.6/lib/Email/Folder.pm" >0.6 (RCLAMP on 2003-05-11)</option> <option value="/release/PALI/Email-Folder-0.860/diff/RCLAMP/Email-Folder-0.5/lib/Email/Folder.pm" >0.5 (RCLAMP on 2003-04-29)</option> <option value="/release/PALI/Email-Folder-0.860/diff/RCLAMP/Email-Folder-0.4/lib/Email/Folder.pm" >0.4 (RCLAMP on 2003-04-24)</option> <option value="/release/PALI/Email-Folder-0.860/diff/RCLAMP/Email-Folder-0.3/lib/Email/Folder.pm" >0.3 (RCLAMP on 2003-04-22)</option> <option value="/release/PALI/Email-Folder-0.860/diff/RCLAMP/Email-Folder-0.2/lib/Email/Folder.pm" >0.2 (RCLAMP on 2003-04-22)</option> <option value="/release/PALI/Email-Folder-0.860/diff/SIMONW/Email-Folder-0.1/lib/Email/Folder.pm" >0.1 (SIMONW on 2003-04-15)</option> </optgroup> </select> </li> <li> <ul class="dependencies"> <li class="nav-header">Dependencies</li> <li><a href="/pod/Carp" title="Carp" class="ellipsis">Carp</a></li> <li><a href="/pod/Email::FolderType" title="Email::FolderType" class="ellipsis">Email::FolderType</a></li> <li><a href="/pod/Email::Simple" title="Email::Simple" class="ellipsis">Email::Simple</a></li> <li><a href="/pod/IO::File" title="IO::File" class="ellipsis">IO::File</a></li> <li><a href="/pod/constant" title="constant" class="ellipsis">constant</a></li> <li><a href="/pod/parent" title="parent" class="ellipsis">parent</a></li> <li><a href="/pod/strict" title="strict" class="ellipsis">strict</a></li> <li><a href="/pod/warnings" title="warnings" class="ellipsis">warnings</a></li> <li> <hr> </li> <li> <a href="/module/Email::Folder/requires">Reverse dependencies</a> </li> <li> <a href="http://deps.cpantesters.org/?module=Email%3A%3AFolder">CPAN Testers List</a> </li> <li> <a href="https://cpandeps.grinnz.com/?dist=Email-Folder">Dependency graph</a> </li> </ul> </li> <li class="nav-header">Permalinks</li> <li> <a href="/release/PALI/Email-Folder-0.860/view/lib/Email/Folder.pm">This version</a> </li> <li> <a href="/pod/Email::Folder">Latest version</a> </li> <li> <div class="plussers"> <div class="nav-header">++ed by:</div> <div> <a class="display-all" href="/author/SZABGAB"><img src="https://www.gravatar.com/avatar/4e0a6fe2acda5df6095514e7d6329e91?d=identicon&s=20" title="SZABGAB" alt="SZABGAB"></a> <a class="display-all" href="/author/SEATEK"><img src="https://www.gravatar.com/avatar/a3ce37aa1cf0c1754ae337ae0de28967?d=identicon&s=20" title="SEATEK" alt="SEATEK"></a> </div>  <div> <a href="/dist/Email-Folder/plussers">2 PAUSE users</a> </div> <div> 1 non-PAUSE user </div> </div> </li> <li> <div> <button class="contributors-show-button btn-link">and 2 contributors</button> <div id="metacpan_contributors" class="slide-out slide-out-hidden"> <div> <ul> <li class="contributor" data-cpan-author="RCLAMP" data-contrib-email="richardc@unixbeard.net" > <a href="/author/RCLAMP" class="cpan-author"> <img class="gravatar" width="20" height="20" src="https://www.gravatar.com/avatar/c25fb742bcf972738e49833b0fb74102?d=identicon&s=20" /> Richard Clamp </a> </li> <li class="contributor" data-contrib-email="simon@thegestalt.org" > <img class="gravatar" width="20" height="20" src="https://www.gravatar.com/avatar/d41d8cd98f00b204e9800998ecf8427e?d=identicon&s=20" /> Simon Wistow </li> </ul> </div> </div> </div> </li> </ul> </div> </nav> <div class="content-navigation"> <div class="breadcrumbs"> <span> <a data-keyboard-shortcut="g a" rel="author" href="/author/PALI" class="author-name">Pali</a> </span> <span> / </span> <div class="release dist-release status-latest maturity-released"> <span class="dropdown"><b class="caret"></b></span> <select class="select-navigator "> <option selected value="/release/PALI/Email-Folder-0.860/view/lib/Email/Folder.pm" >0.860 (PALI on 2016-03-05)</option> <option value="/release/RJBS/Email-Folder-0.859/view/lib/Email/Folder.pm" >0.859 (RJBS on 2014-09-16)</option> <option value="/release/RJBS/Email-Folder-0.858/view/lib/Email/Folder.pm" >0.858 (RJBS on 2014-01-07)</option> <option value="/release/SIMONW/Email-Folder-0.85/view/lib/Email/Folder.pm" >0.85 (SIMONW on 2006-04-04)</option> <option value="/release/SIMONW/Email-Folder-0.84/view/lib/Email/Folder.pm" >0.84 (SIMONW on 2004-12-17)</option> <option value="/release/RCLAMP/Email-Folder-0.83/view/lib/Email/Folder.pm" >0.83 (RCLAMP on 2004-05-09)</option> <optgroup label="BackPAN">' <option value="/release/RJBS/Email-Folder-0.857/view/lib/Email/Folder.pm" >0.857 (RJBS on 2013-08-05)</option> <option value="/release/RJBS/Email-Folder-0.856/view/lib/Email/Folder.pm" >0.856 (RJBS on 2013-08-05)</option> <option value="/release/RJBS/Email-Folder-0.855/view/lib/Email/Folder.pm" >0.855 (RJBS on 2009-07-27)</option> <option value="/release/RJBS/Email-Folder-0.854/view/lib/Email/Folder.pm" >0.854 (RJBS on 2007-12-24)</option> <option value="/release/RJBS/Email-Folder-0.853/view/lib/Email/Folder.pm" >0.853 (RJBS on 2007-03-23)</option> <option value="/release/RJBS/Email-Folder-0.852/view/lib/Email/Folder.pm" >0.852 (RJBS on 2006-08-22)</option> <option value="/release/RJBS/Email-Folder-0.851/view/lib/Email/Folder.pm" >0.851 (RJBS on 2006-08-01)</option> <option value="/release/RCLAMP/Email-Folder-0.82/view/lib/Email/Folder.pm" >0.82 (RCLAMP on 2004-03-23)</option> <option value="/release/RCLAMP/Email-Folder-0.8/view/lib/Email/Folder.pm" >0.8 (RCLAMP on 2003-05-29)</option> <option value="/release/RCLAMP/Email-Folder-0.7/view/lib/Email/Folder.pm" >0.7 (RCLAMP on 2003-05-27)</option> <option value="/release/RCLAMP/Email-Folder-0.6/view/lib/Email/Folder.pm" >0.6 (RCLAMP on 2003-05-11)</option> <option value="/release/RCLAMP/Email-Folder-0.5/view/lib/Email/Folder.pm" >0.5 (RCLAMP on 2003-04-29)</option> <option value="/release/RCLAMP/Email-Folder-0.4/view/lib/Email/Folder.pm" >0.4 (RCLAMP on 2003-04-24)</option> <option value="/release/RCLAMP/Email-Folder-0.3/view/lib/Email/Folder.pm" >0.3 (RCLAMP on 2003-04-22)</option> <option value="/release/RCLAMP/Email-Folder-0.2/view/lib/Email/Folder.pm" >0.2 (RCLAMP on 2003-04-22)</option> <option value="/release/SIMONW/Email-Folder-0.1/view/lib/Email/Folder.pm" >0.1 (SIMONW on 2003-04-15)</option> </optgroup> </select> <a data-keyboard-shortcut="g d" class="release-name" href="/dist/Email-Folder">Email-Folder-0.860</a> </div> <span class="river-gauge-gauge"> <svg width="24px" height="15px" version="1.1" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink"> <g> <title> River stage two 
 • 16 direct dependents 
 • 19 total dependents </title> <rect x="0" y="0" width="4" height="15" fill="#7ea3f2" /> <rect x="5" y="0" width="4" height="15" fill="#7ea3f2" /> <rect x="10" y="0" width="4" height="15" fill="#e4e2e2" /> <rect x="15" y="0" width="4" height="15" fill="#e4e2e2" /> <rect x="20" y="0" width="4" height="15" fill="#e4e2e2" /> </g> </svg> </span> <div id="Email-Folder-fav" class="show-logged-in"> <form action="/account/favorite/add" style="display: inline" method="POST"> <input type="hidden" name="remove" value="0"> <input type="hidden" name="release" value="Email-Folder-0.860"> <input type="hidden" name="author" value="PALI"> <input type="hidden" name="distribution" value="Email-Folder"> <button type="submit" class="favorite highlight"><span>3</span> ++</button> </form> </div> <div class="show-logged-out"> <button class="fav-not-logged-in favorite highlight"><span>3</span> ++</button> </div> / <span>Email::Folder</span> </div> </div> <main class="content"> <nav class="toc"> <div class="toc-header"><strong>Contents</strong></div> <ul> <li><a href="#NAME">NAME</a></li> <li><a href="#VERSION">VERSION</a></li> <li><a href="#SYNOPSIS">SYNOPSIS</a></li> <li><a href="#METHODS">METHODS</a> <ul> <li><a href="#new(%24folder%2C-%25options)">new($folder, %options)</a></li> <li><a href="#messages">messages</a></li> <li><a href="#next_message">next_message</a></li> <li><a href="#bless_message(%24message)">bless_message($message)</a></li> <li><a href="#reader">reader</a></li> </ul> </li> <li><a href="#SEE-ALSO">SEE ALSO</a></li> <li><a href="#AUTHORS">AUTHORS</a></li> <li><a href="#COPYRIGHT-AND-LICENSE">COPYRIGHT AND LICENSE</a></li> </ul></nav> <div class="pod anchors"> <h1 id="NAME">NAME</h1> <p>Email::Folder - read all the messages from a folder as Email::Simple objects</p> <h1 id="VERSION">VERSION</h1> <p>version 0.860</p> <h1 id="SYNOPSIS">SYNOPSIS</h1> <pre><code>use Email::Folder; my $folder = Email::Folder->new("some_file"); print join "\n", map { $_->header("Subject") } $folder->messages;</code></pre> <h1 id="METHODS">METHODS</h1> <h2 id="new($folder,-%options)"><a id="new"></a><a id="new-folder-options"></a>new($folder, %options)</h2> <p>Takes the name of a folder, and a hash of options</p> <p>If a 'reader' option is passed in then that is used as the class to read in messages with.</p> <h2 id="messages">messages</h2> <p>Returns a list containing all of the messages in the folder. Can only be called once as it drains the iterator.</p> <h2 id="next_message">next_message</h2> <p>acts as an iterator. reads the next message from a folder. returns false at the end of the folder</p> <h2 id="bless_message($message)"><a id="bless_message"></a><a id="bless_message-message"></a>bless_message($message)</h2> <p>Takes a raw RFC822 message and blesses it into a class.</p> <p>By default this is an Email::Simple object but can easily be overridden in a subclass.</p> <p>For example, this simple subclass just returns the raw rfc822 messages, and exposes the speed of the parser.</p> <pre><code>package Email::RawFolder; use base 'Email::Folder'; sub bless_message { $_[1] }; 1;</code></pre> <h2 id="reader">reader</h2> <p>read-only accessor to the underlying Email::Reader subclass instance</p> <h1 id="SEE-ALSO"><a id="SEE"></a>SEE ALSO</h1> <p><a href="/pod/Email::LocalDelivery">Email::LocalDelivery</a>, <a href="/pod/Email::FolderType">Email::FolderType</a>, <a href="/pod/Email::Simple">Email::Simple</a></p> <h1 id="AUTHORS">AUTHORS</h1> <ul> <li><p>Simon Wistow <simon@thegestalt.org></p> </li> <li><p>Richard Clamp <richardc@unixbeard.net></p> </li> <li><p>Pali <pali@cpan.org></p> </li> </ul> <h1 id="COPYRIGHT-AND-LICENSE"><a id="COPYRIGHT"></a>COPYRIGHT AND LICENSE</h1> <p>This software is copyright (c) 2006 by Simon Wistow.</p> <p>This is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself.</p></div> <div id="metacpan_install-instructions-dialog" class="modal fade"> <div class="modal-dialog"> <div class="modal-content"> <div class="modal-header"> <button type="button" class="close" data-dismiss="modal" aria-hidden="true">×</button> <h4 class="modal-title">Module Install Instructions</h4> </div> <div class="modal-body"> <p>To install Email::Folder, copy and paste the appropriate command in to your terminal.</p> <p><a href="/dist/App-cpanminus/view/bin/cpanm">cpanm</a></p> <pre><code>cpanm Email::Folder</code></pre> <p><a href="/pod/CPAN">CPAN shell</a></p> <pre><code>perl -MCPAN -e shell install Email::Folder</code></pre> <p>For more information on module installation, please visit <a href="https://www.cpan.org/modules/INSTALL.html">the detailed CPAN module installation guide</a>.</p> </div> <div class="modal-footer"> <a href="#" data-dismiss="modal" class="btn">Close</a> </div> </div> </div> </div> </main> <div class="content-pagination"> </div> </div> <footer class="footer"> <div class="footer-container"> <div class="footer-social"> <div class="footer-link footer-logo"> <a href="/"> <img src="/static/images/metacpan-logo.svg" alt="MetaCPAN" /> </a> </div> <a class="footer-social-link" href="https://github.com/metacpan"> <i class="fab fa-github-square"></i> </a> <a class="footer-social-link" href="https://fosstodon.org/@metacpan"> <i class="fab fa-mastodon"></i> </a> </div> <div class="footer-links"> <div class="footer-link"> <a href="/about">About</a> </div> <div class="footer-link"> <a href="/about/sponsors">Sponsor</a> </div> <div class="footer-link"> <a href="https://grep.metacpan.org">grep::cpan</a> </div> <div class="footer-link"> <a href="/recent">Recent</a> </div> <div class="footer-link"> <a href="/about/faq">FAQ</a> </div> <div class="footer-link"> <a href="/tools">Tools</a> </div> <div class="footer-link"> <a href="https://fastapi.metacpan.org/">API</a> </div> <div class="footer-link"> <a href="https://www.perl.org/">Perl.org</a> </div> </div> <div class="footer-sponsors"> <a class="footer-sponsor-link" target="_blank" href="https://www.bytemark.co.uk/" rel="noopener"> <img class="footer-sponsor-bytemark" src="/static/images/sponsors/bytemark_logo.svg" alt="Bytemark logo"> </a> <a class="footer-sponsor-link" target="_blank" href="https://www.liquidweb.com/" rel="noopener"> <img class="footer-sponsor-liquidweb" src="/static/images/sponsors/liquidweb_logo.png" alt="liquidweb logo"> </a> <a class="footer-sponsor-link" target="_blank" href="https://deriv.com/careers/" rel="noopener"> <img class="footer-sponsor-deriv" src="/static/images/sponsors/deriv.svg" alt="Deriv logo"> </a> <a class="footer-sponsor-link" target="_blank" href="https://geocode.xyz" rel="noopener"> <img class="footer-sponsor-geocode" src="/static/images/sponsors/geocodelogo.svg" alt="Geocode logo"> </a> <a class="footer-sponsor-link" target="_blank" href="https://www.fastly.com/" rel="noopener"> <img class="footer-sponsor-fastly" src="/static/images/sponsors/fastly_logo.svg" alt="Fastly logo"> </a> <a class="footer-sponsor-link" target="_blank" href="https://opencagedata.com" rel="noopener"> <img class="footer-sponsor-opencage" src="/static/images/sponsors/open-cage.svg" alt="OpenCage logo"> </a>  <a class="footer-sponsor-link" target="_blank" href="https://www.elastic.co/" rel="noopener"> <img class="footer-sponsor-elastic" src="/static/images/sponsors/elastic.svg" alt="Elastic logo"> </a>  <a class="footer-sponsor-link" target="_blank" href="https://route4me.com/" rel="noopener"> <img class="footer-sponsor-route4me" src="/static/images/sponsors/route4me.png" alt="Route4Me logo"> </a> </div> </div> </footer> <div class="modal fade" tabindex="-1" role="dialog" id="metacpan_keyboard-shortcuts"> <div class="modal-dialog"> <div class="modal-content"> <div class="modal-header"> <button type="button" class="close" data-dismiss="modal">×</button> <h4 class="modal-title">Keyboard Shortcuts</h4> </div> <div class="modal-body row"> <div class="col-md-6"> <table class="table keyboard-shortcuts"> <thead> <tr> <th></th> <th>Global</th> </tr> </thead> <tbody> <tr> <td class="keys"> <kbd>s</kbd> </td> <td>Focus search bar</td> </tr> <tr> <td class="keys"> <kbd>?</kbd> </td> <td>Bring up this help dialog</td> </tr> </tbody> </table> <table class="table keyboard-shortcuts"> <thead> <tr> <th></th> <th>GitHub</th> </tr> </thead> <tbody> <tr> <td class="keys"> <kbd>g</kbd> <kbd>p</kbd> </td> <td>Go to pull requests</td> </tr> <tr> <td class="keys"> <kbd>g</kbd> <kbd>i</kbd> </td> <td>go to github issues (only if github is preferred repository)</td> </tr> </tbody> </table> </div> <div class="col-md-6"> <table class="table keyboard-shortcuts"> <thead> <tr> <th></th> <th>POD</th> </tr> </thead> <tbody> <tr> <td class="keys"> <kbd>g</kbd> <kbd>a</kbd> </td> <td>Go to author</td> </tr> <tr> <td class="keys"> <kbd>g</kbd> <kbd>c</kbd> </td> <td>Go to changes</td> </tr> <tr> <td class="keys"> <kbd>g</kbd> <kbd>i</kbd> </td> <td>Go to issues</td> </tr> <tr> <td class="keys"> <kbd>g</kbd> <kbd>d</kbd> </td> <td>Go to dist</td> </tr> <tr> <td class="keys"> <kbd>g</kbd> <kbd>r</kbd> </td> <td>Go to repository/SCM</td> </tr> <tr> <td class="keys"> <kbd>g</kbd> <kbd>s</kbd> </td> <td>Go to source</td> </tr> <tr> <td class="keys"> <kbd>g</kbd> <kbd>b</kbd> </td> <td>Go to file browse</td> </tr> </tbody> </table> </div> <div class="col-md-12"> <table class="table keyboard-shortcuts"> <thead> <tr> <th></th> <th>Search terms</th> </tr> </thead> <tbody> <tr> <td><em>module:</em> (e.g. <a href="/search?q=module%3APlugin">module:Plugin</a>)</td> </tr> <tr> <td><em>distribution:</em> (e.g. <a href="/search?q=distribution%3ADancer+auth">distribution:Dancer auth</a>)</td> </tr> <tr> <td><em>author:</em> (e.g. <a href="/search?q=author%3ASONGMU+Redis">author:SONGMU Redis</a>)</td> </tr> <tr> <td><em>version:</em> (e.g. <a href="/search?q=version%3A1.00">version:1.00</a>)</td> </tr> </tbody> </table> </div> </div> <div class="modal-footer"></div> </div> </div> </div> </body> </html>

CINXE.COM

Email::Folder - read all the messages from a folder as Email::Simple objects - metacpan.org