| 
 
 
 
 
                                                    boolean
                                                
 
  | 
 
 
 
 
 alertSubscriber(String palId, String service, Payload payload, String workflow)
 
 
 
  Alerts the specified subscriber of the given notice. 
  | 
 
 
 
 | 
 
 
                                                     
                                                
 
 
 
  | 
 
 
 
 
 block(String palId, String emailAddress, String reason)
 
 
 
  Blocks sending to the email address. 
  | 
 
 
 
 | 
 
 
 
 Data
 
 
 
  | 
 
 
 
 
 getNextEmailBlock(boolean flagAsNotified)
 
 
 
  Returns the next (chronological) email block, flagging it as notified.  The data contains these properties: email, statusCode, reason, blocks, resets, palId, palName.  Returns null if no more blocks. 
  | 
 
 
 
 | 
 
 
 
 SystemDataView
 
 
 
  | 
 
 
 
 
 getSubscribers(String service)
 
 
 
  Provides access to subscribers for the given service. 
  | 
 
 
 
 | 
 
 
 
 
                                                    boolean
                                                
 
  | 
 
 
 
 
 isSubscriber(String palId, String service)
 
 
 
  Returns true if the specified Pal is a subscriber to the given service. 
  | 
 
 
 
 | 
 
 
 
 
                                                    String
                                                
 
  | 
 
 
 
 
 toString()
 
 
 
  Returns a description of this object. 
  | 
 
 
 
 Method Detail
 
 
 
 boolean alertSubscriber(String palId, String service, Payload payload, String workflow)
 
 
 
                                    Alerts the specified subscriber of the given notice.
                                
 
 
 Parameters:
 
 
 
 - 
 
 
 
                                                            String
                                                        
 
                                                     
                                                    palId
                                                    
 
                                                        Required parameter.
                                                    
 
 
 
 
 
 - 
 
 
 
                                                            String
                                                        
 
                                                     
                                                    service
                                                    
 
                                                        Required parameter.
                                                    
 
 
                                                        Allowed values: DSN, REPLY, EBLOCK.
                                                    
 
 
 
 - 
 
 
 Payload
 
 
 
                                                     
                                                    payload
                                                    
 
                                                        Required parameter.
                                                    
 
 
 
 
 
 - 
 
 
 
                                                            String
                                                        
 
                                                     
                                                    workflow
                                                    
 
 
 
 
 
 
 
 
 
 
 
 Returns: 
                                        
 
 
                                                boolean
                                            
 
 
 
 
 
 
 Since:
                                    12-11-2013
                                
 
 
 
 
 
 
 
 block(String palId, String emailAddress, String reason)
 
 
 
                                    Blocks sending to the email address.
                                
 
 
 Parameters:
 
 
 
 - 
 
 
 
                                                            String
                                                        
 
                                                     
                                                    palId
                                                    
 
                                                        Required parameter.
                                                    
 
 
 
 
 
 - 
 
 
 
                                                            String
                                                        
 
                                                     
                                                    emailAddress
                                                    
 
                                                        Required parameter.
                                                    
 
 
 
 
 
 - 
 
 
 
                                                            String
                                                        
 
                                                     
                                                    reason
                                                    
 
                                                        Required parameter.
                                                    
 
 
 
 
 
 
 
 
 
 
 
 
 Since:
                                    04-29-2019
                                
 
 
 
 
 
 
 
 Data getNextEmailBlock(boolean flagAsNotified)
 
 
 
                                    Returns the next (chronological) email block, flagging it as notified.  The data contains these properties: email, statusCode, reason, blocks, resets, palId, palName.  Returns null if no more blocks.
                                
 
 
 Parameters:
 
 
 
 - 
 
 
 
                                                            boolean
                                                        
 
                                                     
                                                    flagAsNotified
                                                    
 
                                                        Required parameter.
                                                    
 
 
 
 
 
 
 
 
 
 
 Returns: 
                                        
 
 Data
 
 
 
 
 
 
 
 
 Since:
                                    01-12-2016
                                
 
 
 
 
 
 
 
 SystemDataView getSubscribers(String service)
 
 
 
                                    Provides access to subscribers for the given service.
                                
 
 
 Parameters:
 
 
 
 - 
 
 
 
                                                            String
                                                        
 
                                                     
                                                    service
                                                    
 
                                                        Required parameter.
                                                    
 
 
                                                        Allowed values: DSN, REPLY, EBLOCK.
                                                    
 
 
 
 
 
 
 
 
 Returns: 
                                        
 
 SystemDataView
 
 
 
 
 
 
 
 DataList Name: SystemSubscribers
 
 
 
 | DataList Keys/Column Name | 
 Column Type | 
 Read Only | 
 
 
 
 
 
 
 | subscriptionId | 
 String | 
 
 
 
  
 
  | 
 
 
 
 
 
 
 
 
 | name | 
 String | 
 
 
 
  
 
  | 
 
 
 
 
 
 
 
 
 | createDate | 
 Date | 
 
 
 
  
 
  | 
 
 
 
 
 
 
 
 
 | palId | 
 String | 
 
 
 
  
 
  | 
 
 
 
 
 
 
 
 
 | palName | 
 String | 
 
 
 
  
 
  | 
 
 
 
 
 
 
 
 
 Since:
                                    12-11-2013
                                
 
 
 
 
 
 
 
 boolean isSubscriber(String palId, String service)
 
 
 
                                    Returns true if the specified Pal is a subscriber to the given service.
                                
 
 
 Parameters:
 
 
 
 - 
 
 
 
                                                            String
                                                        
 
                                                     
                                                    palId
                                                    
 
                                                        Required parameter.
                                                    
 
 
 
 
 
 - 
 
 
 
                                                            String
                                                        
 
                                                     
                                                    service
                                                    
 
                                                        Required parameter.
                                                    
 
 
                                                        Allowed values: DSN, REPLY, EBLOCK.
                                                    
 
 
 
 
 
 
 
 
 Returns: 
                                        
 
 
                                                boolean
                                            
 
 
 
 
 
 
 Since:
                                    04-28-2014
                                
 
 
 
 
 
 
 
 String toString()
 
 
 
                                    Returns a description of this object.
                                
 
 
 
 Returns: 
                                        
 
 
                                                String
                                            
 
 
 
 
 
 
 Since:
                                    12-11-2013