Jump to

• Request
• Response

GET A Create Form For This Mail Session Collection

get

/management/weblogic/{version}/edit/partitions/{name}/resourceGroups/{name}/mailSessionCreateForm

This resource returns a pre-populated mail session model that can be customized then posted (using the POST method) to the mailSessions collection resource to create a new mail session.

Request

Path Parameters

• name: string
  The name property of the instance in the collection.
• version: string
  The version of the WebLogic REST interface.

Query Parameters

• excludeFields(optional): string
  The 'excludeFields' query parameter is used to restrict which fields are returned in the response. It is a comma separated list of field names. If present, only fields whose name is not on the list will be returned. If not present, all fields are returned (unless the 'fields' query parameter is specified). Note: 'fields' must not be specified if 'excludeFields' is specified.
• excludeLinks(optional): string
  The 'excludeLinks' query parameter is used to restrict which links are returned in the response. It is a comma separated list of link relationship names. If present, only links whose relationship name is not on the list will be returned. If not present, all links are returned (unless the 'links' query parameter is specified). Note: 'links' must not be specified if 'excludeLinks' is specified.
• fields(optional): string
  The 'fields' query parameter is used to restrict which fields are returned in the response. It is a comma separated list of field names. If present, only fields with matching names are returned. If not present, all fields are returned (unless the 'excludeFields' query parameter is specified). Note: 'excludeFields' must not be specified if 'fields' is specified.
• links(optional): string
  The 'links' query parameter is used to restrict which links are returned in the response. It is a comma separated list of link relationship names. If present, only links with matching relationship names are returned. If not present, all links are returned (unless the 'excludeLinks' query parameter is specified). Note: 'excludeLinks' must not be specified if 'links' is specified.

Security

• Admin: basic
  Type: basic

  Description: A user in the Admin security role.
• Deployer: basic
  Type: basic

  Description: A user in the Deployer security role.
• Monitor: basic
  Type: basic

  Description: A user in the Monitor security role.
• Operator: basic
  Type: basic

  Description: A user in the Operator security role.

Back to Top

Response

Supported Media Types

• application/json

200 Response

Returns this mail session.

This method can return the following links:

• rel=create uri=/management/weblogic/{version}/edit/partitions/{name}/resourceGroups/{name}/mailSessions

  The collection resource for this create form resource.

Body ()

Root Schema : Mail Session

Type: object

Show Source

• deploymentOrder(optional): integer(int32)
  Minimum Value: 0

  Maximum Value: 2147483647

  Default Value: 1000

  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.

  Constraints

  • not visible for domain scoped mbeans
• dynamicallyCreated(optional): boolean
  Read Only: true

  Default Value: false

  Return whether the MBean was created dynamically or is persisted to config.xml

  Constraints

  • not visible for domain scoped mbeans
• id(optional): integer(int64)
  Read Only: true

  Return the unique id of this MBean instance

  Constraints

  • not visible for domain scoped mbeans
• JNDIName(optional): string

  The JNDI Name associated with this resource.

  Constraints

  • legal null
  • not visible for domain scoped mbeans
• name(optional): string
  Read Only: true

  jmsserverjmshat on

  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

  Constraints

  • legal null
• notes(optional): 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.

  Note: If you create or edit a note from the Administration Console, the Administration Console does not preserve carriage returns/line feeds.

• properties(optional): object Properties
  Title: Properties

  Additional Properties Allowed: additionalProperties

  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 namevalue pair. Separate multiple properties with a semicolon ().

  Constraints

  • not visible for domain scoped mbeans
• sessionPassword(optional): string(password)

  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.

  Constraints

  • not visible for domain scoped mbeans
• sessionUsername(optional): string

  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.

  Constraints

  • not visible for domain scoped mbeans
• tags(optional): array Items
  Title: Items

  Return all tags on this Configuration MBean

  Constraints

  • not visible for domain scoped mbeans
• targets(optional): array Target References
  Title: Target References

  Contains the array of target references.

  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.

  Constraints

  • not visible for domain scoped mbeans
• type(optional): string
  Read Only: true

  Returns the type of the MBean.

  Constraints

  • unharvestable

