/ 
Gravatar-URL-0.01
River stage one • 6 direct dependents • 6 total dependents
/ Gravatar::URL

NAME

Gravatar::URL - Make URLs for Gravatars from an email address

SYNOPSIS

use Gravatar::URL;

my $gravatar_id  = gravatar_id($email);

my $gravatar_url = gravatar_url(email => $email);

DESCRIPTION

A Gravatar is a Globally Recognized Avatar for a given email address. This allows you to have a global picture associated with your email address. You can look up the Gravatar for any email address by constructing a URL to get the image from gravatar.com. This module does that.

Functions

gravatar_url

# By email
my $url = gravatar_url( email => $email, %options );

# By gravatar ID
my $url = gravatar_url( id => $id, %options );

Constructs a URL to fetch the gravatar for a given $email or $id.

$id is a gravatar ID. See "gravatar_id" for more information.

%options are optional and are...

rating

A user can rate how offensive the content of their gravatar is, like a movie. The ratings are G, PG, R and X. If you specify a rating it is the highest rating that will be given.

rating => "R"   # includes G, PG and R

size

Specifies the desired width and height of the gravatar (gravatars are square).

Valid values are from 1 to 80 inclusive. Any size other than 80 will cause the original gravatar image to be downsampled using bicubic resampling before output.

size    => 40,  # 40 x 40 image

default

The url to use if the user has no gravatar or has none that fits your rating requirements.

default => "http://upload.wikimedia.org/wikipedia/en/8/89/Alfred.jpg"

border

Gravatars can be requested to have a 1 pixel colored border. If you'd like that, pass in the color to border as a 3 or 6 digit hex string.

border => "FFFFFF",  # a black border, like my soul
border => "FFF",     # black, but in 3 digits

base

This is the URL of the location of the Gravatar server you wish to grab Gravatars from. Defaults to http://www.gravatar.com/avatar.php".

gravatar_id

my $id = gravatar_id($email);

Converts an $email address into its Gravatar $id.

THANKS

Thanks to gravatar.com for coming up with the whole idea and Ashley Pond V from whose Template::Plugin::Gravatar I took most of the code.

LICENSE

Copyright 2007, Michael G Schwern <schwern@pobox.com>.

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

See http://www.perl.com/perl/misc/Artistic.html

SEE ALSO

Template::Plugin::Gravatar - a Gravatar plugin for Template Toolkit

http://www.gravatar.com - The Gravatar web site

http://site.gravatar.com/site/implement - The Gravatar URL implementor's guide