|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.efaxdeveloper.util.outbound.EmailBundler
public class EmailBundler
EmailBundler
Overview
The EmailBundler is used by the client-side process to bundle email addresses for disposition notification processing. The programmer will instantiate an EmailBundler and add one or more email addresses of recipients that should receive final disposition notification via email.
When submitting an outbound request passing an EmailBundler to the
setDispositionTo(EmailBundler)
method, eFax Developer™ will attempt to send final disposition notifications for the outbound transmission to the email or emails specified in the EmailBundler.The following snippet provides an example of how the EmailBundler might be used within the client-side process:
// Instantiate a new OutboundRequest object OutboundRequest req = new OutboundRequest(); ... // Set to receive disposition notifications upon success or failure req.setDispositionLevel(OutboundRequest.DL_BOTH); // Instantiate an EmailBundler object EmailBundler dispositionEmails = new EmailBundler(); // Add new recipient(s) to the EmailBundler object dispositionEmails.add("email1@a_domain.com"); dispositionEmails.add("email2@a_domain.com"); // Set your disposition emails to the OutboundRequest instance req.setDispositionsTo(dispositionEmails);
OutboundRequest
,
OutboundRequest.setDispositionTo(EmailBundler)
Constructor Summary | |
---|---|
EmailBundler()
Constructor method for EmailBundler |
Method Summary | |
---|---|
void |
add(java.lang.String address)
Method used to store disposition emails for the transmission. |
void |
add(java.lang.String address,
java.lang.String recipient)
Method used to store disposition emails with recipient names for the transmission. |
java.util.Map<java.lang.String,java.lang.String> |
get()
Method used to retrieve a Map object of disposition email addresses stored for the transmission |
int |
size()
Method used to return the number of disposition email addresses stored for the transmission |
Methods inherited from class java.lang.Object |
---|
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public EmailBundler()
Method Detail |
---|
public void add(java.lang.String address)
address
- the recipient's actual email addressadd(String, String)
public void add(java.lang.String address, java.lang.String recipient)
address
- the recipient's actual email addressrecipient
- the recipient's friendly or "To:" nameadd(String)
public java.util.Map<java.lang.String,java.lang.String> get()
public int size()
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |