EmailDialog

```
public class EmailDialog
```
EmailDialog Displays a dialog which allows users to send emails and maintain email settings and contacts

See Also:
[ Example]
Since:
14.0

Field Summary

Fields
Modifier and Type	Field and Description
`static BBjNumber`	`EMAIL_BCC_TYPE=2` Constant that represents a email BCC address type
`static BBjNumber`	`EMAIL_CC_TYPE=1` Constant that represents a email CC address type
`static BBjNumber`	`EMAIL_TO_TYPE=0` Constant that represents a email To address type
`BBjNumber`	`Retries!=0` *** Programmatically configurable properties * **

Constructor Summary
Constructors
Constructor and Description
EmailDialog()
Default Constructor Creates an empty EmailDialog object

Constructors
Constructor and Description
`EmailDialog()` Default Constructor Creates an empty EmailDialog object

Method Summary

Methods
Modifier and Type	Method and Description
`BBjNumber`	`addEmailAddress(BBjString p_emailAddress$, BBjNumber p_emailType)` addEmailAddress Adds an email address to the appropriate list
`BBjNumber`	`addEmailAddress(BBjString p_firstName$, BBjString p_lastName$, BBjString p_emailAddress$, BBjNumber p_emailType)` addEmailAddress Adds an email address to the appropriate list
`BBjNumber`	`addEmailAttachment(BBjString p_emailAttachment$)` addEmailAttachment Adds a file as an email attachment
`BBjNumber`	`addEmailContact(EmailContact p_emailContact!)` addEmailContact Adds an email contact to the contact list
`BBjNumber`	`addEmailContact(EmailContact p_emailContact!, BBjNumber p_emailType)` addEmailContact Adds an email contact to the appropriate list
`BBjNumber`	`addEmailContacts(BBjVector p_emailContacts!)` addEmailContacts Adds email contacts to the contact list
`BBjNumber`	`addEmailContacts(BBjVector p_emailContacts!, BBjNumber p_emailType)` addEmailContacts Adds email contacts to the appropriate list
`void`	`contactsDialogChange(BBjNumber p_newContact)` contactsDialogChange Brings up the contacts dialog
`void`	`doModal()` doModal Runs the email dialog
`BBjNumber`	`getCloseOnSend()` getCloseOnSend Returns whether the dialog should be closed on a send
`BBjNumber`	`getCreateContactsOnSend()` getCreateContactsOnSend Returns whether contacts should be created for new email addresses on a send
`BBjVector`	`getEmailAttachments()` getEmailAttachments Returns the file names of the email attachments
`HashMap`	`getEmailContacts()` getEmailContacts Returns the email contacts
`BBjString`	`getEmailFrom()` getEmailFrom Returns the email from address
`BBjString`	`getEmailMessage()` getEmailMessage Returns the email message
`BBjString`	`getEmailServerHost()` getEmailServerHost Returns the email server host name
`BBjString`	`getEmailServerPassword()` getEmailServerPassword Returns the email server password
`BBjNumber`	`getEmailServerPort()` getEmailServerPort Returns the email server port
`BBjNumber`	`getEmailServerSSL()` getEmailServerSSL Returns the email server SSL
`BBjString`	`getEmailServerUserName()` getEmailServerUserName Returns the email server user name
`BBjString`	`getEmailSubject()` getEmailSubject Returns the email subject
`BBjNumber`	`getHeight()` getHeight Returns the height of the dialog
`BBjString`	`getTitle()` getTitle Returns the dialog title
`BBjNumber`	`getWidth()` getWidth Returns the width of the dialog
`BBjNumber`	`getX()` getX Returns the X location of the email dialog
`BBjNumber`	`getY()` getY Returns the Y location of the email dialog
`void`	`loadEmailContacts()` loadEmailContacts Loads contacts from the HashMap into the contacts grid
`void`	`loadEmailContacts(BBjString p_emailAddress$)` loadEmailContacts Loads email contacts from the HashMap into the contacts grid
`void`	`OnAttachmentDialogApprove(BBjFileChooserApproveEvent p_event!)` OnAttachmentDialogApprove Callback when a file is choosen in the attachment dialog
`void`	`OnAttachmentDialogClose(BBjSysGuiEvent p_event!)` OnAttachmentDialogClose Callback when the attachment dialog should be closed
`void`	`OnAttachmentRemove(BBjToolButtonPushEvent p_event!)` OnAttachmentRemove Callback for when a remove attachment tool button is pushed
`void`	`OnContactChangeDialogClose(BBjSysGuiEvent p_event!)` OnContactChangeDialogClose Callback for when the contact change dialog is closed
`void`	`OnContactChangeEmailEdit(BBjEditModifyEvent p_event!)` OnContactChangeEmailEdit Callback for when the contact change email is edited
`void`	`OnContactChangeFirstNameEdit(BBjEditModifyEvent p_event!)` OnContactChangeFirstNameEdit Callback for when the contact change first name is edited
`void`	`OnContactChangeLastNameEdit(BBjEditModifyEvent p_event!)` OnContactChangeLastNameEdit Callback for when the contact change last name is edited
`void`	`OnContactChangeSave(BBjButtonPushEvent p_event!)` OnContactChangeSave Callback for when the contact change save button is pressed
`void`	`OnContactDialogEdit(BBjButtonPushEvent p_event!)` OnContactDialogEdit Callback when the contact edit button is pressed
`void`	`OnContactDialogNew(BBjButtonPushEvent p_event!)` OnContactDialogEdit Callback when the contact new button is pressed
`void`	`OnContactsDialogClose(BBjSysGuiEvent p_event!)` OnContactsDialogClose Callback to close the Contacts dialog
`void`	`OnContactsDialogRemove(BBjButtonPushEvent p_event!)` OnContactsDialogRemove Callback for when the Contacts remove button is pressed
`void`	`OnContactsDialogSelect(BBjButtonPushEvent p_event!)` OnContactsDialogSelect Callback for when the contacts select button is preseed
`void`	`OnContactsGridDoubleClick(BBjGridDoubleClickEvent p_event!)` OnContactsGridDoubleClick Callback when the user double clicks on the contacts grid
`void`	`OnEmailAddressEdit(BBjEditModifyEvent p_event!)` OnEmailAddressEdit Callback for when an email address text is changed
`void`	`OnEmailAddressLostFocus(BBjLostFocusEvent p_event!)` OnEmailAddressLostFocus Callback for when an email address loses focus
`void`	`OnEmailAddressRemove(BBjToolButtonPushEvent p_event!)` OnEmailAddressRemove Callback for when the email dialog remove email address button is pushed
`void`	`OnEmailAddressSelect(BBjListDoubleClickEvent p_event!)` OnEmailAddressSelect Callback for when an email address is selected from the address list box
`void`	`OnEmailBCCAddressKeypress(BBjEditKeypressEvent p_event!)` OnEmailBCCAddressKeypress Callback for when a key is pressed in the email bcc edit box
`void`	`OnEmailCCAddressKeypress(BBjEditKeypressEvent p_event!)` OnEmailCCAddressKeypress Callback for when a key is pressed in the email cc edit box
`void`	`OnEmailDialogAttachmentClient(BBjSysGuiEvent p_event!)` OnEmailDialogAttachmentClient Callback to add a client file as an attachment to the email
`void`	`OnEmailDialogAttachmentServer(BBjSysGuiEvent p_event!)` OnEmailDialogAttachmentServer Callback to add a server file as an attachment to the email
`void`	`OnEmailDialogBCCAdd(BBjPopupSelectEvent p_event!)` OnEmailDialogBCCAdd Callback for when the email dialog BCC add menu item is selected
`void`	`OnEmailDialogBCCContacts(BBjButtonPushEvent p_event!)` OnEmailDialogBCContacts Callback to bring up the contacts dialog for the BCC addresees
`void`	`OnEmailDialogBCCRemove(BBjPopupSelectEvent p_event!)` OnEmailDialogBCCRemove Callback for when the email dialog BCC remove menu item is selected
`void`	`OnEmailDialogCCAdd(BBjPopupSelectEvent p_event!)` OnEmailDialogCCAdd Callback for when the email dialog CC add menu item is selected
`void`	`OnEmailDialogCCContacts(BBjButtonPushEvent p_event!)` OnEmailDialogCCContacts Callback to bring up the contacts dialog for the CC addresees
`void`	`OnEmailDialogCCRemove(BBjPopupSelectEvent p_event!)` OnEmailDialogCCRemove Callback for when the email dialog CC remove menu item is selected
`void`	`OnEmailDialogClose(BBjSysGuiEvent p_event!)` OnEmailDialogClose Callback for when the email dialog is to be closed
`void`	`OnEmailDialogSend(BBjButtonPushEvent p_event!)` OnEmailDialogSend Callback for when the email dialog send button is pressed
`void`	`OnEmailDialogSettings(BBjButtonPushEvent p_event!)` OnEmailDialogSettings Callback for when the email dialog settings button is pressed
`void`	`OnEmailDialogToContacts(BBjButtonPushEvent p_event!)` OnEmailDialogToContacts Callback to bring up the contacts dialog for the To addresees
`void`	`OnEmailSettingsDialogClose(BBjSysGuiEvent p_event!)` OnEmailSettingsDialogClose Callback for when the email settings dialog is to be closed
`void`	`OnEmailSettingsDialogSave(BBjButtonPushEvent p_event!)` Callback for when the email settings dialog save button is pressed
`void`	`OnEmailToAddressKeypress(BBjEditKeypressEvent p_event!)` OnEmailToAddressKeypress Callback for when a key is pressed in the email to edit box
`void`	`removeAllEmailContacts()` removeAllEmailContacts Removes all email contacts from the contact list
`BBjNumber`	`removeEmailAddress(BBjString p_emailAddress$, BBjNumber p_emailType)` removeEmailAddress Removes an email address from the appropriate list
`BBjNumber`	`removeEmailAddresses(BBjVector p_emailAddresses!, BBjNumber p_emailType)` removeEmailAddresses Removes email addresses from the appropriate list
`BBjNumber`	`removeEmailAttachment(BBjString p_emailAttachment$)` removeEmailAttachment Removes an email attachment
`BBjNumber`	`removeEmailContact(EmailContact p_emailContact!)` removeEmailContact Removes an email contact from the contact list
`BBjNumber`	`removeEmailContact(EmailContact p_emailContact!, BBjNumber p_emailType)` removeEmailContact Removes an email contact from the appropriate list
`BBjNumber`	`removeEmailContacts(BBjVector p_emailContacts!)` removeEmailContacts Removes email contacts from the contact list
`BBjNumber`	`removeEmailContacts(BBjVector p_emailContacts!, BBjNumber p_emailType)` removeEmailContacts Removes email contacts from the appropriate list
`void`	`saveEmailContacts()` saveEmailContacts Saves the email contacts to the user properties
`void`	`setCloseOnSend(BBjNumber p_closeOnSend)` setCloseOnSend Sets whether dialog should be closed on a send
`void`	`setCreateContactsOnSend(BBjNumber p_createContactsOnSend)` setCreateContactsOnSend Sets whether contacts should be created for new email addresses on a send
`void`	`setEmailFrom(BBjString p_emailFrom$)` setEmailFrom Sets the email from address
`void`	`setEmailMessage(BBjString p_emailMessage$)` setEmailMessage Sets the email message
`void`	`setEmailServerHost(BBjString p_emailServerHost$)` setEmailServerHost Sets the email server host
`void`	`setEmailServerPassword(BBjString p_emailServerPassword$)` setEmailServerPassword Sets password that will be used to authenticate to the email server
`void`	`setEmailServerPort(BBjNumber p_emailServerPort)` setEmailServerPort Sets the email server port
`void`	`setEmailServerSSL(BBjNumber p_emailServerSSL)` setEmailServerSSL Sets the email server ssl protocol on or off
`void`	`setEmailServerUserName(BBjString p_emailServerUserName$)` setEmailServerUserName Sets user name that will be used to authenticate to the email server
`void`	`setEmailSubject(BBjString p_emailSubject$)` setEmailSubject Sets the email subject
`void`	`setLocation(BBjNumber p_x, BBjNumber p_y)` setLocation Sets the X, Y location of the dialog
`void`	`setTitle(BBjString p_title$)` setTitle Sets the title of the dialog

