Package com.webmethods.rtl.mail.api

Interface IMailUtil

All Superinterfaces:

IComponent, IComponentProvider, IInitializable, IURIResolver

public interface IMailUtil
extends IComponentProvider

Field Summary

Fields

Modifier and Type	Field	Description
static final String	ADMIN_EMAIL_ADDRESS
static final String	AUTH_TYPE_BASIC
static final String	AUTH_TYPE_OAUTH
static final String	AUTH_TYPE_REST
static final String	DCS_EMAIL_ADDRESS
static final String	DCS_EMAIL_FROM	NIS e-mail properties
static final String	DEFAULT_SMTP_PROTOCOL_VALUE
static final String	MS_GRAPH_ENDPOINT
static final String	MS_GRAPH_OAUTH_SCOPE
static final String	MS_XOAUTH_SCOPE
static final String	SYSTEM_MAIL_DEBUG
static final String	SYSTEM_SMTP_AUTH_LOGIN_DISABLE
static final String	SYSTEM_SMTP_AUTH_MECHANISMS
static final String	SYSTEM_SMTP_AUTH_PLAIN_DISABLE
static final String	SYSTEM_SMTP_AUTH_TYPE
static final String	SYSTEM_SMTP_CONNECTION_TIMEOUT
static final String	SYSTEM_SMTP_HOST	This is the default environment variable for the java.mail package: mail.smtp.host
static final String	SYSTEM_SMTP_OAUTH2_CLIENT_ID
static final String	SYSTEM_SMTP_OAUTH2_CLIENT_SECRET
static final String	SYSTEM_SMTP_OAUTH2_TOKEN_URL
static final String	SYSTEM_SMTP_PASSWORD
static final String	SYSTEM_SMTP_PORT
static final String	SYSTEM_SMTP_PROTOCOL
static final String	SYSTEM_SMTP_TIMEOUT
static final String	SYSTEM_SMTP_TLS_ENABLED
static final String	SYSTEM_SMTP_TLS_REQUIRED
static final String	SYSTEM_SMTP_USERNAME

Fields inherited from interface com.webmethods.portal.system.IComponentProvider

ATTR_APP_NAME, ATTR_BEG_QUERY, ATTR_END_QUERY, ATTR_MID_QUERY, BIZPOLICY_MANAGER, CACHE_PROVIDER, COMMAND_PROVIDER, COMPONENTS_QUERY, INSTALL_PROVIDER, MECH_PROVIDER, METACONTEXT_PROVIDER, PHASE_PROVIDER, POLICY_PROVIDER, SEARCH_PROVIDER

Method Summary

Modifier and Type	Method	Description
Message	getBlankMessage(Session customSession)	returns a new message to be filled in with the custom Session
String	getEmailProperty(String name)
Session	getNewSession(String smtpHostServer)	If you need create a new session, use this
Session	getSession(String smtpHostServer)	If you need the session, here you go
void	sendMail(String to, String cc, String from, String subject, String text)	sends email with the text defaulting as text/html and the default session
void	sendMail(String to, String cc, String from, String subject, String text, String contentType)	sends email with the text as the given contentType and the default session
void	sendMail(String to, String cc, String from, String subject, String text, String contentType, Session customSession)	sends email with the content type and custom session
void	updateConfig(Map<String,Object> props)

Methods inherited from interface com.webmethods.portal.system.IComponent

getComponentData, getComponentName, getComponentProvider, getURI, isInitialized, setComponentData, setComponentProvider

Methods inherited from interface com.webmethods.portal.system.IComponentProvider

exists, getComponent, getComponent, getComponent, getComponentQueryString, getComponents, getDefaultComponent, getLogger, initDeferredWebAppComponents, lookup, registerComponent, reloadComponent, reloadComponent, unregisterComponent, upgradeComponentDataFromBootstrapComponentData

Methods inherited from interface com.webmethods.portal.system.init.IInitializable

init, shutdown

Methods inherited from interface com.webmethods.portal.system.IURIResolver

acquireURI, acquireURI

Field Details

SYSTEM_SMTP_HOST

static final String SYSTEM_SMTP_HOST

This is the default environment variable for the java.mail package: mail.smtp.host

See Also:

• Constant Field Values

SYSTEM_SMTP_PORT

static final String SYSTEM_SMTP_PORT

See Also:

• Constant Field Values

SYSTEM_SMTP_PROTOCOL

static final String SYSTEM_SMTP_PROTOCOL

See Also:

• Constant Field Values

DEFAULT_SMTP_PROTOCOL_VALUE

static final String DEFAULT_SMTP_PROTOCOL_VALUE

