Package com.javahollic.jira.emh.api

Interface IJEMHRuntimeConfig

    • Method Detail

      • getAliases

        KeyValuePair[] getAliases()
        Aliases allow for arbitrary command shortening, can shorten the key, but can also be used to provide a value
        Returns:
        String for simple substitution or String[2] for [0]=key, [1]=value

      • getAssignJiraUsersNameToCustomField

        @Deprecated
String getAssignJiraUsersNameToCustomField()
        Deprecated.
        Use getJiraUserSenderCFId() to get unambiguous ID's instead of locale-sensitive names.
        Get name of custom field used for handling JIRA user sender from incoming email.
        Returns:
        jira user custom field

      • getJiraUserSenderCFId

        String getJiraUserSenderCFId()
        Get ID of the custom field used to handle JIRA user sender from incoming email.
        Returns:
        ID string of the form customfield_xxxxx

      • getAssignJiraUsersOriginalEmailAddressToCustomField

        @Deprecated
String getAssignJiraUsersOriginalEmailAddressToCustomField()
        Deprecated.
        Use getJiraUserSenderEmailAddressCFId() to get unambiguous ID's instead of locale-sensitive names.
        Get name of custom field used for handling JIRA user sender email address of incoming email.
        Returns:
        custom field name

      • getJiraUserSenderEmailAddressCFId

        String getJiraUserSenderEmailAddressCFId()
        Get ID of the custom field used to handle JIRA user sender email address from incoming email.
        Returns:
        ID string of the form customfield_xxxxx

      • getAssignNonJiraUsersOriginalNameToCustomField

        @Deprecated
String getAssignNonJiraUsersOriginalNameToCustomField()
        Deprecated.
        Use getNonJiraUserSenderNameCFId() to get unambiguous ID's instead of locale-sensitive names.
        Get name of custom field used for handling non-JIRA user
        Returns:
        name of custom field

      • getNonJiraUserSenderNameCFId

        String getNonJiraUserSenderNameCFId()
        Get ID of the custom field used to handle non-JIRA user sender name from incoming email.
        Returns:
        ID string of the form customfield_xxxxx

      • getAssignNonJiraUsersOriginalEmailAddressToCustomField

        @Deprecated
String getAssignNonJiraUsersOriginalEmailAddressToCustomField()
        Deprecated.
        Use getNonJiraUserSenderEmailAddressCFId() to get unambiguous ID's instead of locale-sensitive names.
        Get name of custom field used for handling non-JIRA user email address from incoming email.
        Returns:
        name of custom field

      • getNonJiraUserSenderEmailAddressCFId

        String getNonJiraUserSenderEmailAddressCFId()
        Get ID of the custom field used to handle non-JIRA user sender email address from incoming email.
        Returns:
        ID string of the form customfield_xxxxx

      • getWhitelistedAttachmentTypes

        String[] getWhitelistedAttachmentTypes()

      • getBlacklistedAttachmentTypes

        String[] getBlacklistedAttachmentTypes()

      • getBlacklistedAttMimeTypes

        String[] getBlacklistedAttMimeTypes()

      • getBlacklistRecipients

        String[] getBlacklistRecipients()

      • getBlacklistSenders

        String[] getBlacklistSenders()

      • getNonRenamedAtts

        String[] getNonRenamedAtts()

      • getProjectMappingDomainRuleAddresseeMatch

        CatchEmailResult getProjectMappingDomainRuleAddresseeMatch​(javax.mail.Message message)

      • getCatchEmailHeaders

        String[] getCatchEmailHeaders()

      • getCCHandling

        String[] getCCHandling()

      • getCCHandlingJiraUsersCustomFieldName

        @Deprecated
String getCCHandlingJiraUsersCustomFieldName()
        Deprecated.
        Use getCCHandlingJiraUsersCFId() to get unambiguous ID's instead of locale-sensitive names.
        Get name of the custom field used for handling JIRA user reci@Override pients from incoming email.
        Returns:
        name of custom field

      • getCCHandlingJiraUsersCFId

        String getCCHandlingJiraUsersCFId()
        Get ID of the custom field used to handle JIRA user recipients from incoming email.
        Returns:
        ID string of the form customfield_xxxxx

      • getCCHandlingNonJiraUsersCustomFieldName

        @Deprecated
