Class: VertxMail::MailAttachment

Inherits:
Object
  • Object
show all
Defined in:
/Users/julien/java/vertx-aggregator/modules/vertx-lang-ruby/vertx-lang-ruby/target/classes/vertx-mail/mail_attachment.rb

Overview

Represent a mail attachment that can be used in a MailMessage.

Constant Summary

@@j_api_type =
Object.new

Class Method Summary (collapse)

Instance Method Summary (collapse)

Class Method Details

+ (Boolean) accept?(obj)

Returns:

  • (Boolean)


21
22
23
# File '/Users/julien/java/vertx-aggregator/modules/vertx-lang-ruby/vertx-lang-ruby/target/classes/vertx-mail/mail_attachment.rb', line 21

def @@j_api_type.accept?(obj)
  obj.class == MailAttachment
end

+ (::VertxMail::MailAttachment) create + (::VertxMail::MailAttachment) create(json) + (::VertxMail::MailAttachment) create(other)

create a copy of a MailAttachment object

Overloads:

Returns:



273
274
275
276
277
278
279
280
281
282
283
284
285
286
# File '/Users/julien/java/vertx-aggregator/modules/vertx-lang-ruby/vertx-lang-ruby/target/classes/vertx-mail/mail_attachment.rb', line 273

def self.create(*args)
  if !block_given? && args[0] == nil
    return ::Vertx::Util::Utils.safe_create(Java::IoVertxExtMail::MailAttachment.java_method(:create, []).call(),::VertxMail::MailAttachment)
  elsif args[0].class == Hash && !block_given?
    return ::Vertx::Util::Utils.safe_create(Java::IoVertxExtMail::MailAttachment.java_method(:create, [Java::IoVertxCoreJson::JsonObject.java_class]).call(::Vertx::Util::Utils.to_json_object(args[0])),::VertxMail::MailAttachment)
  elsif args[0].class.method_defined?(:j_del) && !block_given?
    return ::Vertx::Util::Utils.safe_create(Java::IoVertxExtMail::MailAttachment.java_method(:create, [Java::IoVertxExtMail::MailAttachment.java_class]).call(args[0].j_del),::VertxMail::MailAttachment)
  end
  if defined?(super)
    super
  else
    raise ArgumentError, "Invalid arguments when calling create(#{args[0]})"
  end
end

+ (Object) j_api_type



30
31
32
# File '/Users/julien/java/vertx-aggregator/modules/vertx-lang-ruby/vertx-lang-ruby/target/classes/vertx-mail/mail_attachment.rb', line 30

def self.j_api_type
  @@j_api_type
end

+ (Object) j_class



33
34
35
# File '/Users/julien/java/vertx-aggregator/modules/vertx-lang-ruby/vertx-lang-ruby/target/classes/vertx-mail/mail_attachment.rb', line 33

def self.j_class
  Java::IoVertxExtMail::MailAttachment.java_class
end

+ (Object) unwrap(obj)



27
28
29
# File '/Users/julien/java/vertx-aggregator/modules/vertx-lang-ruby/vertx-lang-ruby/target/classes/vertx-mail/mail_attachment.rb', line 27

def @@j_api_type.unwrap(obj)
  obj.j_del
end

+ (Object) wrap(obj)



24
25
26
# File '/Users/julien/java/vertx-aggregator/modules/vertx-lang-ruby/vertx-lang-ruby/target/classes/vertx-mail/mail_attachment.rb', line 24

def @@j_api_type.wrap(obj)
  MailAttachment.new(obj)
end

Instance Method Details

- (self) addHeader(key, value)

Add an header to this attachment.

Parameters:

  • key (String)
    the header key
  • value (String)
    the header value

Returns:

  • (self)


71
72
73
74
75
76
77
78
79
80
81
# File '/Users/julien/java/vertx-aggregator/modules/vertx-lang-ruby/vertx-lang-ruby/target/classes/vertx-mail/mail_attachment.rb', line 71

