com.liferay.portal.util

Class SubscriptionSender

java.lang.Object

com.liferay.portal.util.SubscriptionSender

All Implemented Interfaces:

java.io.Serializable

public class SubscriptionSender
extends java.lang.Object
implements java.io.Serializable

Author:

Brian Wing Shun Chan, Mate Thurzo, Raymond Augé

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected java.lang.String	body
protected boolean	bulk
protected long	companyId
protected java.util.List<FileAttachment>	fileAttachments
protected java.lang.String	fromAddress
protected java.lang.String	fromName
protected long	groupId
protected boolean	htmlFormat
protected java.lang.String	inReplyTo
protected java.util.Map<java.util.Locale,java.lang.String>	localizedBodyMap
protected java.util.Map<java.util.Locale,java.lang.String>	localizedSubjectMap
protected java.lang.String	mailId
protected java.lang.String	portletId
protected java.lang.String	replyToAddress
protected long	scopeGroupId
protected ServiceContext	serviceContext
protected SMTPAccount	smtpAccount
protected java.lang.String	subject
protected long	userId

Constructor Summary

Constructors

Constructor and Description
SubscriptionSender()

Method Summary

Methods

Modifier and Type	Method and Description
void	addFileAttachment(java.io.File file)
void	addFileAttachment(java.io.File file, java.lang.String fileName)
void	addPersistedSubscribers(java.lang.String className, long classPK)
void	addRuntimeSubscribers(java.lang.String toAddress, java.lang.String toName)
protected void	deleteSubscription(Subscription subscription)
void	flushNotifications()
void	flushNotificationsAsync()
java.lang.Object	getContextAttribute(java.lang.String key)
java.lang.String	getMailId()
protected boolean	hasPermission(Subscription subscription, java.lang.String inferredClassName, long inferredClassPK, User user)
protected boolean	hasPermission(Subscription subscription, User user) Deprecated. As of 6.2.0, replaced by hasPermission(Subscription, String, long, User)
void	initialize()
protected void	notifySubscriber(Subscription subscription) Deprecated. As of 6.2.0, replaced by notifySubscriber(Subscription, String, long)
protected void	notifySubscriber(Subscription subscription, java.lang.String inferredClassName, long inferredClassPK)
protected void	processMailMessage(MailMessage mailMessage, java.util.Locale locale)
protected java.lang.String	replaceContent(java.lang.String content, java.util.Locale locale)
protected java.lang.String	replaceContent(java.lang.String content, java.util.Locale locale, boolean escape)
protected void	sendEmail(javax.mail.internet.InternetAddress to, java.util.Locale locale)
void	setBody(java.lang.String body)
void	setBulk(boolean bulk)
void	setCompanyId(long companyId)
void	setContextAttribute(java.lang.String key, EscapableObject<java.lang.String> value)
void	setContextAttribute(java.lang.String key, java.lang.Object value)
void	setContextAttribute(java.lang.String key, java.lang.Object value, boolean escape)
void	setContextAttributes(java.lang.Object... values)
void	setContextUserPrefix(java.lang.String contextUserPrefix)
void	setFrom(java.lang.String fromAddress, java.lang.String fromName)
void	setGroupId(long groupId)
void	setHtmlFormat(boolean htmlFormat)
void	setInReplyTo(java.lang.String inReplyTo)
void	setLocalizedBodyMap(java.util.Map<java.util.Locale,java.lang.String> localizedBodyMap)
void	setLocalizedSubjectMap(java.util.Map<java.util.Locale,java.lang.String> localizedSubjectMap)
void	setMailId(java.lang.String popPortletPrefix, java.lang.Object... ids)
void	setPortletId(java.lang.String portletId)
void	setReplyToAddress(java.lang.String replyToAddress)
void	setScopeGroupId(long scopeGroupId)
void	setServiceContext(ServiceContext serviceContext)
void	setSMTPAccount(SMTPAccount smtpAccount)
void	setSubject(java.lang.String subject)
void	setUserId(long userId)

Methods inherited from class java.lang.Object

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

Field Detail

body

protected java.lang.String body

bulk

protected boolean bulk

companyId

protected long companyId

fileAttachments

protected java.util.List<FileAttachment> fileAttachments

fromAddress

protected java.lang.String fromAddress

fromName

protected java.lang.String fromName

groupId

protected long groupId

htmlFormat

protected boolean htmlFormat

inReplyTo

protected java.lang.String inReplyTo

localizedBodyMap

protected java.util.Map<java.util.Locale,java.lang.String> localizedBodyMap

localizedSubjectMap

protected java.util.Map<java.util.Locale,java.lang.String> localizedSubjectMap

mailId

protected java.lang.String mailId

portletId

protected java.lang.String portletId

replyToAddress

protected java.lang.String replyToAddress

