com.evernote.edam.notestore
Class NoteEmailParameters

java.lang.Object
  com.evernote.edam.notestore.NoteEmailParameters

All Implemented Interfaces:

com.evernote.thrift.TBase<NoteEmailParameters>, java.io.Serializable, java.lang.Cloneable, java.lang.Comparable<NoteEmailParameters>

public class NoteEmailParameters
extends java.lang.Object
implements com.evernote.thrift.TBase<NoteEmailParameters>, java.io.Serializable, java.lang.Cloneable

Parameters that must be given to the NoteStore emailNote call. These allow the caller to specify the note to send, the recipient addresses, etc.

guid

If set, this must be the GUID of a note within the user's account that should be retrieved from the service and sent as email. If not set, the 'note' field must be provided instead.

note

If the 'guid' field is not set, this field must be provided, including the full contents of the note note (and all of its Resources) to send. This can be used for a Note that as not been created in the service, for example by a local client with local notes.

toAddresses

If provided, this should contain a list of the SMTP email addresses that should be included in the "To:" line of the email. Callers must specify at least one "to" or "cc" email address.

ccAddresses

If provided, this should contain a list of the SMTP email addresses that should be included in the "Cc:" line of the email. Callers must specify at least one "to" or "cc" email address.

subject

If provided, this should contain the subject line of the email that will be sent. If not provided, the title of the note will be used as the subject of the email.

message

If provided, this is additional personal text that should be included into the email as a message from the owner to the recipient(s).

See Also:

Serialized Form

Constructor Summary

NoteEmailParameters()

NoteEmailParameters(NoteEmailParameters other)
Performs a deep copy on other.

Method Summary

void	addToCcAddresses(java.lang.String elem)
void	addToToAddresses(java.lang.String elem)
void	clear() Return to the state of having just been initialized, as though you had just called the default constructor.
int	compareTo(NoteEmailParameters other)
NoteEmailParameters	deepCopy() Creates a deep copy of the object.
boolean	equals(NoteEmailParameters that)
boolean	equals(java.lang.Object that)
java.util.List<java.lang.String>	getCcAddresses()
java.util.Iterator<java.lang.String>	getCcAddressesIterator()
int	getCcAddressesSize()
java.lang.String	getGuid()
java.lang.String	getMessage()
Note	getNote()
java.lang.String	getSubject()
java.util.List<java.lang.String>	getToAddresses()
java.util.Iterator<java.lang.String>	getToAddressesIterator()
int	getToAddressesSize()
int	hashCode()
boolean	isSetCcAddresses() Returns true if field ccAddresses is set (has been asigned a value) and false otherwise
boolean	isSetGuid() Returns true if field guid is set (has been asigned a value) and false otherwise
boolean	isSetMessage() Returns true if field message is set (has been asigned a value) and false otherwise
boolean	isSetNote() Returns true if field note is set (has been asigned a value) and false otherwise
boolean	isSetSubject() Returns true if field subject is set (has been asigned a value) and false otherwise
boolean	isSetToAddresses() Returns true if field toAddresses is set (has been asigned a value) and false otherwise
void	read(com.evernote.thrift.protocol.TProtocol iprot) Reads an instance of the object from the given protocol.
void	setCcAddresses(java.util.List<java.lang.String> ccAddresses)
void	setCcAddressesIsSet(boolean value)
void	setGuid(java.lang.String guid)
void	setGuidIsSet(boolean value)
void	setMessage(java.lang.String message)
void	setMessageIsSet(boolean value)
void	setNote(Note note)
void	setNoteIsSet(boolean value)
void	setSubject(java.lang.String subject)
void	setSubjectIsSet(boolean value)
void	setToAddresses(java.util.List<java.lang.String> toAddresses)
void	setToAddressesIsSet(boolean value)
java.lang.String	toString()
void	unsetCcAddresses()
void	unsetGuid()
void	unsetMessage()
void	unsetNote()
void	unsetSubject()
void	unsetToAddresses()
void	validate()
void	write(com.evernote.thrift.protocol.TProtocol oprot) Writes the object to the given protocol.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

NoteEmailParameters

public NoteEmailParameters()

NoteEmailParameters

public NoteEmailParameters(NoteEmailParameters other)

Performs a deep copy on other.