Field Detail
- EMAIL_BCC_TYPE=2
```
public static BBjNumber EMAIL_BCC_TYPE=2
```
  Constant that represents a email BCC address type
- EMAIL_CC_TYPE=1
```
public static BBjNumber EMAIL_CC_TYPE=1
```
  Constant that represents a email CC address type
- EMAIL_TO_TYPE=0
```
public static BBjNumber EMAIL_TO_TYPE=0
```
  Constant that represents a email To address type
- Retries!=0
```
public BBjNumber Retries!=0
```
  *** Programmatically configurable properties * **

Constructor Detail
- EmailDialog
```
public EmailDialog()
```
  Default Constructor Creates an empty EmailDialog object

- Method Detail
  - addEmailAddress
```
public BBjNumber addEmailAddress(BBjString p_emailAddress$, BBjNumber p_emailType)
```
    addEmailAddress Adds an email address to the appropriate list
    
    Parameters:
    p_emailAddress$ Email address
    p_emailType Email type (To, CC, BCC)
    Returns:
    Returns TRUE (1) if the email address was added or FALSE (0) otherwise
  - addEmailAddress
```
public BBjNumber addEmailAddress(BBjString p_firstName$, BBjString p_lastName$, BBjString p_emailAddress$, BBjNumber p_emailType)
```
    addEmailAddress Adds an email address to the appropriate list
    
    Parameters:
    p_firstName$ First name
    p_LastName$ Last name
    p_emailAddress$ Email address
    p_emailType Email type (To, CC, BCC)
    Returns:
    Returns TRUE (1) if the email address was added or FALSE (0) otherwise
  - addEmailAttachment
