Facilitates using the JavaMail APIs, which provide applications and other Java EE modules with access to Internet Message Access Protocol (IMAP)- and Simple Mail Transfer Protocol (SMTP)-capable mail servers on your network or the Internet.
In the reference implementation of JavaMail, applications must
instantiate javax.mail.Session
objects, which
designate mail hosts, transport and store protocols, and a default
mail user for connecting to a mail server. In WebLogic Server, you
create a mail session, which configures a
javax.mail.Session
object and registers it in the
WebLogic Server JNDI tree. Applications access the mail session
through JNDI instead of instantiating their own javax.mail.Session
object.
Fully Qualified Interface Name | If you use the getMBeanInfo operation in MBeanTypeServiceMBean, supply the following value as this MBean's fully qualified interface name:weblogic.management.configuration.MailSessionMBean
|
||
Factory Methods | |||
Access Points Inherited from DeploymentMBean |
Because this MBean extends or implements DeploymentMBean, you can also access this MBean by retrieving DeploymentMBeans. The following attributes contain DeploymentMBeans and its subtypes:
|
This section describes attributes that provide access to other MBeans.
|
You must select a target on which an MBean will be deployed from this list of the targets in the current domain on which this item can be deployed. Targets must be either servers or clusters. The deployment will only occur once if deployments overlap.
Privileges | Read/Write |
Type | TargetMBean[] |
Relationship type: | Reference. |
This section describes the following attributes:
Private property that disables caching in proxies.
Privileges | Read only |
Type | boolean |
Redeploy or Restart required | Changes take effect after you redeploy the module or restart the server. |
A priority that the server uses to determine when it deploys an item. The priority is relative to other deployable items of the same type.
For example, the server prioritizes and deploys all EJBs before it prioritizes and deploys startup classes.
Items with the lowest Deployment Order value are deployed first. There is no guarantee on the order of deployments with equal Deployment Order values. There is no guarantee of ordering across clusters.
Privileges | Read/Write |
Type | int |
Default Value | 1000 |
Minimum value | 0 |
Maximum value | 2147483647 |
Return whether the MBean was created dynamically or is persisted to config.xml
Privileges | Read only |
Type | boolean |
Redeploy or Restart required | Changes take effect after you redeploy the module or restart the server. |
Return the unique id of this MBean instance
Privileges | Read only |
Type | long |
Redeploy or Restart required | Changes take effect after you redeploy the module or restart the server. |
The JNDI Name associated with this resource.
Privileges | Read/Write |
Type | java.lang.String |
Returns the MBean info for this MBean.
Deprecated.
Privileges | Read only |
Type | javax.management.MBeanInfo |
Redeploy or Restart required | Changes take effect after you redeploy the module or restart the server. |
The user-specified name of this MBean instance.
This name is included as one of the key properties in the
MBean's javax.management.ObjectName
:
Name=user-specified-name
Privileges | Read/Write |
Type | java.lang.String |
Optional information that you can include to describe this configuration.
WebLogic Server saves this note in the domain's configuration
file (config.xml
) as XML PCDATA. All left angle
brackets (<) are converted to the XML entity
<
. Carriage returns/line feeds are
preserved.
If you create or edit a note from the Administration Console, the Administration Console does not preserve carriage returns/line feeds.
Privileges | Read/Write |
Type | java.lang.String |
Returns the ObjectName under which this MBean is registered in the MBean server.
Deprecated.
Privileges | Read only |
Type | weblogic.management.WebLogicObjectName |
Redeploy or Restart required | Changes take effect after you redeploy the module or restart the server. |
Return the immediate parent for this MBean
Privileges | Read/Write |
Type |
The configuration options and user authentication data that this mail session uses to interact with a mail server. Each property that you specify overrides the default property value as defined by the JavaMail API Design Specification.
Include only the properties defined by the JavaMail API Design Specification.
If you do not specify any properties, this mail session will use the JavaMail default property values.
Express each property as a name=value
pair. Separate multiple properties with a semicolon
(;
).
Privileges | Read/Write |
Type | java.util.Properties |
Returns false if the MBean represented by this object has been unregistered.
Deprecated.
Privileges | Read only |
Type | boolean |
Redeploy or Restart required | Changes take effect after you redeploy the module or restart the server. |
The decrypted JavaMail Session password attribute, for use only temporarily in-memory; the value returned by this attribute should not be held in memory long term.
The value is stored in an encrypted form in the descriptor file and when displayed in an administration console.
Available Since | Release 12.1.3.0 |
Privileges | Read/Write |
Security roles | Read access is granted only to the following roles:
|
Type | java.lang.String |
Encrypted | true |
The encrypted JavaMail Session password as set with
setSessionPassword()
,
setSessionPasswordEncrypted(byte[] bytes)
.
Available Since | Release 12.1.3.0 |
Privileges | Read/Write |
Security roles | Read access is granted only to the following roles:
|
Type | byte[] |
Encrypted | true |
Returns the username to be used to create an authenticated
JavaMail Session, using a JavaMail Authenticator
instance; if this is not set, it will be assumed that the Session
is not to be authenticated.
Available Since | Release 12.1.3.0 |
Privileges | Read/Write |
Security roles | Read access is granted only to the following roles:
|
Type | java.lang.String |
Returns the type of the MBean.
Privileges | Read only |
Type | java.lang.String |
Redeploy or Restart required | Changes take effect after you redeploy the module or restart the server. |
This section describes the following operations:
You can add a target to specify additional servers on which the deployment can be deployed. The targets must be either clusters or servers.
Operation Name | "addTarget" |
Parameters | Object [] { target }
where:
|
Signature | String [] {
"weblogic.management.configuration.TargetMBean" } |
Returns |
boolean
|
Exceptions |
|
If the specified attribute has not been set explicitly, and if the attribute has a default value, this operation forces the MBean to persist the default value.
Unless you use this operation, the default value is not saved and is subject to change if you update to a newer release of WebLogic Server. Invoking this operation isolates this MBean from the effects of such changes.
To insure that you are freezing the default value, invoke the
restoreDefaultValue
operation before you invoke
this.
This operation has no effect if you invoke it on an attribute that does not provide a default value or on an attribute for which some other value has been set.
Deprecated.
Operation Name | "freezeCurrentValue" |
Parameters | Object [] { attributeName }
where:
|
Signature | String [] {
"java.lang.String" } |
Returns |
void
|
Exceptions |
|
return all properties' names whose value is inherited from template mbean. this is a convenient method to get inheritance info on multiple properties in one jmx call.
Operation Name | "getInheritedProperties" |
Parameters | Object [] { propertyNames }
where:
|
Signature | String [] {
"[Ljava.lang.String;" } |
Returns |
class |
Check if the value of a property is inherited from template mbean or not.
Operation Name | "isInherited" |
Parameters | Object [] { propertyName }
where:
|
Signature | String [] {
"java.lang.String" } |
Returns |
boolean
|
Returns true if the specified attribute has been set explicitly in this MBean instance.
Operation Name | "isSet" |
Parameters | Object [] { propertyName }
where:
|
Signature | String [] {
"java.lang.String" } |
Returns |
boolean
|
Removes the value of the addTarget attribute.
For more information, see:
Operation Name | "removeTarget" |
Parameters | Object [] { target }
where:
|
Signature | String [] {
"weblogic.management.configuration.TargetMBean" } |
Returns |
boolean
|
Exceptions |
|
If the specified attribute has a default value, this operation removes any value that has been set explicitly and causes the attribute to use the default value.
Default values are subject to change if you update to a newer
release of WebLogic Server. To prevent the value from changing if
you update to a newer release, invoke the
freezeCurrentValue
operation.
This operation has no effect if you invoke it on an attribute that does not provide a default value or on an attribute that is already using the default.
Deprecated.
Operation Name | "restoreDefaultValue" |
Parameters | Object [] { attributeName }
where:
|
Signature | String [] {
"java.lang.String" } |
Returns |
void
|
Exceptions |
|
Restore the given property to its default value.
Operation Name | "unSet" |
Parameters | Object [] { propertyName }
where:
|
Signature | String [] {
"java.lang.String" } |
Returns |
void
|