SmtpEmail (P2J - Progress 4GL to Java Conversion and Runtime)

java.lang.Object
- com.goldencode.p2j.email.SmtpEmail

All Implemented Interfaces:: EmailSender, Deletable, WrappedResource

public class SmtpEmail
extends java.lang.Object
implements WrappedResource, EmailSender, Deletable

Implementation of the SMTP EMAIL extension. An SmtpEmail object is a handle based resource with attributes and methods that can be used to define the email's state and to send the email. The sending will occur on the client.

This is a FWD-specific set of functionality. It does not exist and will not run in the Progress 4GL.

To create an SMTP-EMAIL resource use the following syntax:

    CREATE SMTP-EMAIL handle [ASSIGN { ATTR_OR_METHOD = value ...}].

The following list of attributes are available:

Attribute Data Type Required Description
---------------- ------------ -------- ------------------------------------------------------------------------------------------------
connection-type character Y Must be "UNENCRYPTED", "STARTTLS_WHEN_AVAILABLE", "STARTTLS_REQUIRED" or "SSL".
smtp-from character Y This is the FROM address (the email address of the sender).
smtp-host character Y This is the SMTP server's IP address or hostname.
smtp-html character N If set, this is the content of the HTML body.
smtp-port character N Defaults to 25 for UNENCRYPTED, 587 for STARTTLS_* and 465 for SSL.
smtp-reply-to character N Optional REPLY-TO address.
smtp-subject character Y This is the subject line.
smtp-text character N If set, this is the content of the HTML body.
smtp-user character N If both the user and the password are NOT set, then no authentication will be attempted. If set, this is the userid for authentication with the SMTP server.
smtp-password character N If both the user and the password are NOT set, then no authentication will be attempted. If set, this is the password for authentication with the SMTP server.
smtp-validate logical N Defaults to TRUE. If FALSE, the SMTP server's SSL certificate will be treated as trusted. Ignored for UNENCRYPTED mode.

The following list of methods are available:

Method Return Type Return Meaning Required Description
-------------------------------- ----------- -------------- -------- -----------------------------------------------------------------------------------------------------
add-to-address(character addr) logical TRUE on success. N This adds a TO address to the mail. At least one recipient is needed.
add-cc-address(character addr) logical TRUE on success. N This adds a CC address to the mail. At least one recipient is needed.
add-bcc-address(character addr) logical TRUE on success. N This adds a BCC address to the mail. At least one recipient is needed.
attach-file(character filename) logical TRUE on success. N This attaches a local file to the email. The file must exist and be accessible to the user.
attach-file(character url) logical TRUE on success. N This attaches a resource specified by URL to the email. The resource will be downloaded when the email is sent. The URL must exist and be accessible to the user.
clear-attachments-list() logical TRUE on success. N Deletes everything in the attachments list.
clear-bcc-list() logical TRUE on success. N Deletes everything in the BCC address list.
clear-cc-list() logical TRUE on success. N Deletes everything in the CC address list.
clear-embedded-image-list() logical TRUE on success. N Deletes everything in the embedded image list.
clear-to-list() logical TRUE on success. N Deletes everything in the TO address list.
embed-file(character filename) character CONTENT-ID N Adds a local file to the embedded image list and returns the content ID to be substituted into the IMG tag of the HTML body. The file must exist and be accessible to the user.
embed-url(character filename) character CONTENT-ID N Adds a URL resource to the embedded image list and returns the content ID to be substituted into the IMG tag of the HTML body. The resource will be downloaded when the email is sent. The URL must exist and be accessible to the user.
get-attachments-list() character[] List as an array. N Returns the attachments list as an array.
get-bcc-list() character[] List as an array. N Returns the BCC address list as an array.
get-cc-list() character[] List as an array. N Returns the CC address list as an array.
get-embedded-image-list() character[] List as an array. N Returns the embedded image list as an array.
get-to-list() character[] List as an array. N Returns the TO address list as an array.
send() logical TRUE on success. Y Sends the email as previously defined. You can call this more than once (possibly changing the state of the handle each time). Every time this is called it will attempt to send the defined email. This may raise an ERROR condition if there are any problems during send.

At the end of lifetime of the object, it should be deleted, as usual with

