qevercloud::NoteEmailParameters Struct Reference

#include <types.h>

Public Member Functions
bool	operator== (const NoteEmailParameters &other) const
bool	operator!= (const NoteEmailParameters &other) const

Public Attributes
Optional< QString >	guid
Optional< Note >	note
Optional< QStringList >	toAddresses
Optional< QStringList >	ccAddresses
Optional< QString >	subject
Optional< QString >	message

Detailed Description

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

Member Function Documentation

bool qevercloud::NoteEmailParameters::operator!= ( const NoteEmailParameters &  other ) const

inline

bool qevercloud::NoteEmailParameters::operator== ( const NoteEmailParameters &  other ) const

inline

Member Data Documentation

Optional< QStringList > qevercloud::NoteEmailParameters::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.

Optional< QString > qevercloud::NoteEmailParameters::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.

Optional< QString > qevercloud::NoteEmailParameters::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).

Optional< Note > qevercloud::NoteEmailParameters::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.

Optional< QString > qevercloud::NoteEmailParameters::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.

Optional< QStringList > qevercloud::NoteEmailParameters::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.