```
public BBjNumber addEmailAttachment(BBjString p_emailAttachment$)
```
    addEmailAttachment Adds a file as an email attachment
    
    Parameters:
    p_emailAttachment$ Location of file to add as an email attachment The attachment will only be added if the associated file can be opened
    Returns:
    Returns TRUE (1) if the email attachment was added or FALSE (0) otherwise
  - addEmailContact
```
public BBjNumber addEmailContact(EmailContact p_emailContact!)
```
    addEmailContact Adds an email contact to the contact list
    
    Parameters:
    p_emailContact! EmailContact object to add to the contact list
    Returns:
    Returns TRUE (1) if the email contact was added or FALSE (0) otherwise
  - addEmailContact
```
public BBjNumber addEmailContact(EmailContact p_emailContact!, BBjNumber p_emailType)
```
    addEmailContact Adds an email contact to the appropriate list
    
    Parameters:
    p_emailContact! Email contact object to add
    p_emailType Email type (To, CC, BCC)
    Returns:
    Returns TRUE (1) if the email contacts was added or FALSE (0) otherwise
  - addEmailContacts
```
public BBjNumber addEmailContacts(BBjVector p_emailContacts!)
```
    addEmailContacts Adds email contacts to the contact list
    
    Parameters:
    p_emailContacts! Vector that contains the EmailContact objects to add
    Returns:
    Returns TRUE (1) if all the email contacts were added or FALSE (0) otherwise
  - addEmailContacts
