ipworks
Class MessageRecipient

java.lang.Object
  |
  +--ipworks.MessageRecipient

public class MessageRecipient

extends java.lang.Object

A recipient of the message.

This type describes who the message is sent to. It includes fields to denote the name and email address of the recipient of the message. The type of recipient must also be specified if the bean is sending the message.

The following is a list of all of the fields and their descriptions for this type:

Address: The email address of the recipient.

Name: The name of the recipient.

Options: Recipient sending options (used only by SMTP). This must be a string of RFC-compliant recipient options (used by SMTP ).

One type of option is a delivery status notification sent per recipient which is specified by RFC 1891.

 control.MessageRecipients(0).Options = "NOTIFY SUCCESS,FAILURE,DELAY" 

RecipientType: Recipient type: To, Cc, or BCc.

See Also:

Atom, Atom.MessageRecipient

Field Summary

static int	rtBCc
static int	rtCc
static int	rtTo

Constructor Summary

MessageRecipient()

MessageRecipient(java.lang.String address)

MessageRecipient(java.lang.String address, int recipientType)

Method Summary

java.lang.String	getAddress()
java.lang.String	getName()
java.lang.String	getOptions()
int	getRecipientType()
void	setAddress(java.lang.String value)
void	setName(java.lang.String value)
void	setOptions(java.lang.String value)
void	setRecipientType(int value)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

rtTo

public static final int rtTo

See Also:

Constant Field Values

rtCc

public static final int rtCc

See Also:

Constant Field Values

rtBCc

public static final int rtBCc

See Also:

Constant Field Values

Constructor Detail

MessageRecipient

public MessageRecipient()

MessageRecipient

public MessageRecipient(java.lang.String address)

MessageRecipient

public MessageRecipient(java.lang.String address,
                        int recipientType)

Method Detail

getAddress

public java.lang.String getAddress()

setAddress

public void setAddress(java.lang.String value)

getName

public java.lang.String getName()

setName

public void setName(java.lang.String value)

getOptions

public java.lang.String getOptions()

setOptions

public void setOptions(java.lang.String value)

getRecipientType

public int getRecipientType()

setRecipientType

public void setRecipientType(int value)