See Also:

• Constant Field Values

SYSTEM_SMTP_USERNAME

static final String SYSTEM_SMTP_USERNAME

See Also:

• Constant Field Values

SYSTEM_SMTP_PASSWORD

static final String SYSTEM_SMTP_PASSWORD

See Also:

• Constant Field Values

SYSTEM_SMTP_TLS_ENABLED

static final String SYSTEM_SMTP_TLS_ENABLED

See Also:

• Constant Field Values

SYSTEM_MAIL_DEBUG

static final String SYSTEM_MAIL_DEBUG

See Also:

• Constant Field Values

SYSTEM_SMTP_CONNECTION_TIMEOUT

static final String SYSTEM_SMTP_CONNECTION_TIMEOUT

See Also:

• Constant Field Values

SYSTEM_SMTP_TIMEOUT

static final String SYSTEM_SMTP_TIMEOUT

See Also:

• Constant Field Values

SYSTEM_SMTP_OAUTH2_CLIENT_ID

static final String SYSTEM_SMTP_OAUTH2_CLIENT_ID

See Also:

• Constant Field Values

SYSTEM_SMTP_OAUTH2_CLIENT_SECRET

static final String SYSTEM_SMTP_OAUTH2_CLIENT_SECRET

See Also:

• Constant Field Values

SYSTEM_SMTP_OAUTH2_TOKEN_URL

static final String SYSTEM_SMTP_OAUTH2_TOKEN_URL

See Also:

• Constant Field Values

SYSTEM_SMTP_TLS_REQUIRED

static final String SYSTEM_SMTP_TLS_REQUIRED

See Also:

• Constant Field Values

SYSTEM_SMTP_AUTH_MECHANISMS

static final String SYSTEM_SMTP_AUTH_MECHANISMS

See Also:

• Constant Field Values

SYSTEM_SMTP_AUTH_LOGIN_DISABLE

static final String SYSTEM_SMTP_AUTH_LOGIN_DISABLE

See Also:

• Constant Field Values

SYSTEM_SMTP_AUTH_PLAIN_DISABLE

static final String SYSTEM_SMTP_AUTH_PLAIN_DISABLE

See Also:

• Constant Field Values

SYSTEM_SMTP_AUTH_TYPE

static final String SYSTEM_SMTP_AUTH_TYPE

See Also:

• Constant Field Values

MS_XOAUTH_SCOPE

static final String MS_XOAUTH_SCOPE

See Also:

• Constant Field Values

MS_GRAPH_ENDPOINT

static final String MS_GRAPH_ENDPOINT

See Also:

• Constant Field Values

MS_GRAPH_OAUTH_SCOPE

static final String MS_GRAPH_OAUTH_SCOPE

See Also:

• Constant Field Values

AUTH_TYPE_OAUTH

static final String AUTH_TYPE_OAUTH

See Also:

• Constant Field Values

AUTH_TYPE_REST

static final String AUTH_TYPE_REST

See Also:

• Constant Field Values

AUTH_TYPE_BASIC

static final String AUTH_TYPE_BASIC

See Also:

• Constant Field Values

DCS_EMAIL_FROM

static final String DCS_EMAIL_FROM

NIS e-mail properties

See Also:

• Constant Field Values

DCS_EMAIL_ADDRESS

static final String DCS_EMAIL_ADDRESS

See Also:

• Constant Field Values

ADMIN_EMAIL_ADDRESS

static final String ADMIN_EMAIL_ADDRESS

See Also:

• Constant Field Values

Method Details

updateConfig

void updateConfig(Map<String,Object> props)
           throws PortalException

Throws:

PortalException

getSession

Session getSession(String smtpHostServer)

If you need the session, here you go

getNewSession

Session getNewSession(String smtpHostServer)

If you need create a new session, use this

sendMail

void sendMail(String to,
 String cc,
 String from,
 String subject,
 String text)
       throws MessagingException

sends email with the text defaulting as text/html and the default session

Throws:

MessagingException

sendMail

void sendMail(String to,
 String cc,
 String from,
 String subject,
 String text,
 String contentType)
       throws MessagingException

sends email with the text as the given contentType and the default session

Throws:

MessagingException

sendMail

void sendMail(String to,
 String cc,
 String from,
 String subject,
 String text,
 String contentType,
 Session customSession)
       throws MessagingException

sends email with the content type and custom session

Throws:

MessagingException

getBlankMessage

Message getBlankMessage(Session customSession)
                 throws MessagingException

returns a new message to be filled in with the custom Session

Throws:

MessagingException

getEmailProperty

String getEmailProperty(String name)