Package com.atlassian.confluence.mail

Interface OAuth2MailServer

All Known Subinterfaces:

InboundMailServer

All Known Implementing Classes:

ConfluenceImapMailServer, ConfluencePopMailServer, ConfluenceSmtpMailServer

public interface OAuth2MailServer

Defines the contract for a mail server that supports OAuth2 authentication.

Since:

9.5

Method Summary

Modifier and Type	Method	Description
@Nullable Authorization	getAuthorization()	Returns the currently registered Authorization if ones configured, otherwise null.
default boolean	isBasicAuth()	Returns whether this MailServer is configured to use BasicAuth or not.
void	setAuthorization(@Nullable Authorization authorization)	Register an Authorization to use when retrieving email from this MailServer

Method Details

getAuthorization

@Nullable Authorization getAuthorization()

Returns the currently registered Authorization if ones configured, otherwise null.

Returns:

Authorization

setAuthorization

void setAuthorization(@Nullable Authorization authorization)

Register an Authorization to use when retrieving email from this MailServer

Parameters:

authorization - An Authorization methodology e.g. OAuth 2.0

isBasicAuth

default boolean isBasicAuth()

Returns whether this MailServer is configured to use BasicAuth or not.

Returns:

see description