DELETE OBJECT handle.

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`private static class`	`SmtpEmail.ContextContainer` Simple container that stores and returns a context-local instance of the remote email sender.

Field Summary

Fields
Modifier and Type	Field and Description
`private EmailDefinition`	`def` Serializable container for email state.
`private static SmtpEmail.ContextContainer`	`remoteSender` Stores context-local state variables.
`private java.lang.Long`	`resourceId` The resource id.
`private boolean`	`valid` Flag to determine if this instance has been deleted.

Constructor Summary

Constructors
Constructor and Description

SmtpEmail()
Construct an instance.

Constructors
Constructor and Description
`SmtpEmail()` Construct an instance.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`logical`	`addBccAddress(character addr)` Add a BCC address to the list of recipients.
`logical`	`addBccAddress(java.lang.String addr)` Add a BCC address to the list of recipients.
`logical`	`addCcAddress(character addr)` Add a CC address to the list of recipients.
`logical`	`addCcAddress(java.lang.String addr)` Add a CC address to the list of recipients.
`logical`	`addToAddress(character addr)` Add a TO address to the list of recipients.
`logical`	`addToAddress(java.lang.String addr)` Add a TO address to the list of recipients.
`logical`	`attachFile(character file)` Attach the specified file to the email.
`logical`	`attachFile(java.lang.String file)` Attach the specified file to the email.
`logical`	`attachURL(character url)` Attach the file specified by the given URL to the email.
`logical`	`attachURL(java.lang.String url)` Attach the file specified by the given URL to the email.
`logical`	`clearAttachmentsList()` Clear the list of attachments.
`logical`	`clearBccAddressList()` Clear the list of BCC recipients.
`logical`	`clearCcAddressList()` Clear the list of CC recipients.
`logical`	`clearEmbeddedImageList()` Clear the list of embedded images.
`logical`	`clearToAddressList()` Clear the list of TO recipients.
`static void`	`create(handle h)` Static factory method for initialization of a fresh new SMTP EMAIL as an extension object.
`void`	`delete()` Perform actual delete of all resources.
`character`	`embedImageByFile(character file)` Embed the image specified by the given file and return the content ID needed to substitute into the HTML (in an IMG tag).
`character`	`embedImageByFile(java.lang.String file)` Embed the image specified by the given file and return the content ID needed to substitute into the HTML (in an IMG tag).
`character`	`embedImageByURL(character url)` Embed the image specified by the given URL and return the content ID needed to substitute into the HTML (in an IMG tag).
`character`	`embedImageByURL(java.lang.String url)` Embed the image specified by the given URL and return the content ID needed to substitute into the HTML (in an IMG tag).
`character[]`	`getAttachmentsList()` Obtain the list of attachments.
`character[]`	`getBccAddressList()` Obtain the list of BCC recipients.
`character[]`	`getCcAddressList()` Obtain the list of CC recipients.
`character`	`getConnectionType()` Gets the connection type for the SMTP communications session.
`character[]`	`getEmbeddedImageList()` Obtain the list of embedded image file and URL names.
`character`	`getSmtpFrom()` Gets the FROM address.
`character`	`getSmtpHost()` Gets the host for the SMTP server.
`character`	`getSmtpHtmlBody()` Gets the HTML body contents.
`character`	`getSmtpPassword()` Gets the password for authenticating with the SMTP server.
`character`	`getSmtpPort()` Gets the port for the SMTP server.
`character`	`getSmtpReplyTo()` Gets the REPLY-TO address.
`character`	`getSmtpSubject()` Gets the SUBJECT line.
`character`	`getSmtpTextBody()` Gets the TEXT body contents.
`character`	`getSmtpUser()` Gets the userid for authenticating with the SMTP server.
`character[]`	`getToAddressList()` Obtain the list of TO recipients.
`java.lang.Long`	`id()` Get this resource's ID, if is already set.
`void`	`id(long id)` Set this resource's ID.
`logical`	`isSmtpValidate()` Returns the state of the SMTP-VALIDATE attribute, which determines if the SMTP server certificate is validated during an SSL or STARTTLS connection.
`logical`	`send()` Send the email.
`void`	`setConnectionType(character type)` Sets the connection type for the SMTP communications session.
`void`	`setConnectionType(java.lang.String type)` Sets the connection type for the SMTP communications session.
`void`	`setSmtpFrom(character from)` Sets the FROM address.
`void`	`setSmtpFrom(java.lang.String from)` Sets the FROM address.
`void`	`setSmtpHost(character host)` Sets the host for the SMTP server.
`void`	`setSmtpHost(java.lang.String host)` Sets the host for the SMTP server.
`void`	`setSmtpHtmlBody(character html)` Sets the HTML body contents.
`void`	`setSmtpHtmlBody(java.lang.String html)` Sets the HTML body contents.
`void`	`setSmtpPassword(character password)` Sets the password for authenticating with the SMTP server.
`void`	`setSmtpPassword(java.lang.String password)` Sets the password for authenticating with the SMTP server.
`void`	`setSmtpPort(character port)` Sets the port for the SMTP server.
`void`	`setSmtpPort(java.lang.String port)` Sets the port for the SMTP server.
`void`	`setSmtpReplyTo(character replyTo)` Sets the REPLY-TO address.
`void`	`setSmtpReplyTo(java.lang.String replyTo)` Sets the REPLY-TO address.
`void`	`setSmtpSubject(character subject)` Sets the SUBJECT line.
`void`	`setSmtpSubject(java.lang.String subject)` Sets the SUBJECT line.
`void`	`setSmtpTextBody(character text)` Sets the TEXT body contents.
`void`	`setSmtpTextBody(java.lang.String text)` Sets the TEXT body contents.
`void`	`setSmtpUser(character userid)` Sets the userid for authenticating with the SMTP server.
`void`	`setSmtpUser(java.lang.String userid)` Sets the userid for authenticating with the SMTP server.
`void`	`setSmtpValidate(boolean validate)` Setter for SMTP-VALIDATE attribute, which determines if the SMTP server certificate is validated during an SSL or STARTTLS connection.
`void`	`setSmtpValidate(logical validate)` Setter for SMTP-VALIDATE attribute, which determines if the SMTP server certificate is validated during an SSL or STARTTLS connection.
`private character[]`	`stringArrayToCharacterArray(java.lang.String[] list)` Convert the given string array into a charaacter array.
`boolean`	`unknown()` Reports if this object is unknown.
`boolean`	`valid()` Checks whether this object is valid.

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

