API docs     >     Mailings

Mailing

Description

The Mailing class, which represents an instance of a Mailing.

Methods

Constructor of the Mailing class
Acquires a lock on the current instance of this Object
Adds an embedded Cblock to this Mailing
Assigns a Cblock to a specific Contentarea in this Mailing
Adds a specific version of a Cblock to a Contentarea in this Mailing
Assigns a Usergroup to a specific version of this Mailing
Approves the current version of this Mailing and all embedded Cblocks and creates a new working version
Approves the specified version of this Mailing and all embedded Cblocks and creates a new working version
Calculates a unique permanent name for this Mailing
Calls a specific Extension hook Callback method
Calls a specific Extension hook Callback method
Checks if the specified lock token is set on the current instance of this Object
Copies Extensions from another Mailing to this Mailing
Copies Properties, Extensions, Usergroups, Permissions, Tags, assigned and embedded Cblocks from another Mailing into a new version of this Mailing
Copies Permissions from another Object to this Object
Copies Properties from another Object to this Object
Copies Tags from another Object to this Object
Cleans up the provided permanent name
get
Gets basic information about this Mailing
Gets the Cblock Mailing link for a specific link id
Gets the version of a Cblock linked to a specific version and Contentarea of this Mailing
Gets a list of Cblocks in a Contentarea for the version of this Mailing
Gets all Contentareas of this Mailing including Cblocks and content
Gets the link id of an embedded Cblock
Gets the first approved version of the Object instance
Gets the Object Id of the current instance
Gets the latest approved version of the Object instance
Gets the latest version of the Object instance
Checks if the current instance of this Object is locked
Gets the name of the Properties Table for this Object
Gets the currently published version of the Object instance
Gets the status of this Mailing
Gets the URL of this Mailing
Gets all assigned Usergroups of this Mailing
Gets the version of the Object instance
Gets all versions of the Object instance
Gets all versions of the Mailing which contain the specified Cblock
Checks if the published version of the Object instance is 999999 (ALWAYS_LATEST_APPROVED_VERSION) and thus the latest approved version of the Object will get published automatically on approval.
Generates a new version of this Mailing by copying the currently instanced version and updates the currently instanced Object to the new version
Callback method which is executed when Usergroup permissions on this Mailing change
Helper method for processing of scheduled approvals
Sets the state of a specific version of this Mailing to "published"
Releases a lock on the current instance of this Object
Removes a specific Cblock from a Contentarea in this Mailing
Removes an assignment of a Cblock to this Mailing
Removes an assignment of an Usergroup to a specific version of this Mailing
Sets the order of Cblocks in this Mailing
Saves the order of Cblocks in a specific Contentarea in this Mailing
Sets the permanent name of this Mailing
Sets the status of this Mailing
Assigns a Template to this Mailing
Assigns a Template to this Mailing by Template identifier

Inherited from

Versionable