Skip to content

Modules Library

If you want to offer your users interesting structures with a non-standard layout or provide the opportunity to save particular elements separately from the entire email (such as structures, containers, stripes) for future use and easy drag-and-drop functionality, you can do so with modules.

Similar to the Image gallery, users can see as many folders (tabs) in the Modules tab as you've and configured for your Plugin application.

In this section, you can manage:

  • Number of folders: Decide how many folders you need.
  • Folder names: Specify the names of created folders in every supported language.
  • Storage key ID: Assign an identifier to modules, which will be used for storage.
  • Permissions: Grant respective permissions.

You can specify the Storage Key ID as a static value or a variable (use braces, e.g., ${UserId}).

For example, if you want to restrict access to one user’s modules from another user, you can create the ‘My modules’ folder and specify its path as ${UserId}. When initializing the Plugin, pass the userId value (e.g., 00000) to the metadata parameter. As a result, the Plugin will fetch the modules from the database by the key “00000”.

Please be advised that you can turn off this feature so the Library section won’t display in the editor at all.

In this case, there won’t be an option to save selected elements from the context menu.

You can create a set of categories to help your users group the modules and filter them according to their preferences.

Depending on your use cases, you can hide some categories (along with the assigned modules to those categories) during plugin initialization. To do so, pass the array of the category IDs (which may be taken from the plugin configuration page).

js
"modulesExcludedCategories": [415, 10]