def add_header(*args)
  if args[0].class == String && args[1].class == String && !block_given?
    @j_del.java_method(:addHeader, [Java::java.lang.String.java_class,Java::java.lang.String.java_class]).call(args[0],args[1])
    return self
  end
  if defined?(super)
    super
  else
    raise ArgumentError, "Invalid arguments when calling add_header(#{args[0]},#{args[1]})"
  end
end

- (String) getContentId

get the Content-ID field

Returns:

  • (String)
    the content id


243
244
245
246
247
248
249
250
251
252
# File '/Users/julien/java/vertx-aggregator/modules/vertx-lang-ruby/vertx-lang-ruby/target/classes/vertx-mail/mail_attachment.rb', line 243

def get_content_id
  if !block_given?
    return @j_del.java_method(:getContentId, []).call()
  end
  if defined?(super)
    super
  else
    raise ArgumentError, "Invalid arguments when calling get_content_id()"
  end
end

- (String) getContentType

get the Content-Type

Returns:

  • (String)
    the contentType


256
257
258
259
260
261
262
263
264
265
# File '/Users/julien/java/vertx-aggregator/modules/vertx-lang-ruby/vertx-lang-ruby/target/classes/vertx-mail/mail_attachment.rb', line 256

def get_content_type
  if !block_given?
    return @j_del.java_method(:getContentType, []).call()
  end
  if defined?(super)
    super
  else
    raise ArgumentError, "Invalid arguments when calling get_content_type()"
  end
end

- (::Vertx::Buffer) getData

get the data

Returns:



331
332
333
334
335
336
337
338
339
340
# File '/Users/julien/java/vertx-aggregator/modules/vertx-lang-ruby/vertx-lang-ruby/target/classes/vertx-mail/mail_attachment.rb', line 331

def get_data
  if !block_given?
    return ::Vertx::Util::Utils.safe_create(@j_del.java_method(:getData, []).call(),::Vertx::Buffer)
  end
  if defined?(super)
    super
  else
    raise ArgumentError, "Invalid arguments when calling get_data()"
  end
end

- (String) getDescription

get the description field

Returns:

  • (String)
    the description


156
157
158
159
160
161
162
163
164
165
# File '/Users/julien/java/vertx-aggregator/modules/vertx-lang-ruby/vertx-lang-ruby/target/classes/vertx-mail/mail_attachment.rb', line 156

def get_description
  if !block_given?
    return @j_del.java_method(:getDescription, []).call()
  end
  if defined?(super)
    super
  else
    raise ArgumentError, "Invalid arguments when calling get_description()"
  end
end

- (String) getDisposition

get the disposition field

Returns:

  • (String)
    the disposition


290
291
292
293
294
295
296
297
298
299
# File '/Users/julien/java/vertx-aggregator/modules/vertx-lang-ruby/vertx-lang-ruby/target/classes/vertx-mail/mail_attachment.rb', line 290

def get_disposition
  if !block_given?
    return @j_del.java_method(:getDisposition, []).call()
  end
  if defined?(super)
    super
  else
    raise ArgumentError, "Invalid arguments when calling get_disposition()"
  end
end

- (::Vertx::MultiMap) getHeaders

Get the headers to be added for this attachment.

Returns:



113
114
115
116
117
118
119
120
121
122
# File '/Users/julien/java/vertx-aggregator/modules/vertx-lang-ruby/vertx-lang-ruby/target/classes/vertx-mail/mail_attachment.rb', line 113

def get_headers
  if !block_given?
    return ::Vertx::Util::Utils.safe_create(@j_del.java_method(:getHeaders, []).call(),::Vertx::MultiMap)
  end
  if defined?(super)
    super
  else
    raise ArgumentError, "Invalid arguments when calling get_headers()"
  end
end

- (String) getName

get the name

Returns:

  • (String)
    the name


85
86
87
88
89
90
91
92
93
94
# File '/Users/julien/java/vertx-aggregator/modules/vertx-lang-ruby/vertx-lang-ruby/target/classes/vertx-mail/mail_attachment.rb', line 85

def get_name
  if !block_given?
    return @j_del.java_method(:getName, []).call()
  end
  if defined?(super)
    super
  else
    raise ArgumentError, "Invalid arguments when calling get_name()"
  end
end

- (Fixnum) getSize

