Package org.opencms.notification
Class CmsContentNotification
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.notification.CmsContentNotification
The E-Mail to be written to responsibles of resources.
-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final StringThe path to the xml content with the subject, header and footer of the notification e-mail.Fields inherited from class org.opencms.notification.A_CmsNotification
HEADER_FOOTER_CONFIG_PATH, HEADER_FOOTER_SEPARATOR, m_cms, m_configuredFooter, m_configuredHeader, m_locale, m_macroResolver, m_mailContent, SYSTEM_MAIL_HOSTFields inherited from class org.apache.commons.mail.HtmlEmail
CID_LENGTH, html, inlineEmbeds, inlineImages, textFields inherited from class 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 -
Method Summary
Modifier and TypeMethodDescriptionstatic booleanexistsEditor(CmsResource resource) Returns true, if there exists an editor for a specific resource.protected StringCreates the mail to be sent to the responsible user.protected List<CmsExtendedNotificationCause> Returns a list of CmsNotificationResourceInfos of the resources that will occur in the notification.protected StringOverwrite the method to return the path to the xmlcontent, where the subject, the header and the footer are defined.Returns the responsible.protected voidsetNotificationCauses(List<CmsExtendedNotificationCause> resources) Sets the resources.Methods inherited from class org.opencms.notification.A_CmsNotification
addMacro, appendHtmlHeader, appendXMLContent, appenHtmlFooter, getCmsObject, getLocale, getReceiver, sendMethods inherited from class org.apache.commons.mail.HtmlEmail
buildMimeMessage, embed, embed, embed, embed, embed, embed, setHtmlMsg, setMsg, setTextMsgMethods inherited from class org.apache.commons.mail.MultiPartEmail
addPart, addPart, addPart, attach, attach, attach, attach, attach, attach, createBodyPart, createMimeMultipart, getContainer, getPrimaryBodyPart, getSubType, init, isBoolHasAttachments, isInitialized, setBoolHasAttachments, setInitialized, setSubTypeMethods inherited from class org.apache.commons.mail.Email
addBcc, addBcc, addBcc, addBcc, addCc, addCc, addCc, addCc, addHeader, addReplyTo, addReplyTo, addReplyTo, addTo, addTo, addTo, addTo, createMimeMessage, getBccAddresses, getBounceAddress, getCcAddresses, getFromAddress, getHeader, getHeaders, getHostName, getMailSession, getMimeMessage, getReplyToAddresses, getSentDate, getSmtpPort, getSocketConnectionTimeout, getSocketTimeout, getSslSmtpPort, getSubject, getToAddresses, isSendPartial, isSSL, isSSLCheckServerIdentity, isSSLOnConnect, isStartTLSEnabled, isStartTLSRequired, isTLS, sendMimeMessage, setAuthentication, setAuthenticator, setBcc, setBounceAddress, setCc, setCharset, setContent, setContent, setDebug, setFrom, setFrom, setFrom, setHeaders, setHostName, setMailSession, setMailSessionFromJNDI, setPopBeforeSmtp, setReplyTo, setSendPartial, setSentDate, setSmtpPort, setSocketConnectionTimeout, setSocketTimeout, setSSL, setSSLCheckServerIdentity, setSSLOnConnect, setSslSmtpPort, setStartTLSEnabled, setStartTLSRequired, setSubject, setTLS, setTo, toInternetAddressArray, updateContentType
-
Field Details
-
NOTIFICATION_CONTENT
The path to the xml content with the subject, header and footer of the notification e-mail.- See Also:
-
-
Method Details
-
existsEditor
Returns true, if there exists an editor for a specific resource.- Parameters:
resource- the resource to check if there exists an editor- Returns:
- true if there exists an editor for the resource
-
getResponsible
Returns the responsible.- Returns:
- the responsible
-
generateHtmlMsg
Creates the mail to be sent to the responsible user.- Specified by:
generateHtmlMsgin classA_CmsNotification- Returns:
- the mail to be sent to the responsible user
-
getNotificationCauses
Returns a list of CmsNotificationResourceInfos of the resources that will occur in the notification.- Returns:
- a list of CmsNotificationResourceInfos of the resources that will occur in the notification
-
getNotificationContent
Description copied from class:A_CmsNotificationOverwrite the method to return the path to the xmlcontent, where the subject, the header and the footer are defined.- Specified by:
getNotificationContentin classA_CmsNotification- Returns:
- The path to the xmlcontent file.
- See Also:
-
setNotificationCauses
Sets the resources.- Parameters:
resources- a list of CmsNotificationResourceInfo's
-