org.opencms.workflow

类 CmsWorkflowNotification

java.lang.Object

org.apache.commons.mail.Email

org.apache.commons.mail.MultiPartEmail

org.apache.commons.mail.HtmlEmail

org.opencms.mail.CmsHtmlMail

org.opencms.notification.A_CmsNotification

org.opencms.workflow.CmsWorkflowNotification

public class CmsWorkflowNotification
extends A_CmsNotification

Notification class for the workflow 'release' action.

字段概要

从类继承的字段 org.opencms.notification.A_CmsNotification

m_mailContent

从类继承的字段 org.apache.commons.mail.HtmlEmail

CID_LENGTH, html, inlineEmbeds, inlineImages, text

从类继承的字段 org.apache.commons.mail.Email

ATTACHMENTS, authenticator, bccList, bounceAddress, ccList, charset, content, CONTENT_TYPE, contentType, debug, EMAIL_BODY, EMAIL_SUBJECT, emailBody, FILE_SERVER, fromAddress, headers, hostName, ISO_8859_1, KOI8_R, MAIL_DEBUG, MAIL_HOST, MAIL_PORT, MAIL_SMTP_AUTH, MAIL_SMTP_CONNECTIONTIMEOUT, MAIL_SMTP_FROM, MAIL_SMTP_PASSWORD, MAIL_SMTP_SOCKET_FACTORY_CLASS, MAIL_SMTP_SOCKET_FACTORY_FALLBACK, MAIL_SMTP_SOCKET_FACTORY_PORT, MAIL_SMTP_TIMEOUT, MAIL_SMTP_USER, MAIL_TRANSPORT_PROTOCOL, MAIL_TRANSPORT_TLS, message, popBeforeSmtp, popHost, popPassword, popUsername, RECEIVER_EMAIL, RECEIVER_NAME, replyList, SENDER_EMAIL, SENDER_NAME, sentDate, SMTP, smtpPort, socketConnectionTimeout, socketTimeout, ssl, sslSmtpPort, subject, TEXT_HTML, TEXT_PLAIN, tls, toList, US_ASCII

构造器概要

构造器

构造器和说明
CmsWorkflowNotification(CmsObject adminCms, CmsObject userCms, CmsUser receiver, java.lang.String notificationContent, CmsProject project, java.util.List<CmsResource> resources, java.lang.String link) Creates a new workflow notification mail object.

方法概要

方法

限定符和类型	方法和说明
protected java.lang.String	generateHtmlMsg() Overwrite the method to generate the message body of the notification.
protected java.lang.String	getMessage(java.lang.String key, java.lang.String... args) Gets a message from the message bundle.
protected java.lang.String	getNotificationContent() Overwrite the method to return the path to the xmlcontent, where the subject, the header and the footer are defined.
java.lang.String[]	getResourceInfo(CmsResource resource) Gets the fields which should be displayed for a single resource.
java.lang.String[]	getResourceInfoHeaders() Gets the resource info headers.

从类继承的方法 org.opencms.notification.A_CmsNotification

addMacro, appendHtmlHeader, appenHtmlFooter, getCmsObject, getLocale, getReceiver, send

从类继承的方法 org.apache.commons.mail.HtmlEmail

buildMimeMessage, embed, embed, embed, embed, embed, embed, setHtmlMsg, setMsg, setTextMsg

从类继承的方法 org.apache.commons.mail.MultiPartEmail

addPart, addPart, addPart, attach, attach, attach, attach, attach, createBodyPart, createMimeMultipart, getContainer, getPrimaryBodyPart, getSubType, init, isBoolHasAttachments, isInitialized, setBoolHasAttachments, setInitialized, setSubType

从类继承的方法 org.apache.commons.mail.Email

addBcc, addBcc, addBcc, addCc, addCc, addCc, addHeader, addReplyTo, addReplyTo, addReplyTo, addTo, addTo, addTo, createMimeMessage, getBccAddresses, getCcAddresses, getFromAddress, getHostName, getMailSession, getMimeMessage, getReplyToAddresses, getSentDate, getSmtpPort, getSocketConnectionTimeout, getSocketTimeout, getSslSmtpPort, getSubject, getToAddresses, isSSL, isTLS, sendMimeMessage, setAuthentication, setAuthenticator, setBcc, setBounceAddress, setCc, setCharset, setContent, setContent, setDebug, setFrom, setFrom, setFrom, setHeaders, setHostName, setMailSession, setMailSessionFromJNDI, setPopBeforeSmtp, setReplyTo, setSentDate, setSmtpPort, setSocketConnectionTimeout, setSocketTimeout, setSSL, setSslSmtpPort, setSubject, setTLS, setTo, toInternetAddressArray, updateContentType

从类继承的方法 java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

构造器详细资料

CmsWorkflowNotification

public CmsWorkflowNotification(CmsObject adminCms,
                       CmsObject userCms,
                       CmsUser receiver,
                       java.lang.String notificationContent,
                       CmsProject project,
                       java.util.List<CmsResource> resources,
                       java.lang.String link)
                        throws org.apache.commons.mail.EmailException

Creates a new workflow notification mail object.

参数:

adminCms - the admin CMS context

userCms - the user CMS context

receiver - the mail recipient

notificationContent - the file from which to read the notification configuration

project - the workflow project

resources - the workflow resources

link - the link used for publishing the resources

抛出:

org.apache.commons.mail.EmailException - if an email error occurs

方法详细资料

getResourceInfo

public java.lang.String[] getResourceInfo(CmsResource resource)

Gets the fields which should be displayed for a single resource.

参数:

resource - the resource for which we should fetch the fields

返回:

a string array containing the information for the given resource

getResourceInfoHeaders

public java.lang.String[] getResourceInfoHeaders()

Gets the resource info headers.

返回:

the resource info headers

generateHtmlMsg

protected java.lang.String generateHtmlMsg()

从类复制的说明: A_CmsNotification

Overwrite the method to generate the message body of the notification. This text is placed between the header and the footer of the defined xmlcontent and the required html code is added.

指定者:

generateHtmlMsg 在类中 A_CmsNotification

返回:

The text to be inserted in the notification.

另请参阅:

A_CmsNotification.generateHtmlMsg()

getMessage

protected java.lang.String getMessage(java.lang.String key,
                          java.lang.String... args)

Gets a message from the message bundle.

参数:

key - the message key

args - the message parameters

返回:

the message from the message bundle

getNotificationContent

protected java.lang.String getNotificationContent()

从类复制的说明: A_CmsNotification

Overwrite the method to return the path to the xmlcontent, where the subject, the header and the footer are defined.

指定者:

getNotificationContent 在类中 A_CmsNotification

返回:

The path to the xmlcontent file.

另请参阅:

A_CmsNotification.getNotificationContent()