Gets the size of the attachment.

Returns:

  • (Fixnum)
    the size of the attachment


197
198
199
200
201
202
203
204
205
206
# File '/Users/julien/java/vertx-aggregator/modules/vertx-lang-ruby/vertx-lang-ruby/target/classes/vertx-mail/mail_attachment.rb', line 197

def get_size
  if !block_given?
    return @j_del.java_method(:getSize, []).call()
  end
  if defined?(super)
    super
  else
    raise ArgumentError, "Invalid arguments when calling get_size()"
  end
end

- (::Vertx::ReadStream) getStream

Gets the data stream.

Returns:



303
304
305
306
307
308
309
310
311
312
# File '/Users/julien/java/vertx-aggregator/modules/vertx-lang-ruby/vertx-lang-ruby/target/classes/vertx-mail/mail_attachment.rb', line 303

def get_stream
  if !block_given?
    return ::Vertx::Util::Utils.safe_create(@j_del.java_method(:getStream, []).call(),::Vertx::ReadStreamImpl,::Vertx::Buffer.j_api_type)
  end
  if defined?(super)
    super
  else
    raise ArgumentError, "Invalid arguments when calling get_stream()"
  end
end

- (self) setContentId(contentId)

set the Content-ID field to be used in the attachment

Parameters:

  • contentId (String)
    the content id

Returns:

  • (self)


170
171
172
173
174
175
176
177
178
179
180
# File '/Users/julien/java/vertx-aggregator/modules/vertx-lang-ruby/vertx-lang-ruby/target/classes/vertx-mail/mail_attachment.rb', line 170

def set_content_id(*args)
  if args[0].class == String && !block_given?
    @j_del.java_method(:setContentId, [Java::java.lang.String.java_class]).call(args[0])
    return self
  end
  if defined?(super)
    super
  else
    raise ArgumentError, "Invalid arguments when calling set_content_id(#{args[0]})"
  end
end

- (self) setContentType(contentType)

set the Content-Type

Parameters:

  • contentType (String)
    the contentType

Returns:

  • (self)


317
318
319
320
321
322
323
324
325
326
327
# File '/Users/julien/java/vertx-aggregator/modules/vertx-lang-ruby/vertx-lang-ruby/target/classes/vertx-mail/mail_attachment.rb', line 317

def set_content_type(*args)
  if args[0].class == String && !block_given?
    @j_del.java_method(:setContentType, [Java::java.lang.String.java_class]).call(args[0])
    return self
  end
  if defined?(super)
    super
  else
    raise ArgumentError, "Invalid arguments when calling set_content_type(#{args[0]})"
  end
end

- (self) setData(data)

set the data

Parameters:

Returns:

  • (self)


127
128
129
130
131
132
133
134
135
136
137
# File '/Users/julien/java/vertx-aggregator/modules/vertx-lang-ruby/vertx-lang-ruby/target/classes/vertx-mail/mail_attachment.rb', line 127

def set_data(*args)
  if args[0].class.method_defined?(:j_del) && !block_given?
    @j_del.java_method(:setData, [Java::IoVertxCoreBuffer::Buffer.java_class]).call(args[0].j_del)
    return self
  end
  if defined?(super)
    super
  else
    raise ArgumentError, "Invalid arguments when calling set_data(#{args[0]})"
  end
end

- (self) setDescription(description)

set the description field to be used in the attachment

Parameters:

  • description (String)
    the description

Returns:

  • (self)


142
143
144
145
146
147
148
149
150
151
152
# File '/Users/julien/java/vertx-aggregator/modules/vertx-lang-ruby/vertx-lang-ruby/target/classes/vertx-mail/mail_attachment.rb', line 142

def set_description(*args)
  if args[0].class == String && !block_given?
    @j_del.java_method(:setDescription, [Java::java.lang.String.java_class]).call(args[0])
    return self
  end
  if defined?(super)
    super
  else
    raise ArgumentError, "Invalid arguments when calling set_description(#{args[0]})"
  end
end

- (self) setDisposition(disposition)

set the disposition field to be used in the attachment

Parameters:

  • disposition (String)
    the disposition

