Class: AsposeWordsCloud::ExecuteMailMergeRequest

Inherits:
Object
  • Object
show all
Defined in:
lib/aspose_words_cloud/models/requests/execute_mail_merge_request.rb

Overview

Request model for execute_mail_merge operation.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(name, data = nil, folder = nil, storage = nil, load_encoding = nil, password = nil, with_regions = nil, mail_merge_data_file = nil, cleanup = nil, use_whole_paragraph_as_region = nil, dest_file_name = nil) ⇒ ExecuteMailMergeRequest

Initializes a new instance.

Parameters:

  • name —

    The template name.

  • data (defaults to: nil) —

    Mail merge data.

  • folder (defaults to: nil) —

    Original document folder.

  • storage (defaults to: nil) —

    Original document storage.

  • load_encoding (defaults to: nil) —

    Encoding that will be used to load an HTML (or TXT) document if the encoding is not specified in HTML.

  • password (defaults to: nil) —

    Password for opening an encrypted document.

  • with_regions (defaults to: nil) —

    With regions flag.

  • mail_merge_data_file (defaults to: nil) —

    Mail merge data file.

  • cleanup (defaults to: nil) —

    Clean up options.

  • use_whole_paragraph_as_region (defaults to: nil) —

    Gets or sets a value indicating whether paragraph with TableStart or. TableEnd field should be fully included into mail merge region or particular range between TableStart and TableEnd fields. The default value is true.

  • dest_file_name (defaults to: nil) —

    Result name of the document after the operation. If this parameter is omitted then result of the operation will be saved with autogenerated name.



81
82
83
84
85
86
87
88
89
90
91
92
93
 
# File 'lib/aspose_words_cloud/models/requests/execute_mail_merge_request.rb', line 81

def initialize(name, data = nil, folder = nil, storage = nil, load_encoding = nil, password = nil, with_regions = nil, mail_merge_data_file = nil, cleanup = nil, use_whole_paragraph_as_region = nil, dest_file_name = nil)
  self.name = name
  self.data = data
  self.folder = folder
  self.storage = storage
  self.load_encoding = load_encoding
  self.password = password
  self.with_regions = with_regions
  self.mail_merge_data_file = mail_merge_data_file
  self.cleanup = cleanup
  self.use_whole_paragraph_as_region = use_whole_paragraph_as_region
  self.dest_file_name = dest_file_name
end

Instance Attribute Details

#cleanup ⇒ Object

Clean up options.



57
58
59
 
# File 'lib/aspose_words_cloud/models/requests/execute_mail_merge_request.rb', line 57

def cleanup
  @cleanup
end

#data ⇒ Object

Mail merge data.



36
37
38
 
# File 'lib/aspose_words_cloud/models/requests/execute_mail_merge_request.rb', line 36

def data
  @data
end

#dest_file_name ⇒ Object

Result name of the document after the operation. If this parameter is omitted then result of the operation will be saved with autogenerated name.



65
66
67
 
# File 'lib/aspose_words_cloud/models/requests/execute_mail_merge_request.rb', line 65

def dest_file_name
  @dest_file_name
end

#folder ⇒ Object

Original document folder.



39
40
41
 
# File 'lib/aspose_words_cloud/models/requests/execute_mail_merge_request.rb', line 39

def folder
  @folder
end

#load_encoding ⇒ Object

Encoding that will be used to load an HTML (or TXT) document if the encoding is not specified in HTML.



45
46
47
 
# File 'lib/aspose_words_cloud/models/requests/execute_mail_merge_request.rb', line 45

def load_encoding
  @load_encoding
end

#mail_merge_data_file ⇒ Object

Mail merge data file.



54
55
56
 
# File 'lib/aspose_words_cloud/models/requests/execute_mail_merge_request.rb', line 54

def mail_merge_data_file
  @mail_merge_data_file
end

#name ⇒ Object

The template name.



33
34
35
 
# File 'lib/aspose_words_cloud/models/requests/execute_mail_merge_request.rb', line 33

def name
  @name
end

#password ⇒ Object

Password for opening an encrypted document.



48
49
50
 
# File 'lib/aspose_words_cloud/models/requests/execute_mail_merge_request.rb', line 48

def password
  @password
end

#storage ⇒ Object

Original document storage.



42
43
44
 
# File 'lib/aspose_words_cloud/models/requests/execute_mail_merge_request.rb', line 42

def storage
  @storage
end

#use_whole_paragraph_as_region ⇒ Object

Gets or sets a value indicating whether paragraph with TableStart or. TableEnd field should be fully included into mail merge region or particular range between TableStart and TableEnd fields. The default value is true.



62
63
64
 
# File 'lib/aspose_words_cloud/models/requests/execute_mail_merge_request.rb', line 62

def use_whole_paragraph_as_region
  @use_whole_paragraph_as_region
end

#with_regions ⇒ Object

With regions flag.



51
52
53
 
# File 'lib/aspose_words_cloud/models/requests/execute_mail_merge_request.rb', line 51

def with_regions
  @with_regions
end