-
Notifications
You must be signed in to change notification settings - Fork 936
/
message.rb
2058 lines (1854 loc) · 63.6 KB
/
message.rb
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
# encoding: utf-8
require "yaml"
module Mail
# The Message class provides a single point of access to all things to do with an
# email message.
#
# You create a new email message by calling the Mail::Message.new method, or just
# Mail.new
#
# A Message object by default has the following objects inside it:
#
# * A Header object which contains all information and settings of the header of the email
# * Body object which contains all parts of the email that are not part of the header, this
# includes any attachments, body text, MIME parts etc.
#
# ==Per RFC2822
#
# 2.1. General Description
#
# At the most basic level, a message is a series of characters. A
# message that is conformant with this standard is comprised of
# characters with values in the range 1 through 127 and interpreted as
# US-ASCII characters [ASCII]. For brevity, this document sometimes
# refers to this range of characters as simply "US-ASCII characters".
#
# Note: This standard specifies that messages are made up of characters
# in the US-ASCII range of 1 through 127. There are other documents,
# specifically the MIME document series [RFC2045, RFC2046, RFC2047,
# RFC2048, RFC2049], that extend this standard to allow for values
# outside of that range. Discussion of those mechanisms is not within
# the scope of this standard.
#
# Messages are divided into lines of characters. A line is a series of
# characters that is delimited with the two characters carriage-return
# and line-feed; that is, the carriage return (CR) character (ASCII
# value 13) followed immediately by the line feed (LF) character (ASCII
# value 10). (The carriage-return/line-feed pair is usually written in
# this document as "CRLF".)
#
# A message consists of header fields (collectively called "the header
# of the message") followed, optionally, by a body. The header is a
# sequence of lines of characters with special syntax as defined in
# this standard. The body is simply a sequence of characters that
# follows the header and is separated from the header by an empty line
# (i.e., a line with nothing preceding the CRLF).
class Message
include Patterns
include Utilities
# ==Making an email
#
# You can make an new mail object via a block, passing a string, file or direct assignment.
#
# ===Making an email via a block
#
# mail = Mail.new do
# from 'mikel@test.lindsaar.net'
# to 'you@test.lindsaar.net'
# subject 'This is a test email'
# body File.read('body.txt')
# end
#
# mail.to_s #=> "From: mikel@test.lindsaar.net\r\nTo: you@...
#
# ===Making an email via passing a string
#
# mail = Mail.new("To: mikel@test.lindsaar.net\r\nSubject: Hello\r\n\r\nHi there!")
# mail.body.to_s #=> 'Hi there!'
# mail.subject #=> 'Hello'
# mail.to #=> 'mikel@test.lindsaar.net'
#
# ===Making an email from a file
#
# mail = Mail.read('path/to/file.eml')
# mail.body.to_s #=> 'Hi there!'
# mail.subject #=> 'Hello'
# mail.to #=> 'mikel@test.lindsaar.net'
#
# ===Making an email via assignment
#
# You can assign values to a mail object via four approaches:
#
# * Message#field_name=(value)
# * Message#field_name(value)
# * Message#['field_name']=(value)
# * Message#[:field_name]=(value)
#
# Examples:
#
# mail = Mail.new
# mail['from'] = 'mikel@test.lindsaar.net'
# mail[:to] = 'you@test.lindsaar.net'
# mail.subject 'This is a test email'
# mail.body = 'This is a body'
#
# mail.to_s #=> "From: mikel@test.lindsaar.net\r\nTo: you@...
#
def initialize(*args, &block)
@body = nil
@body_raw = nil
@separate_parts = false
@text_part = nil
@html_part = nil
@errors = nil
@header = nil
@charset = 'UTF-8'
@defaulted_charset = true
@perform_deliveries = true
@raise_delivery_errors = true
@delivery_handler = nil
@delivery_method = Mail.delivery_method.dup
@transport_encoding = Mail::Encodings.get_encoding('7bit')
@mark_for_delete = false
if args.flatten.first.respond_to?(:each_pair)
init_with_hash(args.flatten.first)
else
init_with_string(args.flatten[0].to_s.strip)
end
if block_given?
instance_eval(&block)
end
self
end
# If you assign a delivery handler, mail will call :deliver_mail on the
# object you assign to delivery_handler, it will pass itself as the
# single argument.
#
# If you define a delivery_handler, then you are responsible for the
# following actions in the delivery cycle:
#
# * Appending the mail object to Mail.deliveries as you see fit.
# * Checking the mail.perform_deliveries flag to decide if you should
# actually call :deliver! the mail object or not.
# * Checking the mail.raise_delivery_errors flag to decide if you
# should raise delivery errors if they occur.
# * Actually calling :deliver! (with the bang) on the mail object to
# get it to deliver itself.
#
# A simplest implementation of a delivery_handler would be
#
# class MyObject
#
# def initialize
# @mail = Mail.new('To: mikel@test.lindsaar.net')
# @mail.delivery_handler = self
# end
#
# attr_accessor :mail
#
# def deliver_mail(mail)
# yield
# end
# end
#
# Then doing:
#
# obj = MyObject.new
# obj.mail.deliver
#
# Would cause Mail to call obj.deliver_mail passing itself as a parameter,
# which then can just yield and let Mail do it's own private do_delivery
# method.
attr_accessor :delivery_handler
# If set to false, mail will go through the motions of doing a delivery,
# but not actually call the delivery method or append the mail object to
# the Mail.deliveries collection. Useful for testing.
#
# Mail.deliveries.size #=> 0
# mail.delivery_method :smtp
# mail.perform_deliveries = false
# mail.deliver # Mail::SMTP not called here
# Mail.deliveries.size #=> 0
#
# If you want to test and query the Mail.deliveries collection to see what
# mail you sent, you should set perform_deliveries to true and use
# the :test mail delivery_method:
#
# Mail.deliveries.size #=> 0
# mail.delivery_method :test
# mail.perform_deliveries = true
# mail.deliver
# Mail.deliveries.size #=> 1
#
# This setting is ignored by mail (though still available as a flag) if you
# define a delivery_handler
attr_accessor :perform_deliveries
# If set to false, mail will silently catch and ignore any exceptions
# raised through attempting to deliver an email.
#
# This setting is ignored by mail (though still available as a flag) if you
# define a delivery_handler
attr_accessor :raise_delivery_errors
def register_for_delivery_notification(observer)
STDERR.puts("Message#register_for_delivery_notification is deprecated, please call Mail.register_observer instead")
Mail.register_observer(observer)
end
def inform_observers
Mail.inform_observers(self)
end
def inform_interceptors
Mail.inform_interceptors(self)
end
# Delivers an mail object.
#
# Examples:
#
# mail = Mail.read('file.eml')
# mail.deliver
def deliver
inform_interceptors
if delivery_handler
delivery_handler.deliver_mail(self) { do_delivery }
else
do_delivery
end
inform_observers
self
end
# This method bypasses checking perform_deliveries and raise_delivery_errors,
# so use with caution.
#
# It still however fires off the intercepters and calls the observers callbacks if they are defined.
#
# Returns self
def deliver!
inform_interceptors
response = delivery_method.deliver!(self)
inform_observers
delivery_method.settings[:return_response] ? response : self
end
def delivery_method(method = nil, settings = {})
unless method
@delivery_method
else
@delivery_method = Configuration.instance.lookup_delivery_method(method).new(settings)
end
end
def reply(*args, &block)
self.class.new.tap do |reply|
if message_id
bracketed_message_id = "<#{message_id}>"
reply.in_reply_to = bracketed_message_id
if !references.nil?
refs = [references].flatten.map { |r| "<#{r}>" }
refs << bracketed_message_id
reply.references = refs.join(' ')
elsif !in_reply_to.nil? && !in_reply_to.kind_of?(Array)
reply.references = "<#{in_reply_to}> #{bracketed_message_id}"
end
reply.references ||= bracketed_message_id
end
if subject
reply.subject = subject =~ /^Re:/i ? subject : "RE: #{subject}"
end
if reply_to || from
reply.to = self[reply_to ? :reply_to : :from].to_s
end
if to
reply.from = self[:to].formatted.first.to_s
end
unless args.empty?
if args.flatten.first.respond_to?(:each_pair)
reply.send(:init_with_hash, args.flatten.first)
else
reply.send(:init_with_string, args.flatten[0].to_s.strip)
end
end
if block_given?
reply.instance_eval(&block)
end
end
end
# Provides the operator needed for sort et al.
#
# Compares this mail object with another mail object, this is done by date, so an
# email that is older than another will appear first.
#
# Example:
#
# mail1 = Mail.new do
# date(Time.now)
# end
# mail2 = Mail.new do
# date(Time.now - 86400) # 1 day older
# end
# [mail2, mail1].sort #=> [mail2, mail1]
def <=>(other)
if other.nil?
1
else
self.date <=> other.date
end
end
# Two emails are the same if they have the same fields and body contents. One
# gotcha here is that Mail will insert Message-IDs when calling encoded, so doing
# mail1.encoded == mail2.encoded is most probably not going to return what you think
# as the assigned Message-IDs by Mail (if not already defined as the same) will ensure
# that the two objects are unique, and this comparison will ALWAYS return false.
#
# So the == operator has been defined like so: Two messages are the same if they have
# the same content, ignoring the Message-ID field, unless BOTH emails have a defined and
# different Message-ID value, then they are false.
#
# So, in practice the == operator works like this:
#
# m1 = Mail.new("Subject: Hello\r\n\r\nHello")
# m2 = Mail.new("Subject: Hello\r\n\r\nHello")
# m1 == m2 #=> true
#
# m1 = Mail.new("Subject: Hello\r\n\r\nHello")
# m2 = Mail.new("Message-ID: <1234@test>\r\nSubject: Hello\r\n\r\nHello")
# m1 == m2 #=> true
#
# m1 = Mail.new("Message-ID: <1234@test>\r\nSubject: Hello\r\n\r\nHello")
# m2 = Mail.new("Subject: Hello\r\n\r\nHello")
# m1 == m2 #=> true
#
# m1 = Mail.new("Message-ID: <1234@test>\r\nSubject: Hello\r\n\r\nHello")
# m2 = Mail.new("Message-ID: <1234@test>\r\nSubject: Hello\r\n\r\nHello")
# m1 == m2 #=> true
#
# m1 = Mail.new("Message-ID: <1234@test>\r\nSubject: Hello\r\n\r\nHello")
# m2 = Mail.new("Message-ID: <DIFFERENT@test>\r\nSubject: Hello\r\n\r\nHello")
# m1 == m2 #=> false
def ==(other)
return false unless other.respond_to?(:encoded)
if self.message_id && other.message_id
result = (self.encoded == other.encoded)
else
self_message_id, other_message_id = self.message_id, other.message_id
self.message_id, other.message_id = '<temp@test>', '<temp@test>'
result = self.encoded == other.encoded
self.message_id = "<#{self_message_id}>" if self_message_id
other.message_id = "<#{other_message_id}>" if other_message_id
result
end
end
# Provides access to the raw source of the message as it was when it
# was instantiated. This is set at initialization and so is untouched
# by the parsers or decoder / encoders
#
# Example:
#
# mail = Mail.new('This is an invalid email message')
# mail.raw_source #=> "This is an invalid email message"
def raw_source
@raw_source
end
# Sets the envelope from for the email
def set_envelope( val )
@raw_envelope = val
@envelope = Mail::Envelope.new( val )
end
# The raw_envelope is the From mikel@test.lindsaar.net Mon May 2 16:07:05 2009
# type field that you can see at the top of any email that has come
# from a mailbox
def raw_envelope
@raw_envelope
end
def envelope_from
@envelope ? @envelope.from : nil
end
def envelope_date
@envelope ? @envelope.date : nil
end
# Sets the header of the message object.
#
# Example:
#
# mail.header = 'To: mikel@test.lindsaar.net\r\nFrom: Bob@bob.com'
# mail.header #=> <#Mail::Header
def header=(value)
@header = Mail::Header.new(value, charset)
end
# Returns the header object of the message object. Or, if passed
# a parameter sets the value.
#
# Example:
#
# mail = Mail::Message.new('To: mikel\r\nFrom: you')
# mail.header #=> #<Mail::Header:0x13ce14 @raw_source="To: mikel\r\nFr...
#
# mail.header #=> nil
# mail.header 'To: mikel\r\nFrom: you'
# mail.header #=> #<Mail::Header:0x13ce14 @raw_source="To: mikel\r\nFr...
def header(value = nil)
value ? self.header = value : @header
end
# Provides a way to set custom headers, by passing in a hash
def headers(hash = {})
hash.each_pair do |k,v|
header[k] = v
end
end
# Returns a list of parser errors on the header, each field that had an error
# will be reparsed as an unstructured field to preserve the data inside, but
# will not be used for further processing.
#
# It returns a nested array of [field_name, value, original_error_message]
# per error found.
#
# Example:
#
# message = Mail.new("Content-Transfer-Encoding: weirdo\r\n")
# message.errors.size #=> 1
# message.errors.first[0] #=> "Content-Transfer-Encoding"
# message.errors.first[1] #=> "weirdo"
# message.errors.first[3] #=> <The original error message exception>
#
# This is a good first defence on detecting spam by the way. Some spammers send
# invalid emails to try and get email parsers to give up parsing them.
def errors
header.errors
end
# Returns the Bcc value of the mail object as an array of strings of
# address specs.
#
# Example:
#
# mail.bcc = 'Mikel <mikel@test.lindsaar.net>'
# mail.bcc #=> ['mikel@test.lindsaar.net']
# mail.bcc = 'Mikel <mikel@test.lindsaar.net>, ada@test.lindsaar.net'
# mail.bcc #=> ['mikel@test.lindsaar.net', 'ada@test.lindsaar.net']
#
# Also allows you to set the value by passing a value as a parameter
#
# Example:
#
# mail.bcc 'Mikel <mikel@test.lindsaar.net>'
# mail.bcc #=> ['mikel@test.lindsaar.net']
#
# Additionally, you can append new addresses to the returned Array like
# object.
#
# Example:
#
# mail.bcc 'Mikel <mikel@test.lindsaar.net>'
# mail.bcc << 'ada@test.lindsaar.net'
# mail.bcc #=> ['mikel@test.lindsaar.net', 'ada@test.lindsaar.net']
def bcc( val = nil )
default :bcc, val
end
# Sets the Bcc value of the mail object, pass in a string of the field
#
# Example:
#
# mail.bcc = 'Mikel <mikel@test.lindsaar.net>'
# mail.bcc #=> ['mikel@test.lindsaar.net']
# mail.bcc = 'Mikel <mikel@test.lindsaar.net>, ada@test.lindsaar.net'
# mail.bcc #=> ['mikel@test.lindsaar.net', 'ada@test.lindsaar.net']
def bcc=( val )
header[:bcc] = val
end
# Returns the Cc value of the mail object as an array of strings of
# address specs.
#
# Example:
#
# mail.cc = 'Mikel <mikel@test.lindsaar.net>'
# mail.cc #=> ['mikel@test.lindsaar.net']
# mail.cc = 'Mikel <mikel@test.lindsaar.net>, ada@test.lindsaar.net'
# mail.cc #=> ['mikel@test.lindsaar.net', 'ada@test.lindsaar.net']
#
# Also allows you to set the value by passing a value as a parameter
#
# Example:
#
# mail.cc 'Mikel <mikel@test.lindsaar.net>'
# mail.cc #=> ['mikel@test.lindsaar.net']
#
# Additionally, you can append new addresses to the returned Array like
# object.
#
# Example:
#
# mail.cc 'Mikel <mikel@test.lindsaar.net>'
# mail.cc << 'ada@test.lindsaar.net'
# mail.cc #=> ['mikel@test.lindsaar.net', 'ada@test.lindsaar.net']
def cc( val = nil )
default :cc, val
end
# Sets the Cc value of the mail object, pass in a string of the field
#
# Example:
#
# mail.cc = 'Mikel <mikel@test.lindsaar.net>'
# mail.cc #=> ['mikel@test.lindsaar.net']
# mail.cc = 'Mikel <mikel@test.lindsaar.net>, ada@test.lindsaar.net'
# mail.cc #=> ['mikel@test.lindsaar.net', 'ada@test.lindsaar.net']
def cc=( val )
header[:cc] = val
end
def comments( val = nil )
default :comments, val
end
def comments=( val )
header[:comments] = val
end
def content_description( val = nil )
default :content_description, val
end
def content_description=( val )
header[:content_description] = val
end
def content_disposition( val = nil )
default :content_disposition, val
end
def content_disposition=( val )
header[:content_disposition] = val
end
def content_id( val = nil )
default :content_id, val
end
def content_id=( val )
header[:content_id] = val
end
def content_location( val = nil )
default :content_location, val
end
def content_location=( val )
header[:content_location] = val
end
def content_transfer_encoding( val = nil )
default :content_transfer_encoding, val
end
def content_transfer_encoding=( val )
header[:content_transfer_encoding] = val
end
def content_type( val = nil )
default :content_type, val
end
def content_type=( val )
header[:content_type] = val
end
def date( val = nil )
default :date, val
end
def date=( val )
header[:date] = val
end
def transport_encoding( val = nil)
if val
self.transport_encoding = val
else
@transport_encoding
end
end
def transport_encoding=( val )
@transport_encoding = Mail::Encodings.get_encoding(val)
end
# Returns the From value of the mail object as an array of strings of
# address specs.
#
# Example:
#
# mail.from = 'Mikel <mikel@test.lindsaar.net>'
# mail.from #=> ['mikel@test.lindsaar.net']
# mail.from = 'Mikel <mikel@test.lindsaar.net>, ada@test.lindsaar.net'
# mail.from #=> ['mikel@test.lindsaar.net', 'ada@test.lindsaar.net']
#
# Also allows you to set the value by passing a value as a parameter
#
# Example:
#
# mail.from 'Mikel <mikel@test.lindsaar.net>'
# mail.from #=> ['mikel@test.lindsaar.net']
#
# Additionally, you can append new addresses to the returned Array like
# object.
#
# Example:
#
# mail.from 'Mikel <mikel@test.lindsaar.net>'
# mail.from << 'ada@test.lindsaar.net'
# mail.from #=> ['mikel@test.lindsaar.net', 'ada@test.lindsaar.net']
def from( val = nil )
default :from, val
end
# Sets the From value of the mail object, pass in a string of the field
#
# Example:
#
# mail.from = 'Mikel <mikel@test.lindsaar.net>'
# mail.from #=> ['mikel@test.lindsaar.net']
# mail.from = 'Mikel <mikel@test.lindsaar.net>, ada@test.lindsaar.net'
# mail.from #=> ['mikel@test.lindsaar.net', 'ada@test.lindsaar.net']
def from=( val )
header[:from] = val
end
def in_reply_to( val = nil )
default :in_reply_to, val
end
def in_reply_to=( val )
header[:in_reply_to] = val
end
def keywords( val = nil )
default :keywords, val
end
def keywords=( val )
header[:keywords] = val
end
# Returns the Message-ID of the mail object. Note, per RFC 2822 the Message ID
# consists of what is INSIDE the < > usually seen in the mail header, so this method
# will return only what is inside.
#
# Example:
#
# mail.message_id = '<1234@message.id>'
# mail.message_id #=> '1234@message.id'
#
# Also allows you to set the Message-ID by passing a string as a parameter
#
# mail.message_id '<1234@message.id>'
# mail.message_id #=> '1234@message.id'
def message_id( val = nil )
default :message_id, val
end
# Sets the Message-ID. Note, per RFC 2822 the Message ID consists of what is INSIDE
# the < > usually seen in the mail header, so this method will return only what is inside.
#
# mail.message_id = '<1234@message.id>'
# mail.message_id #=> '1234@message.id'
def message_id=( val )
header[:message_id] = val
end
# Returns the MIME version of the email as a string
#
# Example:
#
# mail.mime_version = '1.0'
# mail.mime_version #=> '1.0'
#
# Also allows you to set the MIME version by passing a string as a parameter.
#
# Example:
#
# mail.mime_version '1.0'
# mail.mime_version #=> '1.0'
def mime_version( val = nil )
default :mime_version, val
end
# Sets the MIME version of the email by accepting a string
#
# Example:
#
# mail.mime_version = '1.0'
# mail.mime_version #=> '1.0'
def mime_version=( val )
header[:mime_version] = val
end
def received( val = nil )
if val
header[:received] = val
else
header[:received]
end
end
def received=( val )
header[:received] = val
end
def references( val = nil )
default :references, val
end
def references=( val )
header[:references] = val
end
# Returns the Reply-To value of the mail object as an array of strings of
# address specs.
#
# Example:
#
# mail.reply_to = 'Mikel <mikel@test.lindsaar.net>'
# mail.reply_to #=> ['mikel@test.lindsaar.net']
# mail.reply_to = 'Mikel <mikel@test.lindsaar.net>, ada@test.lindsaar.net'
# mail.reply_to #=> ['mikel@test.lindsaar.net', 'ada@test.lindsaar.net']
#
# Also allows you to set the value by passing a value as a parameter
#
# Example:
#
# mail.reply_to 'Mikel <mikel@test.lindsaar.net>'
# mail.reply_to #=> ['mikel@test.lindsaar.net']
#
# Additionally, you can append new addresses to the returned Array like
# object.
#
# Example:
#
# mail.reply_to 'Mikel <mikel@test.lindsaar.net>'
# mail.reply_to << 'ada@test.lindsaar.net'
# mail.reply_to #=> ['mikel@test.lindsaar.net', 'ada@test.lindsaar.net']
def reply_to( val = nil )
default :reply_to, val
end
# Sets the Reply-To value of the mail object, pass in a string of the field
#
# Example:
#
# mail.reply_to = 'Mikel <mikel@test.lindsaar.net>'
# mail.reply_to #=> ['mikel@test.lindsaar.net']
# mail.reply_to = 'Mikel <mikel@test.lindsaar.net>, ada@test.lindsaar.net'
# mail.reply_to #=> ['mikel@test.lindsaar.net', 'ada@test.lindsaar.net']
def reply_to=( val )
header[:reply_to] = val
end
# Returns the Resent-Bcc value of the mail object as an array of strings of
# address specs.
#
# Example:
#
# mail.resent_bcc = 'Mikel <mikel@test.lindsaar.net>'
# mail.resent_bcc #=> ['mikel@test.lindsaar.net']
# mail.resent_bcc = 'Mikel <mikel@test.lindsaar.net>, ada@test.lindsaar.net'
# mail.resent_bcc #=> ['mikel@test.lindsaar.net', 'ada@test.lindsaar.net']
#
# Also allows you to set the value by passing a value as a parameter
#
# Example:
#
# mail.resent_bcc 'Mikel <mikel@test.lindsaar.net>'
# mail.resent_bcc #=> ['mikel@test.lindsaar.net']
#
# Additionally, you can append new addresses to the returned Array like
# object.
#
# Example:
#
# mail.resent_bcc 'Mikel <mikel@test.lindsaar.net>'
# mail.resent_bcc << 'ada@test.lindsaar.net'
# mail.resent_bcc #=> ['mikel@test.lindsaar.net', 'ada@test.lindsaar.net']
def resent_bcc( val = nil )
default :resent_bcc, val
end
# Sets the Resent-Bcc value of the mail object, pass in a string of the field
#
# Example:
#
# mail.resent_bcc = 'Mikel <mikel@test.lindsaar.net>'
# mail.resent_bcc #=> ['mikel@test.lindsaar.net']
# mail.resent_bcc = 'Mikel <mikel@test.lindsaar.net>, ada@test.lindsaar.net'
# mail.resent_bcc #=> ['mikel@test.lindsaar.net', 'ada@test.lindsaar.net']
def resent_bcc=( val )
header[:resent_bcc] = val
end
# Returns the Resent-Cc value of the mail object as an array of strings of
# address specs.
#
# Example:
#
# mail.resent_cc = 'Mikel <mikel@test.lindsaar.net>'
# mail.resent_cc #=> ['mikel@test.lindsaar.net']
# mail.resent_cc = 'Mikel <mikel@test.lindsaar.net>, ada@test.lindsaar.net'
# mail.resent_cc #=> ['mikel@test.lindsaar.net', 'ada@test.lindsaar.net']
#
# Also allows you to set the value by passing a value as a parameter
#
# Example:
#
# mail.resent_cc 'Mikel <mikel@test.lindsaar.net>'
# mail.resent_cc #=> ['mikel@test.lindsaar.net']
#
# Additionally, you can append new addresses to the returned Array like
# object.
#
# Example:
#
# mail.resent_cc 'Mikel <mikel@test.lindsaar.net>'
# mail.resent_cc << 'ada@test.lindsaar.net'
# mail.resent_cc #=> ['mikel@test.lindsaar.net', 'ada@test.lindsaar.net']
def resent_cc( val = nil )
default :resent_cc, val
end
# Sets the Resent-Cc value of the mail object, pass in a string of the field
#
# Example:
#
# mail.resent_cc = 'Mikel <mikel@test.lindsaar.net>'
# mail.resent_cc #=> ['mikel@test.lindsaar.net']
# mail.resent_cc = 'Mikel <mikel@test.lindsaar.net>, ada@test.lindsaar.net'
# mail.resent_cc #=> ['mikel@test.lindsaar.net', 'ada@test.lindsaar.net']
def resent_cc=( val )
header[:resent_cc] = val
end
def resent_date( val = nil )
default :resent_date, val
end
def resent_date=( val )
header[:resent_date] = val
end
# Returns the Resent-From value of the mail object as an array of strings of
# address specs.
#
# Example:
#
# mail.resent_from = 'Mikel <mikel@test.lindsaar.net>'
# mail.resent_from #=> ['mikel@test.lindsaar.net']
# mail.resent_from = 'Mikel <mikel@test.lindsaar.net>, ada@test.lindsaar.net'
# mail.resent_from #=> ['mikel@test.lindsaar.net', 'ada@test.lindsaar.net']
#
# Also allows you to set the value by passing a value as a parameter
#
# Example:
#
# mail.resent_from ['Mikel <mikel@test.lindsaar.net>']
# mail.resent_from #=> 'mikel@test.lindsaar.net'
#
# Additionally, you can append new addresses to the returned Array like
# object.
#
# Example:
#
# mail.resent_from 'Mikel <mikel@test.lindsaar.net>'
# mail.resent_from << 'ada@test.lindsaar.net'
# mail.resent_from #=> ['mikel@test.lindsaar.net', 'ada@test.lindsaar.net']
def resent_from( val = nil )
default :resent_from, val
end
# Sets the Resent-From value of the mail object, pass in a string of the field
#
# Example:
#
# mail.resent_from = 'Mikel <mikel@test.lindsaar.net>'
# mail.resent_from #=> ['mikel@test.lindsaar.net']
# mail.resent_from = 'Mikel <mikel@test.lindsaar.net>, ada@test.lindsaar.net'
# mail.resent_from #=> ['mikel@test.lindsaar.net', 'ada@test.lindsaar.net']
def resent_from=( val )
header[:resent_from] = val
end
def resent_message_id( val = nil )
default :resent_message_id, val
end
def resent_message_id=( val )
header[:resent_message_id] = val
end
# Returns the Resent-Sender value of the mail object, as a single string of an address
# spec. A sender per RFC 2822 must be a single address, so you can not append to
# this address.
#
# Example:
#
# mail.resent_sender = 'Mikel <mikel@test.lindsaar.net>'
# mail.resent_sender #=> 'mikel@test.lindsaar.net'
#
# Also allows you to set the value by passing a value as a parameter
#
# Example:
#
# mail.resent_sender 'Mikel <mikel@test.lindsaar.net>'
# mail.resent_sender #=> 'mikel@test.lindsaar.net'
def resent_sender( val = nil )
default :resent_sender, val
end
# Sets the Resent-Sender value of the mail object, pass in a string of the field
#
# Example:
#
# mail.sender = 'Mikel <mikel@test.lindsaar.net>'
# mail.sender #=> 'mikel@test.lindsaar.net'
def resent_sender=( val )
header[:resent_sender] = val
end
# Returns the Resent-To value of the mail object as an array of strings of
# address specs.
#
# Example:
#
# mail.resent_to = 'Mikel <mikel@test.lindsaar.net>'
# mail.resent_to #=> ['mikel@test.lindsaar.net']
# mail.resent_to = 'Mikel <mikel@test.lindsaar.net>, ada@test.lindsaar.net'
# mail.resent_to #=> ['mikel@test.lindsaar.net', 'ada@test.lindsaar.net']
#
# Also allows you to set the value by passing a value as a parameter
#
# Example:
#
# mail.resent_to 'Mikel <mikel@test.lindsaar.net>'
# mail.resent_to #=> ['mikel@test.lindsaar.net']
#
# Additionally, you can append new addresses to the returned Array like
# object.
#
# Example:
#
# mail.resent_to 'Mikel <mikel@test.lindsaar.net>'
# mail.resent_to << 'ada@test.lindsaar.net'
# mail.resent_to #=> ['mikel@test.lindsaar.net', 'ada@test.lindsaar.net']
def resent_to( val = nil )
default :resent_to, val
end
# Sets the Resent-To value of the mail object, pass in a string of the field
#
# Example:
#
# mail.resent_to = 'Mikel <mikel@test.lindsaar.net>'
# mail.resent_to #=> ['mikel@test.lindsaar.net']
# mail.resent_to = 'Mikel <mikel@test.lindsaar.net>, ada@test.lindsaar.net'
# mail.resent_to #=> ['mikel@test.lindsaar.net', 'ada@test.lindsaar.net']
def resent_to=( val )
header[:resent_to] = val
end
# Returns the return path of the mail object, or sets it if you pass a string
def return_path( val = nil )
default :return_path, val
end
# Sets the return path of the object
def return_path=( val )
header[:return_path] = val
end
# Returns the Sender value of the mail object, as a single string of an address
# spec. A sender per RFC 2822 must be a single address.
#