Method Detail

deepCopy

public NoteEmailParameters deepCopy()

Description copied from interface: com.evernote.thrift.TBase

Creates a deep copy of the object.

Specified by:

deepCopy in interface com.evernote.thrift.TBase<NoteEmailParameters>

clear

public void clear()

Description copied from interface: com.evernote.thrift.TBase

Return to the state of having just been initialized, as though you had just called the default constructor.

Specified by:

clear in interface com.evernote.thrift.TBase<NoteEmailParameters>

getGuid

public java.lang.String getGuid()

setGuid

public void setGuid(java.lang.String guid)

unsetGuid

public void unsetGuid()

isSetGuid

public boolean isSetGuid()

Returns true if field guid is set (has been asigned a value) and false otherwise

setGuidIsSet

public void setGuidIsSet(boolean value)

getNote

public Note getNote()

setNote

public void setNote(Note note)

unsetNote

public void unsetNote()

isSetNote

public boolean isSetNote()

Returns true if field note is set (has been asigned a value) and false otherwise

setNoteIsSet

public void setNoteIsSet(boolean value)

getToAddressesSize

public int getToAddressesSize()

getToAddressesIterator

public java.util.Iterator<java.lang.String> getToAddressesIterator()

addToToAddresses

public void addToToAddresses(java.lang.String elem)

getToAddresses

public java.util.List<java.lang.String> getToAddresses()

setToAddresses

public void setToAddresses(java.util.List<java.lang.String> toAddresses)

unsetToAddresses

public void unsetToAddresses()

isSetToAddresses

public boolean isSetToAddresses()

Returns true if field toAddresses is set (has been asigned a value) and false otherwise

setToAddressesIsSet

public void setToAddressesIsSet(boolean value)

getCcAddressesSize

public int getCcAddressesSize()

getCcAddressesIterator

public java.util.Iterator<java.lang.String> getCcAddressesIterator()

addToCcAddresses

public void addToCcAddresses(java.lang.String elem)

getCcAddresses

public java.util.List<java.lang.String> getCcAddresses()

setCcAddresses

public void setCcAddresses(java.util.List<java.lang.String> ccAddresses)

unsetCcAddresses

public void unsetCcAddresses()

isSetCcAddresses

public boolean isSetCcAddresses()

Returns true if field ccAddresses is set (has been asigned a value) and false otherwise

setCcAddressesIsSet

public void setCcAddressesIsSet(boolean value)

getSubject

public java.lang.String getSubject()

setSubject

public void setSubject(java.lang.String subject)

unsetSubject

public void unsetSubject()

isSetSubject

public boolean isSetSubject()

Returns true if field subject is set (has been asigned a value) and false otherwise

setSubjectIsSet

public void setSubjectIsSet(boolean value)

getMessage

public java.lang.String getMessage()

setMessage

public void setMessage(java.lang.String message)

unsetMessage

public void unsetMessage()

isSetMessage

public boolean isSetMessage()

Returns true if field message is set (has been asigned a value) and false otherwise

setMessageIsSet

public void setMessageIsSet(boolean value)

equals

public boolean equals(java.lang.Object that)

Overrides:

equals in class java.lang.Object

equals

public boolean equals(NoteEmailParameters that)

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

compareTo

public int compareTo(NoteEmailParameters other)

Specified by:

compareTo in interface java.lang.Comparable<NoteEmailParameters>

read

public void read(com.evernote.thrift.protocol.TProtocol iprot)
          throws com.evernote.thrift.TException

Description copied from interface: com.evernote.thrift.TBase

Reads an instance of the object from the given protocol.

Specified by:

read in interface com.evernote.thrift.TBase<NoteEmailParameters>

Parameters:

iprot - Input protocol

Throws:

com.evernote.thrift.TException

write

public void write(com.evernote.thrift.protocol.TProtocol oprot)
           throws com.evernote.thrift.TException

Description copied from interface: com.evernote.thrift.TBase

Writes the object to the given protocol.

Specified by:

write in interface com.evernote.thrift.TBase<NoteEmailParameters>

Parameters:

oprot - Output protocol

Throws:

com.evernote.thrift.TException

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

validate

public void validate()
              throws com.evernote.thrift.TException

Throws:

com.evernote.thrift.TException