MessageInfo (eC-Messenger Remote API v1.82)

Object
- MessageInfo

All Implemented Interfaces:

Serializable
```
public class MessageInfo
extends Object
implements Serializable
```
Object holding information about the message entity in eC-Messenger.

Author:

jfischer

See Also:

Serialized Form

Constructor Summary

Constructors
Constructor and Description

MessageInfo()

Constructors
Constructor and Description
`MessageInfo()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`int`	`getActualRecipientCount()` Returns the number of actual recipients.
`String`	`getAuthorId()` Returns the user id of the message author.
`int`	`getBounceCount()` Returns the number of bounces received for this message.
`int`	`getClickerCount()` Returns the number of unique clickers for this message.
`float`	`getClickRate()` Returns the click rate for this message.
`Date`	`getCreationDate()` Returns the message creation date.
`int`	`getForwardCount()` Returns the number of forwards associated with this message.
`String`	`getGroupId()` Returns the group id of the associated group.
`String`	`getId()` Returns the message id.
`String`	`getName()` Returns the message name.
`float`	`getOpenRate()` Returns the open rate for this message.
`int`	`getReaderCount()` Returns the number of unique readers for this message.
`int`	`getRecipientCount()` Returns the number of recipients.
`Date`	`getSendDate()` Returns the message send date.
`float`	`getSendoutProgress()` Returns the sendout progress in percent. NOTE: For messages with a status other than `processing` or `sent`, the returned value is undefined.
`long`	`getSize()` Returns the message size in bytes.
`String`	`getStatus()` Returns the message status.
`String`	`getSubject()` Returns the message subject.
`String`	`getType()` Returns the message type.
`int`	`getUnsubscriptionCount()` Returns the number of unsubscriptions associated with this message.
`void`	`setActualRecipientCount(int actualRecipientCount)`
`void`	`setAuthorId(String authorId)`
`void`	`setBounceCount(int bounceCount)`
`void`	`setClickerCount(int clickerCount)`
`void`	`setClickRate(float clickRate)`
`void`	`setCreationDate(Date creationDate)`
`void`	`setForwardCount(int forwardCount)`
`void`	`setGroupId(String groupId)`
`void`	`setId(String id)`
`void`	`setName(String name)`
`void`	`setOpenRate(float openRate)`
`void`	`setReaderCount(int readerCount)`
`void`	`setRecipientCount(int recipientCount)`
`void`	`setSendDate(Date sendDate)`
`void`	`setSendoutProgress(float sendoutProgress)`
`void`	`setSize(long size)`
`void`	`setStatus(String status)`
`void`	`setSubject(String subject)`
`void`	`setType(String type)`
`void`	`setUnsubscriptionCount(int unsubscriptionCount)`

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

- Constructor Detail
  - MessageInfo
```
public MessageInfo()
```
- Method Detail
  - getId
```
public String getId()
```
    Returns the message id.
    
    Returns:
    
    the message id.
  - setId
```
public void setId(String id)
```
  - getName
```
public String getName()
```
    Returns the message name.
    
    Returns:
    
    the message name.
  - setName
```
public void setName(String name)
```
  - getSubject
```
public String getSubject()
```
    Returns the message subject. The returned value is the message subject without any possible group specific prefixes.
    
    Returns:
    
    the message subject.
  - setSubject
```
public void setSubject(String subject)
```
  - getType
```
public String getType()
```
    Returns the message type.
    
    Returns:
    
    the message type.
  - setType
```
public void setType(String type)
```
  - getStatus
```
public String getStatus()
```
    Returns the message status.
    
    Returns:
    
    the message status.
  - setStatus
```
public void setStatus(String status)
```
  - getSendoutProgress
```
public float getSendoutProgress()
```
    Returns the sendout progress in percent.
    
    NOTE: For messages with a status other than processing or sent, the returned value is undefined.
    
    Returns:
    
    the sendout progress.
  - setSendoutProgress
```
public void setSendoutProgress(float sendoutProgress)
```
  - getCreationDate
```
public Date getCreationDate()
```
    Returns the message creation date.
    
    Returns:
    
    the message creation date.
  - setCreationDate
```
public void setCreationDate(Date creationDate)
```
  - getSendDate
```
public Date getSendDate()
```
    Returns the message send date. The send date may be in the future for scheduled messages.
    
    NOTE: For messages that have not been sent yet and are not scheduled (e.g. prepared messages), this method returns null.
    
    Returns:
    
    the message send date or null.
  - setSendDate
```
public void setSendDate(Date sendDate)
```
  - getSize
```
public long getSize()
```
    Returns the message size in bytes.
    
    Returns:
    
    the message size in bytes.
  - setSize
```
public void setSize(long size)
```
  - getAuthorId
```
public String getAuthorId()
```
    Returns the user id of the message author.
    
    Returns:
    
    the user id of the message author.
  - setAuthorId
```
public void setAuthorId(String authorId)
```
  - getGroupId
```
public String getGroupId()
```
    Returns the group id of the associated group.
    
    Returns:
    
    the group id of the associated group.
  - setGroupId
```
public void setGroupId(String groupId)
```
  - getRecipientCount
```
public int getRecipientCount()
```
    Returns the number of recipients.
    
    Returns:
    
    the number of recipients.
  - setRecipientCount
```
public void setRecipientCount(int recipientCount)
```
  - getActualRecipientCount
```
public int getActualRecipientCount()
```
    Returns the number of actual recipients.
    
    Returns:
    
    the number of actual recipients.
  - setActualRecipientCount
```
public void setActualRecipientCount(int actualRecipientCount)
```
  - getBounceCount
```
public int getBounceCount()
```
    Returns the number of bounces received for this message.
    
    Returns:
    
    the number of bounces.
  - setBounceCount
```
public void setBounceCount(int bounceCount)
```
  - getReaderCount
```
public int getReaderCount()
```
    Returns the number of unique readers for this message.
    
    Returns:
    
    the number of readers.
  - setReaderCount
```
public void setReaderCount(int readerCount)
```
  - getClickerCount
```
public int getClickerCount()
```
    Returns the number of unique clickers for this message.
    
    Returns:
    
    the number of clickers.
  - setClickerCount
```
public void setClickerCount(int clickerCount)
```
  - getForwardCount
```
public int getForwardCount()
```
    Returns the number of forwards associated with this message.
    
    Returns:
    
    the number of forwards.
  - setForwardCount
```
public void setForwardCount(int forwardCount)
```
  - getUnsubscriptionCount
```
public int getUnsubscriptionCount()
```
    Returns the number of unsubscriptions associated with this message.
    
    Returns:
    
    the number of unsubscriptions.
  - setUnsubscriptionCount
```
public void setUnsubscriptionCount(int unsubscriptionCount)
```
  - getOpenRate
```
public float getOpenRate()
```
    Returns the open rate for this message.
    
    Returns:
    
    the open rate.
  - setOpenRate
```
public void setOpenRate(float openRate)
```
  - getClickRate
```
public float getClickRate()
```
    Returns the click rate for this message.
    
    Returns:
    
    the click rate.
  - setClickRate
```
public void setClickRate(float clickRate)
```

Class MessageInfo

Constructor Summary

Method Summary

Methods inherited from class Object

Constructor Detail

MessageInfo

Method Detail

getId

setId

getName

setName

getSubject

setSubject

getType

setType

getStatus

setStatus

getSendoutProgress

setSendoutProgress

getCreationDate

setCreationDate

getSendDate

setSendDate

getSize

setSize

getAuthorId

setAuthorId

getGroupId

setGroupId

getRecipientCount

setRecipientCount

getActualRecipientCount

setActualRecipientCount

getBounceCount

setBounceCount

getReaderCount

setReaderCount

getClickerCount

setClickerCount

getForwardCount

setForwardCount

getUnsubscriptionCount

setUnsubscriptionCount

getOpenRate

setOpenRate

getClickRate

setClickRate