Default email modules
Below, learn about the modules that you can use when building email templates.
These modules are separate from default web modules, which can be used to build website pages, blog posts, and blog listing pages. Many of the modules below were released to replace usage of default web modules in emails, such as the email_logo
module replacing the logo
module. If your email templates are still using the web versions of these modules, learn how to update your email templates to use email-specific modules instead.
To view a default module's code, you can view and clone the module within the @hubspot
folder of the design manager, or fetch it by its path locally using the HubSpot CLI.
A version of the blog post filter module for emails.
Parameter | Type | Description | Default |
---|---|---|---|
select_blog
| Blog | The blog to display posts from. | |
filter_type
| Choice | Type of filtering links to show. Choices include:
|
tag
|
order_by
| Choice | Ordering for the values of filter links. Choices include:
|
post_count
|
list_title
| Text | An H3 heading. |
"Posts by Tag"
|
max_links
| Number | Number of filter links to show. Leave blank to show all. |
5
|
expand_link_text
| Text | Text to display if more than the |
"See all"
|
A version of the blog post listing module for emails.
Parameter | Type | Description | Default |
---|---|---|---|
select_blog
| Blog | The blog to display posts from. | |
listing_type
| Choice | The type of listing for your posts. Choices include:
|
recent
|
list_title
| Text | An H3 heading. |
"Recent Posts"
|
max_links
| Number | Maximum number of posts to display. |
5
|
A version of the Call-to-Action module for emails.
Parameter | Type | Description | Default |
---|---|---|---|
guid
| String | Globally Unique Identifier of the CTA. |
A version of the header module for emails.
Parameter | Type | Description | Default |
---|---|---|---|
value
| Text | Text for the heading. |
"A clear and bold header"
|
header_tag
| Choice | Choose a heading level. Choice include |
h1
|
Image module for emails.
Parameter | Type | Description | Default |
---|---|---|---|
img
| Image | Image to be used for the email. | |
link
| Text | Optional link for the image. | |
alignment
| Choice | Alignment of the image. Choice include:
|
center
|
A version of the image module for emails.
Parameter | Type | Description | Default |
---|---|---|---|
img
| Image | Image object containing:
|
{
"src": "https://static.hubspot.com/final/img/content/email-template-images/placeholder_200x200.png",
"alt": "placeholder_200x200",
"loading": "disabled",
"width": 200,
"height": 200
}
|
link
| Text | Optional link for the image. | |
target
| Boolean | Opens link in a new tab. |
false
|
A version of the logo module for emails.
Parameter | Type | Description | Default |
---|---|---|---|
img
| Image | Image object containing:
|
{
"override_inherited_src": false,
"src": null,
"alt": null
}
|
link
| Text | Optional link for the logo. If no url is specified, your logo will link to your primary domain. | |
open_in_new_tab
| Boolean | Opens link in a new tab. |
false
|
suppress_company_name
| Boolean | Hide the company name when an image is not selected. |
true
|
heading_level
| Choice | Choose a heading level when no image is selected and |
h1
|
The main body module for emails.
Parameter | Type | Description | Default |
---|---|---|---|
html
| Rich Text | Default content for the email body. Supports HTML. See below for this field's default value. |
Office location information footer for emails (CAN-SPAM compliant).
Parameter | Type | Description | Default |
---|---|---|---|
html
| Rich Text |
Populates required CAN-SPAM information for emails including business address and unsubscribe/preferences links. See below for this field's default value. |
A version of the text module for emails.
Parameter | Type | Description | Default |
---|---|---|---|
value
| Text | Add your text to this parameter. |
"Some additional information in one line"
|
A version of the section header module for emails.
Parameter | Type | Description | Default |
---|---|---|---|
header
| Text | Section header content. |
"A clear and bold header"
|
heading_level
| Choice | Heading level for the |
h1
|
subheader
| Text | Subheading paragraph text for the section. |
"A more subdued subheader"
|
A version of the social sharing module for emails.
Note: The variable social_link_url
in the default column below is the same value as the link
parameter.
Parameter | Type | Description | Default |
---|---|---|---|
link
| Text | This is the destination link that will be shortened for easier sharing on social networks. | |
facebook
| Object | Object containing:
|
{ "enabled": false, "custom_link_format": "http://www.facebook.com/share.php?u={{ social_link_url }}" }
|
twitter
| Object | Object containing:
|
{ "enabled": false, "custom_link_format": "https://twitter.com/intent/tweet?original_referer={{ social_link_url }}&url={{ social_link_url }}&source=tweetbutton&text={{ social_page_title|urlencode }}" }
|
linkedin
| Object | Object containing:
|
{ "enabled": false, "custom_link_format": "http://www.linkedin.com/shareArticle?mini=true&url={{ social_link_url }}" }
|
pinterest
| Object | Object containing:
|
{ "enabled": false, "custom_link_format": "http://pinterest.com/pin/create/button/?url={{ social_link_url }}&media={{ pinterest_media }}", "pinterest_media": { "src": "", "alt": null } }
|
email
| Object | Object containing:
|
{ "enabled": false, "custom_link_format": "mailto:?subject=Check out {{ social_link_url }} &body=Check out {{ social_link_url }}" }
|
Module for displaying email subscription preferences.
Parameter | Type | Description | Default |
---|---|---|---|
header
| Text | H1 heading. |
header
|
subheader_text
| Rich Text | Supplemental text for your H1 heading. |
"If this is not your email address, please ignore this page since the email associated with this page was most likely forwarded to you."
|
unsubscribe_single_text
| Text | Preference selection help text. |
"Uncheck the types of emails you do not want to receive:"
|
unsubscribe_all_text
| Text | Unsubscribe all help text. |
"Or check here to never receive any emails:"
|
unsubscribe_all_unsubbed_text
| Text | Unsubscribe all help text for a currently unsubbed user. |
"You are presently unsubscribed from all of our emails. Would you like to receive our emails again?"
|
unsubscribe_all_option
| Text | Label for unsubscribe all option. |
"Unsubscribe me from all mailing lists."
|
button_text
| Text | Update preferences button text. |
"Update email preferences"
|
resubscribe_button_text
| Text | Resubscribe button text. |
"Yes, resubscribe me!"
|
Confirmation of email subscription changes.
Parameter | Type | Description | Default |
---|---|---|---|
header
| Text | H1 heading. | |
subheader_text
| Rich Text | Supplemental text for your H1 heading. |
"If this is not your email address, please ignore this page since the email associated with this page was most likely forwarded to you."
|
unsubscribe_all_success
| Text | Message on unsubscribe. |
"You have successfully unsubscribed from all email communications."
|
subscription_update_success
| Text | Message on subscription update. |
"You have successfully updated your email preferences."
|
Supported in pages, blog posts, and blog listings.
Parameter | Type | Description | Default |
---|---|---|---|
header
| Text | H1 heading. |
"Email Unsubscribe"
|
input_help_text
| Text | H3 heading for help text. |
"Your email address:"
|
input_placeholder
| Text | Placeholder content for the input field. |
"email@example.com"
|
button_text
| Text | Text to display on the unsubscribe button. |
"Unsubscribe"
|
A video module for emails.
Parameter | Type | Description | Default |
---|---|---|---|
video_type
| Choice | Type of video. Choices include:
|
embed
|
hubspot_video
| Video Player | HubSpot hosted video. Used when | |
embed
| Object | Object containing |
{ "source_type": "oembed" }
|
oembed_thumbnail
| Image | Override oembed thumbnail image when |
{"size_type": "exact"}
|
style_options
| Object | Object containing:
|
{ {"play_button_color":{ "color":"#2f4254", "opacity":100},"play_button_scale" : 30} }
|
alignment
| Choice | Alignment of video. Choices include:
|
center
|
Thank you for your feedback, it means a lot to us.