Class: MicrosoftGraph::Models::MailTips

Inherits:
Object
  • Object
show all
Includes:
MicrosoftKiotaAbstractions::AdditionalDataHolder, MicrosoftKiotaAbstractions::Parsable
Defined in:
lib/models/mail_tips.rb

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize ⇒ Object

Instantiates a new mailTips and sets the default values.



85
86
87
 
# File 'lib/models/mail_tips.rb', line 85

def initialize()
    @additional_data = Hash.new
end

Class Method Details

.create_from_discriminator_value(parse_node) ⇒ Object

Creates a new instance of the appropriate class based on discriminator value

Parameters:

  • parse_node —

    The parse node to use to read the discriminator value and create the object

Returns:

  • a mail_tips

Raises:

  • (StandardError) 


93
94
95
96
 
# File 'lib/models/mail_tips.rb', line 93

def self.create_from_discriminator_value(parse_node)
    raise StandardError, 'parse_node cannot be null' if parse_node.nil?
    return MailTips.new
end

Instance Method Details

#additional_data ⇒ Object

Gets the additionalData property value. Stores additional data not described in the OpenAPI description found when deserializing. Can be used for serialization as well.

Returns:

  • a i_dictionary



55
56
57
 
# File 'lib/models/mail_tips.rb', line 55

def additional_data
    return @additional_data
end

#additional_data=(value) ⇒ Object

Sets the additionalData property value. Stores additional data not described in the OpenAPI description found when deserializing. Can be used for serialization as well.

Parameters:

  • value —

    Value to set for the additionalData property.

Returns:

  • a void



63
64
65
 
# File 'lib/models/mail_tips.rb', line 63

def additional_data=(value)
    @additional_data = value
end

#automatic_replies ⇒ Object

Gets the automaticReplies property value. Mail tips for automatic reply if it has been set up by the recipient.

Returns:

  • a automatic_replies_mail_tips



70
71
72
 
# File 'lib/models/mail_tips.rb', line 70

def automatic_replies
    return @automatic_replies
end

#automatic_replies=(value) ⇒ Object

Sets the automaticReplies property value. Mail tips for automatic reply if it has been set up by the recipient.

Parameters:

  • value —

    Value to set for the automaticReplies property.

Returns:

  • a void



78
79
80
 
# File 'lib/models/mail_tips.rb', line 78

def automatic_replies=(value)
    @automatic_replies = value
end

#custom_mail_tip ⇒ Object

Gets the customMailTip property value. A custom mail tip that can be set on the recipient’s mailbox.

Returns:

  • a string



101
102
103
 
# File 'lib/models/mail_tips.rb', line 101

def custom_mail_tip
    return @custom_mail_tip
end

#custom_mail_tip=(value) ⇒ Object

Sets the customMailTip property value. A custom mail tip that can be set on the recipient’s mailbox.

Parameters:

  • value —

    Value to set for the customMailTip property.

Returns:

  • a void



109
110
111
 
# File 'lib/models/mail_tips.rb', line 109

def custom_mail_tip=(value)
    @custom_mail_tip = value
end

#delivery_restricted ⇒ Object

Gets the deliveryRestricted property value. Whether the recipient’s mailbox is restricted, for example, accepting messages from only a predefined list of senders, rejecting messages from a predefined list of senders, or accepting messages from only authenticated senders.

Returns:

  • a boolean



116
117
118
 
# File 'lib/models/mail_tips.rb', line 116

def delivery_restricted
    return @delivery_restricted
end

#delivery_restricted=(value) ⇒ Object

Sets the deliveryRestricted property value. Whether the recipient’s mailbox is restricted, for example, accepting messages from only a predefined list of senders, rejecting messages from a predefined list of senders, or accepting messages from only authenticated senders.

Parameters:

  • value —

    Value to set for the deliveryRestricted property.

Returns:

  • a void



124
125
126
 
# File 'lib/models/mail_tips.rb', line 124

def delivery_restricted=(value)
    @delivery_restricted = value
end

#email_address ⇒ Object

Gets the emailAddress property value. The email address of the recipient to get mailtips for.

Returns:

  • a email_address



131
132
133
 
# File 'lib/models/mail_tips.rb', line 131

def email_address
    return @email_address
end

#email_address=(value) ⇒ Object

Sets the emailAddress property value. The email address of the recipient to get mailtips for.

Parameters:

  • value —

    Value to set for the emailAddress property.

Returns:

  • a void



139
140
141
 
# File 'lib/models/mail_tips.rb', line 139

def email_address=(value)
    @email_address = value
end

#error ⇒ Object

Gets the error property value. Errors that occur during the getMailTips action.

Returns:

  • a mail_tips_error