scopeGroupId

protected long scopeGroupId

serviceContext

protected ServiceContext serviceContext

smtpAccount

protected SMTPAccount smtpAccount

subject

protected java.lang.String subject

userId

protected long userId

Constructor Detail

SubscriptionSender

public SubscriptionSender()

Method Detail

addFileAttachment

public void addFileAttachment(java.io.File file)

addFileAttachment

public void addFileAttachment(java.io.File file,
                     java.lang.String fileName)

addPersistedSubscribers

public void addPersistedSubscribers(java.lang.String className,
                           long classPK)

addRuntimeSubscribers

public void addRuntimeSubscribers(java.lang.String toAddress,
                         java.lang.String toName)

flushNotifications

public void flushNotifications()
                        throws java.lang.Exception

Throws:

java.lang.Exception

flushNotificationsAsync

public void flushNotificationsAsync()

getContextAttribute

public java.lang.Object getContextAttribute(java.lang.String key)

getMailId

public java.lang.String getMailId()

initialize

public void initialize()
                throws java.lang.Exception

Throws:

java.lang.Exception

setBody

public void setBody(java.lang.String body)

setBulk

public void setBulk(boolean bulk)

setCompanyId

public void setCompanyId(long companyId)

setContextAttribute

public void setContextAttribute(java.lang.String key,
                       EscapableObject<java.lang.String> value)

setContextAttribute

public void setContextAttribute(java.lang.String key,
                       java.lang.Object value)

setContextAttribute

public void setContextAttribute(java.lang.String key,
                       java.lang.Object value,
                       boolean escape)

setContextAttributes

public void setContextAttributes(java.lang.Object... values)

setContextUserPrefix

public void setContextUserPrefix(java.lang.String contextUserPrefix)

setFrom

public void setFrom(java.lang.String fromAddress,
           java.lang.String fromName)

setGroupId

public void setGroupId(long groupId)

setHtmlFormat

public void setHtmlFormat(boolean htmlFormat)

setInReplyTo

public void setInReplyTo(java.lang.String inReplyTo)

setLocalizedBodyMap

public void setLocalizedBodyMap(java.util.Map<java.util.Locale,java.lang.String> localizedBodyMap)

setLocalizedSubjectMap

public void setLocalizedSubjectMap(java.util.Map<java.util.Locale,java.lang.String> localizedSubjectMap)

setMailId

public void setMailId(java.lang.String popPortletPrefix,
             java.lang.Object... ids)

setPortletId

public void setPortletId(java.lang.String portletId)

setReplyToAddress

public void setReplyToAddress(java.lang.String replyToAddress)

setScopeGroupId

public void setScopeGroupId(long scopeGroupId)

See Also:

BaseIndexer.getSiteGroupId(long)

setServiceContext

public void setServiceContext(ServiceContext serviceContext)

setSMTPAccount

public void setSMTPAccount(SMTPAccount smtpAccount)

setSubject

public void setSubject(java.lang.String subject)

setUserId

public void setUserId(long userId)

deleteSubscription

protected void deleteSubscription(Subscription subscription)
                           throws java.lang.Exception

Throws:

java.lang.Exception

hasPermission

protected boolean hasPermission(Subscription subscription,
                    java.lang.String inferredClassName,
                    long inferredClassPK,
                    User user)
                         throws java.lang.Exception

Throws:

java.lang.Exception

hasPermission

protected boolean hasPermission(Subscription subscription,
                    User user)
                         throws java.lang.Exception

Deprecated. As of 6.2.0, replaced by hasPermission(Subscription, String, long, User)

Throws:

java.lang.Exception

notifySubscriber

protected void notifySubscriber(Subscription subscription)
                         throws java.lang.Exception

Deprecated. As of 6.2.0, replaced by notifySubscriber(Subscription, String, long)

Throws:

java.lang.Exception

notifySubscriber

protected void notifySubscriber(Subscription subscription,
                    java.lang.String inferredClassName,
                    long inferredClassPK)
                         throws java.lang.Exception

Throws:

java.lang.Exception

processMailMessage

protected void processMailMessage(MailMessage mailMessage,
                      java.util.Locale locale)
                           throws java.lang.Exception

Throws:

java.lang.Exception

replaceContent

protected java.lang.String replaceContent(java.lang.String content,
                              java.util.Locale locale)
                                   throws java.lang.Exception

Throws:

java.lang.Exception

replaceContent

protected java.lang.String replaceContent(java.lang.String content,
                              java.util.Locale locale,
                              boolean escape)
                                   throws java.lang.Exception

Throws:

java.lang.Exception

sendEmail

protected void sendEmail(javax.mail.internet.InternetAddress to,
             java.util.Locale locale)
                  throws java.lang.Exception

Throws:

java.lang.Exception