tcEmailNotificationUtil (Oracle Fusion Middleware Java API Reference for Oracle Identity Manager)

Constructor Summary

Constructors
Constructor and Description
`tcEmailNotificationUtil()` Creates new tcEmailNotificationUtil
`tcEmailNotificationUtil(com.thortech.xl.dataaccess.tcDataProvider poDataProvider)` Creates a new tcEmailNotificationUtil object.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`void`	`constructEmail(java.lang.String psEmdName)` Gets the email definition and puts it in the internal variables
`void`	`constructEmail(java.lang.String psEmdKey, java.lang.String psReqKey)` Deprecated. Not recomended to use from 11gR1 onwards.
`void`	`constructEmail(java.lang.String psEmdKey, java.lang.String psReqKey, java.lang.String userKey)` Gets the email definition and Request key.
`void`	`constructEmail(java.lang.String psEmdKey, java.lang.String psReqKey, java.lang.String psSchKey, java.lang.String psObiKey)` Deprecated. Not recomended to use from 11gR1 onwards.
`void`	`constructEmail(java.lang.String psEmdKey, java.lang.String psReqKey, java.lang.String psSchKey, java.lang.String psObiKey, java.lang.String usrkey)` Constructs the Email.
`void`	`constructPasswordEmail(java.lang.String psEmdName, java.lang.String usrKey)` Gets the email definition and puts it in the internal variables
`void`	`constructProvisionEmail(java.lang.String psEmdKey, java.lang.String psSchKey)` Constructs the Provisioning Email.
`java.lang.String`	`getBody()` This method returns the body of the email.
`java.lang.String`	`getEmailType()` Returns the Email Type
`java.lang.String`	`getFromAddress()` Returns the From Address
`java.lang.String`	`getFromProvision(java.lang.String psEmdKey, java.lang.String psSchKey)` Returns the From Address for the email definition and task instance key passed
`java.lang.String`	`getFromRequest(java.lang.String psEmdKey, java.lang.String psReqKey)` Deprecated. Not recomended to use from 11gR1 onwards.
`java.lang.String`	`getSubject()` This method returns the subject of the email.
`void`	`sendEmail(java.lang.String psToAddress)` Sends to Email to the Address paased as a parameter
`void`	`sendEmail(java.lang.String psToAddress, java.lang.String psCCAddress)` Sends the Email This method takes two parameter Toaddress and CC adrress.
`void`	`sendEmail(java.util.Vector pvToAddress)` This is used to send the email created to several email boxes.
`static void`	`sendEmailNotification(com.thortech.xl.dataaccess.tcDataProvider db, java.lang.String toAddress, java.lang.String defaultFromAddress, java.lang.String emdName, java.lang.String reqKeyAsString)` Sends Email Notification
`void`	`setBody(java.lang.String value)` Sets the Body of the Email
`void`	`setEmailType(java.lang.String psEmailType)` Sets the Email Type
`void`	`setFromAddress(java.lang.String address)` Sets the From Address
`void`	`setSubject(java.lang.String value)` Sets the Subject of the Email

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - tcEmailNotificationUtil
```
public tcEmailNotificationUtil()
```
    Creates new tcEmailNotificationUtil
  - tcEmailNotificationUtil
```
public tcEmailNotificationUtil(com.thortech.xl.dataaccess.tcDataProvider poDataProvider)
```
    Creates a new tcEmailNotificationUtil object.
    
    Parameters:
    
    poDataProvider - DataBase Conenction
- Method Detail
  - setEmailType
```
public void setEmailType(java.lang.String psEmailType)
```
    Sets the Email Type
    
    Parameters:
    
    psEmailType - EmailType, value can be "P"(Provisioning), "R"(Request) or "G"(General)
  - getEmailType
```
public java.lang.String getEmailType()
```
    Returns the Email Type
    
    Returns:
    
    String EmailType
  - getFromAddress
```
public java.lang.String getFromAddress()
```
    Returns the From Address
    
    Returns:
    
    String FromAddress
  - setFromAddress
```
public void setFromAddress(java.lang.String address)
```
    Sets the From Address
    
    Parameters:
    
    address - FromAddress
  - setSubject
```
public void setSubject(java.lang.String value)
```
    Sets the Subject of the Email
    
    Parameters:
    
    subject - Subject
  - setBody
```
public void setBody(java.lang.String value)
```
    Sets the Body of the Email
    
    Parameters:
    
    EmailBody - EmailBody
  - constructEmail
```
public void constructEmail(java.lang.String psEmdName)
```
    Gets the email definition and puts it in the internal variables
    
    Parameters:
    
    psEmdName - Name of the Email Definition
  - constructEmail
```
public void constructEmail(java.lang.String psEmdKey,
                           java.lang.String psReqKey)
```
    Deprecated. Not recomended to use from 11gR1 onwards.
    
    Gets the email definition and Request key. Puts it on the internal variables.
    
    Parameters:
    
    psEmdKey - Email Definition Key
    
    psReqKey - Request Key
  - constructEmail