```
public BBjNumber addEmailContacts(BBjVector p_emailContacts!, BBjNumber p_emailType)
```
    addEmailContacts Adds email contacts to the appropriate list
    
    Parameters:
    p_emailContacts! Vector that contains the email contact objects to add
    p_emailType Email type (To, CC, BCC)
    Returns:
    Returns TRUE (1) if all the email contacts were added or FALSE (0) otherwise
  - contactsDialogChange
```
public void contactsDialogChange(BBjNumber p_newContact)
```
    contactsDialogChange Brings up the contacts dialog
    
    Parameters:
    p_newContact Specify 1 for a new contact, otherwise 0
  - doModal
```
public void doModal()
```
    doModal Runs the email dialog
  - getCloseOnSend
```
public BBjNumber getCloseOnSend()
```
    getCloseOnSend Returns whether the dialog should be closed on a send
    
    Returns:
    Returns TRUE (1) when the dialog should be close on a send, otherwise FALSE (0) is returned
  - getCreateContactsOnSend
```
public BBjNumber getCreateContactsOnSend()
```
    getCreateContactsOnSend Returns whether contacts should be created for new email addresses on a send
    
    Returns:
    Returns TRUE (1) when contacts should be create created for new email addresses on a send, otherwise FALSE (0) is returned
  - getEmailAttachments
```
public BBjVector getEmailAttachments()
```
    getEmailAttachments Returns the file names of the email attachments
    
    Returns:
    BBjVector containing the attachment file names
  - getEmailContacts
```
public HashMap getEmailContacts()
```
    getEmailContacts Returns the email contacts
    
    Returns:
    HashMap containing EmailContacts
  - getEmailFrom
```
public BBjString getEmailFrom()
```
    getEmailFrom Returns the email from address
    
    Returns:
    Email from address
  - getEmailMessage
```
public BBjString getEmailMessage()
```
    getEmailMessage Returns the email message
    
    Returns:
    Email message
  - getEmailServerHost
```
public BBjString getEmailServerHost()
```
    getEmailServerHost Returns the email server host name
    
    Returns:
    Email server host name
  - getEmailServerPassword
```
public BBjString getEmailServerPassword()
```
    getEmailServerPassword Returns the email server password
    
    Returns:
    Email server password
  - getEmailServerPort
```
public BBjNumber getEmailServerPort()
```
    getEmailServerPort Returns the email server port
    
    Returns:
    Email server port
  - getEmailServerSSL
```
public BBjNumber getEmailServerSSL()
```
    getEmailServerSSL Returns the email server SSL
    
    Returns:
    Returns 1 if the email server is using SSL, otherwise 0 is returned
  - getEmailServerUserName
```
public BBjString getEmailServerUserName()
```
    getEmailServerUserName Returns the email server user name
    
    Returns:
    Email server user name
  - getEmailSubject
```
public BBjString getEmailSubject()
```
    getEmailSubject Returns the email subject
    
    Returns:
    Email subject
  - getHeight
```
public BBjNumber getHeight()
```
    getHeight Returns the height of the dialog
    
    Returns:
    The height of the dialog
  - getTitle