Returns:

  • (self)


229
230
231
232
233
234
235
236
237
238
239
# File '/Users/julien/java/vertx-aggregator/modules/vertx-lang-ruby/vertx-lang-ruby/target/classes/vertx-mail/mail_attachment.rb', line 229

def set_disposition(*args)
  if args[0].class == String && !block_given?
    @j_del.java_method(:setDisposition, [Java::java.lang.String.java_class]).call(args[0])
    return self
  end
  if defined?(super)
    super
  else
    raise ArgumentError, "Invalid arguments when calling set_disposition(#{args[0]})"
  end
end

- (self) setHeaders(headers)

Set the headers to be added for this attachment.

Parameters:

Returns:

  • (self)


55
56
57
58
59
60
61
62
63
64
65
# File '/Users/julien/java/vertx-aggregator/modules/vertx-lang-ruby/vertx-lang-ruby/target/classes/vertx-mail/mail_attachment.rb', line 55

def set_headers(*args)
  if args[0].class.method_defined?(:j_del) && !block_given?
    @j_del.java_method(:setHeaders, [Java::IoVertxCore::MultiMap.java_class]).call(args[0].j_del)
    return self
  end
  if defined?(super)
    super
  else
    raise ArgumentError, "Invalid arguments when calling set_headers(#{args[0]})"
  end
end

- (self) setName(name)

set the name

Parameters:

  • name (String)
    name of the attachment file

Returns:

  • (self)


40
41
42
43
44
45
46
47
48
49
50
# File '/Users/julien/java/vertx-aggregator/modules/vertx-lang-ruby/vertx-lang-ruby/target/classes/vertx-mail/mail_attachment.rb', line 40

def set_name(*args)
  if args[0].class == String && !block_given?
    @j_del.java_method(:setName, [Java::java.lang.String.java_class]).call(args[0])
    return self
  end
  if defined?(super)
    super
  else
    raise ArgumentError, "Invalid arguments when calling set_name(#{args[0]})"
  end
end

- (self) setSize(size)

Sets the size of the attachment.

It is needed when using ReadStream for the MailAttachement.

Parameters:

  • size (Fixnum)
    the size of the attachment

Returns:

  • (self)


214
215
216
217
218
219
220
221
222
223
224
# File '/Users/julien/java/vertx-aggregator/modules/vertx-lang-ruby/vertx-lang-ruby/target/classes/vertx-mail/mail_attachment.rb', line 214

def set_size(*args)
  if args[0].class == Fixnum && !block_given?
    @j_del.java_method(:setSize, [Java::int.java_class]).call(args[0])
    return self
  end
  if defined?(super)
    super
  else
    raise ArgumentError, "Invalid arguments when calling set_size(#{args[0]})"
  end
end

- (self) setStream(stream)

Sets the data stream.

Parameters:

Returns:

  • (self)


99
100
101
102
103
104
105
106
107
108
109
# File '/Users/julien/java/vertx-aggregator/modules/vertx-lang-ruby/vertx-lang-ruby/target/classes/vertx-mail/mail_attachment.rb', line 99

def set_stream(*args)
  if args[0].class.method_defined?(:j_del) && !block_given?
    @j_del.java_method(:setStream, [Java::IoVertxCoreStreams::ReadStream.java_class]).call(args[0].j_del)
    return self
  end
  if defined?(super)
    super
  else
    raise ArgumentError, "Invalid arguments when calling set_stream(#{args[0]})"
  end
end

- (Hash{String => Object}) toJson

convert this object to JSON representation

Returns:

  • (Hash{String => Object})
    the JSON object


184
185
186
187
188
189
190
191
192
193
# File '/Users/julien/java/vertx-aggregator/modules/vertx-lang-ruby/vertx-lang-ruby/target/classes/vertx-mail/mail_attachment.rb', line 184

def to_json
  if !block_given?
    return @j_del.java_method(:toJson, []).call() != nil ? JSON.parse(@j_del.java_method(:toJson, []).call().encode) : nil
  end
  if defined?(super)
    super
  else
    raise ArgumentError, "Invalid arguments when calling to_json()"
  end
end