```
public void constructEmail(java.lang.String psEmdKey,
                           java.lang.String psReqKey,
                           java.lang.String userKey)
```
    Gets the email definition and Request key. Puts it on the internal variables.
    
    Parameters:
    
    psEmdKey - Email Definition Key
    
    psReqKey - Request Key
    
    userKey - User Key
  - constructEmail
```
public void constructEmail(java.lang.String psEmdKey,
                           java.lang.String psReqKey,
                           java.lang.String psSchKey,
                           java.lang.String psObiKey,
                           java.lang.String usrkey)
```
    Constructs the Email.
    
    Parameters:
    
    psEmdKey - Email Definition Key
    
    psReqKey - Request Key
    
    psSchKey - SCH Key
    
    psObiKey - OBI Key
    
    usrKey - User Key
  - constructEmail
```
public void constructEmail(java.lang.String psEmdKey,
                           java.lang.String psReqKey,
                           java.lang.String psSchKey,
                           java.lang.String psObiKey)
```
    Deprecated. Not recomended to use from 11gR1 onwards.
    
    Constructs the Email.
    
    Parameters:
    
    psEmdKey - Email Definition Key
    
    psReqKey - Request Key
    
    psSchKey - SCH Key
    
    psObiKey - OBI Key
  - constructProvisionEmail
```
public void constructProvisionEmail(java.lang.String psEmdKey,
                                    java.lang.String psSchKey)
```
    Constructs the Provisioning Email.
    
    Parameters:
    
    psEmdKey - Email Definition Key
    
    psSchKey - SCH Key, Refer to tcProvisioningOperationsIntf for SCH Key
  - getFromRequest
```
public java.lang.String getFromRequest(java.lang.String psEmdKey,
                                       java.lang.String psReqKey)
```
    Deprecated. Not recomended to use from 11gR1 onwards.
    
    Returns the From Address for the email definition and Request key passed
    
    Parameters:
    
    psEmdKey - Email Definition Key
    
    psReqKey - Request Key
    
    Returns:
    
    String From Address
  - getFromProvision
```
public java.lang.String getFromProvision(java.lang.String psEmdKey,
                                         java.lang.String psSchKey)
```
    Returns the From Address for the email definition and task instance key passed
    
    Parameters:
    
    psEmdKey - Email Definition Key
    
    psSchKey - SCH Key, Refer to tcProvisioningOperationsIntf for SCH Key
    
    Returns:
    
    String From Address
  - constructPasswordEmail
```
public void constructPasswordEmail(java.lang.String psEmdName,
                                   java.lang.String usrKey)
```
    Gets the email definition and puts it in the internal variables
    
    Parameters:
    
    psEmdName - Name of the Email Definition
  - sendEmail
```
public void sendEmail(java.lang.String psToAddress)
```
    Sends to Email to the Address paased as a parameter
    
    Parameters:
    
    psToAddress - TO Address
  - sendEmailNotification
```
public static void sendEmailNotification(com.thortech.xl.dataaccess.tcDataProvider db,
                                         java.lang.String toAddress,
                                         java.lang.String defaultFromAddress,
                                         java.lang.String emdName,
                                         java.lang.String reqKeyAsString)
```
    Sends Email Notification
    
    Parameters:
    
    db - DataBaseConnection Object
    
    toAddress - Address to whom the mail is to be sent
    
    defaultFromAddress - From Address to be used in sending the mail
    
    emdName - Name of the Email Definition which is to be used
    
    reqKeyAsString - Request Key
  - sendEmail
```
public void sendEmail(java.util.Vector pvToAddress)
```
    This is used to send the email created to several email boxes.
    
    Parameters:
    
    pvToAddress - [] - This is a list of the email addresses the email is to be sent to.
  - getBody
```
public java.lang.String getBody()
```
    This method returns the body of the email.
    
    Returns:
    
    Body of the email as a String
  - getSubject
```
public java.lang.String getSubject()
```
    This method returns the subject of the email.
    
    Returns:
    
    Subject of the email as a String
  - sendEmail
```
public void sendEmail(java.lang.String psToAddress,
                      java.lang.String psCCAddress)
```
    Sends the Email This method takes two parameter Toaddress and CC adrress. Note: CC address can be made to take multiple values.(May be added in future need)
    
    Parameters:
    
    psToAddress - To Address
    
    psCCAddress - CC Address

Class tcEmailNotificationUtil

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

tcEmailNotificationUtil

tcEmailNotificationUtil

Method Detail

setEmailType

getEmailType

getFromAddress

setFromAddress

setSubject

setBody

constructEmail

constructEmail

constructEmail

constructEmail

constructEmail

constructProvisionEmail

getFromRequest

getFromProvision

constructPasswordEmail

sendEmail

sendEmailNotification

sendEmail

getBody

getSubject

sendEmail