Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Mass Mailer is a plugin that allows the administrator to send bulk emails to clients. You can choose which customers you would like to send the email to, and it uses the cron job to send so it works in the background.

Tie-Ins*

WidgetsNav LinksClient CardsAutomation TasksEmail TemplatesACL PermissionsSearchEventsService Management
Status
titleNone
Status
colourGreen
titleyes

Status
titleNone

Status
colourGreen
titleyes
Status
colourGrey
titleNONE
Status
colourGreen
titleyes
Status
titleNone
Status
titleNone

Status
titleNone

* Plugins are powerful and are not limited to the tie-ins listed above, these are just some of the most common

...

TagsDescriptionNotes
{client.id_code}IDe.g. "1501"
{client.status}Statuse.g. "Active"
{contact.first_name}First Name 
{contact.last_name}Last Name 
{contact.company}Company Name 
{contact.address1}Address 1 
{contact.address2}Address 2 
{contact.city}City 
{contact.state}State 
{contact.country}Country 
{contact.zip}Zip / Postal code 
{contact.email}Email Address 
{contact.date_added}Member Datee.g. "2016-05-05 11:18:56"

...

TagsDescriptionNotes
 {package.name}Package Namee.g. "DirectAdmin Bronze"
{package.description}Package Text Description 
{package.description_html}Package HTML Description 
{package.status}Package Statuse.g. "Active"
{service.name}Label 
{service.date_added}Date Added 
{service.date_renews}Date Renews 
{service.date_last_renewed}Date Last Renewed 
{service.date_suspended}Date Suspended 
{service.date_canceled}Date Canceled 
{service.status}Statuse.g. "Active"
{module.name}Module Name 
{module.label}Module Row Label 


Expand
titleAdditional Tags

Due to the nature of tag objects containing several fields, many of which are likely irrelevant for use in email templates, but may be useful to you in certain circumstances, a dump of the tags are shown below.

Note
titleNotice:
Please note that the tags may vary depending on the module. We are using the DirectAdmin module for these examples.


Code Block
languagephp
titleThe {service} object
collapsetrue
 stdClass Object
        (
            [id] => 1
            [parent_service_id] => 
            [package_group_id] => 1
            [id_format] => {num}
            [id_value] => 1
            [pricing_id] => 1
            [client_id] => 2
            [module_row_id] => 2
            [coupon_id] => 
            [qty] => 1
            [override_price] => 
            [override_currency] => 
            [status] => active
            [date_added] => 2016-05-05 11:44:22
            [date_renews] => 2016-06-05 11:44:22
            [date_last_renewed] => 
            [date_suspended] => 
            [date_canceled] => 
            [id_code] => 1
            [fields] => Array
                (
                    [0] => stdClass Object
                        (
                            [key] => direct_admin_domain
                            [value] => stellarvps.com
                            [serialized] => 0
                            [encrypted] => 0
                        )

                    [1] => stdClass Object
                        (
                            [key] => direct_admin_email
                            [value] => youremail@yourdomain.com
                            [serialized] => 0
                            [encrypted] => 0
                        )

                    [2] => stdClass Object
                        (
                            [key] => direct_admin_ip
                            [value] => 62.65.82.167
                            [serialized] => 0
                            [encrypted] => 0
                        )

                    [3] => stdClass Object
                        (
                            [key] => direct_admin_password
                            [value] => 01283hekles98i12ayhew834854juhfredw
                            [serialized] => 0
                            [encrypted] => 1
                        )

                    [4] => stdClass Object
                        (
                            [key] => direct_admin_username
                            [value] => stellar
                            [serialized] => 0
                            [encrypted] => 0
                        )

                )

            [package_pricing] => stdClass Object
                (
                    [id] => 1
                    [package_id] => 1
                    [pricing_id] => 1
                    [term] => 1
                    [period] => month
                    [price] => 5.0000
                    [setup_fee] => 0.0000
                    [cancel_fee] => 0.0000
                    [currency] => USD
                )

            [package] => stdClass Object
                (
                    [id] => 1
                    [id_format] => {num}
                    [id_value] => 1
                    [module_id] => 3
                    [name] => DirectAdmin Bronze
                    [description] => 
                    [description_html] => 
                    [qty] => 
                    [module_row] => 2
                    [module_group] => 
                    [taxable] => 0
                    [single_term] => 0
                    [status] => active
                    [company_id] => 1
                    [prorata_day] => 
                    [prorata_cutoff] => 
                )

            [options] => Array
                (
                )

            [name] => stellarvps.com
        )


Code Block
languagephp
titleThe {module} object
collapsetrue
stdClass Object
        (
            [host_name] => directadmin-dev.blesta.com
            [name_servers] => Array
                (
                    [0] => dns1.blesta.com
                    [1] => dns2.blesta.com
                )

            [name] => DirectAdmin
            [label] => DirectAdmin 1
        )


Code Block
languagephp
titleThe {module} object
collapsetrue
stdClass Object
        (
            [id] => 1
            [id_format] => {num}
            [id_value] => 1
            [module_id] => 3
            [name] => DirectAdmin Bronze
            [description] => 
            [description_html] => 
            [qty] => 
            [module_row] => 2
            [module_group] => 
            [taxable] => 0
            [single_term] => 0
            [status] => active
            [company_id] => 1
            [prorata_day] => 
            [prorata_cutoff] => 
            [id_code] => 1
            [email_content] => Array
                (
                    [0] => stdClass Object
                        (
                            [lang] => en_us
                            [html] => <p>
	Your DirectAdmin account is now active, details below:<br />
	<br />
	Domain: {service.direct_admin_domain}<br />
	Username: {service.direct_admin_username}<br />
	Password: {service.direct_admin_password}<br />
	<br />
	To log into DirectAdmin please visit https://{module.host_name}:2222<br />
	Please update your name servers as soon as possible to the following:<br />
	<br />
	{% for name_server in module.name_servers %}<br />
	Name server: {name_server}{% endfor %}<br />
	<br />
	Thank you for your business!</p>

                            [text] => Your DirectAdmin account is now active, details below:

Domain: {service.direct_admin_domain}
Username: {service.direct_admin_username}
Password: {service.direct_admin_password}

To log into DirectAdmin please visit https://{module.host_name}:2222
Please update your name servers as soon as possible to the following:

{% for name_server in module.name_servers %}
Name server: {name_server}{% endfor %}

Thank you for your business!
                        )

                )

            [pricing] => Array
                (
                    [0] => stdClass Object
                        (
                            [id] => 1
                            [pricing_id] => 1
                            [package_id] => 1
                            [term] => 1
                            [period] => month
                            [price] => 5.0000
                            [setup_fee] => 0.0000
                            [cancel_fee] => 0.0000
                            [currency] => USD
                        )

                )

            [meta] => stdClass Object
                (
                    [ip] => 62.65.82.167
                    [package] => TestUserPackage
                    [type] => user
                )

            [groups] => Array
                (
                    [0] => stdClass Object
                        (
                            [id] => 1
                            [name] => DirectAdmin
                            [description] => 
                            [type] => standard
                            [company_id] => 1
                            [allow_upgrades] => 1
                        )

                )

            [option_groups] => Array
                (
                )

            [ip] => 62.65.82.167
            [package] => TestUserPackage
            [type] => user
        )


...