or:

 [subscriber.first_name]

The following won't work:

 <!-- tmpl_var first_name --> 

 [first_name]

Note: that this dot notation isn't using HTML::Template::Plugin::Dot, but is just a variable naming convention, to give the subscriber information some sort of namespace.

The other magical thing that will happen, is that you'll get a new variable to be used in your template called, subscriber, which is a array ref of hashrefs with name/value pairs for all your subscriber fields. So, this'll allow you to do something like this:

 <!-- tmpl_loop subscriber --> 
 
  <!-- tmpl_var name -->: <!-- tmpl_value -->
 
 <!--/tmpl_loop-->

and this will loop over your Profile Fields.

If you'd like, you can also pass the Profile Fields information yourself - this may be useful if you're in some sort of recursive subroutine, or if you already have the information on hand. You may do so by passing the, -subscriber_vars parameter, instead of the -subscriber_vars_param parameter, like so:

 use DADA::MailingList::Subscribers; 
 my $lh = DADA::MailingList::Subscribers->new({-list => 'listshortname'}); 
 
 my $subscriber = $lh->get_subscriber(
                      {
                         -email  => 'this@example.com', 
                         -type   => 'list', 
                         -dotted => 1, 
                       }
                   ); 
 
 use DADA::Template::Widgets; 
 print DADA::Template::Widgets::screen(
 
           { 
                -subscriber_vars => $subscriber,
           }
       ); 

The, subscriber variable will still be magically created for you.

The -subscriber_vars parameter is also a way to override what gets printed for the, subscriber. variables, since nothing is done to check the validity of what you're passing. So, keep that in mind - all these are shortcuts and syntactic sugar. And we like sugar.

A similar thing can be used to retrieve the list settings of a particular list:

 print DADA::Template::Widgets::screen(
    {
    -list_settings_vars_param => 
        {
            -list  => 'listshortname', 
        }
    }
 );

or:

 use DADA::MailingList::Settings; 
 my $ls = DADA::MailingList::Settings->new({-list => 'mylist'}); 
 
 my $list_settings = $ls->get(
                         -dotted => 1, 
                     ); 
 
 use DADA::Template::Widgets; 
 print DADA::Template::Widgets::screen(
 
           { 
                -list_settings_vars => $list_settings,
           }
       ); 

This will even work, as well in a template:

 <!-- tmpl_loop list_settings --> 
 
    <!-- tmpl_var name -->: <!-- tmpl_var value -->
 
 <!-- /tmpl_loop -->

Again, much of this is syntactical sugar and magic, but a lot of it is to keep organized the various sources of your template data. Only at the very final time is all this information folded into itself.

The precendence for these various variables is:

• -list_settings_vars

• -subscriber _vars

• -vars

Which means, if you (for whatever weird reason) want to override anything in either the -list_settings_vars or -subscriber_vars, you can in -vars

wrap_screen

        my $scrn = wrap_screen(
                { 
                        -with => 'list', # or, 'admin', 
                        -screen => 'some_screen.tmpl', # or, "-data => \$some_data, 
                        # ... other options
                }
        ); 

wrap_screen allows you to wrap either one of the two templates (currently) that Dada Mail uses to wrap other template in: list_template.tmpl and admin_template.tmpl.

It takes the same options as, screen and adds a few of its own:

-with is required and should be set to either, list, or admin, depending on whether you want to wrap the template in either the list or admin template.

-wrapper_params can also be passed and the value of its parameters (confusingly) will be different, depending on if you're using list or, admin for, -with

For, list:

• any parameter you would usually send to DADA::Template::HTML::list_template()

  Example:

          my $scrn = DADA::Template::Widgets::wrap_screen(
                  {
                          -screen => 'preview_template.tmpl',
                          -with   => 'list', 
                          -wrapper_params => { 
                                  -data => \$template_info, # This is the actual template we'll be using! 
                          },
                  }
          );

For, admin

• any parameter you would usually send to, DADA::Template::HTML::admin_template

          my $scrn .= DADA::Template::Widgets::wrap_screen(
                  {
                          -screen => 'sending_monitor_index_screen.tmpl',
              -with   => 'admin', 
                          -wrapper_params => { 
                                  -Root_Login => 1,
                                  -List       => 'my_list',  
                          },
                          # ... 
                  }
          );

COPYRIGHT

Copyright (c) 1999 - 2023 Justin Simoni https://justinsimoni.com All rights reserved.

This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with this program; if not, write to the Free Software Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.