Class Evernote::EDAM::NoteStore::NoteEmailParameters
In: ruby/lib/Evernote/EDAM/note_store_types.rb
Parent: Object

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

<dl>

 <dt>guid</dt>
   <dd>
     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.
   </dd>

 <dt>note</dt>
   <dd>
     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.
   </dd>

 <dt>toAddresses</dt>
   <dd>
     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.
   </dd>

 <dt>ccAddresses</dt>
   <dd>
     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.
   </dd>

 <dt>subject</dt>
   <dd>
     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.
   </dd>

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

</dl>

Methods

Included Modules

::Thrift::Struct ::Thrift::Struct_Union

Constants

GUID = 1
NOTE = 2
TOADDRESSES = 3
CCADDRESSES = 4
SUBJECT = 5
MESSAGE = 6
FIELDS = { GUID => {:type => ::Thrift::Types::STRING, :name => 'guid', :optional => true}, NOTE => {:type => ::Thrift::Types::STRUCT, :name => 'note', :class => Evernote::EDAM::Type::Note, :optional => true}, TOADDRESSES => {:type => ::Thrift::Types::LIST, :name => 'toAddresses', :element => {:type => ::Thrift::Types::STRING}, :optional => true}, CCADDRESSES => {:type => ::Thrift::Types::LIST, :name => 'ccAddresses', :element => {:type => ::Thrift::Types::STRING}, :optional => true}, SUBJECT => {:type => ::Thrift::Types::STRING, :name => 'subject', :optional => true}, MESSAGE => {:type => ::Thrift::Types::STRING, :name => 'message', :optional => true}

Public Instance methods

[Source]

     # File ruby/lib/Evernote/EDAM/note_store_types.rb, line 561
561:               def struct_fields; FIELDS; end

[Source]

     # File ruby/lib/Evernote/EDAM/note_store_types.rb, line 563
563:               def validate
564:               end

[Validate]