{
    "type":"object",
    "properties":{
        "JNDIName":{
            "x-weblogic-legalNull":true,
            "x-weblogic-notVisibleForDomainScopedMBeans":true,
            "type":"string",
            "description":"<p>The JNDI Name associated with this resource.</p><p><h5>Constraints</h5></p><ul><li>legal null</li><li>not visible for domain scoped mbeans</li></ul>"
        },
        "deploymentOrder":{
            "default":1000,
            "minimum":0,
            "maximum":2147483647,
            "x-weblogic-notVisibleForDomainScopedMBeans":true,
            "type":"integer",
            "format":"int32",
            "description":"<p>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.</p><p>For example, the server prioritizes and deploys all EJBs before it prioritizes and deploys startup classes.</p><p>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.</p><p><h5>Constraints</h5></p><ul><li>not visible for domain scoped mbeans</li></ul>"
        },
        "dynamicallyCreated":{
            "readOnly":true,
            "default":false,
            "x-weblogic-notVisibleForDomainScopedMBeans":true,
            "type":"boolean",
            "description":"<p>Return whether the MBean was created dynamically or is persisted to config.xml</p><p><h5>Constraints</h5></p><ul><li>not visible for domain scoped mbeans</li></ul>"
        },
        "id":{
            "readOnly":true,
            "x-weblogic-notVisibleForDomainScopedMBeans":true,
            "type":"integer",
            "format":"int64",
            "description":"<p>Return the unique id of this MBean instance</p><p><h5>Constraints</h5></p><ul><li>not visible for domain scoped mbeans</li></ul>"
        },
        "name":{
            "readOnly":true,
            "x-weblogic-legalNull":true,
            "type":"string",
            "description":"<p>jmsserverjmshat on </p><p>The user-specified name of this MBean instance.</p><p>This name is included as one of the key properties in the MBean's <code>javax.management.ObjectName</code></p><p><code>Name=<i>user-specified-name</i></code></p><p><h5>Constraints</h5></p><ul><li>legal null</li></ul>"
        },
        "notes":{
            "type":"string",
            "description":"<p>Optional information that you can include to describe this configuration.</p><p>WebLogic Server saves this note in the domain's configuration file (<code>config.xml</code>) as XML PCDATA. All left angle brackets (<) are converted to the XML entity <code>&lt;</code>. Carriage returns/line feeds are preserved.</p><p>Note: If you create or edit a note from the Administration Console, the Administration Console does not preserve carriage returns/line feeds.</p>"
        },
        "properties":{
            "x-weblogic-notVisibleForDomainScopedMBeans":true,
            "type":"object",
            "description":"<p>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.</p><p>Include only the properties defined by the JavaMail API Design Specification.</p><p>If you do not specify any properties, this mail session will use the JavaMail default property values.</p><p>Express each property as a <code><i>name</i><i>value</i></code> pair. Separate multiple properties with a semicolon (<code></code>).</p><p><h5>Constraints</h5></p><ul><li>not visible for domain scoped mbeans</li></ul>",
            "additionalProperties":{
                "type":"string"
            },
            "title":"Properties"
        },
        "sessionPassword":{
            "x-weblogic-notVisibleForDomainScopedMBeans":true,
            "type":"string",
            "format":"password",
            "description":"<p>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.</p><p>The value is stored in an encrypted form in the descriptor file and when displayed in an administration console.</p><p><h5>Constraints</h5></p><ul><li>not visible for domain scoped mbeans</li></ul>"
        },
        "sessionUsername":{
            "x-weblogic-notVisibleForDomainScopedMBeans":true,
            "type":"string",
            "description":"<p> Returns the username to be used to create an authenticated JavaMail Session, using a JavaMail <code>Authenticator</code> instance; if this is not set, it will be assumed that the Session is not to be authenticated. </p><p><h5>Constraints</h5></p><ul><li>not visible for domain scoped mbeans</li></ul>"
        },
        "tags":{
            "x-weblogic-notVisibleForDomainScopedMBeans":true,
            "title":"Items",
            "type":"array",
            "items":{
                "type":"string",
                "description":""
            },
            "description":"<p>Return all tags on this Configuration MBean</p><p><h5>Constraints</h5></p><ul><li>not visible for domain scoped mbeans</li></ul>"
        },
        "targets":{
            "x-weblogic-notVisibleForDomainScopedMBeans":true,
            "title":"Target References",
            "type":"array",
            "items":{
                "title":"Target Reference",
                "type":"object",
                "properties":{
                    "identity":{
                        "title":"Identity",
                        "type":"array",
                        "items":{
                            "type":"string",
                            "description":""
                        },
                        "description":"DOC TEAM TBD - describe an identity - it's a reference to another WLS REST resource."
                    }
                },
                "description":"Contains the target reference."
            },
            "description":"Contains the array of target references. <p>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.</p><p><h5>Constraints</h5></p><ul><li>not visible for domain scoped mbeans</li></ul>"
        },
        "type":{
            "readOnly":true,
            "x-weblogic-unharvestable":true,
            "type":"string",
            "description":"<p>Returns the type of the MBean.</p><p><h5>Constraints</h5></p><ul><li>unharvestable</li></ul>"
        }
    },
    "description":""
}

