WLDFSMTPNotificationBean

Overview  |   Related MBeans  |   Attributes  |   Operations

Overview

Use this interface to define a SMTP action, which is sent when a diagnostic policy evaluates to true.

Note: As of WebLogic Server 12.2.1, the terms watch and notification are replaced by policy and action, respectively. However, the definition of these terms has not changed.

           
Since9.0.0.0
Security rolesThe following roles have read, write, and invoke permission for all non-encrypted attributes and operations in this MBean:
  • Deployer
Fully Qualified Interface NameIf you use the getMBeanInfo operation in MBeanTypeServiceMBean, supply the following value as this MBean's fully qualified interface name:
weblogic.diagnostics.descriptor.WLDFSMTPNotificationBean
Factory Methods
Additional Access Points In addition to accessing this MBean by invoking a factory method, you can also access this MBean from the following MBean attributes:
    Access Points Inherited from WLDFNotificationBean Because this MBean extends or implements WLDFNotificationBean, you can also access this MBean by retrieving WLDFNotificationBeans. The following attributes contain WLDFNotificationBeans and its subtypes:

      Attributes

      This section describes the following attributes:

      Body

      The body for the mail message. If the body is not specified, a body is created from the action information.

             
      Privileges Read/Write
      Typejava.lang.String

      Enabled

      Specifies whether this action is enabled.

             
      Privileges Read/Write
      Typeboolean
      Default Valuetrue

      Id

      Return the unique id of this bean instance.

             
      Privileges Read only
      Typelong
      Redeploy or Restart required Changes take effect after you redeploy the module or restart the server.

      MailSessionJNDIName

      The JNDI name of the mail session. This name must match the attribute in the corresponding MailSessionMBean.

             
      Privileges Read/Write
      Typejava.lang.String

      Name

      The name of the WebLogic Diagnostic Framework (WLDF) bean.

             
      Privileges Read only
      Typejava.lang.String

      Recipients

      The address of the recipient or recipients of the SMTP action mail. The address uses the syntax defined in RFC822. Typical address syntax is of the form user@host.domain or Personal Name. An address can include multiple recipients, separated by commas or spaces.

      For more information, refer to the javax.mail.internet.InternetAddress.parse method.

             
      Privileges Read/Write
      Typeclass java.lang.String[]

      Subject

      The subject for the mail message. If the subject is not specified, a subject is created from the action information.

             
      Privileges Read/Write
      Typejava.lang.String

      Timeout

      The length of time, in seconds, that an action has to complete execution. By default, the timeout period is 0, which disables the action timeout.

             
      Privileges Read/Write
      Typeint
      Default Value0
      Minimum value0

      Operations

      This section describes the following operations:

        addRecipient

        Adds a recipient to the list of e-mail addresses that will receive this action.

           
        Operation Name"addRecipient"
        ParametersObject [] {  recipient }

        where:

        • recipient is an object of type java.lang.String that specifies:

          recipient
        SignatureString [] { "java.lang.String" }
        Returns void

        removeRecipient

        Removes a recipient from the list of e-mail addresses that will receive this action.

           
        Operation Name"removeRecipient"
        ParametersObject [] {  recipient }

        where:

        • recipient is an object of type java.lang.String that specifies:

          recipient
        SignatureString [] { "java.lang.String" }
        Returns void