public class SomQmgrRecipient extends SomQmgrObject
Modifier and Type | Class and Description |
---|---|
static class |
SomQmgrRecipient.MessageState |
errortext, somSession
Constructor and Description |
---|
SomQmgrRecipient(SomSession session,
java.lang.String c,
java.lang.String m,
SomQmgrMessage msg)
Create a new recipient object
|
SomQmgrRecipient(SomSession session,
java.lang.String c,
java.lang.String m,
SomQmgrMessage msg,
java.lang.String[] pairs)
Create a new recipient object, populating it from the attribute pairs passed in
|
Modifier and Type | Method and Description |
---|---|
java.lang.String |
buildInfoString()
Generate information string about this recipient
|
java.lang.String |
cachedUntil()
Get the time which this message is delayed until
|
java.lang.String |
channel()
Get current channel name
|
java.lang.String |
channels()
Get the list of channels which this recipient address is scheduled on
|
java.lang.String |
channelsDone()
Get a list of channels which have already processed this recipient address
|
void |
clear(SomCommandListener listener)
Clear delay on this recipient
|
java.lang.String |
contentId()
Get content id for recipient
|
void |
delay(int mins,
SomCommandListener listener)
Delay this recipient
|
void |
delete(SomCommandListener listener)
Delete this recipient
|
java.lang.String |
enabled()
Get a string indicating whether this recipient is enabled or not
|
SomQmgrMessage |
getMsg() |
java.lang.String |
group()
Get internal group name
|
java.lang.String |
info()
Get information string for recipient
|
java.lang.String |
lastAttempt()
Get time of last processing attempt
|
java.lang.String |
lastSuccess()
Get time of last successful processing attempt
|
java.lang.String |
msgState()
Get state of this recipient
|
SomQmgrRecipient.MessageState |
msgStateCode()
Get state code
|
java.lang.String |
msgStatus()
Get recipient status
|
java.lang.String |
msgStatusCode()
Get recipient status string as x.y.z
|
java.lang.String |
mta()
Get MTA name for this recipient
|
void |
nondeliver(java.lang.String reason,
SomCommandListener listener)
Nondeliver this recipient
|
java.lang.Integer |
outboundSize()
Get size of outbound message for this recipient
|
java.lang.Integer |
receivedBytes()
Get number of bytes that receiving MTA has acknowledged
|
java.lang.Integer |
recipient()
Get recipient number
|
void |
redirect(java.lang.String addr,
SomCommandListener listener)
Redirect this recipient to a new address
|
java.lang.Integer |
retransmissions()
Get number of retransmissions that have been necessary
|
void |
timeout(SomCommandListener listener)
Time out this recipient
|
java.lang.Integer |
transmittedBytes()
Get number of bytes transmitted
|
java.lang.String |
user()
Get actual address
|
addAttribute, addAttribute, addBindListener, clearAttributes, getBooleanAttributeValue, getDoubleAttributeValue, getIntegerAttributeValue, getSession, getStringAttributeValue, notifyBindListeners, notifyListener, notifyListeners, parsePairs, print_str, print, removeBindListener, setSkipNotifications
public SomQmgrRecipient(SomSession session, java.lang.String c, java.lang.String m, SomQmgrMessage msg)
session
- session for this recipient which must not be nullc
- channel for this recipient which must not be nullm
- mta for this recipient which may be nullmsg
- message for this recipient which may not be nullpublic SomQmgrRecipient(SomSession session, java.lang.String c, java.lang.String m, SomQmgrMessage msg, java.lang.String[] pairs)
session
- session for this recipient which must not be nullc
- channel for this recipient which must not be nullm
- mta for this recipient which may be nullmsg
- message for this recipient which may not be nullpairs
- attribute pairspublic java.lang.String cachedUntil() throws SomException
SomException
- on errorpublic java.lang.String channels() throws SomException
SomException
- on errorpublic java.lang.String channelsDone() throws SomException
SomException
- on errorpublic java.lang.String enabled() throws SomException
SomException
- on errorpublic java.lang.String info() throws SomException
SomException
- on errorpublic java.lang.String lastAttempt() throws SomException
SomException
- on errorpublic java.lang.String lastSuccess() throws SomException
SomException
- on errorpublic java.lang.String msgStatus() throws SomException
SomException
- on errorpublic java.lang.String mta() throws SomException
SomException
- on errorpublic java.lang.String user() throws SomException
SomException
- on errorpublic java.lang.Integer recipient() throws SomException
SomException
- on errorpublic java.lang.String channel() throws SomException
SomException
- on errorpublic java.lang.String contentId() throws SomException
SomException
- on errorpublic java.lang.String group() throws SomException
SomException
- on errorpublic java.lang.String msgState() throws SomException
SomException
- on errorpublic SomQmgrRecipient.MessageState msgStateCode() throws SomException
SomException
- on errorpublic java.lang.String msgStatusCode() throws SomException
SomException
- on errorpublic java.lang.Integer outboundSize() throws SomException
SomException
- on errorpublic java.lang.Integer receivedBytes() throws SomException
SomException
- on errorpublic java.lang.Integer retransmissions() throws SomException
SomException
- on errorpublic java.lang.Integer transmittedBytes() throws SomException
SomException
- on errorpublic java.lang.String buildInfoString()
public void clear(SomCommandListener listener) throws SomException
listener
- Object to notify when operation complete, which may be nullSomException
- on errorpublic void delay(int mins, SomCommandListener listener) throws SomException
mins
- minutes to delay recipient bylistener
- Object to notify when operation complete, which may be nullSomException
- on errorpublic void timeout(SomCommandListener listener) throws SomException
listener
- Object to notify when operation complete, which may be nullSomException
- on errorpublic void delete(SomCommandListener listener) throws SomException
listener
- Object to notify when operation complete, which may be nullSomException
- on errorpublic void redirect(java.lang.String addr, SomCommandListener listener) throws SomException
addr
- new recipient addresslistener
- Object to notify when operation complete, which may be nullSomException
- on errorpublic void nondeliver(java.lang.String reason, SomCommandListener listener) throws SomException
reason
- reason text which must not be nulllistener
- Object to notify when operation complete, which may be nullSomException
- on errorpublic SomQmgrMessage getMsg()
Version: 18.0v6-0
Copyright (c) 2017-2020 Isode