Email configuration helper

While configuring an email editor looks like a demanding task, the email configuration helper plugin is the best way to start and make this experience more manageable.

Look at the logs below to see the configuration problems.

The logs displayed below come from DevTools and show problems encountered by the editor during configuration validation. These issues may cause emails to be displayed incorrectly in various email clients.

After installing the editor, add the feature to your plugin list and toolbar configuration:

import { ClassicEditor } from 'ckeditor5';
import { EmailConfigurationHelper } from 'ckeditor5-premium-features';

ClassicEditor
	.create( document.querySelector( '#editor' ), {
		licenseKey: '<YOUR_LICENSE_KEY>',
		plugins: [ EmailConfigurationHelper, /* ... */ ],
		link: {
			// Configuration.
		}
	} )
	.then( /* ... */ )
	.catch( /* ... */ );

const { ClassicEditor } = CKEDITOR;
const { EmailConfigurationHelper } = CKEDITOR_PREMIUM_FEATURES;

ClassicEditor
	.create( document.querySelector( '#editor' ), {
		licenseKey: '<YOUR_LICENSE_KEY>',
		plugins: [ EmailConfigurationHelper, /* ... */ ],
		link: {
			// Configuration.
		}
	} )
	.then( /* ... */ )
	.catch( /* ... */ );

To use this premium feature, you need to activate it with proper credentials. Refer to the License key and activation guide for details.

The EmailConfigurationConfig property lets you suppress warnings or log messages about email client compatibility.

ClassicEditor
    .create( editorElement, {
        email: {
            logs: {
                suppressAll: false,
                suppress: [
                    'email-configuration-unsupported-reversed-list',
                    'email-configuration-unsupported-list-style-type',
                    // ... other message codes
                ]
            }
        }
    } )

The EmailConfigurationHelper plugin registers the following components:

• The EmailConfigurationHelper component.
• The EmailConfigurationConfig property.