Methods inherited from interface com.goldencode.p2j.util.Deletable
allowDelete

- Field Detail
  - remoteSender
```
private static SmtpEmail.ContextContainer remoteSender
```
    Stores context-local state variables.
  - resourceId
```
private java.lang.Long resourceId
```
    The resource id. Used by WrappedResource management.
  - valid
```
private boolean valid
```
    Flag to determine if this instance has been deleted.
  - def
```
private EmailDefinition def
```
    Serializable container for email state.
- Constructor Detail
  - SmtpEmail
```
public SmtpEmail()
```
    Construct an instance.
- Method Detail
  - create
```
public static void create(handle h)
```
    Static factory method for initialization of a fresh new SMTP EMAIL as an extension object.
    
    Parameters:
    
    h - The handle to store the newly created object.
  - unknown
```
public boolean unknown()
```
    Reports if this object is unknown.
    
    Specified by:
    
    unknown in interface WrappedResource
    
    Returns:
    
    true if object is unknown.
  - id
```
public java.lang.Long id()
```
    Get this resource's ID, if is already set.
    
    Specified by:
    
    id in interface WrappedResource
    
    Returns:
    
    The resource's ID or null if not set.
  - id
```
public void id(long id)
```
    Set this resource's ID.
    
    Specified by:
    
    id in interface WrappedResource
    
    Parameters:
    
    id - The resource's ID.
  - delete
```
public void delete()
```
    Perform actual delete of all resources. At the time of this call, it is assumed the resource is valid for deletion (the handle and the resource are both valid).
    This is called from a handle when working as FWD extension object.
    
    Specified by:
    
    delete in interface Deletable
  - valid
```
public boolean valid()
```
    Checks whether this object is valid. The object is valid from the moment it was created (even if not active) and until expressly deleted.
    
    Specified by:
    
    valid in interface WrappedResource
    
    Returns:
    
    true if this object is valid.
  - getConnectionType
