com.communote.server.core.blog.helper

Class MailBasedPostingHelper

java.lang.Object

com.communote.server.core.blog.helper.MailBasedPostingHelper

public class MailBasedPostingHelper
extends Object

Helper methods for using mail based posting.

Author:

Communote GmbH - http://www.communote.com/

Method Summary

Modifier and Type	Method and Description
static String	createMessageIdentifier(Note note) Creates a message identifier that uniquely identifies a note and can be used as part of a Message-ID email header.
static Long	extractNoteIdFromMessageIdentifier(String messageIdentifier) Extracts the ID of a note from a message identifier that was previously created with createMessageIdentifier(Note).
static String	getBlogEmailAddress(String blogIdentifier) Returns the blog email address of a blog identified by its name identifier.
static String	getBlogMailTo(String alias) Returns the mailto string to be inserted as href value to render a link of the email address of a blog.
static String	getBlogMailToFromEmailAddress(String emailAddress, String alias) Returns the mailto string to be inserted as href value to render a link of the email address of a blog.
static String	getClientWideBlogEmailAddressSuffix() Returns the blog email address without the leading blog name identifier.
static String	getClientWideBlogEmailAddressSuffix(String clientId) Returns the blog email address without the leading blog name identifier.
static String	getCurrentEmailServerDomain() Returns the email server domain (e.g.
static String	getStaticMailAddressSuffix() The static part at the end of the local name of an email address (e.g.
static boolean	isMailFetchingEnabled() Returns whether the mail fetcher is enable by checking the configuration properties.
static boolean	isRunningInSingleAddressMode() Returns true if the mail fetcher is configured to run in single address mode, which means that there is only one address to receive mail based postings and the blog name ID is searched inside the email's subject.

Methods inherited from class java.lang.Object

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

Method Detail

createMessageIdentifier

public static String createMessageIdentifier(Note note)

Creates a message identifier that uniquely identifies a note and can be used as part of a Message-ID email header.

Parameters:

note - the note for which the identifier is to be created

Returns:

the identifier

extractNoteIdFromMessageIdentifier

public static Long extractNoteIdFromMessageIdentifier(String messageIdentifier)

Extracts the ID of a note from a message identifier that was previously created with createMessageIdentifier(Note).

Parameters:

messageIdentifier - the identifier to parse

Returns:

the note ID or null if the identifier does not correspond to the expected format

getBlogEmailAddress

public static String getBlogEmailAddress(String blogIdentifier)

Returns the blog email address of a blog identified by its name identifier. In case the system is configured to use only one email address for all blogs then this address will be returned.

Parameters:

blogIdentifier - the name identifier of the blog

Returns:

the email address or null if the mail fetcher is disabled blogIdentifier is null or getCurrentEmailServerDomain() returns null

getBlogMailTo

public static String getBlogMailTo(String alias)

Returns the mailto string to be inserted as href value to render a link of the email address of a blog.

Parameters:

alias - the alias of the blog

Returns:

the mailto string or null if the mail fetcher is not enabled

getBlogMailToFromEmailAddress

public static String getBlogMailToFromEmailAddress(String emailAddress,
                                                   String alias)

Returns the mailto string to be inserted as href value to render a link of the email address of a blog.

Parameters:

emailAddress - the email address of the blog

alias - the alias of the blog

Returns:

the mailto string or null if the mail fetcher is not enabled

getClientWideBlogEmailAddressSuffix

public static String getClientWideBlogEmailAddressSuffix()

Returns the blog email address without the leading blog name identifier.

Returns:

the email address suffix or null if getCurrentEmailServerDomain() returns null

getClientWideBlogEmailAddressSuffix

public static String getClientWideBlogEmailAddressSuffix(String clientId)

Returns the blog email address without the leading blog name identifier.

Parameters:

clientId - The client id.

Returns:

the email address suffix or null if getCurrentEmailServerDomain() returns null

getCurrentEmailServerDomain

public static String getCurrentEmailServerDomain()

Returns the email server domain (e.g. communote.com). The method will fallback to the mailfetching.host property if the property mailfetching.domain is not found.

Returns:

the domain or null if not specified in mailfetching configuration or the mail fetching is disabled or singleMode is activated

getStaticMailAddressSuffix

public static String getStaticMailAddressSuffix()

The static part at the end of the local name of an email address (e.g. microblog) which is used for mail based posting. This part is separated from the rest of the address by the '.' character. The value can be the empty string which results in not using a static suffix.

Returns:

the static part from configuration or the empty string if configuration property is missing

isMailFetchingEnabled

public static boolean isMailFetchingEnabled()

Returns whether the mail fetcher is enable by checking the configuration properties.

Returns:

true if the mailfetching.enabled property is set to 'true' (case insensitive)

isRunningInSingleAddressMode

public static boolean isRunningInSingleAddressMode()

Returns true if the mail fetcher is configured to run in single address mode, which means that there is only one address to receive mail based postings and the blog name ID is searched inside the email's subject. Note: it's not checked whether mail fetching is enabled or not.

Returns:

true if single address mode is enabled