String getCCHandlingNonJiraUsersCustomFieldName()
        Deprecated.
        Use getCCHandlingNonJiraUsersCFId() to get unambiguous ID's instead of locale-sensitive names.
        Get name of the custom field used for handling non-JIRA user recipients from incoming email.
        Returns:
        name of custom field

      • getCCHandlingNonJiraUsersCFId

        String getCCHandlingNonJiraUsersCFId()
        Get ID of the custom field used to handle non-JIRA user recipients from incoming email.
        Returns:
        ID string of the form customfield_xxxxx

      • getCCEmailAddressesCustomFieldName

        @Deprecated
String getCCEmailAddressesCustomFieldName()
        Deprecated.
        Use getCCEmailAddressesCFId() to get unambiguous ID's instead of locale-sensitive names.
        Get name of the custom field used to handle email addresses found in the CC header from incoming email.
        Returns:
        name of custom field

      • getCCEmailAddressesCFId

        String getCCEmailAddressesCFId()
        Get ID of the custom field used to handle email addresses found in the CC header from incoming email.
        Returns:
        ID string of the form customfield_xxxxx

      • getCreateUsersIDFrom

        String getCreateUsersIDFrom()

      • getAlternateIdProvider

        String getAlternateIdProvider()

      • getCreateUsersIDFromEmailDomainBlacklist

        String[] getCreateUsersIDFromEmailDomainBlacklist()

      • getCreateUsersIDFromEmailDomainWhitelist

        String[] getCreateUsersIDFromEmailDomainWhitelist()

      • getCustomEmailFromAddress

        String getCustomEmailFromAddress()

      • getCustomEmailFromName

        String getCustomEmailFromName()

      • getCustomEmailReplyToAddress

        String getCustomEmailReplyToAddress()

      • getCustomEmailReplyToName

        String getCustomEmailReplyToName()

      • getDefaultAutoJoinGroups

        String[] getDefaultAutoJoinGroups()

      • isAutoJoinNewUsersGroup

        boolean isAutoJoinNewUsersGroup()

      • getDefaultCommentVisibility

        String getDefaultCommentVisibility()

      • getDefaultCustomFieldValue

        String getDefaultCustomFieldValue​(String customFieldName,
                                  javax.mail.Message incomingMessage)

      • getDefaultCustomFieldValue

        String getDefaultCustomFieldValue​(com.atlassian.jira.issue.fields.CustomField arg0,
                                  boolean isCreating,
                                  javax.mail.Message incomingMessage)

      • isDefaultCustomFieldRuleMatch

        boolean isDefaultCustomFieldRuleMatch​(String name,
                                      com.atlassian.jira.issue.Issue fRelatedIssue)

      • getDateFormats

        String[] getDateFormats()

      • getDateTimeFormats

        String[] getDateTimeFormats()

      • getDefaultDueDateDays

        String getDefaultDueDateDays()

      • getDefaultIssueCommentLimit

        int getDefaultIssueCommentLimit()
        Allows a configurable limit to be set stopping commenting on issues with more than this number of comments already
        Returns:
        comment size limit

      • getDefaultIssueCommentSizeLimitKb

        int getDefaultIssueCommentSizeLimitKb()
        Allows a configurable limit to be set stopping excessively large comments being added to issues, possibly erroneously
        Returns:
        comment size limit in bytes (changed from kilobytes in 2.1.8)

      • getDefaultIssueLinkType

        String getDefaultIssueLinkType()

      • isCommentVisibilityOptional

        boolean isCommentVisibilityOptional()

      • getDefaultReporterUserKey

        String getDefaultReporterUserKey()

      • getDefaultSummary

        String getDefaultSummary()

      • getDefaultComment

        String getDefaultComment()

      • getDefaultWorklogSecurityGroup

        String getDefaultWorklogSecurityGroup()

      • getDefaultWorklogSecurityRole

        String getDefaultWorklogSecurityRole()

      • getDirectiveProcessingBehaviour

        String getDirectiveProcessingBehaviour()
        Indicate if any specific variation should be used to enable JEMH directive processing
        Returns:
        onComment, onCreateAndComment

      • isUseTranslatedFieldNames

        boolean isUseTranslatedFieldNames()

      • getWhitelistDirectives

        String[] getWhitelistDirectives()

      • getBlacklistDirectives

        String[] getBlacklistDirectives()

      • getDirectiveGroups

        String[] getDirectiveGroups()
        enabled for JIRA users with given groups
        Returns:
        String[] of Group names whose members may use Directives

      • getEatEmptyBodyLinesMax

        int getEatEmptyBodyLinesMax()

      • getEnabledFieldProcessors

        String[] getEnabledFieldProcessors()

      • getForceUserIdCase

        String getForceUserIdCase()

      • getHintogramEmailTemplate

        Integer getHintogramEmailTemplate()

      • getIndicateSourcedByEmailTemplate

        Integer getIndicateSourcedByEmailTemplate()

      • getForwardEmailTemplate

        Integer getForwardEmailTemplate()

      • getUserSignupEmailTemplate

        Integer getUserSignupEmailTemplate()

      • getThreadMatchRejectTemplate

        Integer getThreadMatchRejectTemplate()

      • calculateFinalCharLimit

        int calculateFinalCharLimit()

      • getIssueCommentLimitExceededAction

        String getIssueCommentLimitExceededAction()
        Determines how failure should be handled, either send to 'forward' user or 'reject' through normal hintOgram method
        Returns:
        action value like 'reject'

      • getJiraDurationUtils

        com.atlassian.jira.util.JiraDurationUtils getJiraDurationUtils​(com.atlassian.jira.security.JiraAuthenticationContext jac)
        Specified by:
        getJiraDurationUtils in interface IJEMHSystemConfigHelper

      • getOverrideHintOgramEmailAddress

        String getOverrideHintOgramEmailAddress()
        Returns:
        Provide ability to intercept all hintOgrams

      • getPrivilegedUser

        com.atlassian.jira.user.ApplicationUser getPrivilegedUser()

      • getProfileId

        int getProfileId()

      • getProfileGroupKey

        String getProfileGroupKey()

      • isProfileGroupDefault

        boolean isProfileGroupDefault()

      • isGroupOutcomeControlEnabled

        boolean isGroupOutcomeControlEnabled()

      • getProcessOutcomesToIgnore

        Set<com.javahollic.jira.emh.api.ao.IJEMHFPAuditEventEntiyDef.ProcessingOutcome> getProcessOutcomesToIgnore()

      • getProfileName

        String getProfileName()

      • getProfileGroupOrder

        int getProfileGroupOrder()

      • isSenderMustHaveAcct

        boolean isSenderMustHaveAcct()

      • getWhitelistSenders

        String[] getWhitelistSenders()

      • isAddSenderAsWatcher

        boolean isAddSenderAsWatcher()

      • isAutoFlushMailQueue

        boolean isAutoFlushMailQueue()

      • isCommentLevelVisibilityForGroupsEnabled

        boolean isCommentLevelVisibilityForGroupsEnabled()

      • isCreateUsers

        boolean isCreateUsers()

      • getUserDirectoryForCreate

        String getUserDirectoryForCreate()

      • isCreateUserSignupEmail

        boolean isCreateUserSignupEmail()

      • isDebugPrintEmail

        boolean isDebugPrintEmail()

      • isDefaultReporterOverridesDerivedReporter

        boolean isDefaultReporterOverridesDerivedReporter()

      • isEnableAutomaticIssueAssignee

        boolean isEnableAutomaticIssueAssignee()

      • isHintOgramEnabled

        boolean isHintOgramEnabled()

      • isNotifyOfAllIssueCreationFailure

        boolean isNotifyOfAllIssueCreationFailure()

      • getCustomEventFireMode

        @Deprecated