146
147
148
 
# File 'lib/models/mail_tips.rb', line 146

def error
    return @error
end

#error=(value) ⇒ Object

Sets the error property value. Errors that occur during the getMailTips action.

Parameters:

  • value —

    Value to set for the error property.

Returns:

  • a void



154
155
156
 
# File 'lib/models/mail_tips.rb', line 154

def error=(value)
    @error = value
end

#external_member_count ⇒ Object

Gets the externalMemberCount property value. The number of external members if the recipient is a distribution list.

Returns:

  • a integer



161
162
163
 
# File 'lib/models/mail_tips.rb', line 161

def external_member_count
    return @external_member_count
end

#external_member_count=(value) ⇒ Object

Sets the externalMemberCount property value. The number of external members if the recipient is a distribution list.

Parameters:

  • value —

    Value to set for the externalMemberCount property.

Returns:

  • a void



169
170
171
 
# File 'lib/models/mail_tips.rb', line 169

def external_member_count=(value)
    @external_member_count = value
end

#get_field_deserializers ⇒ Object

The deserialization information for the current model

Returns:

  • a i_dictionary



176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
 
# File 'lib/models/mail_tips.rb', line 176

def get_field_deserializers()
    return {
        "automaticReplies" => lambda {|n| @automatic_replies = n.get_object_value(lambda {|pn| MicrosoftGraph::Models::AutomaticRepliesMailTips.create_from_discriminator_value(pn) }) },
        "customMailTip" => lambda {|n| @custom_mail_tip = n.get_string_value() },
        "deliveryRestricted" => lambda {|n| @delivery_restricted = n.get_boolean_value() },
        "emailAddress" => lambda {|n| @email_address = n.get_object_value(lambda {|pn| MicrosoftGraph::Models::EmailAddress.create_from_discriminator_value(pn) }) },
        "error" => lambda {|n| @error = n.get_object_value(lambda {|pn| MicrosoftGraph::Models::MailTipsError.create_from_discriminator_value(pn) }) },
        "externalMemberCount" => lambda {|n| @external_member_count = n.get_number_value() },
        "isModerated" => lambda {|n| @is_moderated = n.get_boolean_value() },
        "mailboxFull" => lambda {|n| @mailbox_full = n.get_boolean_value() },
        "maxMessageSize" => lambda {|n| @max_message_size = n.get_number_value() },
        "@odata.type" => lambda {|n| @odata_type = n.get_string_value() },
        "recipientScope" => lambda {|n| @recipient_scope = n.get_enum_value(MicrosoftGraph::Models::RecipientScopeType) },
        "recipientSuggestions" => lambda {|n| @recipient_suggestions = n.get_collection_of_object_values(lambda {|pn| MicrosoftGraph::Models::Recipient.create_from_discriminator_value(pn) }) },
        "totalMemberCount" => lambda {|n| @total_member_count = n.get_number_value() },
    }
end

#is_moderated ⇒ Object

Gets the isModerated property value. Whether sending messages to the recipient requires approval. For example, if the recipient is a large distribution list and a moderator has been set up to approve messages sent to that distribution list, or if sending messages to a recipient requires approval of the recipient’s manager.

Returns:

  • a boolean



197
198
199
 
# File 'lib/models/mail_tips.rb', line 197

def is_moderated
    return @is_moderated
end

#is_moderated=(value) ⇒ Object

Sets the isModerated property value. Whether sending messages to the recipient requires approval. For example, if the recipient is a large distribution list and a moderator has been set up to approve messages sent to that distribution list, or if sending messages to a recipient requires approval of the recipient’s manager.

Parameters:

  • value —

    Value to set for the isModerated property.

Returns:

  • a void



205
206
207
 
# File 'lib/models/mail_tips.rb', line 205

def is_moderated=(value)
    @is_moderated = value
end

#mailbox_full ⇒ Object

Gets the mailboxFull property value. The mailbox full status of the recipient.

Returns:

  • a boolean



212
213
214
 
# File 'lib/models/mail_tips.rb', line 212

def mailbox_full
    return @mailbox_full
end

#mailbox_full=(value) ⇒ Object

Sets the mailboxFull property value. The mailbox full status of the recipient.

Parameters:

  • value —

    Value to set for the mailboxFull property.

Returns:

  • a void



220
221
222
 
# File 'lib/models/mail_tips.rb', line 220

def mailbox_full=(value)
    @mailbox_full = value
end

#max_message_size ⇒ Object

Gets the maxMessageSize property value. The maximum message size that has been configured for the recipient’s organization or mailbox.

Returns:

  • a integer



227
228
229
 
# File 'lib/models/mail_tips.rb', line 227

def max_message_size
    return @max_message_size
