Package io.jmix.email

Class EmailerProperties.OAuth2

java.lang.Object

io.jmix.email.EmailerProperties.OAuth2

Enclosing class:

EmailerProperties

public static class EmailerProperties.OAuth2
extends Object

Field Summary

Fields

Modifier and Type	Field	Description
protected final String	clientId	Client id of application to connect via OAuth2.
protected final boolean	enabled	Whether the OAuth2 authentication is enabled
protected final String	provider	Name of SMTP server provider.
protected final String	redirectUri	Redirect URI used by the authorization code flow when connecting a mailbox account.
protected final String	refreshToken	Initial refresh token value used to get access token.
protected final String	secret	Secret of application to connect via OAuth2.
protected final String	tenantId	Tenant id used to connect to application provided by Microsoft

Constructor Summary

Constructors

Constructor	Description
OAuth2(boolean enabled, @Nullable String provider, @Nullable String clientId, @Nullable String secret, @Nullable String refreshToken, String tenantId, @Nullable String redirectUri)

Method Summary

Modifier and Type	Method	Description
@Nullable String	getClientId()
@Nullable String	getProvider()
@Nullable String	getRedirectUri()
@Nullable String	getRefreshToken()
@Nullable String	getSecret()
String	getTenantId()
boolean	isEnabled()

Methods inherited from class java.lang.Object

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

Field Details

enabled

protected final boolean enabled

Whether the OAuth2 authentication is enabled

provider

protected final String provider

Name of SMTP server provider. Required when OAuth2 authentication is enabled, unless a custom OAuth2TokenProvider bean is defined by the application.

Available values: google, microsoft

clientId

protected final String clientId

Client id of application to connect via OAuth2. Required when OAuth2 authentication is enabled.

secret

protected final String secret

Secret of application to connect via OAuth2. Required when OAuth2 authentication is enabled.

refreshToken

protected final String refreshToken

Initial refresh token value used to get access token. This value is used only while no refresh token is stored in the database. Once a token is stored (via the email connection view or automatically after provider-side token rotation), the stored value takes precedence.

tenantId

protected final String tenantId

Tenant id used to connect to application provided by Microsoft

redirectUri

protected final String redirectUri

Redirect URI used by the authorization code flow when connecting a mailbox account. If not set, the URI is derived from the current request. Set it explicitly when the application is behind a reverse proxy and the derived URI is wrong. The value must be registered as a redirect URI of the OAuth client.

Constructor Details

OAuth2

public OAuth2(@DefaultValue("false")
 boolean enabled,
 @Nullable String provider,
 @Nullable String clientId,
 @Nullable String secret,
 @Nullable String refreshToken,
 @DefaultValue("common")
 String tenantId,
 @Nullable String redirectUri)

Method Details

isEnabled

public boolean isEnabled()

See Also:

• enabled

getProvider

public @Nullable String getProvider()

See Also:

• provider

getClientId

public @Nullable String getClientId()

See Also:

• clientId

getSecret

public @Nullable String getSecret()

See Also:

• secret

getRefreshToken

public @Nullable String getRefreshToken()

See Also:

• refreshToken

getTenantId

public String getTenantId()

See Also:

• tenantId

getRedirectUri

public @Nullable String getRedirectUri()

See Also:

• redirectUri