The Perl and Raku Conference 2025: Greenville, South Carolina - June 27-29 Learn more

KAMELKEV / CSS-Inliner-3944 / README 

            

              
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119

              
NAME
    CSS::Inliner - Library for converting CSS <style> blocks to inline
    styles.
SYNOPSIS
    use Inliner;
    my $inliner = new Inliner();
    $inliner->read_file({ filename => 'myfile.html' });
    print $inliner->inlinify();
DESCRIPTION
    Library for converting CSS style blocks into inline styles in an HTML
    document. Specifically this is intended for the ease of generating HTML
    emails. This is useful as even in 2013 Gmail and Hotmail don't support
    top level <style> declarations.
METHODS
     new
        Instantiates the Inliner object. Sets up class variables that are
        used during file parsing/processing. Possible options are:
        html_tree - (optional) Pass in a fresh unparsed instance of
        HTML::Treebuilder
        NOTE: Any passed references to HTML::TreeBuilder will be
        substantially altered by passing it in here...
        strip_attrs - (optional) Remove all "id" and "class" attributes
        during inlining
        leave_style - (optional) Leave style/link tags alone within <head>
        during inlining
        relaxed - (optional) Relaxed HTML parsing which will attempt to
        interpret non-HTML4 documents.
        NOTE: This argument is not compatible with passing an html_tree.
    fetch_file
        Fetches a remote HTML file that supposedly contains both HTML and a
        style declaration, properly tags the data with the proper
        characterset as provided by the remote webserver (if any).
        Subsequently calls the read method automatically.
        This method expands all relative urls, as well as fully expands the
        stylesheet reference within the document.
        This method requires you to pass in a params hash that contains a
        url argument for the requested document. For example:
        $self->fetch_file({ url => 'http://www.example.com' });
    read_file
        Opens and reads an HTML file that supposedly contains both HTML and
        a style declaration. It subsequently calls the read() method
        automatically.
        This method requires you to pass in a params hash that contains a
        filename argument. For example:
        $self->read_file({ filename => 'myfile.html' });
        Additionally you can specify the character encoding within the file,
        for example:
        $self->read_file({ filename => 'myfile.html', charset => 'utf8' });
    read
        Reads passed html data and parses it. The intermediate data is
        stored in class variables.
        The <style> block is ripped out of the html here, and stored
        separately. Class/ID/Names used in the markup are left alone.
        This method requires you to pass in a params hash that contains
        scalar html data. For example:
        $self->read({ html => $html });
        NOTE: You are required to pass a properly encoded perl reference to
        the html data. This method does *not* do the dirty work of encoding
        the html as utf8 - do that before calling this method.
    inlinify
        Processes the html data that was entered through either 'read' or
        'read_file', returns a scalar that contains a composite chunk of
        html that has inline styles instead of a top level <style>
        declaration.
    query
        Given a particular selector return back the applicable styles
    specificity
        Given a particular selector return back the associated selectivity
    content_warnings
        Return back any warnings thrown while inlining a given block of
        content.
        Note: content warnings are initialized at inlining time, not at read
        time. In order to receive back content feedback you must perform
        inlinify first
Sponsor
    This code has been developed under sponsorship of MailerMailer LLC,
    http://www.mailermailer.com/
AUTHOR
    Kevin Kamel <kamelkev@mailermailer.com>
CONTRIBUTORS
    Vivek Khera <vivek@khera.org>, Michael Peters <wonko@cpan.org>
LICENSE
    This module is Copyright 2013 Khera Communications, Inc. It is licensed
    under the same terms as Perl itself.