IJEMHDataTypes.CustomEventFireMode getCustomEventFireMode()
        Deprecated.
        since 3.3.14, as only bundles should be fired
        Returns:
        type representing how custom events should be fired by JEMH.

      • isIndicateSourcedByEmailHeader

        @Deprecated
boolean isIndicateSourcedByEmailHeader()
        Deprecated.

      • isIndicateWhichHandlerProcessedMail

        boolean isIndicateWhichHandlerProcessedMail()

      • isEmbeddedAttsEnabled

        boolean isEmbeddedAttsEnabled()

      • isNotifyUsers

        boolean isNotifyUsers()

      • isProjectAutoAssign

        boolean isProjectAutoAssign()

      • isProjectAutoAssignSubAddresses

        boolean isProjectAutoAssignSubAddresses()

      • isStripQuotes

        boolean isStripQuotes()

      • isUpdateWithCommentsAlwaysToTriggerUpdateEvents

        boolean isUpdateWithCommentsAlwaysToTriggerUpdateEvents()

      • isUseEmailSenderForSecurityChecks

        boolean isUseEmailSenderForSecurityChecks()

      • isUseGenericEventEnabled

        boolean isUseGenericEventEnabled()

      • isProjLeadForForward

        boolean isProjLeadForForward()

      • getForwardEmails

        String getForwardEmails()

      • isAddOriginalEmailToForwardNotification

        boolean isAddOriginalEmailToForwardNotification()

      • getIssueSecurityLevel

        String getIssueSecurityLevel()

      • getHtmlExtractMethod

        String getHtmlExtractMethod()

      • isUseProvidedHtmlImageAttributes

        boolean isUseProvidedHtmlImageAttributes()

      • getHtmlImageAttributes

        String getHtmlImageAttributes()

      • isAssigneeFirstValidUser

        boolean isAssigneeFirstValidUser()

      • getSubjectCleanupRegexps

        String getSubjectCleanupRegexps()
        This field is now applied Before Directive processing only. For post-Directive processing, us Project Mapping cleanup regexps
        Returns:
        csv regexps

      • getBodyCleanupRegexps

        String getBodyCleanupRegexps()
        This field is now applied Before Directive processing only. For post-Directive processing, us Project Mapping cleanup regexps
        Returns:
        csv regexps

      • getSubjectIssueKeyRegexp

        String getSubjectIssueKeyRegexp()

      • getForwardSubjectPrefixes

        String getForwardSubjectPrefixes()

      • isPreValidateCustomFieldValues

        boolean isPreValidateCustomFieldValues()

      • isHideHtmlLinks

        boolean isHideHtmlLinks()

      • isRemoveNbsp

        boolean isRemoveNbsp()

      • isIgnoreSubjectIssueKeys

        boolean isIgnoreSubjectIssueKeys()

      • isDisableAttZipWrapper

        boolean isDisableAttZipWrapper()

      • getCreateEmailNameFormat

        String getCreateEmailNameFormat()

      • getCommentEmailNameFormat

        String getCommentEmailNameFormat()

      • getProjAssignFromSubj

        String getProjAssignFromSubj()

      • getCustomEventOnComment

        int getCustomEventOnComment()

      • isAutoLabelEnabled

        boolean isAutoLabelEnabled()

      • getAutoLabelIgnores

        List<String> getAutoLabelIgnores()

      • getAutoLabelSubstitutions

        Map<String,​String> getAutoLabelSubstitutions()

      • getAutoLabelMinCharCount

        int getAutoLabelMinCharCount()

      • getAutoLabelMaxCharCount

        int getAutoLabelMaxCharCount()

      • getAutoLabelSubjectDelimiter

        String getAutoLabelSubjectDelimiter()

      • isAutoLabelAddSuggestions

        boolean isAutoLabelAddSuggestions()

      • isAutoLabelAddUniqueOriginals

        boolean isAutoLabelAddUniqueOriginals()

      • isCanCreateLabels

        boolean isCanCreateLabels()

      • isAutoLabelSenderDomain

        boolean isAutoLabelSenderDomain()

      • getWhitelistAutoLabelSenderDomains

        Set<String> getWhitelistAutoLabelSenderDomains()

      • getBlacklistAutoLabelSenderDomains

        Set<String> getBlacklistAutoLabelSenderDomains()

      • getSenderDomainCfId

        String getSenderDomainCfId()
        Get ID of custom field used for sender domain
        Returns:
        ID of custom field in form customfield_xxxxx

      • getCustomEventOnCreate

        int getCustomEventOnCreate()

      • isColonSuffixMultilineDisabled

        boolean isColonSuffixMultilineDisabled()

      • isAddAttachImgLinks

        boolean isAddAttachImgLinks()

      • isAddAttachFileLinks

        boolean isAddAttachFileLinks()

      • getEmailSentDateCF

        @Deprecated
