Package com.liferay.portal.kernel.util
Class SubscriptionSender
Object
com.liferay.portal.kernel.util.SubscriptionSender
- All Implemented Interfaces:
Serializable
- Direct Known Subclasses:
GroupSubscriptionCheckSubscriptionSender
- Author:
- Brian Wing Shun Chan, Máté Thurzó, Raymond Augé, Sergio González, Roberto Díaz
- See Also:
-
Nested Class Summary
Nested Classes -
Field Summary
FieldsModifier and TypeFieldDescriptionprotected Stringprotected booleanprotected longDeprecated.As of Cavanaugh (7.4.x), with no direct replacementprotected longprotected longprotected List<FileAttachment>protected Stringprotected Stringprotected longprotected booleanprotected Stringprotected Stringprotected Stringprotected Stringprotected longprotected ServiceContextprotected SMTPAccountprotected Stringprotected boolean -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionvoidaddAssetEntryPersistedSubscribers(String assetEntryClassName, long assetEntryClassPK) voidaddFileAttachment(File file) voidaddFileAttachment(File file, String fileName) <T> voidaddHook(SubscriptionSender.Hook.Event<T> event, SubscriptionSender.Hook<T> hook) voidaddPersistedSubscribers(String className, long classPK) voidaddPersistedSubscribers(String className, long classPK, boolean notifyImmediately) voidaddRuntimeSubscribers(String toAddress, String toName) protected voiddeleteSubscription(Subscription subscription) voidvoidlongDeprecated.As of Cavanaugh (7.4.x), with no direct replacementlongprotected booleanhasPermission(Subscription subscription, User user) protected booleanhasPermission(Subscription subscription, String className, long classPK, User user) protected BooleanhasSubscribePermission(PermissionChecker permissionChecker, Subscription subscription) booleanvoidbooleanisBulk()protected voidnotifyPersistedSubscriber(Subscription subscription, boolean notifyImmediately) protected voidnotifyPersistedSubscriber(Subscription subscription, String className, long classPK, boolean notifyImmediately) protected voidnotifyRuntimeSubscriber(javax.mail.internet.InternetAddress to, Locale locale) protected voidpopulateNotificationEventJSONObject(JSONObject notificationEventJSONObject) protected voidprocessMailMessage(MailMessage mailMessage, Locale locale) protected voidvoidsendEmailNotification(long userId) protected voidsendEmailNotification(User user) protected voidsendNotification(User user) Deprecated.As of Mueller (7.2.x)protected voidsendNotification(User user, boolean notifyImmediately) protected voidsendUserNotification(User user) Deprecated.As of Mueller (7.2.x)protected voidsendUserNotification(User user, boolean notifyImmediately) voidvoidsetBulk(boolean bulk) voidsetClassName(String className) voidsetClassPK(long classPK) voidsetCompanyId(long companyId) Deprecated.As of Cavanaugh (7.4.x), with no direct replacementvoidsetContextAttribute(String key, EscapableObject<String> value) voidsetContextAttribute(String key, Object value) voidsetContextAttribute(String key, Object value, boolean escape) voidsetContextAttributes(Object... values) voidsetContextCreatorUserPrefix(String contextCreatorUserPrefix) voidsetCreatorUserId(long creatorUserId) voidsetCurrentUserId(long currentUserId) voidsetEntryTitle(String entryTitle) voidsetEntryURL(String entryURL) voidvoidsetGroupId(long groupId) voidsetHtmlFormat(boolean htmlFormat) voidsetInReplyTo(String inReplyTo) voidsetLocalizedBodyMap(Map<Locale, String> localizedBodyMap) void<T extends Serializable & Function<Locale,String>>
voidsetLocalizedContextAttribute(String key, T function) <T extends Serializable & Function<Locale,String>>
voidsetLocalizedContextAttribute(String key, T function, boolean escape) voidsetLocalizedContextAttributeWithFunction(String key, Function<Locale, String> function) voidsetLocalizedContextAttributeWithFunction(String key, Function<Locale, String> function, boolean escape) voidsetLocalizedPortletTitleMap(Map<Locale, String> localizedPortletTitleMap) voidsetLocalizedSubjectMap(Map<Locale, String> localizedSubjectMap) voidvoidsetNotificationClassName(String notificationClassName) voidsetNotificationClassNameId(long notificationClassNameId) Deprecated.As of Cavanaugh (7.4.x), replaced bysetNotificationClassName(String)voidsetNotificationType(int notificationType) voidsetPortletId(String portletId) voidsetReplyToAddress(String replyToAddress) voidsetScopeGroupId(long scopeGroupId) voidsetSendToCurrentUser(boolean sendToCurrentUser) voidsetServiceContext(ServiceContext serviceContext) voidsetSMTPAccount(SMTPAccount smtpAccount) voidsetSubject(String subject) voidsetUniqueMailId(boolean uniqueMailId)
-
Field Details
-
body
-
bulk
protected boolean bulk -
companyId
Deprecated.As of Cavanaugh (7.4.x), with no direct replacement -
creatorUserId
protected long creatorUserId -
currentUserId
protected long currentUserId -
fileAttachments
-
fromAddress
-
fromName
-
groupId
protected long groupId -
htmlFormat
protected boolean htmlFormat -
inReplyTo
-
localizedBodyMap
-
localizedPortletTitleMap
-
localizedSubjectMap
-
mailId
-
portletId
-
replyToAddress
-
scopeGroupId
protected long scopeGroupId -
serviceContext
-
smtpAccount
-
subject
-
uniqueMailId
protected boolean uniqueMailId
-
-
Constructor Details
-
SubscriptionSender
public SubscriptionSender()
-
-
Method Details
-
addAssetEntryPersistedSubscribers
-
addFileAttachment
-
addFileAttachment
-
addHook
-
addPersistedSubscribers
-
addPersistedSubscribers
-
addRuntimeSubscribers
-
flushNotifications
- Throws:
Exception
-
flushNotificationsAsync
public void flushNotificationsAsync() -
getCompanyId
Deprecated.As of Cavanaugh (7.4.x), with no direct replacement -
getContextAttribute
-
getCurrentUserId
public long getCurrentUserId() -
getMailId
-
getServiceContext
-
hasSubscribers
public boolean hasSubscribers() -
initialize
- Throws:
Exception
-
isBulk
public boolean isBulk() -
sendEmailNotification
- Throws:
Exception
-
setBody
-
setBulk
public void setBulk(boolean bulk) -
setClassName
-
setClassPK
public void setClassPK(long classPK) -
setCompanyId
Deprecated.As of Cavanaugh (7.4.x), with no direct replacement -
setContextAttribute
-
setContextAttribute
-
setContextAttribute
-
setContextAttributes
-
setContextCreatorUserPrefix
-
setCreatorUserId
public void setCreatorUserId(long creatorUserId) -
setCurrentUserId
public void setCurrentUserId(long currentUserId) -
setEntryTitle
-
setEntryURL
-
setFrom
-
setGroupId
public void setGroupId(long groupId) -
setHtmlFormat
public void setHtmlFormat(boolean htmlFormat) -
setInReplyTo
-
setLocalizedBodyMap
-
setLocalizedContextAttribute
-
setLocalizedContextAttribute
public <T extends Serializable & Function<Locale,String>> void setLocalizedContextAttribute(String key, T function) -
setLocalizedContextAttribute
public <T extends Serializable & Function<Locale,String>> void setLocalizedContextAttribute(String key, T function, boolean escape) -
setLocalizedContextAttributeWithFunction
-
setLocalizedContextAttributeWithFunction
-
setLocalizedPortletTitleMap
-
setLocalizedSubjectMap
-
setMailId
-
setNotificationClassName
-
setNotificationClassNameId
Deprecated.As of Cavanaugh (7.4.x), replaced bysetNotificationClassName(String) -
setNotificationType
public void setNotificationType(int notificationType) - See Also:
-
setPortletId
-
setReplyToAddress
-
setScopeGroupId
public void setScopeGroupId(long scopeGroupId) - See Also:
-
setSendToCurrentUser
public void setSendToCurrentUser(boolean sendToCurrentUser) -
setServiceContext
-
setSMTPAccount
-
setSubject
-
setUniqueMailId
public void setUniqueMailId(boolean uniqueMailId) -
deleteSubscription
- Throws:
Exception
-
hasPermission
protected boolean hasPermission(Subscription subscription, String className, long classPK, User user) throws Exception - Throws:
Exception
-
hasPermission
- Throws:
Exception
-
hasSubscribePermission
protected Boolean hasSubscribePermission(PermissionChecker permissionChecker, Subscription subscription) throws PortalException - Throws:
PortalException
-
notifyPersistedSubscriber
protected void notifyPersistedSubscriber(Subscription subscription, boolean notifyImmediately) throws Exception - Throws:
Exception
-
notifyPersistedSubscriber
protected void notifyPersistedSubscriber(Subscription subscription, String className, long classPK, boolean notifyImmediately) throws Exception - Throws:
Exception
-
notifyRuntimeSubscriber
protected void notifyRuntimeSubscriber(javax.mail.internet.InternetAddress to, Locale locale) throws Exception - Throws:
Exception
-
populateNotificationEventJSONObject
-
processMailMessage
- Throws:
Exception
-
sendEmail
- Throws:
Exception
-
sendEmailNotification
- Throws:
Exception
-
sendNotification
Deprecated.As of Mueller (7.2.x)- Throws:
Exception
-
sendNotification
- Throws:
Exception
-
sendUserNotification
Deprecated.As of Mueller (7.2.x)- Throws:
Exception
-
sendUserNotification
- Throws:
Exception
-