```
public BBjString getTitle()
```
    getTitle Returns the dialog title
    
    Returns:
    Dialog title
  - getWidth
```
public BBjNumber getWidth()
```
    getWidth Returns the width of the dialog
    
    Returns:
    The width of the dialog
  - getX
```
public BBjNumber getX()
```
    getX Returns the X location of the email dialog
    
    Returns:
    X location of the email dialog
  - getY
```
public BBjNumber getY()
```
    getY Returns the Y location of the email dialog
    
    Returns:
    Y location of the email dialog
  - loadEmailContacts
```
public void loadEmailContacts()
```
    loadEmailContacts Loads contacts from the HashMap into the contacts grid
  - loadEmailContacts
```
public void loadEmailContacts(BBjString p_emailAddress$)
```
    loadEmailContacts Loads email contacts from the HashMap into the contacts grid
    
    Parameters:
    p_emailAddress$ Email address to be selected after the grid is loaded
  - OnAttachmentDialogApprove
```
public void OnAttachmentDialogApprove(BBjFileChooserApproveEvent p_event!)
```
    OnAttachmentDialogApprove Callback when a file is choosen in the attachment dialog
    
    Parameters:
    p_event! BBjFileChooserApproveEvent object
  - OnAttachmentDialogClose
```
public void OnAttachmentDialogClose(BBjSysGuiEvent p_event!)
```
    OnAttachmentDialogClose Callback when the attachment dialog should be closed
    
    Parameters:
    p_event! BBjSysGuiEvent object
  - OnAttachmentRemove
```
public void OnAttachmentRemove(BBjToolButtonPushEvent p_event!)
```
    OnAttachmentRemove Callback for when a remove attachment tool button is pushed
    
    Parameters:
    p_event! BBjToolButtonPushEvent object
  - OnContactChangeDialogClose
```
public void OnContactChangeDialogClose(BBjSysGuiEvent p_event!)
```
    OnContactChangeDialogClose Callback for when the contact change dialog is closed
    
    Parameters:
    p_event! BBjSysGuiEvent object
  - OnContactChangeEmailEdit
```
public void OnContactChangeEmailEdit(BBjEditModifyEvent p_event!)
```
    OnContactChangeEmailEdit Callback for when the contact change email is edited
    
    Parameters:
    p_event! BBjEditModifyEvent object
  - OnContactChangeFirstNameEdit
```
public void OnContactChangeFirstNameEdit(BBjEditModifyEvent p_event!)
```
    OnContactChangeFirstNameEdit Callback for when the contact change first name is edited
    
    Parameters:
    p_event! BBjEditModifyEvent object
  - OnContactChangeLastNameEdit
```
public void OnContactChangeLastNameEdit(BBjEditModifyEvent p_event!)
```
    OnContactChangeLastNameEdit Callback for when the contact change last name is edited
    
    Parameters:
    p_event! BBjEditModifyEvent object
  - OnContactChangeSave
```
public void OnContactChangeSave(BBjButtonPushEvent p_event!)
```
    OnContactChangeSave Callback for when the contact change save button is pressed
    
    Parameters:
    p_event! BBjButtonPushEvent object
  - OnContactDialogEdit
```
public void OnContactDialogEdit(BBjButtonPushEvent p_event!)
```
    OnContactDialogEdit Callback when the contact edit button is pressed
    
    Parameters:
    p_event! BBjButtonPushEvent object
  - OnContactDialogNew
```
public void OnContactDialogNew(BBjButtonPushEvent p_event!)
```
    OnContactDialogEdit Callback when the contact new button is pressed
    
    Parameters:
    p_event! BBjButtonPushEvent object
  - OnContactsDialogClose
```
public void OnContactsDialogClose(BBjSysGuiEvent p_event!)
```
    OnContactsDialogClose Callback to close the Contacts dialog
    
    Parameters:
    p_event! BBjSysGuiEvent object
  - OnContactsDialogRemove
```
public void OnContactsDialogRemove(BBjButtonPushEvent p_event!)
```
    OnContactsDialogRemove Callback for when the Contacts remove button is pressed
    
    Parameters:
    p_event! BBjButtonPushEvent object
  - OnContactsDialogSelect
```
public void OnContactsDialogSelect(BBjButtonPushEvent p_event!)
```
    OnContactsDialogSelect Callback for when the contacts select button is preseed
    
    Parameters:
    p_event! BBjButtonPushEvent object
  - OnContactsGridDoubleClick
```
public void OnContactsGridDoubleClick(BBjGridDoubleClickEvent p_event!)
```
    OnContactsGridDoubleClick Callback when the user double clicks on the contacts grid
    
    Parameters:
    p_event! BBjGridDoubleClickEvent object
  - OnEmailAddressEdit