```
public character getConnectionType()
```
    Gets the connection type for the SMTP communications session.
    
    Specified by:
    
    getConnectionType in interface EmailSender
    
    Returns:
    
    The connection type which is "UNENCRYPTED", "STARTTLS_WHEN_AVAILABLE", "STARTTLS_REQUIRED" or "SSL".
  - setConnectionType
```
public void setConnectionType(character type)
```
    Sets the connection type for the SMTP communications session.
    
    Specified by:
    
    setConnectionType in interface EmailSender
    
    Parameters:
    
    type - The connection type which must be "UNENCRYPTED", "STARTTLS_WHEN_AVAILABLE", "STARTTLS_REQUIRED" or "SSL". Must not be null or unknown.
  - setConnectionType
```
public void setConnectionType(java.lang.String type)
```
    Sets the connection type for the SMTP communications session.
    
    Specified by:
    
    setConnectionType in interface EmailSender
    
    Parameters:
    
    type - The connection type which must be "UNENCRYPTED", "STARTTLS_WHEN_AVAILABLE", "STARTTLS_REQUIRED" or "SSL". Must not be null.
  - getSmtpHost
```
public character getSmtpHost()
```
    Gets the host for the SMTP server.
    
    Specified by:
    
    getSmtpHost in interface EmailSender
    
    Returns:
    
    The name or IP address of the SMTP server.
  - setSmtpHost
```
public void setSmtpHost(character host)
```
    Sets the host for the SMTP server.
    
    Specified by:
    
    setSmtpHost in interface EmailSender
    
    Parameters:
    
    host - The name or IP address of the SMTP server. Must not be null or unknown.
  - setSmtpHost
```
public void setSmtpHost(java.lang.String host)
```
    Sets the host for the SMTP server.
    
    Specified by:
    
    setSmtpHost in interface EmailSender
    
    Parameters:
    
    host - The name or IP address of the SMTP server. Must not be null.
  - getSmtpPort
```
public character getSmtpPort()
```
    Gets the port for the SMTP server.
    
    Specified by:
    
    getSmtpPort in interface EmailSender
    
    Returns:
    
    The port used by the SMTP server.
  - setSmtpPort
```
public void setSmtpPort(character port)
```
    Sets the port for the SMTP server.
    
    Specified by:
    
    setSmtpPort in interface EmailSender
    
    Parameters:
    
    port - The port used by the SMTP server.
  - setSmtpPort
```
public void setSmtpPort(java.lang.String port)
```
    Sets the port for the SMTP server.
    
    Specified by:
    
    setSmtpPort in interface EmailSender
    
    Parameters:
    
    port - The port used by the SMTP server.
  - getSmtpUser
```
public character getSmtpUser()
```
    Gets the userid for authenticating with the SMTP server.
    
    Specified by:
    
    getSmtpUser in interface EmailSender
    
    Returns:
    
    The userid.
  - setSmtpUser
```
public void setSmtpUser(character userid)
```
    Sets the userid for authenticating with the SMTP server.
    
    Specified by:
    
    setSmtpUser in interface EmailSender
    
    Parameters:
    
    userid - The userid for authentication.
  - setSmtpUser
```
public void setSmtpUser(java.lang.String userid)
```
    Sets the userid for authenticating with the SMTP server.
    
    Specified by:
    
    setSmtpUser in interface EmailSender
    
    Parameters:
    
    userid - The userid for authentication.
  - getSmtpPassword
```
public character getSmtpPassword()
```
    Gets the password for authenticating with the SMTP server.
    
    Specified by:
    
    getSmtpPassword in interface EmailSender
    
    Returns:
    
    The password.
  - setSmtpPassword
```
public void setSmtpPassword(character password)
```
    Sets the password for authenticating with the SMTP server.
    
    Specified by:
    
    setSmtpPassword in interface EmailSender
    
    Parameters:
    
    password - The password for authentication.
  - setSmtpPassword
```
public void setSmtpPassword(java.lang.String password)
```
    Sets the password for authenticating with the SMTP server.
    
    Specified by:
    
    setSmtpPassword in interface EmailSender
    
    Parameters:
    
    password - The password for authentication.
  - isSmtpValidate
