Management API Reference for mail-session

Mail session definition

Children (2)

custom
server
- imap
- pop3
- smtp

Provided Capabilities (1)

Name	Dynamic	Other provider points
org.wildfly.mail.session	true	none

Attributes (3)

debug - Enables Jakarta Mail debugging

Type	BOOLEAN
Default Value	false
Is the attribute nillable?	true
Does the attribute allow expression?	true
Where is the attribute stored?	configuration
Access Type	read-write
Is restarted required?	resource-services
Stability Level	default
Raw DMR model	`{ "type" : { "TYPE_MODEL_VALUE" : "BOOLEAN" }, "description" : "Enables Jakarta Mail debugging", "expressions-allowed" : true, "required" : false, "nillable" : true, "default" : false, "stability" : "default", "access-type" : "read-write", "storage" : "configuration", "restart-required" : "resource-services", "capability-reference" : null }`

from - From address that is used as default from, if not set when sending

Type	STRING
Is the attribute nillable?	true
Does the attribute allow expression?	true
Where is the attribute stored?	configuration
Access Type	read-write
Is restarted required?	resource-services
Stability Level	default
Raw DMR model	`{ "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "From address that is used as default from, if not set when sending", "expressions-allowed" : true, "required" : false, "nillable" : true, "min-length" : 1, "max-length" : 2147483647, "stability" : "default", "access-type" : "read-write", "storage" : "configuration", "restart-required" : "resource-services", "capability-reference" : null }`

jndi-name - JNDI name to where mail session should be bound

Type	STRING
Does the attribute allow expression?	true
Where is the attribute stored?	configuration
Access Type	read-write
Is restarted required?	resource-services
Stability Level	default
Raw DMR model	`{ "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "JNDI name to where mail session should be bound", "expressions-allowed" : true, "required" : true, "nillable" : false, "min-length" : 1, "max-length" : 2147483647, "stability" : "default", "access-type" : "read-write", "storage" : "configuration", "restart-required" : "resource-services", "capability-reference" : null }`

Operations (2)

add - Adds a mail session

Request Parameter	Type	Required	Expressions Allowed	Default value	Description
debug	BOOLEAN	false	true	false	Enables Jakarta Mail debugging
from	STRING	false	true		From address that is used as default from, if not set when sending
jndi-name	STRING	true	true		JNDI name to where mail session should be bound

Raw DMR model


{
    "operation-name" : "add",
    "description" : "Adds a mail session",
    "request-properties" : {
        "debug" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "BOOLEAN"
            },
            "description" : "Enables Jakarta Mail debugging",
            "expressions-allowed" : true,
            "required" : false,
            "nillable" : true,
            "default" : false,
            "stability" : "default"
        },
        "from" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "STRING"
            },
            "description" : "From address that is used as default from, if not set when sending",
            "expressions-allowed" : true,
            "required" : false,
            "nillable" : true,
            "min-length" : 1,
            "max-length" : 2147483647,
            "stability" : "default"
        },
        "jndi-name" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "STRING"
            },
            "description" : "JNDI name to where mail session should be bound",
            "expressions-allowed" : true,
            "required" : true,
            "nillable" : false,
            "min-length" : 1,
            "max-length" : 2147483647,
            "stability" : "default"
        }
    },
    "reply-properties" : {},
    "stability" : "default",
    "read-only" : false,
    "runtime-only" : false
}

remove - Removes a mail session

Raw DMR model


{
    "operation-name" : "remove",
    "description" : "Removes a mail session",
    "request-properties" : {},
    "reply-properties" : {},
    "stability" : "default",
    "read-only" : false,
    "restart-required" : "resource-services",
    "runtime-only" : false
}

Galleon Features

Galleon features are to be used when creating Galleon feature-packs.

subsystem.mail.mail-session

        
<feature spec="subsystem.mail.mail-session">
  <param name="mail-session" value="{resource name}"/>
  <param name="debug" value="{value}"/>
  <param name="from" value="{value}"/>
  <param name="jndi-name" value="{value}"/>
<feature/>