```
public void OnEmailAddressEdit(BBjEditModifyEvent p_event!)
```
    OnEmailAddressEdit Callback for when an email address text is changed
    
    Parameters:
    p_event! BBjEditModifyEvent object
  - OnEmailAddressLostFocus
```
public void OnEmailAddressLostFocus(BBjLostFocusEvent p_event!)
```
    OnEmailAddressLostFocus Callback for when an email address loses focus
    
    Parameters:
    p_event! BBjLostFocusEvent object
  - OnEmailAddressRemove
```
public void OnEmailAddressRemove(BBjToolButtonPushEvent p_event!)
```
    OnEmailAddressRemove Callback for when the email dialog remove email address button is pushed
    
    Parameters:
    p_event! BBjToolButtonPushEvent object
  - OnEmailAddressSelect
```
public void OnEmailAddressSelect(BBjListDoubleClickEvent p_event!)
```
    OnEmailAddressSelect Callback for when an email address is selected from the address list box
    
    Parameters:
    p_event! BBjListDoubleClickEvent object
  - OnEmailBCCAddressKeypress
```
public void OnEmailBCCAddressKeypress(BBjEditKeypressEvent p_event!)
```
    OnEmailBCCAddressKeypress Callback for when a key is pressed in the email bcc edit box
    
    Parameters:
    p_event! BBjEditKeypressEvent object
  - OnEmailCCAddressKeypress
```
public void OnEmailCCAddressKeypress(BBjEditKeypressEvent p_event!)
```
    OnEmailCCAddressKeypress Callback for when a key is pressed in the email cc edit box
    
    Parameters:
    p_event! BBjEditKeypressEvent object
  - OnEmailDialogAttachmentClient
```
public void OnEmailDialogAttachmentClient(BBjSysGuiEvent p_event!)
```
    OnEmailDialogAttachmentClient Callback to add a client file as an attachment to the email
    
    Parameters:
    p_event! BBjSysGuiEvent object
  - OnEmailDialogAttachmentServer
```
public void OnEmailDialogAttachmentServer(BBjSysGuiEvent p_event!)
```
    OnEmailDialogAttachmentServer Callback to add a server file as an attachment to the email
    
    Parameters:
    p_event! BBjSysGuiEvent object
  - OnEmailDialogBCCAdd
```
public void OnEmailDialogBCCAdd(BBjPopupSelectEvent p_event!)
```
    OnEmailDialogBCCAdd Callback for when the email dialog BCC add menu item is selected
    
    Parameters:
    p_event! BBjPopupSelectEvent object
  - OnEmailDialogBCCContacts
```
public void OnEmailDialogBCCContacts(BBjButtonPushEvent p_event!)
```
    OnEmailDialogBCContacts Callback to bring up the contacts dialog for the BCC addresees
    
    Parameters:
    p_event! BBjButtonPushEvent object
  - OnEmailDialogBCCRemove
```
public void OnEmailDialogBCCRemove(BBjPopupSelectEvent p_event!)
```
    OnEmailDialogBCCRemove Callback for when the email dialog BCC remove menu item is selected
    
    Parameters:
    p_event! BBjPopupSelectEvent object
  - OnEmailDialogCCAdd
```
public void OnEmailDialogCCAdd(BBjPopupSelectEvent p_event!)
```
    OnEmailDialogCCAdd Callback for when the email dialog CC add menu item is selected
    
    Parameters:
    p_event! BBjPopupSelectEvent object
  - OnEmailDialogCCContacts
```
public void OnEmailDialogCCContacts(BBjButtonPushEvent p_event!)
```
    OnEmailDialogCCContacts Callback to bring up the contacts dialog for the CC addresees
    
    Parameters:
    p_event! BBjButtonPushEvent object
  - OnEmailDialogCCRemove
```
public void OnEmailDialogCCRemove(BBjPopupSelectEvent p_event!)
```
    OnEmailDialogCCRemove Callback for when the email dialog CC remove menu item is selected
    
    Parameters:
    p_event! BBjPopupSelectEvent object
  - OnEmailDialogClose
```
public void OnEmailDialogClose(BBjSysGuiEvent p_event!)
```
    OnEmailDialogClose Callback for when the email dialog is to be closed
    
    Parameters:
    p_event! BBjSysGuiEvent object
  - OnEmailDialogSend
```
public void OnEmailDialogSend(BBjButtonPushEvent p_event!)
```
    OnEmailDialogSend Callback for when the email dialog send button is pressed
    
    Parameters:
    p_event! BBjButtonPushEvent object
  - OnEmailDialogSettings