```
public logical isSmtpValidate()
```
    Returns the state of the SMTP-VALIDATE attribute, which determines if the SMTP server certificate is validated during an SSL or STARTTLS connection.
    
    Specified by:
    
    isSmtpValidate in interface EmailSender
    
    Returns:
    
    Current state of the SMTP-VALIDATE attribute.
  - setSmtpValidate
```
public void setSmtpValidate(boolean validate)
```
    Setter for SMTP-VALIDATE attribute, which determines if the SMTP server certificate is validated during an SSL or STARTTLS connection.
    
    Specified by:
    
    setSmtpValidate in interface EmailSender
    
    Parameters:
    
    validate - true to validate the server certificate.
  - setSmtpValidate
```
public void setSmtpValidate(logical validate)
```
    Setter for SMTP-VALIDATE attribute, which determines if the SMTP server certificate is validated during an SSL or STARTTLS connection.
    
    Specified by:
    
    setSmtpValidate in interface EmailSender
    
    Parameters:
    
    validate - true to validate the server certificate.
  - getSmtpFrom
```
public character getSmtpFrom()
```
    Gets the FROM address.
    
    Specified by:
    
    getSmtpFrom in interface EmailSender
    
    Returns:
    
    The FROM address.
  - setSmtpFrom
```
public void setSmtpFrom(character from)
```
    Sets the FROM address.
    
    Specified by:
    
    setSmtpFrom in interface EmailSender
    
    Parameters:
    
    from - The FROM address.
  - setSmtpFrom
```
public void setSmtpFrom(java.lang.String from)
```
    Sets the FROM address.
    
    Specified by:
    
    setSmtpFrom in interface EmailSender
    
    Parameters:
    
    from - The FROM address.
  - getSmtpReplyTo
```
public character getSmtpReplyTo()
```
    Gets the REPLY-TO address.
    
    Specified by:
    
    getSmtpReplyTo in interface EmailSender
    
    Returns:
    
    The REPLY-TO address.
  - setSmtpReplyTo
```
public void setSmtpReplyTo(character replyTo)
```
    Sets the REPLY-TO address.
    
    Specified by:
    
    setSmtpReplyTo in interface EmailSender
    
    Parameters:
    
    replyTo - The REPLY-TO address.
  - setSmtpReplyTo
```
public void setSmtpReplyTo(java.lang.String replyTo)
```
    Sets the REPLY-TO address.
    
    Specified by:
    
    setSmtpReplyTo in interface EmailSender
    
    Parameters:
    
    replyTo - The REPLY-TO address.
  - getSmtpSubject
```
public character getSmtpSubject()
```
    Gets the SUBJECT line.
    
    Specified by:
    
    getSmtpSubject in interface EmailSender
    
    Returns:
    
    The SUBJECT line.
  - setSmtpSubject
```
public void setSmtpSubject(character subject)
```
    Sets the SUBJECT line.
    
    Specified by:
    
    setSmtpSubject in interface EmailSender
    
    Parameters:
    
    subject - The SUBJECT line.
  - setSmtpSubject
```
public void setSmtpSubject(java.lang.String subject)
```
    Sets the SUBJECT line.
    
    Specified by:
    
    setSmtpSubject in interface EmailSender
    
    Parameters:
    
    subject - The SUBJECT line.
  - getSmtpHtmlBody
```
public character getSmtpHtmlBody()
```
    Gets the HTML body contents.
    
    Specified by:
    
    getSmtpHtmlBody in interface EmailSender
    
    Returns:
    
    The HTML body contents.
  - setSmtpHtmlBody
```
public void setSmtpHtmlBody(character html)
```
    Sets the HTML body contents.
    
    Specified by:
    
    setSmtpHtmlBody in interface EmailSender
    
    Parameters:
    
    html - The HTML body contents.
  - setSmtpHtmlBody
```
public void setSmtpHtmlBody(java.lang.String html)
```
    Sets the HTML body contents.
    
    Specified by:
    
    setSmtpHtmlBody in interface EmailSender
    
    Parameters:
    
    html - The HTML body contents.
  - getSmtpTextBody
```
public character getSmtpTextBody()
```
    Gets the TEXT body contents.
    
    Specified by:
    
    getSmtpTextBody in interface EmailSender
    
    Returns:
    
    The TEXT body contents.
  - setSmtpTextBody
