Jump to

• Request
• Response

Find SMTP Account Status Notification Handler by DN

get

/rest/v1/admin/{dn}

Returns an SMTP Account Status Notification Handler by DN

Request

Supported Media Types

• application/json

Path Parameters

• dn: string
  LDAP DN of the entry to be fetched.

Query Parameters

• attributes: array
  Collection Format: multi

  List of attributes to be fetched for the entry.

  • [0]: string

  {
      "name":"attributes",
      "in":"query",
      "description":"List of attributes to be fetched for the entry.",
      "type":"array",
      "collectionFormat":"multi",
      "items":{
          "type":"string"
      }
  }

• controls: array
  Collection Format: multi

  LDAP controls to be sent to server for search operation.

  • [0]: string

  {
      "name":"controls",
      "in":"query",
      "description":"LDAP controls to be sent to server for search operation.",
      "type":"array",
      "collectionFormat":"multi",
      "items":{
          "type":"string"
      }
  }

• filter: string
  Search filter for the LDAP search operation. Should follow LDAP search filter syntax.
• scope: string
  Scope for the LDAP search operation.

  Allowed Values: [ "base", "sub", "one" ]

Back to Top

Response

Supported Media Types

• application/json

200 Response

OK

Body ()

Root Schema : SMTP Account Status Notification Handler GetSuccessResponse

Type: object

Show Source

• msgType: string
  Default Value: urn:ietf:params:rest:schemas:oracle:oud:1.0:SearchResponse

  The REST message type
• searchResultEntries: array searchResultEntries
  Number of search result entries returned after the LDAP operation.
• totalResults: integer(int32)
  Specifies the number of entries created, and returned.

{
    "type":"object",
    "required":[
        "msgType",
        "totalResults",
        "searchResultEntries"
    ],
    "properties":{
        "msgType":{
            "description":"The REST message type",
            "default":"urn:ietf:params:rest:schemas:oracle:oud:1.0:SearchResponse",
            "type":"string"
        },
        "totalResults":{
            "type":"integer",
            "format":"int32",
            "description":"Specifies the number of entries created, and returned."
        },
        "searchResultEntries":{
            "type":"array",
            "description":"Number of search result entries returned after the LDAP operation.",
            "items":{
                "$ref":"#/definitions/SMTP Account Status Notification Handler SearchResultEntry"
            }
        }
    }
}

Nested Schema : searchResultEntries

Type: array

Number of search result entries returned after the LDAP operation.

Show Source

• Array of: object SMTP Account Status Notification Handler SearchResultEntry

{
    "type":"array",
    "description":"Number of search result entries returned after the LDAP operation.",
    "items":{
        "$ref":"#/definitions/SMTP Account Status Notification Handler SearchResultEntry"
    }
}

Nested Schema : SMTP Account Status Notification Handler SearchResultEntry

Type: object

Show Source

• attributes: object SMTP Account Status Notification Handler Properties
• dn: string
  LDAP DN of the entry to be created

{
    "type":"object",
    "required":[
        "dn",
        "attributes"
    ],
    "properties":{
        "dn":{
            "description":"LDAP DN of the entry to be created",
            "type":"string"
        },
        "attributes":{
            "$ref":"#/definitions/SMTP Account Status Notification Handler Properties"
        }
    }
}

Nested Schema : SMTP Account Status Notification Handler Properties

Type: object

Show Source

• cn(optional): string
  CN (common name) of the entry
• ds-cfg-email-address-attribute-type(optional): array ds-cfg-email-address-attribute-type
  Specifies which attribute in the user's entries may be used to obtain the email address when notifying the end user.
• ds-cfg-enabled: boolean
  Indicates whether the Account Status Notification Handler is enabled. Only enabled handlers are invoked whenever a related event occurs in the server.
• ds-cfg-java-class: string
  Default Value: org.opends.server.extensions.SMTPAccountStatusNotificationHandler

  Specifies the fully-qualified name of the Java class that provides the SMTP Account Status Notification Handler implementation.
• ds-cfg-message-subject: array ds-cfg-message-subject
  Specifies the subject that should be used for email messages generated by this account status notification handler.
• ds-cfg-message-template-file: array ds-cfg-message-template-file
  Specifies the path to the file containing the message template to generate the email notification messages.
• ds-cfg-recipient-address(optional): array ds-cfg-recipient-address
  Specifies an email address to which notification messages are sent, either instead of or in addition to the end user for whom the notification has been generated.
• ds-cfg-send-message-without-end-user-address: boolean
  Default Value: true

  Indicates whether an email notification message should be generated and sent to the set of notification recipients even if the user entry does not contain any values for any of the email address attributes (that is, in cases when it is not be possible to notify the end user).
• ds-cfg-sender-address: string
  Specifies the email address from which the message is sent. Note that this does not necessarily have to be a legitimate email address.
• objectclass: array objectclass
  Objectclass(es) which this entry belongs to.

