Section: User Contributed Perl Documentation (3pm)

Updated: 2012-02-15

Index?action=index Return to Main Contents


HTTP::Cookies - HTTP cookie jars


Or for an empty and temporary cookie jar:


This class is for objects that represent a ``cookie jar'' --- that is, a database of all the HTTP cookies that a given LWP::UserAgent object knows about.

Cookies are a general mechanism which server side connections can use to both store and retrieve information on the client side of the connection. For more information about cookies refer to <URL:> and <URL:>. This module also implements the new style cookies described in RFC 2965. The two variants of cookies are supposed to be able to coexist happily.

Instances of the class HTTP::Cookies are able to store a collection of Set-Cookie2: and Set-Cookie: headers and are able to use this information to initialize Cookie-headers in HTTP::Request objects. The state of a HTTP::Cookies object can be saved in and restored from files.


The following methods are provided:

$cookie_jar = HTTP
:Cookies->new:The constructor takes hash style parameters. The following parameters are recognized:

Future parameters might include (not yet implemented):

$cookie_jar->add_cookie_header( $request )
The add_cookie_header() method will set the appropriate Cookie:-header for the HTTP::Request object given as argument. The must have a valid url attribute before this method is called.:
$cookie_jar->extract_cookies( $response )
The extract_cookies() method will look for Set-Cookie: and Set-Cookie2: headers in the HTTP::Response object passed as argument. Any of these headers that are found are used to update the state of the .:
$cookie_jar->set_cookie( $version, $key, $val, $path, $domain, $port, $path_spec, $secure, $maxage, $discard, \%rest )
The set_cookie() method updates the state of the . The , , , and arguments are strings. The , , arguments are boolean values. The value is a number indicating number of seconds that this cookie will live. A value <= 0 will delete this cookie. defines various other attributes like ``Comment and `CommentURL.:


$cookie_jar->save( $file )
This method file saves the state of the to a file. The state can then be restored later using the load() method. If a filename is not specified we will use the name specified during construction. If the attribute ignore_discard is set, then we will even save cookies that are marked to be discarded.

The default is to save a sequence of ``Set-Cookie3 lines. ``Set-Cookie3 is a proprietary LWP format, not known to be compatible with any browser. The HTTP::Cookies::Netscape sub-class can be used to save in a format compatible with Netscape.



$cookie_jar->load( $file )
This method reads the cookies from the file and adds them to the . The file must be in the format written by the save() method.:
This method empties the and re-loads the from the last save file.:


:$cookie_jar->clear( $domain )

:$cookie_jar->clear( $domain, $path )

$cookie_jar->clear( $domain, $path, $key )
Invoking this method without arguments will empty the whole . If given a single argument only cookies belonging to that domain will be removed. If given two arguments, cookies belonging to the specified path within that domain are removed. If given three arguments, then the cookie with the specified key, path and domain is removed.:
Discard all temporary cookies. Scans for all cookies in the jar with either no expire field or a true flag. To be called when the user agent shuts down according to RFC 2965.:
$cookie_jar->scan( \&callback )
The argument is a subroutine that will be invoked for each cookie stored in the . The subroutine will be invoked with the following arguments:


$cookie_jar->as_string( $skip_discardables )
The as_string() method will return the state of the represented as a sequence of ``Set-Cookie3 header lines separated by ``\n. If is TRUE, it will not return lines for cookies with the Discard attribute.:


HTTP::Cookies::Netscape, HTTP::Cookies::Microsoft


Copyright 1997-2002 Gisle Aas

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