```
public void setSmtpTextBody(character text)
```
    Sets the TEXT body contents.
    
    Specified by:
    
    setSmtpTextBody in interface EmailSender
    
    Parameters:
    
    text - The TEXT body contents.
  - setSmtpTextBody
```
public void setSmtpTextBody(java.lang.String text)
```
    Sets the TEXT body contents.
    
    Specified by:
    
    setSmtpTextBody in interface EmailSender
    
    Parameters:
    
    text - The TEXT body contents.
  - addToAddress
```
public logical addToAddress(character addr)
```
    Add a TO address to the list of recipients.
    
    Specified by:
    
    addToAddress in interface EmailSender
    
    Parameters:
    
    addr - The TO address.
  - addToAddress
```
public logical addToAddress(java.lang.String addr)
```
    Add a TO address to the list of recipients.
    
    Specified by:
    
    addToAddress in interface EmailSender
    
    Parameters:
    
    addr - The TO address.
  - addCcAddress
```
public logical addCcAddress(character addr)
```
    Add a CC address to the list of recipients.
    
    Specified by:
    
    addCcAddress in interface EmailSender
    
    Parameters:
    
    addr - The CC address.
  - addCcAddress
```
public logical addCcAddress(java.lang.String addr)
```
    Add a CC address to the list of recipients.
    
    Specified by:
    
    addCcAddress in interface EmailSender
    
    Parameters:
    
    addr - The CC address.
  - addBccAddress
```
public logical addBccAddress(character addr)
```
    Add a BCC address to the list of recipients.
    
    Specified by:
    
    addBccAddress in interface EmailSender
    
    Parameters:
    
    addr - The BCC address.
  - addBccAddress
```
public logical addBccAddress(java.lang.String addr)
```
    Add a BCC address to the list of recipients.
    
    Specified by:
    
    addBccAddress in interface EmailSender
    
    Parameters:
    
    addr - The BCC address.
  - attachFile
```
public logical attachFile(character file)
```
    Attach the specified file to the email.
    
    Specified by:
    
    attachFile in interface EmailSender
    
    Parameters:
    
    file - The file to attach.
  - attachFile
```
public logical attachFile(java.lang.String file)
```
    Attach the specified file to the email.
    
    Specified by:
    
    attachFile in interface EmailSender
    
    Parameters:
    
    file - The file to attach.
  - attachURL
```
public logical attachURL(character url)
```
    Attach the file specified by the given URL to the email.
    
    Specified by:
    
    attachURL in interface EmailSender
    
    Parameters:
    
    url - The resource to attach.
  - attachURL
```
public logical attachURL(java.lang.String url)
```
    Attach the file specified by the given URL to the email.
    
    Specified by:
    
    attachURL in interface EmailSender
    
    Parameters:
    
    url - The resource to attach.
  - clearAttachmentsList
```
public logical clearAttachmentsList()
```
    Clear the list of attachments.
    
    Specified by:
    
    clearAttachmentsList in interface EmailSender
  - clearBccAddressList
```
public logical clearBccAddressList()
```
    Clear the list of BCC recipients.
    
    Specified by:
    
    clearBccAddressList in interface EmailSender
  - clearCcAddressList
```
public logical clearCcAddressList()
```
    Clear the list of CC recipients.
    
    Specified by:
    
    clearCcAddressList in interface EmailSender
  - clearEmbeddedImageList
```
public logical clearEmbeddedImageList()
```
    Clear the list of embedded images.
    
    Specified by:
    
    clearEmbeddedImageList in interface EmailSender
  - clearToAddressList
```
public logical clearToAddressList()
```
    Clear the list of TO recipients.
    
    Specified by:
    
    clearToAddressList in interface EmailSender
  - embedImageByFile
```
public character embedImageByFile(character file)
```
    Embed the image specified by the given file and return the content ID needed to substitute into the HTML (in an IMG tag). The result will be visible inline in the HTML document as part of the IMG.
    
    Specified by:
    
    embedImageByFile in interface EmailSender
    
    Parameters:
    
    file - The resource to attach.
    
    Returns:
    
    The content ID for use in an IMG tag.
  - embedImageByFile