end

#max_message_size=(value) ⇒ Object

Sets the maxMessageSize property value. The maximum message size that has been configured for the recipient’s organization or mailbox.

Parameters:

  • value —

    Value to set for the maxMessageSize property.

Returns:

  • a void



235
236
237
 
# File 'lib/models/mail_tips.rb', line 235

def max_message_size=(value)
    @max_message_size = value
end

#odata_type ⇒ Object

Gets the @odata.type property value. The OdataType property

Returns:

  • a string



242
243
244
 
# File 'lib/models/mail_tips.rb', line 242

def odata_type
    return @odata_type
end

#odata_type=(value) ⇒ Object

Sets the @odata.type property value. The OdataType property

Parameters:

  • value —

    Value to set for the @odata.type property.

Returns:

  • a void



250
251
252
 
# File 'lib/models/mail_tips.rb', line 250

def odata_type=(value)
    @odata_type = value
end

#recipient_scope ⇒ Object

Gets the recipientScope property value. The scope of the recipient. Possible values are: none, internal, external, externalPartner, externalNonParther. For example, an administrator can set another organization to be its ‘partner’. The scope is useful if an administrator wants certain mailtips to be accessible to certain scopes. It’s also useful to senders to inform them that their message may leave the organization, helping them make the correct decisions about wording, tone and content.

Returns:

  • a recipient_scope_type



257
258
259
 
# File 'lib/models/mail_tips.rb', line 257

def recipient_scope
    return @recipient_scope
end

#recipient_scope=(value) ⇒ Object

Sets the recipientScope property value. The scope of the recipient. Possible values are: none, internal, external, externalPartner, externalNonParther. For example, an administrator can set another organization to be its ‘partner’. The scope is useful if an administrator wants certain mailtips to be accessible to certain scopes. It’s also useful to senders to inform them that their message may leave the organization, helping them make the correct decisions about wording, tone and content.

Parameters:

  • value —

    Value to set for the recipientScope property.

Returns:

  • a void



265
266
267
 
# File 'lib/models/mail_tips.rb', line 265

def recipient_scope=(value)
    @recipient_scope = value
end

#recipient_suggestions ⇒ Object

Gets the recipientSuggestions property value. Recipients suggested based on previous contexts where they appear in the same message.

Returns:

  • a recipient



272
273
274
 
# File 'lib/models/mail_tips.rb', line 272

def recipient_suggestions
    return @recipient_suggestions
end

#recipient_suggestions=(value) ⇒ Object

Sets the recipientSuggestions property value. Recipients suggested based on previous contexts where they appear in the same message.

Parameters:

  • value —

    Value to set for the recipientSuggestions property.

Returns:

  • a void



280
281
282
 
# File 'lib/models/mail_tips.rb', line 280

def recipient_suggestions=(value)
    @recipient_suggestions = value
end

#serialize(writer) ⇒ Object

Serializes information the current object

Parameters:

  • writer —

    Serialization writer to use to serialize this model

Returns:

  • a void

Raises:

  • (StandardError) 


288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
 
# File 'lib/models/mail_tips.rb', line 288

def serialize(writer)
    raise StandardError, 'writer cannot be null' if writer.nil?
    writer.write_object_value("automaticReplies", @automatic_replies)
    writer.write_string_value("customMailTip", @custom_mail_tip)
    writer.write_boolean_value("deliveryRestricted", @delivery_restricted)
    writer.write_object_value("emailAddress", @email_address)
    writer.write_object_value("error", @error)
    writer.write_number_value("externalMemberCount", @external_member_count)
    writer.write_boolean_value("isModerated", @is_moderated)
    writer.write_boolean_value("mailboxFull", @mailbox_full)
    writer.write_number_value("maxMessageSize", @max_message_size)
    writer.write_string_value("@odata.type", @odata_type)
    writer.write_enum_value("recipientScope", @recipient_scope)
    writer.write_collection_of_object_values("recipientSuggestions", @recipient_suggestions)
    writer.write_number_value("totalMemberCount", @total_member_count)
    writer.write_additional_data(@additional_data)
end

#total_member_count ⇒ Object

Gets the totalMemberCount property value. The number of members if the recipient is a distribution list.

Returns:

  • a integer



309
310
311
 
# File 'lib/models/mail_tips.rb', line 309

def total_member_count
    return @total_member_count
end

#total_member_count=(value) ⇒ Object

Sets the totalMemberCount property value. The number of members if the recipient is a distribution list.

Parameters:

  • value —

    Value to set for the totalMemberCount property.

Returns:

  • a void



317
318
319
 
# File 'lib/models/mail_tips.rb', line 317

def total_member_count=(value)
    @total_member_count = value
end