postal 0.1.4
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- data/.document +5 -0
- data/.gitignore +8 -0
- data/LICENSE +20 -0
- data/README.rdoc +108 -0
- data/Rakefile +60 -0
- data/VERSION +1 -0
- data/lib/postal.rb +47 -0
- data/lib/postal/base.rb +47 -0
- data/lib/postal/list.rb +28 -0
- data/lib/postal/lmapi/lmapi.rb +1311 -0
- data/lib/postal/lmapi/lmapi_driver.rb +687 -0
- data/lib/postal/lmapi/lmapi_mapping_registry.rb +1237 -0
- data/lib/postal/mailing.rb +171 -0
- data/lib/postal/member.rb +141 -0
- data/postal.gemspec +66 -0
- data/test/list_test.rb +20 -0
- data/test/lmapiClient.rb +854 -0
- data/test/lyris_sample.yml +16 -0
- data/test/mailing_test.rb +60 -0
- data/test/member_test.rb +89 -0
- data/test/postal_suite.rb +4 -0
- data/test/test_helper.rb +23 -0
- metadata +91 -0
|
@@ -0,0 +1,171 @@
|
|
|
1
|
+
module Postal
|
|
2
|
+
class Mailing < Postal::Base
|
|
3
|
+
|
|
4
|
+
class << self
|
|
5
|
+
|
|
6
|
+
end
|
|
7
|
+
|
|
8
|
+
|
|
9
|
+
DEFAULT_ATTRIBUTES = {:additional_headers => nil,
|
|
10
|
+
:attachments => nil,
|
|
11
|
+
:bypass_moderation => nil,
|
|
12
|
+
:campaign => nil,
|
|
13
|
+
:char_set_id => nil,
|
|
14
|
+
:detect_html => nil,
|
|
15
|
+
:dont_attempt_after_date => nil,
|
|
16
|
+
:enable_recovery => nil,
|
|
17
|
+
:from => nil,
|
|
18
|
+
:html_message => nil,
|
|
19
|
+
:html_section_encoding => nil,
|
|
20
|
+
:is_html_section_encoded => nil,
|
|
21
|
+
:is_text_section_encoded => nil,
|
|
22
|
+
:list_name => nil,
|
|
23
|
+
:recency_number_of_mailings => nil,
|
|
24
|
+
:recency_which => nil,
|
|
25
|
+
:reply_to => nil,
|
|
26
|
+
:resend_after_days => nil,
|
|
27
|
+
:sample_size => nil,
|
|
28
|
+
:scheduled_mailing_date => nil,
|
|
29
|
+
:subject => nil,
|
|
30
|
+
:text_message => nil,
|
|
31
|
+
:text_section_encoding => nil,
|
|
32
|
+
:title => nil,
|
|
33
|
+
:to => nil,
|
|
34
|
+
:track_opens => nil,
|
|
35
|
+
:rewrite_date_when_sent => nil }
|
|
36
|
+
|
|
37
|
+
attr_accessor :additional_headers,
|
|
38
|
+
:attachments,
|
|
39
|
+
:bypass_moderation,
|
|
40
|
+
:campaign,
|
|
41
|
+
:char_set_id,
|
|
42
|
+
:detect_html,
|
|
43
|
+
:dont_attempt_after_date,
|
|
44
|
+
:enable_recovery,
|
|
45
|
+
:from,
|
|
46
|
+
:html_message,
|
|
47
|
+
:html_section_encoding,
|
|
48
|
+
:is_html_section_encoded,
|
|
49
|
+
:is_text_section_encoded,
|
|
50
|
+
:list_name,
|
|
51
|
+
:recency_number_of_mailings,
|
|
52
|
+
:recency_which,
|
|
53
|
+
:reply_to,
|
|
54
|
+
:resend_after_days,
|
|
55
|
+
:sample_size,
|
|
56
|
+
:scheduled_mailing_date,
|
|
57
|
+
:subject,
|
|
58
|
+
:text_message,
|
|
59
|
+
:text_section_encoding,
|
|
60
|
+
:title,
|
|
61
|
+
:to,
|
|
62
|
+
:track_opens,
|
|
63
|
+
:rewrite_date_when_sent
|
|
64
|
+
|
|
65
|
+
# Create a new mailing ready to send
|
|
66
|
+
def initialize(args={})
|
|
67
|
+
args = DEFAULT_ATTRIBUTES.merge(args)
|
|
68
|
+
@to = args[:to]
|
|
69
|
+
@additional_headers = args[:additional_headers]
|
|
70
|
+
@attachments = args[:attachments]
|
|
71
|
+
@bypass_moderation = args[:bypass_moderation]
|
|
72
|
+
@campaign = args[:campaign]
|
|
73
|
+
@char_set_id = args[:char_set_id]
|
|
74
|
+
@detect_html = args[:detect_html]
|
|
75
|
+
@dont_attempt_after_date = args[:dont_attempt_after_date]
|
|
76
|
+
@enable_recovery = args[:enable_recovery]
|
|
77
|
+
@from = args[:from]
|
|
78
|
+
@html_message = args[:html_message]
|
|
79
|
+
@html_section_encoding = args[:html_section_encoding]
|
|
80
|
+
@is_html_section_encoded = args[:is_html_section_encoded]
|
|
81
|
+
@is_text_section_encoded = args[:is_text_section_encoded]
|
|
82
|
+
@list_name = args[:list_name] || Postal.options[:list_name]
|
|
83
|
+
@recency_number_of_mailings = args[:recency_number_of_mailings]
|
|
84
|
+
@recency_which = args[:recency_which]
|
|
85
|
+
@reply_to = args[:reply_to]
|
|
86
|
+
@resend_after_days = args[:resend_after_days]
|
|
87
|
+
@sample_size = args[:sample_size]
|
|
88
|
+
@scheduled_mailing_date = args[:scheduled_mailing_date]
|
|
89
|
+
@subject = args[:subject]
|
|
90
|
+
@text_message = args[:text_message]
|
|
91
|
+
@text_section_encoding = args[:text_section_encoding]
|
|
92
|
+
@title = args[:title]
|
|
93
|
+
@to = args[:to]
|
|
94
|
+
@track_opens = args[:track_opens]
|
|
95
|
+
@rewrite_date_when_sent = args[:rewrite_date_when_sent]
|
|
96
|
+
end
|
|
97
|
+
|
|
98
|
+
|
|
99
|
+
# Send the mailing
|
|
100
|
+
def send
|
|
101
|
+
if valid?
|
|
102
|
+
mail = Postal::Lmapi::MailingStruct.new(:additionalHeaders => @additional_headers,
|
|
103
|
+
:attachments => @attachments,
|
|
104
|
+
:bypassModeration => @bypass_moderation,
|
|
105
|
+
:campaign => @campaign,
|
|
106
|
+
:charSetID => @char_set_id,
|
|
107
|
+
:detectHtml => @detect_html,
|
|
108
|
+
:dontAttemptAfterDate => @dont_attempt_after_date,
|
|
109
|
+
:enableRecovery => @enable_recovery,
|
|
110
|
+
:from => @from,
|
|
111
|
+
:htmlMessage => @html_message,
|
|
112
|
+
:htmlSectionEncoding => @html_section_encoding,
|
|
113
|
+
:isHtmlSectionEncoded => @is_html_section_encoded,
|
|
114
|
+
:isTextSectionEncoded => @is_text_section_encoded,
|
|
115
|
+
:listName => @list_name,
|
|
116
|
+
:recencyNumberOfMailings => @recency_number_of_mailings,
|
|
117
|
+
:recencyWhich => @recency_which,
|
|
118
|
+
:replyTo => @reply_to,
|
|
119
|
+
:resendAfterDays => @resend_after_days,
|
|
120
|
+
:sampleSize => @sample_size,
|
|
121
|
+
:scheduledMailingDate => @scheduled_mailing_date,
|
|
122
|
+
:subject => @subject,
|
|
123
|
+
:textMessage => @text_message,
|
|
124
|
+
:textSectionEncoding => @text_section_encoding,
|
|
125
|
+
:title => @title,
|
|
126
|
+
:trackOpens => @track_opens,
|
|
127
|
+
:rewriteDateWhenSent => @rewrite_date_when_sent )
|
|
128
|
+
|
|
129
|
+
# are we sending to a list of email addresses or member ids
|
|
130
|
+
case @to.to_a.first
|
|
131
|
+
when ::String
|
|
132
|
+
emails = @to.to_a
|
|
133
|
+
member_ids = []
|
|
134
|
+
when ::Fixnum
|
|
135
|
+
emails = []
|
|
136
|
+
member_ids = @to.to_a
|
|
137
|
+
end
|
|
138
|
+
|
|
139
|
+
return Postal.driver.sendMailingDirect(emails,member_ids,mail)
|
|
140
|
+
else
|
|
141
|
+
return false
|
|
142
|
+
end
|
|
143
|
+
end
|
|
144
|
+
|
|
145
|
+
|
|
146
|
+
# same as send() but throws an error instead of just returning false
|
|
147
|
+
def send!
|
|
148
|
+
if id = send
|
|
149
|
+
return id
|
|
150
|
+
else
|
|
151
|
+
raise Postal::CouldNotSendMailing, 'Your mail was invalid and could not be sent.'
|
|
152
|
+
end
|
|
153
|
+
end
|
|
154
|
+
|
|
155
|
+
alias_method :save, :send
|
|
156
|
+
alias_method :save!, :send!
|
|
157
|
+
|
|
158
|
+
|
|
159
|
+
# Determines whether the email is valid to send
|
|
160
|
+
def valid?
|
|
161
|
+
return validate
|
|
162
|
+
end
|
|
163
|
+
|
|
164
|
+
|
|
165
|
+
# Determines whether we have everything we need to send an email
|
|
166
|
+
def validate
|
|
167
|
+
return (@list_name && @to && @subject) ? true : false
|
|
168
|
+
end
|
|
169
|
+
|
|
170
|
+
end
|
|
171
|
+
end
|
|
@@ -0,0 +1,141 @@
|
|
|
1
|
+
module Postal
|
|
2
|
+
class Member < Postal::Base
|
|
3
|
+
|
|
4
|
+
class << self
|
|
5
|
+
|
|
6
|
+
def find_by_filter(*args)
|
|
7
|
+
unless args.find { |arg| arg.match(/ListName/) }
|
|
8
|
+
args << "ListName=#{Postal.options[:list_name]}"
|
|
9
|
+
end
|
|
10
|
+
if soap_members = Postal.driver.selectMembers(args)
|
|
11
|
+
members = soap_members.collect do |member|
|
|
12
|
+
demographics = {}
|
|
13
|
+
member.demographics.each { |demo| demographics.merge!({ demo.name.to_sym => demo.value }) }
|
|
14
|
+
Member.new(:email => member.emailAddress, :name => member.fullName, :id => member.memberID, :list_name => member.listName, :demographics => demographics)
|
|
15
|
+
end
|
|
16
|
+
if members.size == 1
|
|
17
|
+
return members.first
|
|
18
|
+
else
|
|
19
|
+
return members
|
|
20
|
+
end
|
|
21
|
+
else
|
|
22
|
+
return nil
|
|
23
|
+
end
|
|
24
|
+
end
|
|
25
|
+
|
|
26
|
+
|
|
27
|
+
# Will NOT let you delete the entire list's members (only pass a ListName) Returns the number of members that were deleted, or nil if none were
|
|
28
|
+
def destroy(*args)
|
|
29
|
+
unless args.find { |arg| arg.match(/ListName/) }
|
|
30
|
+
args << "ListName=#{Postal.options[:list_name]}"
|
|
31
|
+
end
|
|
32
|
+
# raise Postal::WouldDeleteAllMembers, 'Not passing any parameters (other than ListName) to this method will delete ALL members of a list. If you really want to delete all members of this list, use destroy! instead.' if args.to_a.size == 1 && args.to_a.first.match(/ListName/)
|
|
33
|
+
return Postal.driver.deleteMembers(args)
|
|
34
|
+
end
|
|
35
|
+
|
|
36
|
+
|
|
37
|
+
# WILL let you delete an entire list's members (only pass a ListName). Returns the number of members that were deleted, or nil if none were
|
|
38
|
+
# def destroy!(*args)
|
|
39
|
+
# return Postal.driver.deleteMembers(args)
|
|
40
|
+
# end
|
|
41
|
+
|
|
42
|
+
|
|
43
|
+
protected
|
|
44
|
+
|
|
45
|
+
def find_by_email(args,options)
|
|
46
|
+
if args.size == 1
|
|
47
|
+
list_name = Postal.options[:list_name]
|
|
48
|
+
else
|
|
49
|
+
list_name = args.last
|
|
50
|
+
end
|
|
51
|
+
email = args.first
|
|
52
|
+
member_id = 0
|
|
53
|
+
|
|
54
|
+
begin
|
|
55
|
+
return Postal.driver.getMemberID(Postal::Lmapi::SimpleMemberStruct.new(list_name,member_id,email))
|
|
56
|
+
rescue SOAP::FaultError
|
|
57
|
+
return nil
|
|
58
|
+
end
|
|
59
|
+
end
|
|
60
|
+
|
|
61
|
+
|
|
62
|
+
def find_by_id(args,options)
|
|
63
|
+
member_id = args.first
|
|
64
|
+
return Postal.driver.getEmailFromMemberID(member_id)
|
|
65
|
+
end
|
|
66
|
+
|
|
67
|
+
|
|
68
|
+
# Find one or more members by name
|
|
69
|
+
def find_some(args,options={})
|
|
70
|
+
case args.first
|
|
71
|
+
when ::String
|
|
72
|
+
find_by_email(args,options)
|
|
73
|
+
when ::Fixnum
|
|
74
|
+
find_by_id(args,options)
|
|
75
|
+
when nil
|
|
76
|
+
find_by_struct(options)
|
|
77
|
+
end
|
|
78
|
+
end
|
|
79
|
+
|
|
80
|
+
end
|
|
81
|
+
|
|
82
|
+
DEFAULT_ATTRIBUTES = { :id => nil, :email => nil, :name => nil, :list_name => nil, :demographics => {} }
|
|
83
|
+
|
|
84
|
+
attr_accessor :id, :email, :name, :list_name, :demographics
|
|
85
|
+
|
|
86
|
+
|
|
87
|
+
# Create a new member instance
|
|
88
|
+
def initialize(attributes={})
|
|
89
|
+
attributes = DEFAULT_ATTRIBUTES.merge(attributes)
|
|
90
|
+
@id = attributes[:id]
|
|
91
|
+
@email = attributes[:email]
|
|
92
|
+
@name = attributes[:name]
|
|
93
|
+
@list_name = attributes[:list_name] || Postal.options[:list_name]
|
|
94
|
+
@demographics = attributes[:demographics]
|
|
95
|
+
end
|
|
96
|
+
|
|
97
|
+
|
|
98
|
+
# Save the member to Lyris and returns the member ID that was created. Returns `false` if the save fails.
|
|
99
|
+
def save
|
|
100
|
+
# if @list is a list Object then get the name out (all Lyris wants is the name)
|
|
101
|
+
list_name = @list_name
|
|
102
|
+
begin
|
|
103
|
+
@id = Postal.driver.createSingleMember(@email, @name, list_name)
|
|
104
|
+
update_attributes(@demographics) unless @demographics.empty?
|
|
105
|
+
return @id
|
|
106
|
+
rescue SOAP::FaultError
|
|
107
|
+
return false
|
|
108
|
+
end
|
|
109
|
+
end
|
|
110
|
+
|
|
111
|
+
|
|
112
|
+
# Saves the member to Lyris and returns the member ID that was created. Throws an error if the save fails.
|
|
113
|
+
def save!
|
|
114
|
+
if id = save
|
|
115
|
+
return id
|
|
116
|
+
else
|
|
117
|
+
raise Postal::CouldNotCreateMember, 'Could not create a new member. The most likely cause is that the specified list already contains this email address.'
|
|
118
|
+
end
|
|
119
|
+
end
|
|
120
|
+
|
|
121
|
+
|
|
122
|
+
# Update the demographics for a user
|
|
123
|
+
def update_attributes(attributes={})
|
|
124
|
+
list_name = @list_name
|
|
125
|
+
demos = attributes.collect { |key,value| Postal::Lmapi::KeyValueType.new(value,key.to_s) }
|
|
126
|
+
member = Postal::Lmapi::SimpleMemberStruct.new(list_name, @id, @email)
|
|
127
|
+
return Postal.driver.updateMemberDemographics(member,demos)
|
|
128
|
+
end
|
|
129
|
+
|
|
130
|
+
|
|
131
|
+
# Throw an error if demographics couldn't be saved
|
|
132
|
+
def update_attributes!(attributes={})
|
|
133
|
+
if update_attributes(attributes)
|
|
134
|
+
return true
|
|
135
|
+
else
|
|
136
|
+
raise Postal::CouldNotUpdateMember, 'Could not update the member. The most likely cause is that your demographics are invalid.'
|
|
137
|
+
end
|
|
138
|
+
end
|
|
139
|
+
|
|
140
|
+
end
|
|
141
|
+
end
|
data/postal.gemspec
ADDED
|
@@ -0,0 +1,66 @@
|
|
|
1
|
+
# -*- encoding: utf-8 -*-
|
|
2
|
+
|
|
3
|
+
Gem::Specification.new do |s|
|
|
4
|
+
s.name = %q{postal}
|
|
5
|
+
s.version = "0.1.4"
|
|
6
|
+
|
|
7
|
+
s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
|
|
8
|
+
s.authors = ["Rob Cameron"]
|
|
9
|
+
s.date = %q{2009-08-31}
|
|
10
|
+
s.description = %q{Lyris is an enterprise email service. Postal makes it easy for Ruby to talk to Lyris's API.}
|
|
11
|
+
s.email = %q{cannikinn@gmail.com}
|
|
12
|
+
s.extra_rdoc_files = [
|
|
13
|
+
"LICENSE",
|
|
14
|
+
"README.rdoc"
|
|
15
|
+
]
|
|
16
|
+
s.files = [
|
|
17
|
+
".document",
|
|
18
|
+
".gitignore",
|
|
19
|
+
"LICENSE",
|
|
20
|
+
"README.rdoc",
|
|
21
|
+
"Rakefile",
|
|
22
|
+
"VERSION",
|
|
23
|
+
"lib/postal.rb",
|
|
24
|
+
"lib/postal/base.rb",
|
|
25
|
+
"lib/postal/list.rb",
|
|
26
|
+
"lib/postal/lmapi/lmapi.rb",
|
|
27
|
+
"lib/postal/lmapi/lmapi_driver.rb",
|
|
28
|
+
"lib/postal/lmapi/lmapi_mapping_registry.rb",
|
|
29
|
+
"lib/postal/mailing.rb",
|
|
30
|
+
"lib/postal/member.rb",
|
|
31
|
+
"postal.gemspec",
|
|
32
|
+
"test/list_test.rb",
|
|
33
|
+
"test/lmapiClient.rb",
|
|
34
|
+
"test/lyris_sample.yml",
|
|
35
|
+
"test/mailing_test.rb",
|
|
36
|
+
"test/member_test.rb",
|
|
37
|
+
"test/postal_suite.rb",
|
|
38
|
+
"test/test_helper.rb"
|
|
39
|
+
]
|
|
40
|
+
s.homepage = %q{http://github.com/cannikin/postal}
|
|
41
|
+
s.rdoc_options = ["--charset=UTF-8"]
|
|
42
|
+
s.require_paths = ["lib"]
|
|
43
|
+
s.rubygems_version = %q{1.3.5}
|
|
44
|
+
s.summary = %q{Gem for talking to the Lyris API}
|
|
45
|
+
s.test_files = [
|
|
46
|
+
"test/list_test.rb",
|
|
47
|
+
"test/lmapiClient.rb",
|
|
48
|
+
"test/mailing_test.rb",
|
|
49
|
+
"test/member_test.rb",
|
|
50
|
+
"test/postal_suite.rb",
|
|
51
|
+
"test/test_helper.rb"
|
|
52
|
+
]
|
|
53
|
+
|
|
54
|
+
if s.respond_to? :specification_version then
|
|
55
|
+
current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
|
|
56
|
+
s.specification_version = 3
|
|
57
|
+
|
|
58
|
+
if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
|
|
59
|
+
s.add_runtime_dependency(%q<soap4r>, [">= 1.5.8"])
|
|
60
|
+
else
|
|
61
|
+
s.add_dependency(%q<soap4r>, [">= 1.5.8"])
|
|
62
|
+
end
|
|
63
|
+
else
|
|
64
|
+
s.add_dependency(%q<soap4r>, [">= 1.5.8"])
|
|
65
|
+
end
|
|
66
|
+
end
|
data/test/list_test.rb
ADDED
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
require 'test_helper'
|
|
2
|
+
|
|
3
|
+
class ListTest < Test::Unit::TestCase
|
|
4
|
+
|
|
5
|
+
@config = nil
|
|
6
|
+
|
|
7
|
+
def setup
|
|
8
|
+
load_config
|
|
9
|
+
end
|
|
10
|
+
|
|
11
|
+
# lists
|
|
12
|
+
def test_can_find_list_that_exists
|
|
13
|
+
assert Postal::List.find(@config['list_name'])
|
|
14
|
+
end
|
|
15
|
+
|
|
16
|
+
def test_returns_nil_if_list_not_found
|
|
17
|
+
assert_nil Postal::List.find('foo')
|
|
18
|
+
end
|
|
19
|
+
|
|
20
|
+
end
|
data/test/lmapiClient.rb
ADDED
|
@@ -0,0 +1,854 @@
|
|
|
1
|
+
#!/usr/bin/env ruby
|
|
2
|
+
|
|
3
|
+
# Sample client generated by wsdl2ruby
|
|
4
|
+
|
|
5
|
+
# require 'lmapiDriver.rb'
|
|
6
|
+
|
|
7
|
+
endpoint_url = ARGV.shift
|
|
8
|
+
obj = LmapiSoap.new(endpoint_url)
|
|
9
|
+
|
|
10
|
+
# run ruby with -d to see SOAP wiredumps.
|
|
11
|
+
obj.wiredump_dev = STDERR if $DEBUG
|
|
12
|
+
|
|
13
|
+
# SYNOPSIS
|
|
14
|
+
# ApiVersion
|
|
15
|
+
#
|
|
16
|
+
# ARGS
|
|
17
|
+
# N/A
|
|
18
|
+
#
|
|
19
|
+
# RETURNS
|
|
20
|
+
# v_return C_String - {http://www.w3.org/2001/XMLSchema}string
|
|
21
|
+
#
|
|
22
|
+
|
|
23
|
+
puts obj.apiVersion
|
|
24
|
+
|
|
25
|
+
# SYNOPSIS
|
|
26
|
+
# CurrentUserEmailAddress
|
|
27
|
+
#
|
|
28
|
+
# ARGS
|
|
29
|
+
# N/A
|
|
30
|
+
#
|
|
31
|
+
# RETURNS
|
|
32
|
+
# v_return C_String - {http://www.w3.org/2001/XMLSchema}string
|
|
33
|
+
#
|
|
34
|
+
|
|
35
|
+
puts obj.currentUserEmailAddress
|
|
36
|
+
|
|
37
|
+
# SYNOPSIS
|
|
38
|
+
# DeleteMembers(filterCriteriaArray)
|
|
39
|
+
#
|
|
40
|
+
# ARGS
|
|
41
|
+
# filterCriteriaArray ArrayOfstring - {http://www.lyris.com/lmapi}ArrayOfstring
|
|
42
|
+
#
|
|
43
|
+
# RETURNS
|
|
44
|
+
# v_return Int - {http://www.w3.org/2001/XMLSchema}int
|
|
45
|
+
#
|
|
46
|
+
filterCriteriaArray = nil
|
|
47
|
+
puts obj.deleteMembers(filterCriteriaArray)
|
|
48
|
+
|
|
49
|
+
# SYNOPSIS
|
|
50
|
+
# GetMemberID(simpleMemberStructIn)
|
|
51
|
+
#
|
|
52
|
+
# ARGS
|
|
53
|
+
# simpleMemberStructIn SimpleMemberStruct - {http://tempuri.org/ns1.xsd}SimpleMemberStruct
|
|
54
|
+
#
|
|
55
|
+
# RETURNS
|
|
56
|
+
# v_return Int - {http://www.w3.org/2001/XMLSchema}int
|
|
57
|
+
#
|
|
58
|
+
simpleMemberStructIn = nil
|
|
59
|
+
puts obj.getMemberID(simpleMemberStructIn)
|
|
60
|
+
|
|
61
|
+
# SYNOPSIS
|
|
62
|
+
# CreateSingleMember(emailAddress, fullName, listName)
|
|
63
|
+
#
|
|
64
|
+
# ARGS
|
|
65
|
+
# emailAddress C_String - {http://www.w3.org/2001/XMLSchema}string
|
|
66
|
+
# fullName C_String - {http://www.w3.org/2001/XMLSchema}string
|
|
67
|
+
# listName C_String - {http://www.w3.org/2001/XMLSchema}string
|
|
68
|
+
#
|
|
69
|
+
# RETURNS
|
|
70
|
+
# v_return Int - {http://www.w3.org/2001/XMLSchema}int
|
|
71
|
+
#
|
|
72
|
+
emailAddress = fullName = listName = nil
|
|
73
|
+
puts obj.createSingleMember(emailAddress, fullName, listName)
|
|
74
|
+
|
|
75
|
+
# SYNOPSIS
|
|
76
|
+
# CreateManyMembers(arrayOfTinyMemberStructIn, listName, skipBadRecords)
|
|
77
|
+
#
|
|
78
|
+
# ARGS
|
|
79
|
+
# arrayOfTinyMemberStructIn ArrayOfTinyMemberStruct - {http://www.lyris.com/lmapi}ArrayOfTinyMemberStruct
|
|
80
|
+
# listName C_String - {http://www.w3.org/2001/XMLSchema}string
|
|
81
|
+
# skipBadRecords Boolean - {http://www.w3.org/2001/XMLSchema}boolean
|
|
82
|
+
#
|
|
83
|
+
# RETURNS
|
|
84
|
+
# v_return Int - {http://www.w3.org/2001/XMLSchema}int
|
|
85
|
+
#
|
|
86
|
+
arrayOfTinyMemberStructIn = listName = skipBadRecords = nil
|
|
87
|
+
puts obj.createManyMembers(arrayOfTinyMemberStructIn, listName, skipBadRecords)
|
|
88
|
+
|
|
89
|
+
# SYNOPSIS
|
|
90
|
+
# SqlSelect(sqlStatement)
|
|
91
|
+
#
|
|
92
|
+
# ARGS
|
|
93
|
+
# sqlStatement C_String - {http://www.w3.org/2001/XMLSchema}string
|
|
94
|
+
#
|
|
95
|
+
# RETURNS
|
|
96
|
+
# v_return ArrayOfArrayOfstring - {http://www.lyris.com/lmapi}ArrayOfArrayOfstring
|
|
97
|
+
#
|
|
98
|
+
sqlStatement = nil
|
|
99
|
+
puts obj.sqlSelect(sqlStatement)
|
|
100
|
+
|
|
101
|
+
# SYNOPSIS
|
|
102
|
+
# SqlInsert(sqlStatement, dataArray, returnID)
|
|
103
|
+
#
|
|
104
|
+
# ARGS
|
|
105
|
+
# sqlStatement C_String - {http://www.w3.org/2001/XMLSchema}string
|
|
106
|
+
# dataArray ArrayOfKeyValueType - {http://www.lyris.com/lmapi}ArrayOfKeyValueType
|
|
107
|
+
# returnID Boolean - {http://www.w3.org/2001/XMLSchema}boolean
|
|
108
|
+
#
|
|
109
|
+
# RETURNS
|
|
110
|
+
# v_return Int - {http://www.w3.org/2001/XMLSchema}int
|
|
111
|
+
#
|
|
112
|
+
sqlStatement = dataArray = returnID = nil
|
|
113
|
+
puts obj.sqlInsert(sqlStatement, dataArray, returnID)
|
|
114
|
+
|
|
115
|
+
# SYNOPSIS
|
|
116
|
+
# SqlUpdate(sqlStatement, dataArray, sqlWhere)
|
|
117
|
+
#
|
|
118
|
+
# ARGS
|
|
119
|
+
# sqlStatement C_String - {http://www.w3.org/2001/XMLSchema}string
|
|
120
|
+
# dataArray ArrayOfKeyValueType - {http://www.lyris.com/lmapi}ArrayOfKeyValueType
|
|
121
|
+
# sqlWhere C_String - {http://www.w3.org/2001/XMLSchema}string
|
|
122
|
+
#
|
|
123
|
+
# RETURNS
|
|
124
|
+
# v_return Boolean - {http://www.w3.org/2001/XMLSchema}boolean
|
|
125
|
+
#
|
|
126
|
+
sqlStatement = dataArray = sqlWhere = nil
|
|
127
|
+
puts obj.sqlUpdate(sqlStatement, dataArray, sqlWhere)
|
|
128
|
+
|
|
129
|
+
# SYNOPSIS
|
|
130
|
+
# SqlDelete(tableName, sqlWhere)
|
|
131
|
+
#
|
|
132
|
+
# ARGS
|
|
133
|
+
# tableName C_String - {http://www.w3.org/2001/XMLSchema}string
|
|
134
|
+
# sqlWhere C_String - {http://www.w3.org/2001/XMLSchema}string
|
|
135
|
+
#
|
|
136
|
+
# RETURNS
|
|
137
|
+
# v_return Boolean - {http://www.w3.org/2001/XMLSchema}boolean
|
|
138
|
+
#
|
|
139
|
+
tableName = sqlWhere = nil
|
|
140
|
+
puts obj.sqlDelete(tableName, sqlWhere)
|
|
141
|
+
|
|
142
|
+
# SYNOPSIS
|
|
143
|
+
# UpdateMemberPassword(simpleMemberStructIn, password)
|
|
144
|
+
#
|
|
145
|
+
# ARGS
|
|
146
|
+
# simpleMemberStructIn SimpleMemberStruct - {http://tempuri.org/ns1.xsd}SimpleMemberStruct
|
|
147
|
+
# password C_String - {http://www.w3.org/2001/XMLSchema}string
|
|
148
|
+
#
|
|
149
|
+
# RETURNS
|
|
150
|
+
# v_return Boolean - {http://www.w3.org/2001/XMLSchema}boolean
|
|
151
|
+
#
|
|
152
|
+
simpleMemberStructIn = password = nil
|
|
153
|
+
puts obj.updateMemberPassword(simpleMemberStructIn, password)
|
|
154
|
+
|
|
155
|
+
# SYNOPSIS
|
|
156
|
+
# CheckMemberPassword(simpleMemberStructIn, password)
|
|
157
|
+
#
|
|
158
|
+
# ARGS
|
|
159
|
+
# simpleMemberStructIn SimpleMemberStruct - {http://tempuri.org/ns1.xsd}SimpleMemberStruct
|
|
160
|
+
# password C_String - {http://www.w3.org/2001/XMLSchema}string
|
|
161
|
+
#
|
|
162
|
+
# RETURNS
|
|
163
|
+
# v_return Boolean - {http://www.w3.org/2001/XMLSchema}boolean
|
|
164
|
+
#
|
|
165
|
+
simpleMemberStructIn = password = nil
|
|
166
|
+
puts obj.checkMemberPassword(simpleMemberStructIn, password)
|
|
167
|
+
|
|
168
|
+
# SYNOPSIS
|
|
169
|
+
# CopyMember(simpleMemberStructIn, emailAddress, fullName, listName)
|
|
170
|
+
#
|
|
171
|
+
# ARGS
|
|
172
|
+
# simpleMemberStructIn SimpleMemberStruct - {http://tempuri.org/ns1.xsd}SimpleMemberStruct
|
|
173
|
+
# emailAddress C_String - {http://www.w3.org/2001/XMLSchema}string
|
|
174
|
+
# fullName C_String - {http://www.w3.org/2001/XMLSchema}string
|
|
175
|
+
# listName C_String - {http://www.w3.org/2001/XMLSchema}string
|
|
176
|
+
#
|
|
177
|
+
# RETURNS
|
|
178
|
+
# v_return Int - {http://www.w3.org/2001/XMLSchema}int
|
|
179
|
+
#
|
|
180
|
+
simpleMemberStructIn = emailAddress = fullName = listName = nil
|
|
181
|
+
puts obj.copyMember(simpleMemberStructIn, emailAddress, fullName, listName)
|
|
182
|
+
|
|
183
|
+
# SYNOPSIS
|
|
184
|
+
# CreateList(listTypeEnumIn, listName, shortDescription, adminName, adminEmail, adminPassword, topic)
|
|
185
|
+
#
|
|
186
|
+
# ARGS
|
|
187
|
+
# listTypeEnumIn ListTypeEnum - {http://tempuri.org/ns1.xsd}ListTypeEnum
|
|
188
|
+
# listName C_String - {http://www.w3.org/2001/XMLSchema}string
|
|
189
|
+
# shortDescription C_String - {http://www.w3.org/2001/XMLSchema}string
|
|
190
|
+
# adminName C_String - {http://www.w3.org/2001/XMLSchema}string
|
|
191
|
+
# adminEmail C_String - {http://www.w3.org/2001/XMLSchema}string
|
|
192
|
+
# adminPassword C_String - {http://www.w3.org/2001/XMLSchema}string
|
|
193
|
+
# topic C_String - {http://www.w3.org/2001/XMLSchema}string
|
|
194
|
+
#
|
|
195
|
+
# RETURNS
|
|
196
|
+
# v_return Int - {http://www.w3.org/2001/XMLSchema}int
|
|
197
|
+
#
|
|
198
|
+
listTypeEnumIn = listName = shortDescription = adminName = adminEmail = adminPassword = topic = nil
|
|
199
|
+
puts obj.createList(listTypeEnumIn, listName, shortDescription, adminName, adminEmail, adminPassword, topic)
|
|
200
|
+
|
|
201
|
+
# SYNOPSIS
|
|
202
|
+
# DeleteList(listName)
|
|
203
|
+
#
|
|
204
|
+
# ARGS
|
|
205
|
+
# listName C_String - {http://www.w3.org/2001/XMLSchema}string
|
|
206
|
+
#
|
|
207
|
+
# RETURNS
|
|
208
|
+
# v_return Boolean - {http://www.w3.org/2001/XMLSchema}boolean
|
|
209
|
+
#
|
|
210
|
+
listName = nil
|
|
211
|
+
puts obj.deleteList(listName)
|
|
212
|
+
|
|
213
|
+
# SYNOPSIS
|
|
214
|
+
# EmailOnWhatLists(emailAddress)
|
|
215
|
+
#
|
|
216
|
+
# ARGS
|
|
217
|
+
# emailAddress C_String - {http://www.w3.org/2001/XMLSchema}string
|
|
218
|
+
#
|
|
219
|
+
# RETURNS
|
|
220
|
+
# v_return ArrayOfstring - {http://www.lyris.com/lmapi}ArrayOfstring
|
|
221
|
+
#
|
|
222
|
+
emailAddress = nil
|
|
223
|
+
puts obj.emailOnWhatLists(emailAddress)
|
|
224
|
+
|
|
225
|
+
# SYNOPSIS
|
|
226
|
+
# EmailPasswordOnWhatLists(emailAddress, password)
|
|
227
|
+
#
|
|
228
|
+
# ARGS
|
|
229
|
+
# emailAddress C_String - {http://www.w3.org/2001/XMLSchema}string
|
|
230
|
+
# password C_String - {http://www.w3.org/2001/XMLSchema}string
|
|
231
|
+
#
|
|
232
|
+
# RETURNS
|
|
233
|
+
# v_return ArrayOfstring - {http://www.lyris.com/lmapi}ArrayOfstring
|
|
234
|
+
#
|
|
235
|
+
emailAddress = password = nil
|
|
236
|
+
puts obj.emailPasswordOnWhatLists(emailAddress, password)
|
|
237
|
+
|
|
238
|
+
# SYNOPSIS
|
|
239
|
+
# CreateListAdmin(adminEmail, adminPassword, adminListName, adminFullName, receiveListAdminMail, receiveModerationNotification, bypassListModeration)
|
|
240
|
+
#
|
|
241
|
+
# ARGS
|
|
242
|
+
# adminEmail C_String - {http://www.w3.org/2001/XMLSchema}string
|
|
243
|
+
# adminPassword C_String - {http://www.w3.org/2001/XMLSchema}string
|
|
244
|
+
# adminListName C_String - {http://www.w3.org/2001/XMLSchema}string
|
|
245
|
+
# adminFullName C_String - {http://www.w3.org/2001/XMLSchema}string
|
|
246
|
+
# receiveListAdminMail Boolean - {http://www.w3.org/2001/XMLSchema}boolean
|
|
247
|
+
# receiveModerationNotification Boolean - {http://www.w3.org/2001/XMLSchema}boolean
|
|
248
|
+
# bypassListModeration Boolean - {http://www.w3.org/2001/XMLSchema}boolean
|
|
249
|
+
#
|
|
250
|
+
# RETURNS
|
|
251
|
+
# v_return Int - {http://www.w3.org/2001/XMLSchema}int
|
|
252
|
+
#
|
|
253
|
+
adminEmail = adminPassword = adminListName = adminFullName = receiveListAdminMail = receiveModerationNotification = bypassListModeration = nil
|
|
254
|
+
puts obj.createListAdmin(adminEmail, adminPassword, adminListName, adminFullName, receiveListAdminMail, receiveModerationNotification, bypassListModeration)
|
|
255
|
+
|
|
256
|
+
# SYNOPSIS
|
|
257
|
+
# CreateMemberBan(memberBanStructIn)
|
|
258
|
+
#
|
|
259
|
+
# ARGS
|
|
260
|
+
# memberBanStructIn MemberBanStruct - {http://tempuri.org/ns1.xsd}MemberBanStruct
|
|
261
|
+
#
|
|
262
|
+
# RETURNS
|
|
263
|
+
# v_return Int - {http://www.w3.org/2001/XMLSchema}int
|
|
264
|
+
#
|
|
265
|
+
memberBanStructIn = nil
|
|
266
|
+
puts obj.createMemberBan(memberBanStructIn)
|
|
267
|
+
|
|
268
|
+
# SYNOPSIS
|
|
269
|
+
# GetEmailFromMemberID(memberID)
|
|
270
|
+
#
|
|
271
|
+
# ARGS
|
|
272
|
+
# memberID Int - {http://www.w3.org/2001/XMLSchema}int
|
|
273
|
+
#
|
|
274
|
+
# RETURNS
|
|
275
|
+
# v_return C_String - {http://www.w3.org/2001/XMLSchema}string
|
|
276
|
+
#
|
|
277
|
+
memberID = nil
|
|
278
|
+
puts obj.getEmailFromMemberID(memberID)
|
|
279
|
+
|
|
280
|
+
# SYNOPSIS
|
|
281
|
+
# GetListID(listName)
|
|
282
|
+
#
|
|
283
|
+
# ARGS
|
|
284
|
+
# listName C_String - {http://www.w3.org/2001/XMLSchema}string
|
|
285
|
+
#
|
|
286
|
+
# RETURNS
|
|
287
|
+
# v_return Int - {http://www.w3.org/2001/XMLSchema}int
|
|
288
|
+
#
|
|
289
|
+
listName = nil
|
|
290
|
+
puts obj.getListID(listName)
|
|
291
|
+
|
|
292
|
+
# SYNOPSIS
|
|
293
|
+
# GetListnameFromMemberID(memberID)
|
|
294
|
+
#
|
|
295
|
+
# ARGS
|
|
296
|
+
# memberID Int - {http://www.w3.org/2001/XMLSchema}int
|
|
297
|
+
#
|
|
298
|
+
# RETURNS
|
|
299
|
+
# v_return C_String - {http://www.w3.org/2001/XMLSchema}string
|
|
300
|
+
#
|
|
301
|
+
memberID = nil
|
|
302
|
+
puts obj.getListnameFromMemberID(memberID)
|
|
303
|
+
|
|
304
|
+
# SYNOPSIS
|
|
305
|
+
# ImportContent(contentID)
|
|
306
|
+
#
|
|
307
|
+
# ARGS
|
|
308
|
+
# contentID Int - {http://www.w3.org/2001/XMLSchema}int
|
|
309
|
+
#
|
|
310
|
+
# RETURNS
|
|
311
|
+
# v_return SimpleMailingStruct - {http://tempuri.org/ns1.xsd}SimpleMailingStruct
|
|
312
|
+
#
|
|
313
|
+
contentID = nil
|
|
314
|
+
puts obj.importContent(contentID)
|
|
315
|
+
|
|
316
|
+
# SYNOPSIS
|
|
317
|
+
# SelectMembers(filterCriteriaArray)
|
|
318
|
+
#
|
|
319
|
+
# ARGS
|
|
320
|
+
# filterCriteriaArray ArrayOfstring - {http://www.lyris.com/lmapi}ArrayOfstring
|
|
321
|
+
#
|
|
322
|
+
# RETURNS
|
|
323
|
+
# v_return ArrayOfMemberStruct - {http://www.lyris.com/lmapi}ArrayOfMemberStruct
|
|
324
|
+
#
|
|
325
|
+
filterCriteriaArray = nil
|
|
326
|
+
puts obj.selectMembers(filterCriteriaArray)
|
|
327
|
+
|
|
328
|
+
# SYNOPSIS
|
|
329
|
+
# SelectSimpleMembers(filterCriteriaArray)
|
|
330
|
+
#
|
|
331
|
+
# ARGS
|
|
332
|
+
# filterCriteriaArray ArrayOfstring - {http://www.lyris.com/lmapi}ArrayOfstring
|
|
333
|
+
#
|
|
334
|
+
# RETURNS
|
|
335
|
+
# v_return ArrayOfSimpleMemberStruct - {http://www.lyris.com/lmapi}ArrayOfSimpleMemberStruct
|
|
336
|
+
#
|
|
337
|
+
filterCriteriaArray = nil
|
|
338
|
+
puts obj.selectSimpleMembers(filterCriteriaArray)
|
|
339
|
+
|
|
340
|
+
# SYNOPSIS
|
|
341
|
+
# SendMailing(segmentID, mailingStructIn)
|
|
342
|
+
#
|
|
343
|
+
# ARGS
|
|
344
|
+
# segmentID Int - {http://www.w3.org/2001/XMLSchema}int
|
|
345
|
+
# mailingStructIn MailingStruct - {http://tempuri.org/ns1.xsd}MailingStruct
|
|
346
|
+
#
|
|
347
|
+
# RETURNS
|
|
348
|
+
# v_return Int - {http://www.w3.org/2001/XMLSchema}int
|
|
349
|
+
#
|
|
350
|
+
segmentID = mailingStructIn = nil
|
|
351
|
+
puts obj.sendMailing(segmentID, mailingStructIn)
|
|
352
|
+
|
|
353
|
+
# SYNOPSIS
|
|
354
|
+
# MailingStatus(mailingID)
|
|
355
|
+
#
|
|
356
|
+
# ARGS
|
|
357
|
+
# mailingID Int - {http://www.w3.org/2001/XMLSchema}int
|
|
358
|
+
#
|
|
359
|
+
# RETURNS
|
|
360
|
+
# v_return C_String - {http://www.w3.org/2001/XMLSchema}string
|
|
361
|
+
#
|
|
362
|
+
mailingID = nil
|
|
363
|
+
puts obj.mailingStatus(mailingID)
|
|
364
|
+
|
|
365
|
+
# SYNOPSIS
|
|
366
|
+
# ScheduleMailing(segmentID, sendDate, mailingStructIn)
|
|
367
|
+
#
|
|
368
|
+
# ARGS
|
|
369
|
+
# segmentID Int - {http://www.w3.org/2001/XMLSchema}int
|
|
370
|
+
# sendDate DateTime - {http://www.w3.org/2001/XMLSchema}dateTime
|
|
371
|
+
# mailingStructIn MailingStruct - {http://tempuri.org/ns1.xsd}MailingStruct
|
|
372
|
+
#
|
|
373
|
+
# RETURNS
|
|
374
|
+
# v_return Int - {http://www.w3.org/2001/XMLSchema}int
|
|
375
|
+
#
|
|
376
|
+
segmentID = sendDate = mailingStructIn = nil
|
|
377
|
+
puts obj.scheduleMailing(segmentID, sendDate, mailingStructIn)
|
|
378
|
+
|
|
379
|
+
# SYNOPSIS
|
|
380
|
+
# ModerateMailing(moderateID, accept, sendRejectMessage)
|
|
381
|
+
#
|
|
382
|
+
# ARGS
|
|
383
|
+
# moderateID Int - {http://www.w3.org/2001/XMLSchema}int
|
|
384
|
+
# accept Boolean - {http://www.w3.org/2001/XMLSchema}boolean
|
|
385
|
+
# sendRejectMessage Boolean - {http://www.w3.org/2001/XMLSchema}boolean
|
|
386
|
+
#
|
|
387
|
+
# RETURNS
|
|
388
|
+
# v_return Boolean - {http://www.w3.org/2001/XMLSchema}boolean
|
|
389
|
+
#
|
|
390
|
+
moderateID = accept = sendRejectMessage = nil
|
|
391
|
+
puts obj.moderateMailing(moderateID, accept, sendRejectMessage)
|
|
392
|
+
|
|
393
|
+
# SYNOPSIS
|
|
394
|
+
# SelectContent(filterCriteriaArray)
|
|
395
|
+
#
|
|
396
|
+
# ARGS
|
|
397
|
+
# filterCriteriaArray ArrayOfstring - {http://www.lyris.com/lmapi}ArrayOfstring
|
|
398
|
+
#
|
|
399
|
+
# RETURNS
|
|
400
|
+
# v_return ArrayOfContentStruct - {http://www.lyris.com/lmapi}ArrayOfContentStruct
|
|
401
|
+
#
|
|
402
|
+
filterCriteriaArray = nil
|
|
403
|
+
puts obj.selectContent(filterCriteriaArray)
|
|
404
|
+
|
|
405
|
+
# SYNOPSIS
|
|
406
|
+
# SelectLists(listName, siteName)
|
|
407
|
+
#
|
|
408
|
+
# ARGS
|
|
409
|
+
# listName C_String - {http://www.w3.org/2001/XMLSchema}string
|
|
410
|
+
# siteName C_String - {http://www.w3.org/2001/XMLSchema}string
|
|
411
|
+
#
|
|
412
|
+
# RETURNS
|
|
413
|
+
# v_return ArrayOfListStruct - {http://www.lyris.com/lmapi}ArrayOfListStruct
|
|
414
|
+
#
|
|
415
|
+
listName = siteName = nil
|
|
416
|
+
puts obj.selectLists(listName, siteName)
|
|
417
|
+
|
|
418
|
+
# SYNOPSIS
|
|
419
|
+
# SelectSegments(filterCriteriaArray)
|
|
420
|
+
#
|
|
421
|
+
# ARGS
|
|
422
|
+
# filterCriteriaArray ArrayOfstring - {http://www.lyris.com/lmapi}ArrayOfstring
|
|
423
|
+
#
|
|
424
|
+
# RETURNS
|
|
425
|
+
# v_return ArrayOfSegmentStruct - {http://www.lyris.com/lmapi}ArrayOfSegmentStruct
|
|
426
|
+
#
|
|
427
|
+
filterCriteriaArray = nil
|
|
428
|
+
puts obj.selectSegments(filterCriteriaArray)
|
|
429
|
+
|
|
430
|
+
# SYNOPSIS
|
|
431
|
+
# SendMailingDirect(emailAddressArray, memberIDArray, mailingStructIn)
|
|
432
|
+
#
|
|
433
|
+
# ARGS
|
|
434
|
+
# emailAddressArray ArrayOfstring - {http://www.lyris.com/lmapi}ArrayOfstring
|
|
435
|
+
# memberIDArray ArrayOfint - {http://www.lyris.com/lmapi}ArrayOfint
|
|
436
|
+
# mailingStructIn MailingStruct - {http://tempuri.org/ns1.xsd}MailingStruct
|
|
437
|
+
#
|
|
438
|
+
# RETURNS
|
|
439
|
+
# v_return Int - {http://www.w3.org/2001/XMLSchema}int
|
|
440
|
+
#
|
|
441
|
+
emailAddressArray = memberIDArray = mailingStructIn = nil
|
|
442
|
+
puts obj.sendMailingDirect(emailAddressArray, memberIDArray, mailingStructIn)
|
|
443
|
+
|
|
444
|
+
# SYNOPSIS
|
|
445
|
+
# SendMemberDoc(simpleMemberStructIn, docTypeIn)
|
|
446
|
+
#
|
|
447
|
+
# ARGS
|
|
448
|
+
# simpleMemberStructIn SimpleMemberStruct - {http://tempuri.org/ns1.xsd}SimpleMemberStruct
|
|
449
|
+
# docTypeIn MessageTypeEnum - {http://tempuri.org/ns1.xsd}MessageTypeEnum
|
|
450
|
+
#
|
|
451
|
+
# RETURNS
|
|
452
|
+
# v_return Int - {http://www.w3.org/2001/XMLSchema}int
|
|
453
|
+
#
|
|
454
|
+
simpleMemberStructIn = docTypeIn = nil
|
|
455
|
+
puts obj.sendMemberDoc(simpleMemberStructIn, docTypeIn)
|
|
456
|
+
|
|
457
|
+
# SYNOPSIS
|
|
458
|
+
# TrackingSummary(outMailID)
|
|
459
|
+
#
|
|
460
|
+
# ARGS
|
|
461
|
+
# outMailID Int - {http://www.w3.org/2001/XMLSchema}int
|
|
462
|
+
#
|
|
463
|
+
# RETURNS
|
|
464
|
+
# v_return TrackingSummaryStruct - {http://tempuri.org/ns1.xsd}TrackingSummaryStruct
|
|
465
|
+
#
|
|
466
|
+
outMailID = nil
|
|
467
|
+
puts obj.trackingSummary(outMailID)
|
|
468
|
+
|
|
469
|
+
# SYNOPSIS
|
|
470
|
+
# Unsubscribe(simpleMemberStructArrayIn)
|
|
471
|
+
#
|
|
472
|
+
# ARGS
|
|
473
|
+
# simpleMemberStructArrayIn ArrayOfSimpleMemberStruct - {http://www.lyris.com/lmapi}ArrayOfSimpleMemberStruct
|
|
474
|
+
#
|
|
475
|
+
# RETURNS
|
|
476
|
+
# v_return Int - {http://www.w3.org/2001/XMLSchema}int
|
|
477
|
+
#
|
|
478
|
+
simpleMemberStructArrayIn = nil
|
|
479
|
+
puts obj.unsubscribe(simpleMemberStructArrayIn)
|
|
480
|
+
|
|
481
|
+
# SYNOPSIS
|
|
482
|
+
# UpdateMemberEmail(simpleMemberStructIn, emailAddress)
|
|
483
|
+
#
|
|
484
|
+
# ARGS
|
|
485
|
+
# simpleMemberStructIn SimpleMemberStruct - {http://tempuri.org/ns1.xsd}SimpleMemberStruct
|
|
486
|
+
# emailAddress C_String - {http://www.w3.org/2001/XMLSchema}string
|
|
487
|
+
#
|
|
488
|
+
# RETURNS
|
|
489
|
+
# v_return Boolean - {http://www.w3.org/2001/XMLSchema}boolean
|
|
490
|
+
#
|
|
491
|
+
simpleMemberStructIn = emailAddress = nil
|
|
492
|
+
puts obj.updateMemberEmail(simpleMemberStructIn, emailAddress)
|
|
493
|
+
|
|
494
|
+
# SYNOPSIS
|
|
495
|
+
# UpdateMemberKind(simpleMemberStructIn, memberKind)
|
|
496
|
+
#
|
|
497
|
+
# ARGS
|
|
498
|
+
# simpleMemberStructIn SimpleMemberStruct - {http://tempuri.org/ns1.xsd}SimpleMemberStruct
|
|
499
|
+
# memberKind MemberKindEnum - {http://tempuri.org/ns1.xsd}MemberKindEnum
|
|
500
|
+
#
|
|
501
|
+
# RETURNS
|
|
502
|
+
# v_return Boolean - {http://www.w3.org/2001/XMLSchema}boolean
|
|
503
|
+
#
|
|
504
|
+
simpleMemberStructIn = memberKind = nil
|
|
505
|
+
puts obj.updateMemberKind(simpleMemberStructIn, memberKind)
|
|
506
|
+
|
|
507
|
+
# SYNOPSIS
|
|
508
|
+
# UpdateMemberStatus(simpleMemberStructIn, memberStatus)
|
|
509
|
+
#
|
|
510
|
+
# ARGS
|
|
511
|
+
# simpleMemberStructIn SimpleMemberStruct - {http://tempuri.org/ns1.xsd}SimpleMemberStruct
|
|
512
|
+
# memberStatus MemberStatusEnum - {http://tempuri.org/ns1.xsd}MemberStatusEnum
|
|
513
|
+
#
|
|
514
|
+
# RETURNS
|
|
515
|
+
# v_return Boolean - {http://www.w3.org/2001/XMLSchema}boolean
|
|
516
|
+
#
|
|
517
|
+
simpleMemberStructIn = memberStatus = nil
|
|
518
|
+
puts obj.updateMemberStatus(simpleMemberStructIn, memberStatus)
|
|
519
|
+
|
|
520
|
+
# SYNOPSIS
|
|
521
|
+
# UpdateList(listStructIn)
|
|
522
|
+
#
|
|
523
|
+
# ARGS
|
|
524
|
+
# listStructIn ListStruct - {http://tempuri.org/ns1.xsd}ListStruct
|
|
525
|
+
#
|
|
526
|
+
# RETURNS
|
|
527
|
+
# v_return Boolean - {http://www.w3.org/2001/XMLSchema}boolean
|
|
528
|
+
#
|
|
529
|
+
listStructIn = nil
|
|
530
|
+
puts obj.updateList(listStructIn)
|
|
531
|
+
|
|
532
|
+
# SYNOPSIS
|
|
533
|
+
# UpdateListAdmin(simpleMemberStructIn, isListAdmin, receiveListAdminMail, receiveModerationNotification, bypassListModeration)
|
|
534
|
+
#
|
|
535
|
+
# ARGS
|
|
536
|
+
# simpleMemberStructIn SimpleMemberStruct - {http://tempuri.org/ns1.xsd}SimpleMemberStruct
|
|
537
|
+
# isListAdmin Boolean - {http://www.w3.org/2001/XMLSchema}boolean
|
|
538
|
+
# receiveListAdminMail Boolean - {http://www.w3.org/2001/XMLSchema}boolean
|
|
539
|
+
# receiveModerationNotification Boolean - {http://www.w3.org/2001/XMLSchema}boolean
|
|
540
|
+
# bypassListModeration Boolean - {http://www.w3.org/2001/XMLSchema}boolean
|
|
541
|
+
#
|
|
542
|
+
# RETURNS
|
|
543
|
+
# v_return Boolean - {http://www.w3.org/2001/XMLSchema}boolean
|
|
544
|
+
#
|
|
545
|
+
simpleMemberStructIn = isListAdmin = receiveListAdminMail = receiveModerationNotification = bypassListModeration = nil
|
|
546
|
+
puts obj.updateListAdmin(simpleMemberStructIn, isListAdmin, receiveListAdminMail, receiveModerationNotification, bypassListModeration)
|
|
547
|
+
|
|
548
|
+
# SYNOPSIS
|
|
549
|
+
# UpdateMemberDemographics(simpleMemberStructIn, demographicsArray)
|
|
550
|
+
#
|
|
551
|
+
# ARGS
|
|
552
|
+
# simpleMemberStructIn SimpleMemberStruct - {http://tempuri.org/ns1.xsd}SimpleMemberStruct
|
|
553
|
+
# demographicsArray ArrayOfKeyValueType - {http://www.lyris.com/lmapi}ArrayOfKeyValueType
|
|
554
|
+
#
|
|
555
|
+
# RETURNS
|
|
556
|
+
# v_return Boolean - {http://www.w3.org/2001/XMLSchema}boolean
|
|
557
|
+
#
|
|
558
|
+
simpleMemberStructIn = demographicsArray = nil
|
|
559
|
+
puts obj.updateMemberDemographics(simpleMemberStructIn, demographicsArray)
|
|
560
|
+
|
|
561
|
+
# SYNOPSIS
|
|
562
|
+
# CreateMemberColumn(fieldName, fieldType)
|
|
563
|
+
#
|
|
564
|
+
# ARGS
|
|
565
|
+
# fieldName C_String - {http://www.w3.org/2001/XMLSchema}string
|
|
566
|
+
# fieldType FieldTypeEnum - {http://tempuri.org/ns1.xsd}FieldTypeEnum
|
|
567
|
+
#
|
|
568
|
+
# RETURNS
|
|
569
|
+
# v_return Boolean - {http://www.w3.org/2001/XMLSchema}boolean
|
|
570
|
+
#
|
|
571
|
+
fieldName = fieldType = nil
|
|
572
|
+
puts obj.createMemberColumn(fieldName, fieldType)
|
|
573
|
+
|
|
574
|
+
# SYNOPSIS
|
|
575
|
+
# DeleteMemberColumn(fieldName)
|
|
576
|
+
#
|
|
577
|
+
# ARGS
|
|
578
|
+
# fieldName C_String - {http://www.w3.org/2001/XMLSchema}string
|
|
579
|
+
#
|
|
580
|
+
# RETURNS
|
|
581
|
+
# v_return Boolean - {http://www.w3.org/2001/XMLSchema}boolean
|
|
582
|
+
#
|
|
583
|
+
fieldName = nil
|
|
584
|
+
puts obj.deleteMemberColumn(fieldName)
|
|
585
|
+
|
|
586
|
+
# SYNOPSIS
|
|
587
|
+
# CreateSegment(segmentStructIn)
|
|
588
|
+
#
|
|
589
|
+
# ARGS
|
|
590
|
+
# segmentStructIn SegmentStruct - {http://tempuri.org/ns1.xsd}SegmentStruct
|
|
591
|
+
#
|
|
592
|
+
# RETURNS
|
|
593
|
+
# v_return Int - {http://www.w3.org/2001/XMLSchema}int
|
|
594
|
+
#
|
|
595
|
+
segmentStructIn = nil
|
|
596
|
+
puts obj.createSegment(segmentStructIn)
|
|
597
|
+
|
|
598
|
+
# SYNOPSIS
|
|
599
|
+
# UpdateSegment(segmentStructIn)
|
|
600
|
+
#
|
|
601
|
+
# ARGS
|
|
602
|
+
# segmentStructIn SegmentStruct - {http://tempuri.org/ns1.xsd}SegmentStruct
|
|
603
|
+
#
|
|
604
|
+
# RETURNS
|
|
605
|
+
# v_return Boolean - {http://www.w3.org/2001/XMLSchema}boolean
|
|
606
|
+
#
|
|
607
|
+
segmentStructIn = nil
|
|
608
|
+
puts obj.updateSegment(segmentStructIn)
|
|
609
|
+
|
|
610
|
+
# SYNOPSIS
|
|
611
|
+
# DeleteSegment(segmentID)
|
|
612
|
+
#
|
|
613
|
+
# ARGS
|
|
614
|
+
# segmentID Int - {http://www.w3.org/2001/XMLSchema}int
|
|
615
|
+
#
|
|
616
|
+
# RETURNS
|
|
617
|
+
# v_return Boolean - {http://www.w3.org/2001/XMLSchema}boolean
|
|
618
|
+
#
|
|
619
|
+
segmentID = nil
|
|
620
|
+
puts obj.deleteSegment(segmentID)
|
|
621
|
+
|
|
622
|
+
# SYNOPSIS
|
|
623
|
+
# SendMessage(messageStructIn)
|
|
624
|
+
#
|
|
625
|
+
# ARGS
|
|
626
|
+
# messageStructIn MessageStruct - {http://tempuri.org/ns1.xsd}MessageStruct
|
|
627
|
+
#
|
|
628
|
+
# RETURNS
|
|
629
|
+
# v_return Int - {http://www.w3.org/2001/XMLSchema}int
|
|
630
|
+
#
|
|
631
|
+
messageStructIn = nil
|
|
632
|
+
puts obj.sendMessage(messageStructIn)
|
|
633
|
+
|
|
634
|
+
# SYNOPSIS
|
|
635
|
+
# CreateSite(siteStructIn)
|
|
636
|
+
#
|
|
637
|
+
# ARGS
|
|
638
|
+
# siteStructIn SiteStruct - {http://tempuri.org/ns1.xsd}SiteStruct
|
|
639
|
+
#
|
|
640
|
+
# RETURNS
|
|
641
|
+
# v_return Int - {http://www.w3.org/2001/XMLSchema}int
|
|
642
|
+
#
|
|
643
|
+
siteStructIn = nil
|
|
644
|
+
puts obj.createSite(siteStructIn)
|
|
645
|
+
|
|
646
|
+
# SYNOPSIS
|
|
647
|
+
# UpdateSite(siteStructIn)
|
|
648
|
+
#
|
|
649
|
+
# ARGS
|
|
650
|
+
# siteStructIn SiteStruct - {http://tempuri.org/ns1.xsd}SiteStruct
|
|
651
|
+
#
|
|
652
|
+
# RETURNS
|
|
653
|
+
# v_return Boolean - {http://www.w3.org/2001/XMLSchema}boolean
|
|
654
|
+
#
|
|
655
|
+
siteStructIn = nil
|
|
656
|
+
puts obj.updateSite(siteStructIn)
|
|
657
|
+
|
|
658
|
+
# SYNOPSIS
|
|
659
|
+
# DeleteSite(siteID)
|
|
660
|
+
#
|
|
661
|
+
# ARGS
|
|
662
|
+
# siteID Int - {http://www.w3.org/2001/XMLSchema}int
|
|
663
|
+
#
|
|
664
|
+
# RETURNS
|
|
665
|
+
# v_return Boolean - {http://www.w3.org/2001/XMLSchema}boolean
|
|
666
|
+
#
|
|
667
|
+
siteID = nil
|
|
668
|
+
puts obj.deleteSite(siteID)
|
|
669
|
+
|
|
670
|
+
# SYNOPSIS
|
|
671
|
+
# CreateTopic(topicStructIn)
|
|
672
|
+
#
|
|
673
|
+
# ARGS
|
|
674
|
+
# topicStructIn TopicStruct - {http://tempuri.org/ns1.xsd}TopicStruct
|
|
675
|
+
#
|
|
676
|
+
# RETURNS
|
|
677
|
+
# v_return Boolean - {http://www.w3.org/2001/XMLSchema}boolean
|
|
678
|
+
#
|
|
679
|
+
topicStructIn = nil
|
|
680
|
+
puts obj.createTopic(topicStructIn)
|
|
681
|
+
|
|
682
|
+
# SYNOPSIS
|
|
683
|
+
# UpdateTopic(topicStructIn)
|
|
684
|
+
#
|
|
685
|
+
# ARGS
|
|
686
|
+
# topicStructIn TopicStruct - {http://tempuri.org/ns1.xsd}TopicStruct
|
|
687
|
+
#
|
|
688
|
+
# RETURNS
|
|
689
|
+
# v_return Boolean - {http://www.w3.org/2001/XMLSchema}boolean
|
|
690
|
+
#
|
|
691
|
+
topicStructIn = nil
|
|
692
|
+
puts obj.updateTopic(topicStructIn)
|
|
693
|
+
|
|
694
|
+
# SYNOPSIS
|
|
695
|
+
# DeleteTopic(topicTitle)
|
|
696
|
+
#
|
|
697
|
+
# ARGS
|
|
698
|
+
# topicTitle C_String - {http://www.w3.org/2001/XMLSchema}string
|
|
699
|
+
#
|
|
700
|
+
# RETURNS
|
|
701
|
+
# v_return Boolean - {http://www.w3.org/2001/XMLSchema}boolean
|
|
702
|
+
#
|
|
703
|
+
topicTitle = nil
|
|
704
|
+
puts obj.deleteTopic(topicTitle)
|
|
705
|
+
|
|
706
|
+
# SYNOPSIS
|
|
707
|
+
# GetPreviewMailing(previewStructIn)
|
|
708
|
+
#
|
|
709
|
+
# ARGS
|
|
710
|
+
# previewStructIn PreviewStruct - {http://tempuri.org/ns1.xsd}PreviewStruct
|
|
711
|
+
#
|
|
712
|
+
# RETURNS
|
|
713
|
+
# v_return C_String - {http://www.w3.org/2001/XMLSchema}string
|
|
714
|
+
#
|
|
715
|
+
previewStructIn = nil
|
|
716
|
+
puts obj.getPreviewMailing(previewStructIn)
|
|
717
|
+
|
|
718
|
+
# SYNOPSIS
|
|
719
|
+
# CreateServerAdmin(serverAdminStructIn)
|
|
720
|
+
#
|
|
721
|
+
# ARGS
|
|
722
|
+
# serverAdminStructIn ServerAdminStruct - {http://tempuri.org/ns1.xsd}ServerAdminStruct
|
|
723
|
+
#
|
|
724
|
+
# RETURNS
|
|
725
|
+
# v_return Int - {http://www.w3.org/2001/XMLSchema}int
|
|
726
|
+
#
|
|
727
|
+
serverAdminStructIn = nil
|
|
728
|
+
puts obj.createServerAdmin(serverAdminStructIn)
|
|
729
|
+
|
|
730
|
+
# SYNOPSIS
|
|
731
|
+
# UpdateServerAdmin(serverAdminStructIn)
|
|
732
|
+
#
|
|
733
|
+
# ARGS
|
|
734
|
+
# serverAdminStructIn ServerAdminStruct - {http://tempuri.org/ns1.xsd}ServerAdminStruct
|
|
735
|
+
#
|
|
736
|
+
# RETURNS
|
|
737
|
+
# v_return Boolean - {http://www.w3.org/2001/XMLSchema}boolean
|
|
738
|
+
#
|
|
739
|
+
serverAdminStructIn = nil
|
|
740
|
+
puts obj.updateServerAdmin(serverAdminStructIn)
|
|
741
|
+
|
|
742
|
+
# SYNOPSIS
|
|
743
|
+
# DeleteServerAdmin(serverAdminStructIn)
|
|
744
|
+
#
|
|
745
|
+
# ARGS
|
|
746
|
+
# serverAdminStructIn ServerAdminStruct - {http://tempuri.org/ns1.xsd}ServerAdminStruct
|
|
747
|
+
#
|
|
748
|
+
# RETURNS
|
|
749
|
+
# v_return Boolean - {http://www.w3.org/2001/XMLSchema}boolean
|
|
750
|
+
#
|
|
751
|
+
serverAdminStructIn = nil
|
|
752
|
+
puts obj.deleteServerAdmin(serverAdminStructIn)
|
|
753
|
+
|
|
754
|
+
# SYNOPSIS
|
|
755
|
+
# CreateSiteAdmin(siteAdminStructIn)
|
|
756
|
+
#
|
|
757
|
+
# ARGS
|
|
758
|
+
# siteAdminStructIn SiteAdminStruct - {http://tempuri.org/ns1.xsd}SiteAdminStruct
|
|
759
|
+
#
|
|
760
|
+
# RETURNS
|
|
761
|
+
# v_return Int - {http://www.w3.org/2001/XMLSchema}int
|
|
762
|
+
#
|
|
763
|
+
siteAdminStructIn = nil
|
|
764
|
+
puts obj.createSiteAdmin(siteAdminStructIn)
|
|
765
|
+
|
|
766
|
+
# SYNOPSIS
|
|
767
|
+
# UpdateSiteAdmin(siteAdminStructIn)
|
|
768
|
+
#
|
|
769
|
+
# ARGS
|
|
770
|
+
# siteAdminStructIn SiteAdminStruct - {http://tempuri.org/ns1.xsd}SiteAdminStruct
|
|
771
|
+
#
|
|
772
|
+
# RETURNS
|
|
773
|
+
# v_return Boolean - {http://www.w3.org/2001/XMLSchema}boolean
|
|
774
|
+
#
|
|
775
|
+
siteAdminStructIn = nil
|
|
776
|
+
puts obj.updateSiteAdmin(siteAdminStructIn)
|
|
777
|
+
|
|
778
|
+
# SYNOPSIS
|
|
779
|
+
# DeleteSiteAdmin(siteAdminStructIn)
|
|
780
|
+
#
|
|
781
|
+
# ARGS
|
|
782
|
+
# siteAdminStructIn SiteAdminStruct - {http://tempuri.org/ns1.xsd}SiteAdminStruct
|
|
783
|
+
#
|
|
784
|
+
# RETURNS
|
|
785
|
+
# v_return Boolean - {http://www.w3.org/2001/XMLSchema}boolean
|
|
786
|
+
#
|
|
787
|
+
siteAdminStructIn = nil
|
|
788
|
+
puts obj.deleteSiteAdmin(siteAdminStructIn)
|
|
789
|
+
|
|
790
|
+
# SYNOPSIS
|
|
791
|
+
# CreateContent(contentStructIn)
|
|
792
|
+
#
|
|
793
|
+
# ARGS
|
|
794
|
+
# contentStructIn ContentStruct - {http://tempuri.org/ns1.xsd}ContentStruct
|
|
795
|
+
#
|
|
796
|
+
# RETURNS
|
|
797
|
+
# v_return Int - {http://www.w3.org/2001/XMLSchema}int
|
|
798
|
+
#
|
|
799
|
+
contentStructIn = nil
|
|
800
|
+
puts obj.createContent(contentStructIn)
|
|
801
|
+
|
|
802
|
+
# SYNOPSIS
|
|
803
|
+
# UpdateContent(contentStructIn)
|
|
804
|
+
#
|
|
805
|
+
# ARGS
|
|
806
|
+
# contentStructIn ContentStruct - {http://tempuri.org/ns1.xsd}ContentStruct
|
|
807
|
+
#
|
|
808
|
+
# RETURNS
|
|
809
|
+
# v_return Boolean - {http://www.w3.org/2001/XMLSchema}boolean
|
|
810
|
+
#
|
|
811
|
+
contentStructIn = nil
|
|
812
|
+
puts obj.updateContent(contentStructIn)
|
|
813
|
+
|
|
814
|
+
# SYNOPSIS
|
|
815
|
+
# DeleteContent(contentStructIn)
|
|
816
|
+
#
|
|
817
|
+
# ARGS
|
|
818
|
+
# contentStructIn ContentStruct - {http://tempuri.org/ns1.xsd}ContentStruct
|
|
819
|
+
#
|
|
820
|
+
# RETURNS
|
|
821
|
+
# v_return Boolean - {http://www.w3.org/2001/XMLSchema}boolean
|
|
822
|
+
#
|
|
823
|
+
contentStructIn = nil
|
|
824
|
+
puts obj.deleteContent(contentStructIn)
|
|
825
|
+
|
|
826
|
+
# SYNOPSIS
|
|
827
|
+
# SelectListsEx(listName, siteName, fieldsToFetch, whereClause)
|
|
828
|
+
#
|
|
829
|
+
# ARGS
|
|
830
|
+
# listName C_String - {http://www.w3.org/2001/XMLSchema}string
|
|
831
|
+
# siteName C_String - {http://www.w3.org/2001/XMLSchema}string
|
|
832
|
+
# fieldsToFetch ArrayOfstring - {http://www.lyris.com/lmapi}ArrayOfstring
|
|
833
|
+
# whereClause ArrayOfstring - {http://www.lyris.com/lmapi}ArrayOfstring
|
|
834
|
+
#
|
|
835
|
+
# RETURNS
|
|
836
|
+
# v_return ArrayOfArrayOfstring - {http://www.lyris.com/lmapi}ArrayOfArrayOfstring
|
|
837
|
+
#
|
|
838
|
+
listName = siteName = fieldsToFetch = whereClause = nil
|
|
839
|
+
puts obj.selectListsEx(listName, siteName, fieldsToFetch, whereClause)
|
|
840
|
+
|
|
841
|
+
# SYNOPSIS
|
|
842
|
+
# SelectMembersEx(fieldsToFetch, filterCriteriaArray)
|
|
843
|
+
#
|
|
844
|
+
# ARGS
|
|
845
|
+
# fieldsToFetch ArrayOfstring - {http://www.lyris.com/lmapi}ArrayOfstring
|
|
846
|
+
# filterCriteriaArray ArrayOfstring - {http://www.lyris.com/lmapi}ArrayOfstring
|
|
847
|
+
#
|
|
848
|
+
# RETURNS
|
|
849
|
+
# v_return ArrayOfArrayOfstring - {http://www.lyris.com/lmapi}ArrayOfArrayOfstring
|
|
850
|
+
#
|
|
851
|
+
fieldsToFetch = filterCriteriaArray = nil
|
|
852
|
+
puts obj.selectMembersEx(fieldsToFetch, filterCriteriaArray)
|
|
853
|
+
|
|
854
|
+
|