com.google.api.services.gmail.model

Class MessagePartBody

java.lang.Object

java.util.AbstractMap<java.lang.String,java.lang.Object>

com.google.api.client.util.GenericData

com.google.api.client.json.GenericJson

com.google.api.services.gmail.model.MessagePartBody

All Implemented Interfaces:

java.lang.Cloneable, java.util.Map<java.lang.String,java.lang.Object>

public final class MessagePartBody
extends com.google.api.client.json.GenericJson

The body of a single MIME message part.

This is the Java data model class that specifies how to parse/serialize into the JSON that is transmitted over HTTP when working with the Gmail API. For a detailed explanation see: http://code.google.com/p/google-http-java-client/wiki/JSON

Author:

Google, Inc.

Nested Class Summary

Nested classes/interfaces inherited from class com.google.api.client.util.GenericData

com.google.api.client.util.GenericData.Flags

Nested classes/interfaces inherited from class java.util.AbstractMap

java.util.AbstractMap.SimpleEntry<K,V>, java.util.AbstractMap.SimpleImmutableEntry<K,V>

Nested classes/interfaces inherited from interface java.util.Map

java.util.Map.Entry<K,V>

Constructor Summary

Constructors

Constructor and Description
MessagePartBody()

Method Summary

Methods

Modifier and Type	Method and Description
MessagePartBody	clone()
byte[]	decodeData() The body data of a MIME message part.
MessagePartBody	encodeData(byte[] data) The body data of a MIME message part.
java.lang.String	getAttachmentId() When present, contains the ID of an external attachment that can be retrieved in a separate messages.attachments.get request.
java.lang.String	getData() The body data of a MIME message part.
java.lang.Integer	getSize() Total number of bytes in the body of the message part.
MessagePartBody	set(java.lang.String fieldName, java.lang.Object value)
MessagePartBody	setAttachmentId(java.lang.String attachmentId) When present, contains the ID of an external attachment that can be retrieved in a separate messages.attachments.get request.
MessagePartBody	setData(java.lang.String data) The body data of a MIME message part.
MessagePartBody	setSize(java.lang.Integer size) Total number of bytes in the body of the message part.

Methods inherited from class com.google.api.client.json.GenericJson

getFactory, setFactory, toPrettyString, toString

Methods inherited from class com.google.api.client.util.GenericData

entrySet, get, getClassInfo, getUnknownKeys, put, putAll, remove, setUnknownKeys

Methods inherited from class java.util.AbstractMap

clear, containsKey, containsValue, equals, hashCode, isEmpty, keySet, size, values

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

MessagePartBody

public MessagePartBody()

Method Detail

getAttachmentId

public java.lang.String getAttachmentId()

When present, contains the ID of an external attachment that can be retrieved in a separate messages.attachments.get request. When not present, the entire content of the message part body is contained in the data field.

Returns:

value or null for none

setAttachmentId

public MessagePartBody setAttachmentId(java.lang.String attachmentId)

When present, contains the ID of an external attachment that can be retrieved in a separate messages.attachments.get request. When not present, the entire content of the message part body is contained in the data field.

Parameters:

attachmentId - attachmentId or null for none

getData

public java.lang.String getData()

The body data of a MIME message part. May be empty for MIME container types that have no message body or when the body data is sent as a separate attachment. An attachment ID is present if the body data is contained in a separate attachment.

Returns:

value or null for none

See Also:

decodeData()

decodeData

public byte[] decodeData()

The body data of a MIME message part. May be empty for MIME container types that have no message body or when the body data is sent as a separate attachment. An attachment ID is present if the body data is contained in a separate attachment.

Returns:

Base64 decoded value or null for none

Since:

1.14

See Also:

getData()

setData

public MessagePartBody setData(java.lang.String data)

The body data of a MIME message part. May be empty for MIME container types that have no message body or when the body data is sent as a separate attachment. An attachment ID is present if the body data is contained in a separate attachment.

Parameters:

data - data or null for none

See Also:

#encodeData()

encodeData

public MessagePartBody encodeData(byte[] data)

The body data of a MIME message part. May be empty for MIME container types that have no message body or when the body data is sent as a separate attachment. An attachment ID is present if the body data is contained in a separate attachment.

Since:

1.14

See Also:

The value is encoded Base64 or {@code null} for none.

getSize

public java.lang.Integer getSize()

Total number of bytes in the body of the message part.

Returns:

value or null for none

setSize

public MessagePartBody setSize(java.lang.Integer size)

Total number of bytes in the body of the message part.

Parameters:

size - size or null for none

set

public MessagePartBody set(java.lang.String fieldName,
                  java.lang.Object value)

Overrides:

set in class com.google.api.client.json.GenericJson

clone

public MessagePartBody clone()

Overrides:

clone in class com.google.api.client.json.GenericJson