Class: Google::Apis::GmailV1::Message
- Inherits:
-
Object
- Object
- Google::Apis::GmailV1::Message
- Includes:
- Core::Hashable, Core::JsonObjectSupport
- Defined in:
- lib/google/apis/gmail_v1/classes.rb,
lib/google/apis/gmail_v1/representations.rb,
lib/google/apis/gmail_v1/representations.rb
Overview
An email message.
Instance Attribute Summary collapse
-
#history_id ⇒ Fixnum
The ID of the last history record that modified this message.
-
#id ⇒ String
The immutable ID of the message.
-
#internal_date ⇒ Fixnum
The internal message creation timestamp (epoch ms), which determines ordering in the inbox.
-
#label_ids ⇒ Array<String>
List of IDs of labels applied to this message.
-
#payload ⇒ Google::Apis::GmailV1::MessagePart
A single MIME message part.
-
#raw ⇒ String
The entire email message in an RFC 2822 formatted and base64url encoded string.
-
#size_estimate ⇒ Fixnum
Estimated size in bytes of the message.
-
#snippet ⇒ String
A short part of the message text.
-
#thread_id ⇒ String
The ID of the thread the message belongs to.
Instance Method Summary collapse
-
#initialize(**args) ⇒ Message
constructor
A new instance of Message.
-
#update!(**args) ⇒ Object
Update properties of this object.
Constructor Details
#initialize(**args) ⇒ Message
Returns a new instance of Message.
1248 1249 1250 |
# File 'lib/google/apis/gmail_v1/classes.rb', line 1248 def initialize(**args) update!(**args) end |
Instance Attribute Details
#history_id ⇒ Fixnum
The ID of the last history record that modified this message.
Corresponds to the JSON property historyId
1194 1195 1196 |
# File 'lib/google/apis/gmail_v1/classes.rb', line 1194 def history_id @history_id end |
#id ⇒ String
The immutable ID of the message.
Corresponds to the JSON property id
1199 1200 1201 |
# File 'lib/google/apis/gmail_v1/classes.rb', line 1199 def id @id end |
#internal_date ⇒ Fixnum
The internal message creation timestamp (epoch ms), which determines ordering
in the inbox. For normal SMTP-received email, this represents the time the
message was originally accepted by Google, which is more reliable than the
Date
header. However, for API-migrated mail, it can be configured by client
to be based on the Date
header.
Corresponds to the JSON property internalDate
1208 1209 1210 |
# File 'lib/google/apis/gmail_v1/classes.rb', line 1208 def internal_date @internal_date end |
#label_ids ⇒ Array<String>
List of IDs of labels applied to this message.
Corresponds to the JSON property labelIds
1213 1214 1215 |
# File 'lib/google/apis/gmail_v1/classes.rb', line 1213 def label_ids @label_ids end |
#payload ⇒ Google::Apis::GmailV1::MessagePart
A single MIME message part.
Corresponds to the JSON property payload
1218 1219 1220 |
# File 'lib/google/apis/gmail_v1/classes.rb', line 1218 def payload @payload end |
#raw ⇒ String
The entire email message in an RFC 2822 formatted and base64url encoded string.
Returned in messages.get
and drafts.get
responses when the format=RAW
parameter is supplied.
Corresponds to the JSON property raw
NOTE: Values are automatically base64 encoded/decoded in the client library.
1226 1227 1228 |
# File 'lib/google/apis/gmail_v1/classes.rb', line 1226 def raw @raw end |
#size_estimate ⇒ Fixnum
Estimated size in bytes of the message.
Corresponds to the JSON property sizeEstimate
1231 1232 1233 |
# File 'lib/google/apis/gmail_v1/classes.rb', line 1231 def size_estimate @size_estimate end |
#snippet ⇒ String
A short part of the message text.
Corresponds to the JSON property snippet
1236 1237 1238 |
# File 'lib/google/apis/gmail_v1/classes.rb', line 1236 def snippet @snippet end |
#thread_id ⇒ String
The ID of the thread the message belongs to. To add a message or draft to a
thread, the following criteria must be met: 1. The requested threadId
must
be specified on the Message
or Draft.Message
you supply with your request.
- The
References
andIn-Reply-To
headers must be set in compliance with the RFC 2822 standard. 3. TheSubject
headers must match. Corresponds to the JSON propertythreadId
1246 1247 1248 |
# File 'lib/google/apis/gmail_v1/classes.rb', line 1246 def thread_id @thread_id end |
Instance Method Details
#update!(**args) ⇒ Object
Update properties of this object
1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 |
# File 'lib/google/apis/gmail_v1/classes.rb', line 1253 def update!(**args) @history_id = args[:history_id] if args.key?(:history_id) @id = args[:id] if args.key?(:id) @internal_date = args[:internal_date] if args.key?(:internal_date) @label_ids = args[:label_ids] if args.key?(:label_ids) @payload = args[:payload] if args.key?(:payload) @raw = args[:raw] if args.key?(:raw) @size_estimate = args[:size_estimate] if args.key?(:size_estimate) @snippet = args[:snippet] if args.key?(:snippet) @thread_id = args[:thread_id] if args.key?(:thread_id) end |