```
public void OnEmailDialogSettings(BBjButtonPushEvent p_event!)
```
    OnEmailDialogSettings Callback for when the email dialog settings button is pressed
    
    Parameters:
    p_event! BBjButtonPushEvent object
  - OnEmailDialogToContacts
```
public void OnEmailDialogToContacts(BBjButtonPushEvent p_event!)
```
    OnEmailDialogToContacts Callback to bring up the contacts dialog for the To addresees
    
    Parameters:
    p_event! BBjButtonPushEvent object
  - OnEmailSettingsDialogClose
```
public void OnEmailSettingsDialogClose(BBjSysGuiEvent p_event!)
```
    OnEmailSettingsDialogClose Callback for when the email settings dialog is to be closed
    
    Parameters:
    p_event! BBjSysGuiEvent object
  - OnEmailSettingsDialogSave
```
public void OnEmailSettingsDialogSave(BBjButtonPushEvent p_event!)
```
    Callback for when the email settings dialog save button is pressed
    
    Parameters:
    p_event! BBjButtonPushEvent object
  - OnEmailToAddressKeypress
```
public void OnEmailToAddressKeypress(BBjEditKeypressEvent p_event!)
```
    OnEmailToAddressKeypress Callback for when a key is pressed in the email to edit box
    
    Parameters:
    p_event! BBjEditKeypressEvent object
  - removeAllEmailContacts
```
public void removeAllEmailContacts()
```
    removeAllEmailContacts Removes all email contacts from the contact list
  - removeEmailAddress
```
public BBjNumber removeEmailAddress(BBjString p_emailAddress$, BBjNumber p_emailType)
```
    removeEmailAddress Removes an email address from the appropriate list
    
    Parameters:
    p_emailAddress$ Email address to remove
    p_emailType Email type (To, CC, BCC)
    Returns:
    Returns TRUE (1) if the email address was removed or FALSE (0) otherwise
  - removeEmailAddresses
```
public BBjNumber removeEmailAddresses(BBjVector p_emailAddresses!, BBjNumber p_emailType)
```
    removeEmailAddresses Removes email addresses from the appropriate list
    
    Parameters:
    p_emailAddresses Vector that contains the email addresses to remove
    p_emailType Email type (To, CC, BCC)
    Returns:
    Returns TRUE (1) if all the email addresses were removed or FALSE (0) otherwise
  - removeEmailAttachment
```
public BBjNumber removeEmailAttachment(BBjString p_emailAttachment$)
```
    removeEmailAttachment Removes an email attachment
    
    Parameters:
    p_emailAttachment$ Path of file to remove from being an email attachment
    Returns:
    Returns TRUE (1) if the email attachment was removed or FALSE (0) otherwise
  - removeEmailContact
```
public BBjNumber removeEmailContact(EmailContact p_emailContact!)
```
    removeEmailContact Removes an email contact from the contact list
    
    Parameters:
    p_emailContact! EmailContact object to remove from the contact list
    Returns:
    Returns TRUE (1) if the email contact was removed or FALSE (0) otherwise
  - removeEmailContact
```
public BBjNumber removeEmailContact(EmailContact p_emailContact!, BBjNumber p_emailType)
```
    removeEmailContact Removes an email contact from the appropriate list
    
    Parameters:
    p_emailContact Email contact object to remove
    p_emailType Email type (To, CC, BCC)
    Returns:
    Returns TRUE (1) if the email contact was removed or FALSE (0) otherwise
  - removeEmailContacts
```
public BBjNumber removeEmailContacts(BBjVector p_emailContacts!)
```
    removeEmailContacts Removes email contacts from the contact list
    
    Parameters:
    p_emailContacts! Vector that contains the EmailContact objects to remove from the contact list
    Returns:
    Returns TRUE (1) if all the email contacts were removed or FALSE (0) otherwise
  - removeEmailContacts
```
public BBjNumber removeEmailContacts(BBjVector p_emailContacts!, BBjNumber p_emailType)
```
    removeEmailContacts Removes email contacts from the appropriate list
    
    Parameters:
    p_emailContacts Vector that contains the EmailContact objects to remove
    p_emailType Email type (To, CC, BCC)
    Returns:
    Returns TRUE (1) if all the email contacts were removed or FALSE (0) otherwise
  - saveEmailContacts
```
public void saveEmailContacts()
```
    saveEmailContacts Saves the email contacts to the user properties
  - setCloseOnSend
```
public void setCloseOnSend(BBjNumber p_closeOnSend)
```
    setCloseOnSend Sets whether dialog should be closed on a send
    
    Parameters:
    p_closeOnSend Specify TRUE (1) to close the dialog on a send, otherwise specify FALSE (0)
  - setCreateContactsOnSend
