Common functions

$AEE.baseDir(value)

Use this function to get/set the relative path of the editor.
Parameters:
value: The path represented by a string.
If invoked without parameter, the function returns the current value of baseDir.
//Setter
$AEE.baseDir('../emaileditor');

//Getter
$AEE.baseDir() //returns '../emaileditor'
                
Try it!

$AEE.baseUrl(value)

Use this function to set/get the full path of the editor.
Parameters:
value: The path represented by a string.
If invoked without parameter, the function returns the current value of baseUrl.
//Setter
$AEE.baseDir('http://automizy.com/automizyemaileditor');

//Getter
$AEE.baseDir() //returns 'http://automizy.com/automizyemaileditor'
                
Try it!

$AEE.clickToBack(func)

Use this function to set the function which will be called when clicking on the Back button.
Parameters:
func: The function you want to invoke.
$AEE.clickToBack(function(){
    if($AEE.saved){
        $AEE.close();
    }else if(confirm('You have unsaved edits in the campaign. Are you sure you want to exit?')){
        $AEE.close();
    }
});
                
Try it!

$AEE.clickToPreview(func)

Use this function to set the function which will be called when clicking on the Preview button.
Parameters:
func: The function you want to invoke.
$AEE.clickToPreview(function(){
    alert('Preview not available.');
});
                
Try it!

$AEE.clickToSave

Use this function to set the function which will be called when clicking on the Save button.
Parameters:
func: The function you want to invoke.
$AEE.clickToSave(function(){
    alert('Saved!');
});
                
Try it!

$AEE.clickToSaveAndExit(func)

Use this function to set the function which will be called when clicking on the Save and next button.
Parameters:
func: The function you want to invoke.
$AEE.clickToSaveAndExit(function(){
    alert('Saved!');
    $AEE.close();
});
                
Try it!

$AEE.clickToSendTest()

Use this function to set the function which will be called when clicking on the Send test button.
Parameters:
func: The function you want to invoke.
$AEE.clickToSendTest(function(){
    alert('Send test!');
});
                
Try it!

$AEE.customFields(obj)

Use this function to set/get the options of the custom fields tab.
Parameters:
obj: The custom fields with their names.
//Setter
$AEE.customFields({
    name: "Name",
    age: "Age"
});

//Getter
$AEE.customFields() //returns {name: "Name", age: "Age"}
                
Try it!

$AEE.getDescription()

Use this function to get the description (The first 255 characters of the text, without breaking).
This description is used when you want to share it on Facebook, for example.
$AEE.getDescription()
                
Try it!

$AEE.logoLink(url)

Use this function to set/get the link of the Automizy logo on the top left corner.
Parameters:
url: The url you want to open when clicking on the logo.
//Setter
$AEE.logoLink("https://automizy.com");

//Getter
$AEE.logoLink(); //returns "https://automizy.com"
                
Try it!

$AEE.logoSrc(url)

Use this function to set the logo in the top left corner.
Parameters:
url: The path of the image you want to use.
//Setter
$AEE.logoSrc('vendor/automizy-email-editor/images/logo-automizy.png')

//Getter
$AEE.logoSrc() //returns 'vendor/automizy-email-editor/images/logo-automizy.png'
                
Try it!

$AEE.maxWidth(val)

Use this function to get/set the maximal width of the email.
Parameters:
val: The width in pixels you want to set.
//Setter
$AEE.maxWidth(600);

//Getter
$AEE.maxWidth() //returns 600
                
Try it!

$AEE.minWidth(val)

Use this function to get/set the minimal width of the email.
Parameters:
val: The width in pixels you want to set.
//Setter
$AEE.minWidth(300);

//Getter
$AEE.minWidth() //returns 300
                
Try it!

$AEE.recipient(email)

You can set/get the recipient of the test email using this function.
Parameters:
email: The email address you want to set.
//Setter
$AEE.recipient('myaddress@mymail.com')

//Getter
$AEE.recipient() //returns 'myaddress@mymail.com'
                
Try it!

$AEE.save()

Use this function to save the email.
$AEE.save();
                
Try it!

$AEE.saveAndExit()

Use this function to save the email and exit.
$AEE.saveAndExit();
                
Try it!

$AEE.segments(obj)

Use this fnction to set/get the segments.
Parameters:
obj: The segments with their id and names.
//Setter
$AEE.segments({
    1: "Segment1",
    2: "Segment2"
}

//Getter
$AEE.segments() //returns {1: "Segment1", 2: "Segment2",}
                
Try it!

$AEE.showSaveMessage()

Use this function to show the 'Last saved' message with the current time.
$AEE.showSaveMessage();
                
Try it!

$AEE.systemFields(obj)

Use this function to set/get the options of the built-in custom fields tab.
Parameters:
obj: The custom fields with their names.
//Setter
$AEE.systemFields({
    unsubscribe: "Unsubscribe link",
    facebookShare: "Share on Facebook link"
});

//Getter
$AEE.systemFields() //returns {unsubscribe: "Unsubscribe link", facebookShare: "Share on Facebook link"}
                
Try it!

$AEE.title(str)

Use this function to set/get the title of the email.
Parameters:
str: The title you want to set.
//Setter
$AEE.title('My email');

//Getter
$AEE.title() //returns 'My email'
                
Try it!

$AEE.widget()

Use this function to get the DOM element of the editor.
$AEE.widget();
                
Try it!