Class ecm.widget.dialog.EmailDialog
Extends
ecm.widget.dialog.BaseDialog.
Provides a dialog that is used to send an e-mail with attached documents or item links.
Defined in: <ecm\widget\dialog\EmailDialog.js>.
Constructor Summary
Constructor Attributes | Constructor Name and Description |
---|---|
Field Summary
Field Attributes | Field Name and Description |
---|---|
An array of ecm.model.Item objects to be attached to the e-mail (optional).
|
|
Defines how items are to be e-mailed (optional).
|
|
The version of the items to be attached, i.e, "current" or "released" (optional).
|
- Fields borrowed from class ecm.widget.dialog.BaseDialog:
- expandable, fitContentArea, lockFullscreen
Method Summary
Method Attributes | Method Name and Description |
---|---|
createEmailAddressListInput(id, domNode)
Creates an input for e-mail addresses.
|
|
destroy()
Overrides
ecm.widget.dialog.BaseDialog.destroy() to destroy the To, Cc, and Bcc inputs. |
|
isValid()
Returns true if all inputs are valid.
|
|
Lists the attachments.
|
|
loadDefaults(callback)
An extension point for filling the form with predefined values before the dialog is shown.
|
|
onSend()
Sends the e-mail.
|
|
show()
Shows the dialog.
|
|
showBCC()
Shows the BCC field.
|
|
showCC()
Shows the CC field.
|
|
Disables the send button if there is invalid input.
|
- Methods borrowed from class ecm.widget.dialog.BaseDialog:
- addButton, appendSecondaryMessage, buildRendering, clearMessage, clearSecondaryMessage, hide, isMaximized, onDragOver, resize, setExpandable, setIntroText, setIntroTextRef, setMaximized, setMessage, setReferenceLink, setResizable, setSize, setSizeToViewportRatio, setTitle, setWidth, showActionBar
Field Detail
attachments
An array of ecm.model.Item objects to be attached to the e-mail (optional).
attachmentType
Defines how items are to be e-mailed (optional).
- link - As a link (default)
- attachment - As an attachment
- allParts - All parts as a compressed file
- pdf - As PDF
- allPartsPdf - All parts as a PDF file
attachmentVersion
The version of the items to be attached, i.e, "current" or "released" (optional).
Method Detail
createEmailAddressListInput(id, domNode)
Creates an input for e-mail addresses.
- Parameters:
- id
- A unique ID for the input
- domNode
- The DOM node where the input will be placed at
destroy()
Overrides
ecm.widget.dialog.BaseDialog.destroy()
to destroy the To, Cc, and Bcc inputs.
isValid()
Returns true if all inputs are valid.
listAttachments()
Lists the attachments.
loadDefaults(callback)
An extension point for filling the form with predefined values before the dialog is shown.
Since this might be an asynchronous process,
callback
must be called to show the dialog.
- Parameters:
- callback
- A callback function that must be called to show the dialog after the form has been filled
onSend()
Sends the e-mail.
postCreate()
show()
Shows the dialog.
showBCC()
Shows the BCC field.
showCC()
Shows the CC field.
updateSendButtonState()
Disables the send button if there is invalid input.