```
public void setCreateContactsOnSend(BBjNumber p_createContactsOnSend)
```
    setCreateContactsOnSend Sets whether contacts should be created for new email addresses on a send
    
    Parameters:
    p_createContactsOnSend Specify TRUE (1) to create contacts for new email addresses on a send, otherwise specify FALSE (0)
  - setEmailFrom
```
public void setEmailFrom(BBjString p_emailFrom$)
```
    setEmailFrom Sets the email from address
    
    Parameters:
    p_emailFrom$ From email address
  - setEmailMessage
```
public void setEmailMessage(BBjString p_emailMessage$)
```
    setEmailMessage Sets the email message
    
    Parameters:
    p_emailMessage$ Email message
  - setEmailServerHost
```
public void setEmailServerHost(BBjString p_emailServerHost$)
```
    setEmailServerHost Sets the email server host
    
    Parameters:
    p_emailServerHost$ Email server host name
  - setEmailServerPassword
```
public void setEmailServerPassword(BBjString p_emailServerPassword$)
```
    setEmailServerPassword Sets password that will be used to authenticate to the email server
    
    Parameters:
    p_emailServerPassword$ Password that will be used to authenticate to the email server
  - setEmailServerPort
```
public void setEmailServerPort(BBjNumber p_emailServerPort)
```
    setEmailServerPort Sets the email server port
    
    Parameters:
    p_emailServerPort Email server port
  - setEmailServerSSL
```
public void setEmailServerSSL(BBjNumber p_emailServerSSL)
```
    setEmailServerSSL Sets the email server ssl protocol on or off
    
    Parameters:
    p_emailServerSSL Specify 1 for ssl ortherwise specify 0
  - setEmailServerUserName
```
public void setEmailServerUserName(BBjString p_emailServerUserName$)
```
    setEmailServerUserName Sets user name that will be used to authenticate to the email server
    
    Parameters:
    p_emailServerUserName$ User name that will be used to authenticate to the email server
  - setEmailSubject
```
public void setEmailSubject(BBjString p_emailSubject$)
```
    setEmailSubject Sets the email subject
    
    Parameters:
    p_emailSubject$ Email subject
  - setLocation
```
public void setLocation(BBjNumber p_x, BBjNumber p_y)
```
    setLocation Sets the X, Y location of the dialog
    
    Parameters:
    p_x Specifies the X location
    p_y Specifies the y location
  - setTitle
```
public void setTitle(BBjString p_title$)
```
    setTitle Sets the title of the dialog
    
    Parameters:
    p_title$ Sets the title of the dialog

Class EmailDialog

Field Summary

Constructor Summary

Method Summary

Field Detail

EMAIL_BCC_TYPE=2

EMAIL_CC_TYPE=1

EMAIL_TO_TYPE=0

Retries!=0

Constructor Detail

EmailDialog

Method Detail

addEmailAddress

addEmailAddress

addEmailAttachment

addEmailContact

addEmailContact

addEmailContacts

addEmailContacts

contactsDialogChange

doModal

getCloseOnSend

getCreateContactsOnSend

getEmailAttachments

getEmailContacts

getEmailFrom

getEmailMessage

getEmailServerHost

getEmailServerPassword

getEmailServerPort

getEmailServerSSL

getEmailServerUserName

getEmailSubject

getHeight

getTitle

getWidth

getX

getY

loadEmailContacts

loadEmailContacts

OnAttachmentDialogApprove

OnAttachmentDialogClose

OnAttachmentRemove

OnContactChangeDialogClose

OnContactChangeEmailEdit

OnContactChangeFirstNameEdit

OnContactChangeLastNameEdit

OnContactChangeSave

OnContactDialogEdit

OnContactDialogNew

OnContactsDialogClose

OnContactsDialogRemove

OnContactsDialogSelect

OnContactsGridDoubleClick

OnEmailAddressEdit

OnEmailAddressLostFocus

OnEmailAddressRemove

OnEmailAddressSelect

OnEmailBCCAddressKeypress

OnEmailCCAddressKeypress

OnEmailDialogAttachmentClient

OnEmailDialogAttachmentServer

OnEmailDialogBCCAdd

OnEmailDialogBCCContacts

OnEmailDialogBCCRemove

OnEmailDialogCCAdd

OnEmailDialogCCContacts

OnEmailDialogCCRemove

OnEmailDialogClose

OnEmailDialogSend

OnEmailDialogSettings

OnEmailDialogToContacts

OnEmailSettingsDialogClose

OnEmailSettingsDialogSave

OnEmailToAddressKeypress

removeAllEmailContacts

removeEmailAddress

removeEmailAddresses

removeEmailAttachment

removeEmailContact