```
public character embedImageByFile(java.lang.String file)
```
    Embed the image specified by the given file and return the content ID needed to substitute into the HTML (in an IMG tag). The result will be visible inline in the HTML document as part of the IMG.
    
    Specified by:
    
    embedImageByFile in interface EmailSender
    
    Parameters:
    
    file - The resource to attach.
    
    Returns:
    
    The content ID for use in an IMG tag.
  - embedImageByURL
```
public character embedImageByURL(character url)
```
    Embed the image specified by the given URL and return the content ID needed to substitute into the HTML (in an IMG tag). The result will be visible inline in the HTML document as part of the IMG.
    
    Specified by:
    
    embedImageByURL in interface EmailSender
    
    Parameters:
    
    url - The resource to attach.
    
    Returns:
    
    The content ID for use in an IMG tag.
  - embedImageByURL
```
public character embedImageByURL(java.lang.String url)
```
    Embed the image specified by the given URL and return the content ID needed to substitute into the HTML (in an IMG tag). The result will be visible inline in the HTML document as part of the IMG.
    
    Specified by:
    
    embedImageByURL in interface EmailSender
    
    Parameters:
    
    url - The resource to attach.
    
    Returns:
    
    The content ID for use in an IMG tag.
  - getAttachmentsList
```
public character[] getAttachmentsList()
```
    Obtain the list of attachments.
    
    Specified by:
    
    getAttachmentsList in interface EmailSender
    
    Returns:
    
    The array of attachment file and URL names.
  - getBccAddressList
```
public character[] getBccAddressList()
```
    Obtain the list of BCC recipients.
    
    Specified by:
    
    getBccAddressList in interface EmailSender
    
    Returns:
    
    The array of all BCC recipients.
  - getCcAddressList
```
public character[] getCcAddressList()
```
    Obtain the list of CC recipients.
    
    Specified by:
    
    getCcAddressList in interface EmailSender
    
    Returns:
    
    The array of all CC recipients.
  - getEmbeddedImageList
```
public character[] getEmbeddedImageList()
```
    Obtain the list of embedded image file and URL names.
    
    Specified by:
    
    getEmbeddedImageList in interface EmailSender
    
    Returns:
    
    The array of attachment file and URL names.
  - getToAddressList
```
public character[] getToAddressList()
```
    Obtain the list of TO recipients.
    
    Specified by:
    
    getToAddressList in interface EmailSender
    
    Returns:
    
    The array of all TO recipients.
  - send
```
public logical send()
             throws ErrorConditionException
```
    Send the email.
    
    Specified by:
    
    send in interface EmailSender
    
    Returns:
    
    true if the send succeeded.
    
    Throws:
    
    ErrorConditionException - On any failure, unless silent error mode is enabled.
  - stringArrayToCharacterArray
```
private character[] stringArrayToCharacterArray(java.lang.String[] list)
```
    Convert the given string array into a charaacter array.
    
    Parameters:
    
    list - Input array.
    
    Returns:
    
    The output array.

Class SmtpEmail

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface com.goldencode.p2j.util.Deletable

Field Detail

remoteSender

resourceId

valid

def

Constructor Detail

SmtpEmail

Method Detail

create

unknown

id

id

delete

valid

getConnectionType

setConnectionType

setConnectionType

getSmtpHost

setSmtpHost

setSmtpHost

getSmtpPort

setSmtpPort

setSmtpPort

getSmtpUser

setSmtpUser

setSmtpUser

getSmtpPassword

setSmtpPassword

setSmtpPassword

isSmtpValidate

setSmtpValidate

setSmtpValidate

getSmtpFrom

setSmtpFrom

setSmtpFrom

getSmtpReplyTo

setSmtpReplyTo

setSmtpReplyTo

getSmtpSubject

setSmtpSubject

setSmtpSubject

getSmtpHtmlBody

setSmtpHtmlBody

setSmtpHtmlBody

getSmtpTextBody

setSmtpTextBody

setSmtpTextBody

addToAddress

addToAddress

addCcAddress

addCcAddress

addBccAddress

addBccAddress

attachFile

attachFile

attachURL

attachURL

clearAttachmentsList

clearBccAddressList

clearCcAddressList

clearEmbeddedImageList

clearToAddressList

embedImageByFile

embedImageByFile

embedImageByURL

embedImageByURL

getAttachmentsList

getBccAddressList

getCcAddressList

getEmbeddedImageList

getToAddressList

send

stringArrayToCharacterArray