Nested Schema : Properties

Type: object

Title: Properties

Additional Properties Allowed

Show Source

• string

{
    "x-weblogic-notVisibleForDomainScopedMBeans":true,
    "type":"object",
    "description":"<p>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.</p><p>Include only the properties defined by the JavaMail API Design Specification.</p><p>If you do not specify any properties, this mail session will use the JavaMail default property values.</p><p>Express each property as a <code><i>name</i><i>value</i></code> pair. Separate multiple properties with a semicolon (<code></code>).</p><p><h5>Constraints</h5></p><ul><li>not visible for domain scoped mbeans</li></ul>",
    "additionalProperties":{
        "type":"string"
    },
    "title":"Properties"
}

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 namevalue pair. Separate multiple properties with a semicolon ().

Constraints

• not visible for domain scoped mbeans

Nested Schema : Items

Type: array

Title: Items

Return all tags on this Configuration MBean

Constraints

• not visible for domain scoped mbeans

Show Source

• Array of: string

{
    "x-weblogic-notVisibleForDomainScopedMBeans":true,
    "title":"Items",
    "type":"array",
    "items":{
        "type":"string",
        "description":""
    },
    "description":"<p>Return all tags on this Configuration MBean</p><p><h5>Constraints</h5></p><ul><li>not visible for domain scoped mbeans</li></ul>"
}

Nested Schema : Target References

Type: array

Title: Target References

Contains the array of target references.

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.

Constraints

• not visible for domain scoped mbeans

Show Source

• Array of: object Target Reference
  Title: Target Reference

  Contains the target reference.

{
    "x-weblogic-notVisibleForDomainScopedMBeans":true,
    "title":"Target References",
    "type":"array",
    "items":{
        "title":"Target Reference",
        "type":"object",
        "properties":{
            "identity":{
                "title":"Identity",
                "type":"array",
                "items":{
                    "type":"string",
                    "description":""
                },
                "description":"DOC TEAM TBD - describe an identity - it's a reference to another WLS REST resource."
            }
        },
        "description":"Contains the target reference."
    },
    "description":"Contains the array of target references. <p>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.</p><p><h5>Constraints</h5></p><ul><li>not visible for domain scoped mbeans</li></ul>"
}

Nested Schema : Target Reference

Type: object

Title: Target Reference

Contains the target reference.

Show Source

• identity(optional): array Identity
  Title: Identity

  DOC TEAM TBD - describe an identity - it's a reference to another WLS REST resource.

{
    "title":"Target Reference",
    "type":"object",
    "properties":{
        "identity":{
            "title":"Identity",
            "type":"array",
            "items":{
                "type":"string",
                "description":""
            },
            "description":"DOC TEAM TBD - describe an identity - it's a reference to another WLS REST resource."
        }
    },
    "description":"Contains the target reference."
}

Nested Schema : Identity

Type: array

Title: Identity

DOC TEAM TBD - describe an identity - it's a reference to another WLS REST resource.

Show Source

• Array of: string

{
    "title":"Identity",
    "type":"array",
    "items":{
        "type":"string",
        "description":""
    },
    "description":"DOC TEAM TBD - describe an identity - it's a reference to another WLS REST resource."
}

Back to Top