@PublicApi public interface

MailSettings

com.atlassian.jira.mail.settings.MailSettings
Known Indirect Subclasses

@PublicApi

This interface is designed for plugins to consume (call its methods).

Clients of @PublicApi can expect that programs compiled against a given version will remain binary compatible with later versions of the @PublicApi as per each product's API policy as long as the client does not implement/extend @PublicApi interfaces or classes (refer to each product's API policy for the exact guarantee---usually binary compatibility is guaranteed at least across minor versions).

Note: since @PublicApi interfaces and classes are not designed to be implemented or extended by clients, we may perform certain types of binary-incompatible changes to these classes and interfaces, but these will not affect well-behaved clients that do not extend/implement these types (in general, only classes and interfaces annotated with @PublicSpi are safe to extend/implement).

Class Overview

Responsible for holding the mail settings for JIRA.

Summary

Nested Classes
class MailSettings.DefaultMailSettings  
class MailSettings.Fetch Represents the state of incoming mail processing in JIRA. 
class MailSettings.Send Represents the state of outgoing mail for this JIRA instance. 
Public Methods
MailSettings.Fetch fetch()
Retrieves the incoming mail settings for JIRA.
MailSettings.Send send()
Retrieves the outgoing mail settings for JIRA.

Public Methods

public MailSettings.Fetch fetch ()

Retrieves the incoming mail settings for JIRA.

Returns
  • An object representing the incoming mail settings for JIRA.

public MailSettings.Send send ()

Retrieves the outgoing mail settings for JIRA.

Returns
  • An object representing the outgoing mail settings for JIRA.