String getEmailSentDateCF()
        Deprecated.
        Use getEmailSentDateCFId() instead.
        Get name of custom field used for handling email sent date of incoming email.
        Returns:
        name of custom field

      • getEmailSentDateCFId

        String getEmailSentDateCFId()
        Get ID of custom field used for email sent date of incoming email.
        Returns:
        ID of cutom field in form customfield_xxxxx

      • isAllowAnonymousCommenting

        boolean isAllowAnonymousCommenting()

      • getNonCatchmailMatchAction

        String getNonCatchmailMatchAction()

      • getNoIssOnCommentAction

        String getNoIssOnCommentAction()

      • isNormaliseNewlines

        boolean isNormaliseNewlines()

      • isUseReprocessedMessage

        boolean isUseReprocessedMessage()

      • isThreadCheckDisabled

        boolean isThreadCheckDisabled()

      • isMergeResentMessages

        boolean isMergeResentMessages()

      • isThreadMatchRejectEnforced

        boolean isThreadMatchRejectEnforced()

      • getThreadMatchNotWithResolutions

        String[] getThreadMatchNotWithResolutions()

      • getThreadMatchJql

        String getThreadMatchJql()

      • isNotifyThreadMatchReject

        boolean isNotifyThreadMatchReject()

      • getThreadRejectSenderCfId

        long getThreadRejectSenderCfId()

      • getNoCommentHeaderAddresses

        String getNoCommentHeaderAddresses()

      • isEnableGenericThirdPartyCFHandling

        boolean isEnableGenericThirdPartyCFHandling()

      • isTreatUnprivilegedAsNonJira

        boolean isTreatUnprivilegedAsNonJira()

      • getUnprivReporterAction

        String getUnprivReporterAction()

      • getUnprivReporterCondition

        String getUnprivReporterCondition()

      • isEscapeWikiMarkup

        boolean isEscapeWikiMarkup()

      • isUseXpriorityHeader

        boolean isUseXpriorityHeader()

      • isAddIssueEntityProps

        boolean isAddIssueEntityProps()

      • getPrecedenceFilterAction

        String getPrecedenceFilterAction​(String headerValue)
        Get action for late running precedence filter from matching project mapping. Implementation should be aware what mapping/rule was found to match.
        Parameters:
        headerValue - the value from the email header
        Returns:
        a String representing the action to be taken

      • getMappedProjectKey

        String getMappedProjectKey()

      • clearMessage

        void clearMessage()
        Method to remove Message object and related meta data from the config, to limit memory usage in multi-profile configurations

      • initWith

        com.javahollic.jira.emh.api.ao.IJEMHFPAuditEventEntiyDef.ProcessingOutcome initWith​(javax.mail.Message message,
                                                                                    com.javahollic.jira.emh.api.ao.IJEMHFPAuditEventEntiyDef auditEvent)
                                                                             throws javax.mail.MessagingException
        Throws:
        javax.mail.MessagingException

      • isJsdExternalCommentsEnabled

        boolean isJsdExternalCommentsEnabled()

      • getProcessingThrottle

        int getProcessingThrottle()

      • isAddOrgMemberAsReqPart

        boolean isAddOrgMemberAsReqPart()

      • getPostProcessedMessage

        javax.mail.Message getPostProcessedMessage()

      • getCustomActionFromConfig

        String getCustomActionFromConfig​(String filterHeader,
                                 String filterHeaderValue)

      • getCustomMessageFilterHeaders

        Set<String> getCustomMessageFilterHeaders()