{
    "type":"object",
    "required":[
        "objectclass",
        "ds-cfg-java-class",
        "ds-cfg-sender-address",
        "ds-cfg-message-template-file",
        "ds-cfg-enabled",
        "ds-cfg-send-message-without-end-user-address",
        "ds-cfg-message-subject"
    ],
    "properties":{
        "objectclass":{
            "type":"array",
            "description":"Objectclass(es) which this entry belongs to.",
            "items":{
                "type":"string"
            }
        },
        "cn":{
            "type":"string",
            "description":"CN (common name) of the entry"
        },
        "ds-cfg-java-class":{
            "description":"Specifies the fully-qualified name of the Java class that provides the SMTP Account Status Notification Handler implementation. ",
            "readOnly":false,
            "default":"org.opends.server.extensions.SMTPAccountStatusNotificationHandler",
            "type":"string"
        },
        "ds-cfg-sender-address":{
            "description":"Specifies the email address from which the message is sent. Note that this does not necessarily have to be a legitimate email address. ",
            "readOnly":false,
            "type":"string"
        },
        "ds-cfg-email-address-attribute-type":{
            "description":"Specifies which attribute in the user's entries may be used to obtain the email address when notifying the end user. ",
            "readOnly":false,
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "ds-cfg-recipient-address":{
            "description":"Specifies an email address to which notification messages are sent, either instead of or in addition to the end user for whom the notification has been generated. ",
            "readOnly":false,
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "ds-cfg-message-template-file":{
            "description":"Specifies the path to the file containing the message template to generate the email notification messages. ",
            "readOnly":false,
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "ds-cfg-enabled":{
            "description":"Indicates whether the Account Status Notification Handler is enabled. Only enabled handlers are invoked whenever a related event occurs in the server. ",
            "readOnly":false,
            "type":"boolean"
        },
        "ds-cfg-send-message-without-end-user-address":{
            "description":"Indicates whether an email notification message should be generated and sent to the set of notification recipients even if the user entry does not contain any values for any of the email address attributes (that is, in cases when it is not be possible to notify the end user). ",
            "readOnly":false,
            "default":true,
            "type":"boolean"
        },
        "ds-cfg-message-subject":{
            "description":"Specifies the subject that should be used for email messages generated by this account status notification handler. ",
            "readOnly":false,
            "type":"array",
            "items":{
                "type":"string"
            }
        }
    }
}

Nested Schema : ds-cfg-email-address-attribute-type

Type: array

Specifies which attribute in the user's entries may be used to obtain the email address when notifying the end user.

Show Source

• Array of: string

{
    "description":"Specifies which attribute in the user's entries may be used to obtain the email address when notifying the end user. ",
    "readOnly":false,
    "type":"array",
    "items":{
        "type":"string"
    }
}

Nested Schema : ds-cfg-message-subject

Type: array

Specifies the subject that should be used for email messages generated by this account status notification handler.

Show Source

• Array of: string

{
    "description":"Specifies the subject that should be used for email messages generated by this account status notification handler. ",
    "readOnly":false,
    "type":"array",
    "items":{
        "type":"string"
    }
}

Nested Schema : ds-cfg-message-template-file

Type: array

Specifies the path to the file containing the message template to generate the email notification messages.

Show Source

• Array of: string

{
    "description":"Specifies the path to the file containing the message template to generate the email notification messages. ",
    "readOnly":false,
    "type":"array",
    "items":{
        "type":"string"
    }
}

Nested Schema : ds-cfg-recipient-address

Type: array

Specifies an email address to which notification messages are sent, either instead of or in addition to the end user for whom the notification has been generated.

Show Source

• Array of: string

{
    "description":"Specifies an email address to which notification messages are sent, either instead of or in addition to the end user for whom the notification has been generated. ",
    "readOnly":false,
    "type":"array",
    "items":{
        "type":"string"
    }
}

Nested Schema : objectclass

Type: array

Objectclass(es) which this entry belongs to.

Show Source

• Array of: string

{
    "type":"array",
    "description":"Objectclass(es) which this entry belongs to.",
    "items":{
        "type":"string"
    }
}

406 Response

Not Acceptable

Body ()

Root Schema : ErrorResponse

Type: object

Show Source

• ldapErrorCode(optional): integer(int32)
  Specifies the LDAP error code returned for the operation.
• message: string
  Error message returned returned for the operation.
• msgType: string
  Default Value: urn:ietf:params:rest:schemas:oracle:oud:1.0:ErrorResponse

  The REST message type

{
    "type":"object",
    "required":[
        "msgType",
        "message"
    ],
    "properties":{
        "msgType":{
            "description":"The REST message type",
            "default":"urn:ietf:params:rest:schemas:oracle:oud:1.0:ErrorResponse",
            "type":"string"
        },
        "message":{
            "description":"Error message returned returned for the operation.",
            "type":"string"
        },
        "ldapErrorCode":{
            "type":"integer",
            "format":"int32",
            "description":"Specifies the LDAP error code returned for the operation."
        }
    }
}

Back to Top