Skip to content

Office365

Attributes

AssignCategoryBulkInput module-attribute

AssignCategoryBulkInput = List[str]

MeetingTimeSuggestions module-attribute

MeetingTimeSuggestions = List[Dict[str, Any]]

TRIGGER_OPERATIONS module-attribute

TRIGGER_OPERATIONS: Dict[str, Dict[str, Any]] = {'CalendarGetOnChangedItemsV3': {'operation_id': 'CalendarGetOnChangedItemsV3', 'path': '/{connectionId}/datasets/calendars/v3/tables/{table}/onchangeditems', 'method': 'get', 'required_parameters': ['table'], 'callback_payload_type': 'GraphCalendarEventListWithActionType'}, 'CalendarGetOnNewItemsV3': {'operation_id': 'CalendarGetOnNewItemsV3', 'path': '/{connectionId}/datasets/calendars/v3/tables/{table}/onnewitems', 'method': 'get', 'required_parameters': ['table'], 'callback_payload_type': 'GraphCalendarEventListClientReceive'}, 'CalendarGetOnUpdatedItemsV3': {'operation_id': 'CalendarGetOnUpdatedItemsV3', 'path': '/{connectionId}/datasets/calendars/v3/tables/{table}/onupdateditems', 'method': 'get', 'required_parameters': ['table'], 'callback_payload_type': 'GraphCalendarEventListClientReceive'}, 'OnFlaggedEmailV4': {'operation_id': 'OnFlaggedEmailV4', 'path': '/{connectionId}/v4/Mail/OnFlaggedEmail', 'method': 'get', 'required_parameters': [], 'callback_payload_type': 'TriggerBatchResponseGraphClientReceiveMessage'}, 'OnNewEmailV3': {'operation_id': 'OnNewEmailV3', 'path': '/{connectionId}/v3/Mail/OnNewEmail', 'method': 'get', 'required_parameters': [], 'callback_payload_type': 'TriggerBatchResponseGraphClientReceiveMessage'}, 'OnNewMentionMeEmailV3': {'operation_id': 'OnNewMentionMeEmailV3', 'path': '/{connectionId}/v3/Mail/OnNewMentionMeEmail', 'method': 'get', 'required_parameters': [], 'callback_payload_type': 'TriggerBatchResponseGraphClientReceiveMessage'}, 'OnUpcomingEventsV3': {'operation_id': 'OnUpcomingEventsV3', 'path': '/{connectionId}/v3/Events/OnUpcomingEvents', 'method': 'get', 'required_parameters': ['table'], 'callback_payload_type': 'GraphCalendarEventListClientReceive'}, 'SharedMailboxOnNewEmailV2': {'operation_id': 'SharedMailboxOnNewEmailV2', 'path': '/{connectionId}/v2/SharedMailbox/Mail/OnNewEmail', 'method': 'get', 'required_parameters': ['mailboxAddress'], 'callback_payload_type': 'TriggerBatchResponseGraphClientReceiveMessage'}}

Classes

GraphOutlookCategory dataclass

GraphOutlookCategory(id: Optional[str] = None, display_name: Optional[str] = None)

Response for Get Outlook category names

Attributes

id class-attribute instance-attribute
id: Optional[str] = None

The ID of the Outlook Category.

display_name class-attribute instance-attribute
display_name: Optional[str] = field(default=None, metadata={'wire_name': 'displayName'})

The display name of the Outlook Category.

OutlookReceiveMessage dataclass

OutlookReceiveMessage(internet_message_id: Optional[str] = None, body_preview: Optional[str] = None, id: Optional[str] = None, conversation_id: Optional[str] = None, has_attachments: Optional[bool] = None, is_read: Optional[bool] = None, created_date_time: Optional[str] = None, received_date_time: Optional[str] = None, last_modified_date_time: Optional[str] = None, attachments: Optional[List[OutlookReceiveAttachment]] = None, to_recipients: Optional[List[Recipient]] = None, cc_recipients: Optional[List[Recipient]] = None, bcc_recipients: Optional[List[Recipient]] = None, reply_to: Optional[List[Recipient]] = None, subject: Optional[str] = None, body: Optional[ItemBody] = None, from_: Optional[Recipient] = None, importance: Optional[str] = None, internet_message_headers: Optional[List[InternetMessageHeader]] = None)

Response for Draft an email message

Attributes

internet_message_id class-attribute instance-attribute
internet_message_id: Optional[str] = field(default=None, metadata={'wire_name': 'InternetMessageId'})

Internet Message Id

body_preview class-attribute instance-attribute
body_preview: Optional[str] = field(default=None, metadata={'wire_name': 'BodyPreview'})

Body preview

id class-attribute instance-attribute
id: Optional[str] = field(default=None, metadata={'wire_name': 'Id'})

Id

conversation_id class-attribute instance-attribute
conversation_id: Optional[str] = field(default=None, metadata={'wire_name': 'ConversationId'})

Conversation Id

has_attachments class-attribute instance-attribute
has_attachments: Optional[bool] = field(default=None, metadata={'wire_name': 'HasAttachments'})

Has attachments

is_read class-attribute instance-attribute
is_read: Optional[bool] = field(default=None, metadata={'wire_name': 'IsRead'})

Is read

created_date_time class-attribute instance-attribute
created_date_time: Optional[str] = field(default=None, metadata={'wire_name': 'CreatedDateTime'})

Created date and time

received_date_time class-attribute instance-attribute
received_date_time: Optional[str] = field(default=None, metadata={'wire_name': 'ReceivedDateTime'})

Received date and time

last_modified_date_time class-attribute instance-attribute
last_modified_date_time: Optional[str] = field(default=None, metadata={'wire_name': 'LastModifiedDateTime'})

Last modified date and time

attachments class-attribute instance-attribute
attachments: Optional[List[OutlookReceiveAttachment]] = field(default=None, metadata={'wire_name': 'Attachments'})

Attachments

to_recipients class-attribute instance-attribute
to_recipients: Optional[List[Recipient]] = field(default=None, metadata={'wire_name': 'ToRecipients'})

To Recipient

cc_recipients class-attribute instance-attribute
cc_recipients: Optional[List[Recipient]] = field(default=None, metadata={'wire_name': 'CcRecipients'})

Cc Recipients

bcc_recipients class-attribute instance-attribute
bcc_recipients: Optional[List[Recipient]] = field(default=None, metadata={'wire_name': 'BccRecipients'})

Bcc Recipients

reply_to class-attribute instance-attribute
reply_to: Optional[List[Recipient]] = field(default=None, metadata={'wire_name': 'ReplyTo'})

The email addresses to use when replying

subject class-attribute instance-attribute
subject: Optional[str] = field(default=None, metadata={'wire_name': 'Subject'})

Subject

importance class-attribute instance-attribute
importance: Optional[str] = field(default=None, metadata={'wire_name': 'Importance'})

Importance

internet_message_headers class-attribute instance-attribute
internet_message_headers: Optional[List[InternetMessageHeader]] = field(default=None, metadata={'wire_name': 'InternetMessageHeaders'})

Internet message headers

BatchOperationResult dataclass

BatchOperationResult(success_count: Optional[int] = None, failures: Optional[List[BatchItemFailureResult]] = None)

Response for Assign a category to multiple emails

Attributes

success_count class-attribute instance-attribute
success_count: Optional[int] = field(default=None, metadata={'wire_name': 'successCount'})

The count of messages processed successfully.

failures class-attribute instance-attribute
failures: Optional[List[BatchItemFailureResult]] = None

The list of failed messages with errors.

SubscriptionResponse dataclass

SubscriptionResponse(id: Optional[str] = None, resource: Optional[str] = None, notification_type: Optional[str] = None, notification_url: Optional[str] = None)

Response for Send email with options

Attributes

id class-attribute instance-attribute
id: Optional[str] = None

Id of the subscription

resource class-attribute instance-attribute
resource: Optional[str] = None

Resource of the subscription request

notification_type class-attribute instance-attribute
notification_type: Optional[str] = field(default=None, metadata={'wire_name': 'notificationType'})

Notification Type

notification_url class-attribute instance-attribute
notification_url: Optional[str] = field(default=None, metadata={'wire_name': 'notificationUrl'})

Notification Url

ObjectWithoutType dataclass

ObjectWithoutType(additional_properties: Dict[str, Any] = dict())

Response for Send an HTTP request

Attributes

additional_properties class-attribute instance-attribute
additional_properties: Dict[str, Any] = field(default_factory=dict)

Dynamic properties determined at runtime (similar to .NET [JsonExtensionData])

MCPQueryResponse dataclass

MCPQueryResponse(jsonrpc: Optional[str] = None, id: Optional[str] = None, method: Optional[str] = None, params: Optional[Dict[str, Any]] = None, result: Optional[Dict[str, Any]] = None, error: Optional[Dict[str, Any]] = None)

Response for Email Management MCP Server (deprecated)

GraphCalendarEventClientReceive dataclass

GraphCalendarEventClientReceive(subject: Optional[str] = None, start: Optional[str] = None, end: Optional[str] = None, start_with_time_zone: Optional[str] = None, end_with_time_zone: Optional[str] = None, body: Optional[str] = None, is_html: Optional[bool] = None, response_type: Optional[str] = None, response_time: Optional[str] = None, id: Optional[str] = None, created_date_time: Optional[str] = None, last_modified_date_time: Optional[str] = None, organizer: Optional[str] = None, time_zone: Optional[str] = None, series_master_id: Optional[str] = None, i_cal_u_id: Optional[str] = None, categories: Optional[List[str]] = None, web_link: Optional[str] = None, required_attendees: Optional[str] = None, optional_attendees: Optional[str] = None, resource_attendees: Optional[str] = None, location: Optional[str] = None, importance: Optional[str] = None, is_all_day: Optional[bool] = None, recurrence: Optional[str] = None, recurrence_end: Optional[str] = None, number_of_occurences: Optional[int] = None, reminder_minutes_before_start: Optional[int] = None, is_reminder_on: Optional[bool] = None, show_as: Optional[str] = None, response_requested: Optional[bool] = None, sensitivity: Optional[str] = None)

Response for Get event

Attributes

subject class-attribute instance-attribute
subject: Optional[str] = None

Event subject

start class-attribute instance-attribute
start: Optional[str] = None

Start time of the event (example: '2017-08-29T04:00:00.0000000')

end class-attribute instance-attribute
end: Optional[str] = None

End time of the event (example: '2017-08-29T05:00:00.0000000')

start_with_time_zone class-attribute instance-attribute
start_with_time_zone: Optional[str] = field(default=None, metadata={'wire_name': 'startWithTimeZone'})

Start time of the event with time zone (example: '2017-08-29T04:00:00.0000000+00:00')

end_with_time_zone class-attribute instance-attribute
end_with_time_zone: Optional[str] = field(default=None, metadata={'wire_name': 'endWithTimeZone'})

End time of the event with time zone (example: '2017-08-29T05:00:00.0000000+00:00')

body class-attribute instance-attribute
body: Optional[str] = None

Body of the message associated with the event

is_html class-attribute instance-attribute
is_html: Optional[bool] = field(default=None, metadata={'wire_name': 'isHtml'})

Set to true if the body is Html

response_type class-attribute instance-attribute
response_type: Optional[str] = field(default=None, metadata={'wire_name': 'responseType'})

The response type of the event (none, organizer, tentativelyAccepted, accepted, declined or notResponded)

response_time class-attribute instance-attribute
response_time: Optional[str] = field(default=None, metadata={'wire_name': 'responseTime'})

The response time of the event

id class-attribute instance-attribute
id: Optional[str] = None

The event's unique identifier

created_date_time class-attribute instance-attribute
created_date_time: Optional[str] = field(default=None, metadata={'wire_name': 'createdDateTime'})

The date and time that the event was created

last_modified_date_time class-attribute instance-attribute
last_modified_date_time: Optional[str] = field(default=None, metadata={'wire_name': 'lastModifiedDateTime'})

The date and time that the event was last modified

organizer class-attribute instance-attribute
organizer: Optional[str] = None

The organizer of the event

time_zone class-attribute instance-attribute
time_zone: Optional[str] = field(default=None, metadata={'wire_name': 'timeZone'})

Time zone of the event

series_master_id class-attribute instance-attribute
series_master_id: Optional[str] = field(default=None, metadata={'wire_name': 'seriesMasterId'})

Unique identifier for Series Master event type

i_cal_u_id class-attribute instance-attribute
i_cal_u_id: Optional[str] = field(default=None, metadata={'wire_name': 'iCalUId'})

A unique identifier for an event across calendars. This ID is different for each occurrence in a recurring series

categories class-attribute instance-attribute
categories: Optional[List[str]] = None

The categories associated with the event

web_link: Optional[str] = field(default=None, metadata={'wire_name': 'webLink'})

The URL to open the event in Outlook Web App

required_attendees class-attribute instance-attribute
required_attendees: Optional[str] = field(default=None, metadata={'wire_name': 'requiredAttendees'})

Required attendees for the event separated by semicolons

optional_attendees class-attribute instance-attribute
optional_attendees: Optional[str] = field(default=None, metadata={'wire_name': 'optionalAttendees'})

Optional attendees for the event separated by semicolons

resource_attendees class-attribute instance-attribute
resource_attendees: Optional[str] = field(default=None, metadata={'wire_name': 'resourceAttendees'})

Resource attendees for the event separated by semicolons

location class-attribute instance-attribute
location: Optional[str] = None

Location of the event

importance class-attribute instance-attribute
importance: Optional[str] = None

The importance of the event: low, normal, or high

is_all_day class-attribute instance-attribute
is_all_day: Optional[bool] = field(default=None, metadata={'wire_name': 'isAllDay'})

Set to true if the event lasts all day

recurrence class-attribute instance-attribute
recurrence: Optional[str] = None

The recurrence pattern for the event: none, daily, weekly, monthly or yearly

recurrence_end class-attribute instance-attribute
recurrence_end: Optional[str] = field(default=None, metadata={'wire_name': 'recurrenceEnd'})

End Date of the recurrence

number_of_occurences class-attribute instance-attribute
number_of_occurences: Optional[int] = field(default=None, metadata={'wire_name': 'numberOfOccurences'})

How many times to repeat the event

reminder_minutes_before_start class-attribute instance-attribute
reminder_minutes_before_start: Optional[int] = field(default=None, metadata={'wire_name': 'reminderMinutesBeforeStart'})

Time in minutes before event start to remind

is_reminder_on class-attribute instance-attribute
is_reminder_on: Optional[bool] = field(default=None, metadata={'wire_name': 'isReminderOn'})

Set to true if an alert is set to remind the user of the event.

show_as class-attribute instance-attribute
show_as: Optional[str] = field(default=None, metadata={'wire_name': 'showAs'})

Status to show during the event: free, tentative, busy, oof, workingElsewhere or unknown

response_requested class-attribute instance-attribute
response_requested: Optional[bool] = field(default=None, metadata={'wire_name': 'responseRequested'})

Set to true if the sender would like a response when the event is accepted or declined

sensitivity class-attribute instance-attribute
sensitivity: Optional[str] = None

The possible values are: normal, personal, private, confidential

GraphCalendarEventListClientReceive dataclass

GraphCalendarEventListClientReceive(value: Optional[List[GraphCalendarEventClientReceive]] = None)

Response for Get events

Attributes

value class-attribute instance-attribute
value: Optional[List[GraphCalendarEventClientReceive]] = None

List of calendar items

GraphCalendarEventListWithActionType dataclass

GraphCalendarEventListWithActionType(value: Optional[List[GraphCalendarEventClientWithActionType]] = None)

Response for When an event is added, updated or deleted

Attributes

value class-attribute instance-attribute
value: Optional[List[GraphCalendarEventClientWithActionType]] = None

List of calendar items

CalendarGetTablesResponse dataclass

CalendarGetTablesResponse(value: Optional[List[Dict[str, Any]]] = None)

Response for Get calendars

Attributes

value class-attribute instance-attribute
value: Optional[List[Dict[str, Any]]] = None

value

ContactResponse dataclass

ContactResponse(id: Optional[str] = None, parent_folder_id: Optional[str] = None, birthday: Optional[str] = None, file_as: Optional[str] = None, display_name: Optional[str] = None, given_name: Optional[str] = None, initials: Optional[str] = None, middle_name: Optional[str] = None, nick_name: Optional[str] = None, surname: Optional[str] = None, title: Optional[str] = None, generation: Optional[str] = None, email_addresses: Optional[List[EmailAddressV2]] = None, im_addresses: Optional[List[str]] = None, job_title: Optional[str] = None, company_name: Optional[str] = None, department: Optional[str] = None, office_location: Optional[str] = None, profession: Optional[str] = None, business_home_page: Optional[str] = None, assistant_name: Optional[str] = None, manager: Optional[str] = None, home_phones: Optional[List[str]] = None, business_phones: Optional[List[str]] = None, mobile_phone: Optional[str] = None, home_address: Optional[PhysicalAddress] = None, business_address: Optional[PhysicalAddress] = None, other_address: Optional[PhysicalAddress] = None, yomi_company_name: Optional[str] = None, yomi_given_name: Optional[str] = None, yomi_surname: Optional[str] = None, categories: Optional[List[str]] = None, change_key: Optional[str] = None, created_date_time: Optional[str] = None, last_modified_date_time: Optional[str] = None)

Response for Get contact

Attributes

id class-attribute instance-attribute
id: Optional[str] = None

The contact's unique identifier.

parent_folder_id class-attribute instance-attribute
parent_folder_id: Optional[str] = field(default=None, metadata={'wire_name': 'parentFolderId'})

The ID of the contact's parent folder

birthday class-attribute instance-attribute
birthday: Optional[str] = None

The contact's birthday

file_as class-attribute instance-attribute
file_as: Optional[str] = field(default=None, metadata={'wire_name': 'fileAs'})

The name the contact is filed under

display_name class-attribute instance-attribute
display_name: Optional[str] = field(default=None, metadata={'wire_name': 'displayName'})

The contact's display name

given_name class-attribute instance-attribute
given_name: Optional[str] = field(default=None, metadata={'wire_name': 'givenName'})

The contact's given name

initials class-attribute instance-attribute
initials: Optional[str] = None

The contact's initials

middle_name class-attribute instance-attribute
middle_name: Optional[str] = field(default=None, metadata={'wire_name': 'middleName'})

The contact's middle name

nick_name class-attribute instance-attribute
nick_name: Optional[str] = field(default=None, metadata={'wire_name': 'nickName'})

The contact's nickname

surname class-attribute instance-attribute
surname: Optional[str] = None

The contact's surname

title class-attribute instance-attribute
title: Optional[str] = None

The contact's title

generation class-attribute instance-attribute
generation: Optional[str] = None

The contact's generation

email_addresses class-attribute instance-attribute
email_addresses: Optional[List[EmailAddressV2]] = field(default=None, metadata={'wire_name': 'emailAddresses'})

The contact's email addresses

im_addresses class-attribute instance-attribute
im_addresses: Optional[List[str]] = field(default=None, metadata={'wire_name': 'imAddresses'})

The contact's instant messaging (IM) addresses

job_title class-attribute instance-attribute
job_title: Optional[str] = field(default=None, metadata={'wire_name': 'jobTitle'})

The contact's job title

company_name class-attribute instance-attribute
company_name: Optional[str] = field(default=None, metadata={'wire_name': 'companyName'})

The name of the contact's company

department class-attribute instance-attribute
department: Optional[str] = None

The contact's department

office_location class-attribute instance-attribute
office_location: Optional[str] = field(default=None, metadata={'wire_name': 'officeLocation'})

The location of the contact's office

profession class-attribute instance-attribute
profession: Optional[str] = None

The contact's profession

business_home_page class-attribute instance-attribute
business_home_page: Optional[str] = field(default=None, metadata={'wire_name': 'businessHomePage'})

The business home page of the contact

assistant_name class-attribute instance-attribute
assistant_name: Optional[str] = field(default=None, metadata={'wire_name': 'assistantName'})

The name of the contact's assistant

manager class-attribute instance-attribute
manager: Optional[str] = None

The name of the contact's manager

home_phones class-attribute instance-attribute
home_phones: Optional[List[str]] = field(default=None, metadata={'wire_name': 'homePhones'})

The contact's home phone numbers

business_phones class-attribute instance-attribute
business_phones: Optional[List[str]] = field(default=None, metadata={'wire_name': 'businessPhones'})

The contact's business phone numbers

mobile_phone class-attribute instance-attribute
mobile_phone: Optional[str] = field(default=None, metadata={'wire_name': 'mobilePhone'})

The contact's mobile phone number

yomi_company_name class-attribute instance-attribute
yomi_company_name: Optional[str] = field(default=None, metadata={'wire_name': 'yomiCompanyName'})

The phonetic Japanese company name of the contact

yomi_given_name class-attribute instance-attribute
yomi_given_name: Optional[str] = field(default=None, metadata={'wire_name': 'yomiGivenName'})

The phonetic Japanese given name (first name) of the contact

yomi_surname class-attribute instance-attribute
yomi_surname: Optional[str] = field(default=None, metadata={'wire_name': 'yomiSurname'})

The phonetic Japanese surname (last name) of the contact

categories class-attribute instance-attribute
categories: Optional[List[str]] = None

The categories associated with the contact

change_key class-attribute instance-attribute
change_key: Optional[str] = field(default=None, metadata={'wire_name': 'changeKey'})

Identifies the version of the event object

created_date_time class-attribute instance-attribute
created_date_time: Optional[str] = field(default=None, metadata={'wire_name': 'createdDateTime'})

The time the contact was created

last_modified_date_time class-attribute instance-attribute
last_modified_date_time: Optional[str] = field(default=None, metadata={'wire_name': 'lastModifiedDateTime'})

The time the contact was modified

EntityListResponseContactResponse dataclass

EntityListResponseContactResponse(value: Optional[List[ContactResponse]] = None)

Response for Get contacts

Attributes

value class-attribute instance-attribute
value: Optional[List[ContactResponse]] = None

List of values

EntityListResponseGraphContactFolder dataclass

EntityListResponseGraphContactFolder(value: Optional[List[GraphContactFolder]] = None)

Response for Get contact folders

Attributes

value class-attribute instance-attribute
value: Optional[List[GraphContactFolder]] = None

List of values

FindMeetingTimesInput dataclass

FindMeetingTimesInput(required_attendees: Optional[str] = None, optional_attendees: Optional[str] = None, resource_attendees: Optional[str] = None, meeting_duration: Optional[int] = None, start: Optional[str] = None, end: Optional[str] = None, max_candidates: Optional[int] = None, minimum_attendee_percentage: Optional[str] = None, is_organizer_optional: Optional[bool] = None, activity_domain: Optional[str] = None)

Find meeting times

Attributes

required_attendees class-attribute instance-attribute
required_attendees: Optional[str] = field(default=None, metadata={'wire_name': 'RequiredAttendees'})

List of semicolon separated email addresses

optional_attendees class-attribute instance-attribute
optional_attendees: Optional[str] = field(default=None, metadata={'wire_name': 'OptionalAttendees'})

List of semicolon separated email addresses

resource_attendees class-attribute instance-attribute
resource_attendees: Optional[str] = field(default=None, metadata={'wire_name': 'ResourceAttendees'})

Resource attendees for the event separated by semicolons

meeting_duration class-attribute instance-attribute
meeting_duration: Optional[int] = field(default=None, metadata={'wire_name': 'MeetingDuration'})

Duration of the meeting in minutes

start class-attribute instance-attribute
start: Optional[str] = field(default=None, metadata={'wire_name': 'Start'})

Start time for meeting time suggestions

end class-attribute instance-attribute
end: Optional[str] = field(default=None, metadata={'wire_name': 'End'})

End time for meeting time suggestions

max_candidates class-attribute instance-attribute
max_candidates: Optional[int] = field(default=None, metadata={'wire_name': 'MaxCandidates'})

The maximum number of meeting suggestions to return in the response

minimum_attendee_percentage class-attribute instance-attribute
minimum_attendee_percentage: Optional[str] = field(default=None, metadata={'wire_name': 'MinimumAttendeePercentage'})

The minimum required confidence for a time slot to be returned in the response

is_organizer_optional class-attribute instance-attribute
is_organizer_optional: Optional[bool] = field(default=None, metadata={'wire_name': 'IsOrganizerOptional'})

true if the organizer doesn't have to attend. The default is false

activity_domain class-attribute instance-attribute
activity_domain: Optional[str] = field(default=None, metadata={'wire_name': 'ActivityDomain'})

Work, Personal, Unrestricted, or Unknown

FindMeetingTimesResponse dataclass

FindMeetingTimesResponse(empty_suggestions_reason: Optional[str] = None, meeting_time_suggestions: Optional[MeetingTimeSuggestions] = None)

Response for Find meeting times

Attributes

empty_suggestions_reason class-attribute instance-attribute
empty_suggestions_reason: Optional[str] = field(default=None, metadata={'wire_name': 'emptySuggestionsReason'})

Empty Suggestions Reason

GetAttachmentResponse dataclass

GetAttachmentResponse(id: Optional[str] = None, name: Optional[str] = None, content_type: Optional[str] = None, size: Optional[int] = None, content_bytes: Optional[str] = None, is_inline: Optional[bool] = None, last_modified_date_time: Optional[str] = None, content_id: Optional[str] = None, sensitivity_label_info: Optional[List[SensitivityLabelMetadata]] = None)

Response for Get Attachment

Attributes

id class-attribute instance-attribute
id: Optional[str] = None

Id of the attachment.

name class-attribute instance-attribute
name: Optional[str] = None

Name of attachment.

content_type class-attribute instance-attribute
content_type: Optional[str] = field(default=None, metadata={'wire_name': 'contentType'})

Content type of attachment.

size class-attribute instance-attribute
size: Optional[int] = None

Size of attachment.

content_bytes class-attribute instance-attribute
content_bytes: Optional[str] = field(default=None, metadata={'wire_name': 'contentBytes'})

Content of attachment.

is_inline class-attribute instance-attribute
is_inline: Optional[bool] = field(default=None, metadata={'wire_name': 'isInline'})

Set to true if this is an inline attachment.

last_modified_date_time class-attribute instance-attribute
last_modified_date_time: Optional[str] = field(default=None, metadata={'wire_name': 'lastModifiedDateTime'})

The date and time when the attachment was last modified.

content_id class-attribute instance-attribute
content_id: Optional[str] = field(default=None, metadata={'wire_name': 'contentId'})

Content Id

GraphClientReceiveMessage dataclass

GraphClientReceiveMessage(from_: Optional[str] = None, to_recipients: Optional[str] = None, cc_recipients: Optional[str] = None, bcc_recipients: Optional[str] = None, reply_to: Optional[str] = None, subject: Optional[str] = None, body: Optional[str] = None, importance: Optional[str] = None, body_preview: Optional[str] = None, has_attachments: Optional[bool] = None, id: Optional[str] = None, internet_message_id: Optional[str] = None, conversation_id: Optional[str] = None, received_date_time: Optional[str] = None, is_read: Optional[bool] = None, attachments: Optional[List[GraphClientReceiveFileAttachment]] = None, is_html: Optional[bool] = None, sensitivity_label_info: Optional[List[SensitivityLabelMetadata]] = None)

Response for Get email

Attributes

from_ class-attribute instance-attribute
from_: Optional[str] = field(default=None, metadata={'wire_name': 'from'})

The mailbox owner and sender of the message

to_recipients class-attribute instance-attribute
to_recipients: Optional[str] = field(default=None, metadata={'wire_name': 'toRecipients'})

The recipients for the message

cc_recipients class-attribute instance-attribute
cc_recipients: Optional[str] = field(default=None, metadata={'wire_name': 'ccRecipients'})

The Cc recipients for the message

bcc_recipients class-attribute instance-attribute
bcc_recipients: Optional[str] = field(default=None, metadata={'wire_name': 'bccRecipients'})

The Bcc recipients for the message

reply_to class-attribute instance-attribute
reply_to: Optional[str] = field(default=None, metadata={'wire_name': 'replyTo'})

The email addresses to use when replying

subject class-attribute instance-attribute
subject: Optional[str] = None

The subject of the message

body class-attribute instance-attribute
body: Optional[str] = None

The body of the message

importance class-attribute instance-attribute
importance: Optional[str] = None

The importance of the message (low, normal, high)

body_preview class-attribute instance-attribute
body_preview: Optional[str] = field(default=None, metadata={'wire_name': 'bodyPreview'})

The preview of the message

has_attachments class-attribute instance-attribute
has_attachments: Optional[bool] = field(default=None, metadata={'wire_name': 'hasAttachments'})

Indicates whether the message has attachments

id class-attribute instance-attribute
id: Optional[str] = None

The unique identifier of the message

internet_message_id class-attribute instance-attribute
internet_message_id: Optional[str] = field(default=None, metadata={'wire_name': 'internetMessageId'})

The message ID in the format specified by RFC2822

conversation_id class-attribute instance-attribute
conversation_id: Optional[str] = field(default=None, metadata={'wire_name': 'conversationId'})

The Id of the conversation the email belongs to

received_date_time class-attribute instance-attribute
received_date_time: Optional[str] = field(default=None, metadata={'wire_name': 'receivedDateTime'})

The date and time the message was received

is_read class-attribute instance-attribute
is_read: Optional[bool] = field(default=None, metadata={'wire_name': 'isRead'})

Indicates whether the message has been read

attachments class-attribute instance-attribute
attachments: Optional[List[GraphClientReceiveFileAttachment]] = None

The file attachments for the message

is_html class-attribute instance-attribute
is_html: Optional[bool] = field(default=None, metadata={'wire_name': 'isHtml'})

Is Html?

BatchResponseGraphClientReceiveMessage dataclass

BatchResponseGraphClientReceiveMessage(value: Optional[List[GraphClientReceiveMessage]] = None)

Response for Get emails

Attributes

value class-attribute instance-attribute
value: Optional[List[GraphClientReceiveMessage]] = None

A list of the response objects

EntityListResponseGraphCalendarEventClientReceive dataclass

EntityListResponseGraphCalendarEventClientReceive(value: Optional[List[GraphCalendarEventClientReceive]] = None)

Response for Get calendar view of events

Attributes

value class-attribute instance-attribute
value: Optional[List[GraphCalendarEventClientReceive]] = None

List of values

GetMailTipsInput dataclass

GetMailTipsInput(mail_tips_options: Optional[str] = None, email_addresses: Optional[List[str]] = None)

Get mail tips for a mailbox

Attributes

mail_tips_options class-attribute instance-attribute
mail_tips_options: Optional[str] = field(default=None, metadata={'wire_name': 'MailTipsOptions'})

Flags that represents the mailtips.

email_addresses class-attribute instance-attribute
email_addresses: Optional[List[str]] = field(default=None, metadata={'wire_name': 'EmailAddresses'})

Address of the mailbox to get mail tips for.

GetMailTipsResponse dataclass

GetMailTipsResponse(value: Optional[List[MailTipsClientReceive]] = None)

Response for Get mail tips for a mailbox

GetRoomListsResponse dataclass

GetRoomListsResponse(value: Optional[List[Dict[str, Any]]] = None)

Response for Get room lists

Attributes

value class-attribute instance-attribute
value: Optional[List[Dict[str, Any]]] = None

value

GetRoomsResponse dataclass

GetRoomsResponse(value: Optional[List[Dict[str, Any]]] = None)

Response for Get rooms

Attributes

value class-attribute instance-attribute
value: Optional[List[Dict[str, Any]]] = None

value

GetRoomsInRoomListResponse dataclass

GetRoomsInRoomListResponse(value: Optional[List[Dict[str, Any]]] = None)

Response for Get rooms in room list

Attributes

value class-attribute instance-attribute
value: Optional[List[Dict[str, Any]]] = None

value

MarkAsReadInput dataclass

MarkAsReadInput(is_read: Optional[bool] = None)

Mark as read or unread

Attributes

is_read class-attribute instance-attribute
is_read: Optional[bool] = field(default=None, metadata={'wire_name': 'isRead'})

Mark as read/unread.

TriggerBatchResponseGraphClientReceiveMessage dataclass

TriggerBatchResponseGraphClientReceiveMessage(value: Optional[List[GraphClientReceiveMessage]] = None)

Response for When an email is flagged

Attributes

value class-attribute instance-attribute
value: Optional[List[GraphClientReceiveMessage]] = None

A list of the response objects

SetAutomaticRepliesSettingInput dataclass

SetAutomaticRepliesSettingInput(automatic_replies_setting: Optional[AutomaticRepliesSettingClient] = None)

Set up automatic replies

SetAutomaticRepliesSettingResponse dataclass

SetAutomaticRepliesSettingResponse(automatic_replies_setting: Optional[AutomaticRepliesSettingClient] = None)

Response for Set up automatic replies

TableMetadata dataclass

TableMetadata(name: Optional[str] = None, title: Optional[str] = None, x_ms_permission: Optional[str] = None, x_ms_capabilities: Optional[TableCapabilitiesMetadata] = None, schema: Optional[ObjectEntity] = None, referenced_entities: Optional[ObjectEntity] = None, web_url: Optional[str] = None)

Definition: TableMetadata

Attributes

name class-attribute instance-attribute
name: Optional[str] = None

Table name

title class-attribute instance-attribute
title: Optional[str] = None

Table title

x_ms_permission class-attribute instance-attribute
x_ms_permission: Optional[str] = field(default=None, metadata={'wire_name': 'x-ms-permission'})

Table permission

web_url class-attribute instance-attribute
web_url: Optional[str] = field(default=None, metadata={'wire_name': 'webUrl'})

Url link

TableCapabilitiesMetadata dataclass

TableCapabilitiesMetadata(sort_restrictions: Optional[TableSortRestrictionsMetadata] = None, filter_restrictions: Optional[TableFilterRestrictionsMetadata] = None, select_restrictions: Optional[TableSelectRestrictionsMetadata] = None, is_only_server_pagable: Optional[bool] = None, filter_function_support: Optional[List[str]] = None, server_paging_options: Optional[List[str]] = None)

Definition: TableCapabilitiesMetadata

Attributes

is_only_server_pagable class-attribute instance-attribute
is_only_server_pagable: Optional[bool] = field(default=None, metadata={'wire_name': 'isOnlyServerPagable'})

Server paging restrictions

filter_function_support class-attribute instance-attribute
filter_function_support: Optional[List[str]] = field(default=None, metadata={'wire_name': 'filterFunctionSupport'})

List of supported filter capabilities

server_paging_options class-attribute instance-attribute
server_paging_options: Optional[List[str]] = field(default=None, metadata={'wire_name': 'serverPagingOptions'})

List of supported server-driven paging capabilities

ObjectEntity dataclass

ObjectEntity(additional_properties: Dict[str, Any] = dict())

Definition: Object

Attributes

additional_properties class-attribute instance-attribute
additional_properties: Dict[str, Any] = field(default_factory=dict)

Dynamic properties determined at runtime (similar to .NET [JsonExtensionData])

TableSortRestrictionsMetadata dataclass

TableSortRestrictionsMetadata(sortable: Optional[bool] = None, unsortable_properties: Optional[List[str]] = None, ascending_only_properties: Optional[List[str]] = None)

Definition: TableSortRestrictionsMetadata

Attributes

sortable class-attribute instance-attribute
sortable: Optional[bool] = None

Indicates whether this table has sortable columns

unsortable_properties class-attribute instance-attribute
unsortable_properties: Optional[List[str]] = field(default=None, metadata={'wire_name': 'unsortableProperties'})

List of unsortable properties

ascending_only_properties class-attribute instance-attribute
ascending_only_properties: Optional[List[str]] = field(default=None, metadata={'wire_name': 'ascendingOnlyProperties'})

List of properties which support ascending order only

TableFilterRestrictionsMetadata dataclass

TableFilterRestrictionsMetadata(filterable: Optional[bool] = None, non_filterable_properties: Optional[List[str]] = None, required_properties: Optional[List[str]] = None)

Definition: TableFilterRestrictionsMetadata

Attributes

filterable class-attribute instance-attribute
filterable: Optional[bool] = None

Indicates whether this table has filterable columns

non_filterable_properties class-attribute instance-attribute
non_filterable_properties: Optional[List[str]] = field(default=None, metadata={'wire_name': 'nonFilterableProperties'})

List of non filterable properties

required_properties class-attribute instance-attribute
required_properties: Optional[List[str]] = field(default=None, metadata={'wire_name': 'requiredProperties'})

List of required properties

TableSelectRestrictionsMetadata dataclass

TableSelectRestrictionsMetadata(selectable: Optional[bool] = None)

Definition: TableSelectRestrictionsMetadata

Attributes

selectable class-attribute instance-attribute
selectable: Optional[bool] = None

Indicates whether this table has selectable columns

CalendarEventList dataclass

CalendarEventList(value: Optional[List[CalendarEventBackend]] = None)

Definition: CalendarEventList

Attributes

value class-attribute instance-attribute
value: Optional[List[CalendarEventBackend]] = None

List of calendar items

CalendarEventBackend dataclass

CalendarEventBackend(id: Optional[str] = None, attendees: Optional[List[Attendee]] = None, body: Optional[ItemBody] = None, body_preview: Optional[str] = None, categories: Optional[List[str]] = None, change_key: Optional[str] = None, date_time_created: Optional[str] = None, date_time_last_modified: Optional[str] = None, end: Optional[str] = None, end_time_zone: Optional[str] = None, has_attachments: Optional[bool] = None, i_cal_u_id: Optional[str] = None, importance: Optional[str] = None, is_all_day: Optional[bool] = None, is_cancelled: Optional[bool] = None, is_organizer: Optional[bool] = None, location: Optional[Location] = None, organizer: Optional[Recipient] = None, recurrence: Optional[PatternedRecurrence] = None, reminder: Optional[int] = None, response_requested: Optional[bool] = None, response_status: Optional[ResponseStatus] = None, series_master_id: Optional[str] = None, show_as: Optional[str] = None, start: Optional[str] = None, start_time_zone: Optional[str] = None, subject: Optional[str] = None, type_: Optional[str] = None, web_link: Optional[str] = None, reason: Optional[str] = None)

Definition: CalendarEventBackend

Attributes

id class-attribute instance-attribute
id: Optional[str] = field(default=None, metadata={'wire_name': 'Id'})

The Event's unique identifier

attendees class-attribute instance-attribute
attendees: Optional[List[Attendee]] = field(default=None, metadata={'wire_name': 'Attendees'})

List of attendees for the event

body_preview class-attribute instance-attribute
body_preview: Optional[str] = field(default=None, metadata={'wire_name': 'BodyPreview'})

The preview of the message associated with the event

categories class-attribute instance-attribute
categories: Optional[List[str]] = field(default=None, metadata={'wire_name': 'Categories'})

The categories associated with the event

change_key class-attribute instance-attribute
change_key: Optional[str] = field(default=None, metadata={'wire_name': 'ChangeKey'})

This property identifies the version of the event object. Every time the event is changed, ChangeKey changes as well.

date_time_created class-attribute instance-attribute
date_time_created: Optional[str] = field(default=None, metadata={'wire_name': 'DateTimeCreated'})

The date and time that the event was created

date_time_last_modified class-attribute instance-attribute
date_time_last_modified: Optional[str] = field(default=None, metadata={'wire_name': 'DateTimeLastModified'})

The date and time that the event was last modified

end class-attribute instance-attribute
end: Optional[str] = field(default=None, metadata={'wire_name': 'End'})

The end time of the event

end_time_zone class-attribute instance-attribute
end_time_zone: Optional[str] = field(default=None, metadata={'wire_name': 'EndTimeZone'})

This property specifies the time zone of the meeting end time. The value must be as defined in Windows (example: 'Pacific Standard Time').

has_attachments class-attribute instance-attribute
has_attachments: Optional[bool] = field(default=None, metadata={'wire_name': 'HasAttachments'})

Set to true if the event has attachments

i_cal_u_id class-attribute instance-attribute
i_cal_u_id: Optional[str] = field(default=None, metadata={'wire_name': 'ICalUId'})

A unique identifier that is shared by all instances of an event across different calendars

importance class-attribute instance-attribute
importance: Optional[str] = field(default=None, metadata={'wire_name': 'Importance'})

The importance of the event: Low, Normal, or High

is_all_day class-attribute instance-attribute
is_all_day: Optional[bool] = field(default=None, metadata={'wire_name': 'IsAllDay'})

Set to true if the event lasts all day

is_cancelled class-attribute instance-attribute
is_cancelled: Optional[bool] = field(default=None, metadata={'wire_name': 'IsCancelled'})

Set to true if the event has been canceled

is_organizer class-attribute instance-attribute
is_organizer: Optional[bool] = field(default=None, metadata={'wire_name': 'IsOrganizer'})

Set to true if the message sender is also the organizer

reminder class-attribute instance-attribute
reminder: Optional[int] = field(default=None, metadata={'wire_name': 'Reminder'})

Time in minutes before event start to remind

response_requested class-attribute instance-attribute
response_requested: Optional[bool] = field(default=None, metadata={'wire_name': 'ResponseRequested'})

Set to true if the sender would like a response when the event is accepted or declined

series_master_id class-attribute instance-attribute
series_master_id: Optional[str] = field(default=None, metadata={'wire_name': 'SeriesMasterId'})

Unique identifier for Series Master event type

show_as class-attribute instance-attribute
show_as: Optional[str] = field(default=None, metadata={'wire_name': 'ShowAs'})

Shows as free or busy

start class-attribute instance-attribute
start: Optional[str] = field(default=None, metadata={'wire_name': 'Start'})

The start time of the event

start_time_zone class-attribute instance-attribute
start_time_zone: Optional[str] = field(default=None, metadata={'wire_name': 'StartTimeZone'})

This property specifies the time zone of the meeting start time. The value must be as defined in Windows (example: 'Pacific Standard Time').

subject class-attribute instance-attribute
subject: Optional[str] = field(default=None, metadata={'wire_name': 'Subject'})

Event subject

type_ class-attribute instance-attribute
type_: Optional[str] = field(default=None, metadata={'wire_name': 'Type'})

The event type: Single Instance, Occurrence, Exception, or Series Master

web_link: Optional[str] = field(default=None, metadata={'wire_name': 'WebLink'})

The preview of the message associated with the event

reason class-attribute instance-attribute
reason: Optional[str] = field(default=None, metadata={'wire_name': 'Reason'})

The reason property used by O365 sync events protocol, will be 'deleted' if its a deleted event.

Attendee dataclass

Attendee(status: Optional[ResponseStatus] = None, type_: Optional[str] = None, email_address: Optional[EmailAddress] = None)

Definition: Attendee

ItemBody dataclass

ItemBody(content_type: Optional[str] = None, content: Optional[str] = None)

Definition: ItemBody

Location dataclass

Location(display_name: Optional[str] = None, address: Optional[PhysicalAddress] = None, coordinates: Optional[GeoCoordinates] = None)

Definition: Location

Recipient dataclass

Recipient(email_address: Optional[EmailAddress] = None)

Definition: Recipient

PatternedRecurrence dataclass

PatternedRecurrence(pattern: Optional[RecurrencePattern] = None, range: Optional[RecurrenceRange] = None)

Definition: PatternedRecurrence

ResponseStatus dataclass

ResponseStatus(response: Optional[str] = None, time: Optional[str] = None)

Definition: ResponseStatus

EmailAddress dataclass

EmailAddress(name: Optional[str] = None, address: Optional[str] = None)

Definition: EmailAddress

GeoCoordinates dataclass

GeoCoordinates(altitude: Optional[float] = None, latitude: Optional[float] = None, longitude: Optional[float] = None, accuracy: Optional[float] = None, altitude_accuracy: Optional[float] = None)

Definition: GeoCoordinates

RecurrencePattern dataclass

RecurrencePattern(type_: Optional[str] = None, interval: Optional[int] = None, month: Optional[int] = None, day_of_month: Optional[int] = None, days_of_week: Optional[List[str]] = None, first_day_of_week: Optional[str] = None, index: Optional[str] = None)

Definition: RecurrencePattern

RecurrenceRange dataclass

RecurrenceRange(type_: Optional[str] = None, start_date: Optional[str] = None, end_date: Optional[str] = None, number_of_occurrences: Optional[int] = None)

Definition: RecurrenceRange

CalendarEventListClientReceive dataclass

CalendarEventListClientReceive(value: Optional[List[CalendarEventClientReceive]] = None)

Definition: CalendarEventListClientReceive

Attributes

value class-attribute instance-attribute
value: Optional[List[CalendarEventClientReceive]] = None

List of calendar items

CalendarEventClientReceive dataclass

CalendarEventClientReceive(subject: Optional[str] = None, start: Optional[str] = None, end: Optional[str] = None, show_as: Optional[int] = None, recurrence: Optional[int] = None, response_type: Optional[int] = None, response_time: Optional[str] = None, i_cal_u_id: Optional[str] = None, importance: Optional[int] = None, id: Optional[str] = None, date_time_created: Optional[str] = None, date_time_last_modified: Optional[str] = None, organizer: Optional[str] = None, time_zone: Optional[str] = None, series_master_id: Optional[str] = None, categories: Optional[List[str]] = None, web_link: Optional[str] = None, required_attendees: Optional[str] = None, optional_attendees: Optional[str] = None, resource_attendees: Optional[str] = None, body: Optional[str] = None, is_html: Optional[bool] = None, location: Optional[str] = None, is_all_day: Optional[bool] = None, recurrence_end: Optional[str] = None, number_of_occurrences: Optional[int] = None, reminder: Optional[int] = None, response_requested: Optional[bool] = None)

Definition: CalendarEventClientReceive

Attributes

subject class-attribute instance-attribute
subject: Optional[str] = field(default=None, metadata={'wire_name': 'Subject'})

Event subject

start class-attribute instance-attribute
start: Optional[str] = field(default=None, metadata={'wire_name': 'Start'})

Start time of the event (example: '2016-11-01T14:30:00Z')

end class-attribute instance-attribute
end: Optional[str] = field(default=None, metadata={'wire_name': 'End'})

End time of the event (example: '2016-11-01T15:30:00Z')

show_as class-attribute instance-attribute
show_as: Optional[int] = field(default=None, metadata={'wire_name': 'ShowAs'})

Status to show during the event (Unknown - -1, Free - 0, Tentative - 1, Busy - 2, Oof - 3, WorkingElsewhere - 4)

recurrence class-attribute instance-attribute
recurrence: Optional[int] = field(default=None, metadata={'wire_name': 'Recurrence'})

The recurrence pattern for the event (None - 0, Daily - 1, Weekly - 2, Monthly - 3, Yearly - 4)

response_type class-attribute instance-attribute
response_type: Optional[int] = field(default=None, metadata={'wire_name': 'ResponseType'})

The response type of the event (None - 0, Organizer - 1, TentativelyAccepted - 2, Accepted - 3, Declined - 4, NotResponded - 5)

response_time class-attribute instance-attribute
response_time: Optional[str] = field(default=None, metadata={'wire_name': 'ResponseTime'})

The response time of the event

i_cal_u_id class-attribute instance-attribute
i_cal_u_id: Optional[str] = field(default=None, metadata={'wire_name': 'ICalUId'})

A unique identifier that is shared by all instances of an event across different calendars

importance class-attribute instance-attribute
importance: Optional[int] = field(default=None, metadata={'wire_name': 'Importance'})

The importance of the event (0 - Low, 1 - Normal, 2 - High)

id class-attribute instance-attribute
id: Optional[str] = field(default=None, metadata={'wire_name': 'Id'})

The event's unique identifier

date_time_created class-attribute instance-attribute
date_time_created: Optional[str] = field(default=None, metadata={'wire_name': 'DateTimeCreated'})

The date and time that the event was created

date_time_last_modified class-attribute instance-attribute
date_time_last_modified: Optional[str] = field(default=None, metadata={'wire_name': 'DateTimeLastModified'})

The date and time that the event was last modified

organizer class-attribute instance-attribute
organizer: Optional[str] = field(default=None, metadata={'wire_name': 'Organizer'})

The organizer of the event

time_zone class-attribute instance-attribute
time_zone: Optional[str] = field(default=None, metadata={'wire_name': 'TimeZone'})

Time zone of the event

series_master_id class-attribute instance-attribute
series_master_id: Optional[str] = field(default=None, metadata={'wire_name': 'SeriesMasterId'})

Unique identifier for Series Master event type

categories class-attribute instance-attribute
categories: Optional[List[str]] = field(default=None, metadata={'wire_name': 'Categories'})

The categories associated with the event

web_link: Optional[str] = field(default=None, metadata={'wire_name': 'WebLink'})

The URL to open the event in Outlook Web App

required_attendees class-attribute instance-attribute
required_attendees: Optional[str] = field(default=None, metadata={'wire_name': 'RequiredAttendees'})

Required attendees for the event separated by semicolons

optional_attendees class-attribute instance-attribute
optional_attendees: Optional[str] = field(default=None, metadata={'wire_name': 'OptionalAttendees'})

Optional attendees for the event separated by semicolons

resource_attendees class-attribute instance-attribute
resource_attendees: Optional[str] = field(default=None, metadata={'wire_name': 'ResourceAttendees'})

Resource attendees for the event separated by semicolons

body class-attribute instance-attribute
body: Optional[str] = field(default=None, metadata={'wire_name': 'Body'})

Body of the message associated with the event

is_html class-attribute instance-attribute
is_html: Optional[bool] = field(default=None, metadata={'wire_name': 'IsHtml'})

Set to true if the body is Html

location class-attribute instance-attribute
location: Optional[str] = field(default=None, metadata={'wire_name': 'Location'})

Location of the event

is_all_day class-attribute instance-attribute
is_all_day: Optional[bool] = field(default=None, metadata={'wire_name': 'IsAllDay'})

Set to true if the event lasts all day

recurrence_end class-attribute instance-attribute
recurrence_end: Optional[str] = field(default=None, metadata={'wire_name': 'RecurrenceEnd'})

End time of the recurrence

number_of_occurrences class-attribute instance-attribute
number_of_occurrences: Optional[int] = field(default=None, metadata={'wire_name': 'NumberOfOccurrences'})

How many times to repeat the event

reminder class-attribute instance-attribute
reminder: Optional[int] = field(default=None, metadata={'wire_name': 'Reminder'})

Time in minutes before event start to remind

response_requested class-attribute instance-attribute
response_requested: Optional[bool] = field(default=None, metadata={'wire_name': 'ResponseRequested'})

Set to true if the sender would like a response when the event is accepted or declined

PaginatedListResponseCalendarEventClientReceiveStringEnums dataclass

PaginatedListResponseCalendarEventClientReceiveStringEnums(values: Optional[List[CalendarEventClientReceiveStringEnums]] = None)

Definition: PaginatedListResponse[CalendarEventClientReceiveStringEnums]

Attributes

values class-attribute instance-attribute
values: Optional[List[CalendarEventClientReceiveStringEnums]] = field(default=None, metadata={'wire_name': 'Values'})

Values

CalendarEventClientReceiveStringEnums dataclass

CalendarEventClientReceiveStringEnums(importance: Optional[str] = None, response_type: Optional[str] = None, recurrence: Optional[str] = None, show_as: Optional[str] = None, subject: Optional[str] = None, start: Optional[str] = None, end: Optional[str] = None, response_time: Optional[str] = None, i_cal_u_id: Optional[str] = None, id: Optional[str] = None, date_time_created: Optional[str] = None, date_time_last_modified: Optional[str] = None, organizer: Optional[str] = None, time_zone: Optional[str] = None, series_master_id: Optional[str] = None, categories: Optional[List[str]] = None, web_link: Optional[str] = None, required_attendees: Optional[str] = None, optional_attendees: Optional[str] = None, resource_attendees: Optional[str] = None, body: Optional[str] = None, is_html: Optional[bool] = None, location: Optional[str] = None, is_all_day: Optional[bool] = None, recurrence_end: Optional[str] = None, number_of_occurrences: Optional[int] = None, reminder: Optional[int] = None, response_requested: Optional[bool] = None)

Definition: CalendarEventClientReceiveStringEnums

Attributes

importance class-attribute instance-attribute
importance: Optional[str] = field(default=None, metadata={'wire_name': 'Importance'})

The importance of the event: Low, Normal, or High

response_type class-attribute instance-attribute
response_type: Optional[str] = field(default=None, metadata={'wire_name': 'ResponseType'})

The response type of the event: None, Organizer, TentativelyAccepted, Accepted, Declined or NotResponded

recurrence class-attribute instance-attribute
recurrence: Optional[str] = field(default=None, metadata={'wire_name': 'Recurrence'})

The recurrence pattern for the event

show_as class-attribute instance-attribute
show_as: Optional[str] = field(default=None, metadata={'wire_name': 'ShowAs'})

Status to show during the event

subject class-attribute instance-attribute
subject: Optional[str] = field(default=None, metadata={'wire_name': 'Subject'})

Event subject

start class-attribute instance-attribute
start: Optional[str] = field(default=None, metadata={'wire_name': 'Start'})

Start time of the event (example: '2016-11-01T14:30:00Z')

end class-attribute instance-attribute
end: Optional[str] = field(default=None, metadata={'wire_name': 'End'})

End time of the event (example: '2016-11-01T15:30:00Z')

response_time class-attribute instance-attribute
response_time: Optional[str] = field(default=None, metadata={'wire_name': 'ResponseTime'})

The response time of the event

i_cal_u_id class-attribute instance-attribute
i_cal_u_id: Optional[str] = field(default=None, metadata={'wire_name': 'ICalUId'})

A unique identifier that is shared by all instances of an event across different calendars

id class-attribute instance-attribute
id: Optional[str] = field(default=None, metadata={'wire_name': 'Id'})

The event's unique identifier

date_time_created class-attribute instance-attribute
date_time_created: Optional[str] = field(default=None, metadata={'wire_name': 'DateTimeCreated'})

The date and time that the event was created

date_time_last_modified class-attribute instance-attribute
date_time_last_modified: Optional[str] = field(default=None, metadata={'wire_name': 'DateTimeLastModified'})

The date and time that the event was last modified

organizer class-attribute instance-attribute
organizer: Optional[str] = field(default=None, metadata={'wire_name': 'Organizer'})

The organizer of the event

time_zone class-attribute instance-attribute
time_zone: Optional[str] = field(default=None, metadata={'wire_name': 'TimeZone'})

Time zone of the event

series_master_id class-attribute instance-attribute
series_master_id: Optional[str] = field(default=None, metadata={'wire_name': 'SeriesMasterId'})

Unique identifier for Series Master event type

categories class-attribute instance-attribute
categories: Optional[List[str]] = field(default=None, metadata={'wire_name': 'Categories'})

The categories associated with the event

web_link: Optional[str] = field(default=None, metadata={'wire_name': 'WebLink'})

The URL to open the event in Outlook Web App

required_attendees class-attribute instance-attribute
required_attendees: Optional[str] = field(default=None, metadata={'wire_name': 'RequiredAttendees'})

Required attendees for the event separated by semicolons

optional_attendees class-attribute instance-attribute
optional_attendees: Optional[str] = field(default=None, metadata={'wire_name': 'OptionalAttendees'})

Optional attendees for the event separated by semicolons

resource_attendees class-attribute instance-attribute
resource_attendees: Optional[str] = field(default=None, metadata={'wire_name': 'ResourceAttendees'})

Resource attendees for the event separated by semicolons

body class-attribute instance-attribute
body: Optional[str] = field(default=None, metadata={'wire_name': 'Body'})

Body of the message associated with the event

is_html class-attribute instance-attribute
is_html: Optional[bool] = field(default=None, metadata={'wire_name': 'IsHtml'})

Set to true if the body is Html

location class-attribute instance-attribute
location: Optional[str] = field(default=None, metadata={'wire_name': 'Location'})

Location of the event

is_all_day class-attribute instance-attribute
is_all_day: Optional[bool] = field(default=None, metadata={'wire_name': 'IsAllDay'})

Set to true if the event lasts all day

recurrence_end class-attribute instance-attribute
recurrence_end: Optional[str] = field(default=None, metadata={'wire_name': 'RecurrenceEnd'})

End time of the recurrence

number_of_occurrences class-attribute instance-attribute
number_of_occurrences: Optional[int] = field(default=None, metadata={'wire_name': 'NumberOfOccurrences'})

How many times to repeat the event

reminder class-attribute instance-attribute
reminder: Optional[int] = field(default=None, metadata={'wire_name': 'Reminder'})

Time in minutes before event start to remind

response_requested class-attribute instance-attribute
response_requested: Optional[bool] = field(default=None, metadata={'wire_name': 'ResponseRequested'})

Set to true if the sender would like a response when the event is accepted or declined

ClientSubscription dataclass

ClientSubscription(notification_url: Optional[str] = None)

Definition: ClientSubscription

Attributes

notification_url class-attribute instance-attribute
notification_url: Optional[str] = field(default=None, metadata={'wire_name': 'NotificationUrl'})

Callback url to the flow engine. Expected as part of the request and provided by Flow.

EntityListResponseFilePickerFile dataclass

EntityListResponseFilePickerFile(value: Optional[List[FilePickerFile]] = None)

Definition: EntityListResponse[FilePickerFile]

Attributes

value class-attribute instance-attribute
value: Optional[List[FilePickerFile]] = None

List of values

FilePickerFile dataclass

FilePickerFile(id: Optional[str] = None, display_name: Optional[str] = None, is_folder: Optional[bool] = None, path: Optional[str] = None)

Definition: FilePickerFile

Attributes

id class-attribute instance-attribute
id: Optional[str] = field(default=None, metadata={'wire_name': 'Id'})

Uniquely identifies the file

display_name class-attribute instance-attribute
display_name: Optional[str] = field(default=None, metadata={'wire_name': 'DisplayName'})

Display name for the file

is_folder class-attribute instance-attribute
is_folder: Optional[bool] = field(default=None, metadata={'wire_name': 'IsFolder'})

Set to true if the file is a folder

path class-attribute instance-attribute
path: Optional[str] = field(default=None, metadata={'wire_name': 'Path'})

Path of the file

ClientSendMessage dataclass

ClientSendMessage(from_: Optional[str] = None, cc: Optional[str] = None, bcc: Optional[str] = None, to: Optional[str] = None, subject: Optional[str] = None, body: Optional[str] = None, attachments: Optional[List[ClientSendAttachment]] = None, sensitivity: Optional[str] = None, reply_to: Optional[str] = None, importance: Optional[str] = None, is_html: Optional[bool] = None)

Definition: ClientSendMessage

Attributes

from_ class-attribute instance-attribute
from_: Optional[str] = field(default=None, metadata={'wire_name': 'From'})

Email address to send mail from (requires "Send as" or "Send on behalf of" permission for that mailbox). For more info on granting permissions please refer https://docs.microsoft.com/office365/admin/manage/send-email-as-distribution-list

cc class-attribute instance-attribute
cc: Optional[str] = field(default=None, metadata={'wire_name': 'Cc'})

Specify email addresses separated by semicolons like someone@contoso.com

bcc class-attribute instance-attribute
bcc: Optional[str] = field(default=None, metadata={'wire_name': 'Bcc'})

Specify email addresses separated by semicolons like someone@contoso.com

to class-attribute instance-attribute
to: Optional[str] = field(default=None, metadata={'wire_name': 'To'})

Specify email addresses separated by semicolons like someone@contoso.com

subject class-attribute instance-attribute
subject: Optional[str] = field(default=None, metadata={'wire_name': 'Subject'})

Specify the subject of the mail

body class-attribute instance-attribute
body: Optional[str] = field(default=None, metadata={'wire_name': 'Body'})

Specify the body of the mail

attachments class-attribute instance-attribute
attachments: Optional[List[ClientSendAttachment]] = field(default=None, metadata={'wire_name': 'Attachments'})

Attachments

sensitivity class-attribute instance-attribute
sensitivity: Optional[str] = field(default=None, metadata={'wire_name': 'Sensitivity'})

Sensitivity

reply_to class-attribute instance-attribute
reply_to: Optional[str] = field(default=None, metadata={'wire_name': 'ReplyTo'})

The email addresses to use when replying

importance class-attribute instance-attribute
importance: Optional[str] = field(default=None, metadata={'wire_name': 'Importance'})

Importance

is_html class-attribute instance-attribute
is_html: Optional[bool] = field(default=None, metadata={'wire_name': 'IsHtml'})

Is Html?

ClientSendAttachment dataclass

ClientSendAttachment(name: Optional[str] = None, content_bytes: Optional[str] = None)

Definition: ClientSendAttachment

Attributes

name class-attribute instance-attribute
name: Optional[str] = field(default=None, metadata={'wire_name': 'Name'})

Attachment name

content_bytes class-attribute instance-attribute
content_bytes: Optional[str] = field(default=None, metadata={'wire_name': 'ContentBytes'})

Attachment content

ClientReceiveMessageStringEnums dataclass

ClientReceiveMessageStringEnums(importance: Optional[str] = None, from_: Optional[str] = None, to: Optional[str] = None, cc: Optional[str] = None, bcc: Optional[str] = None, reply_to: Optional[str] = None, subject: Optional[str] = None, body: Optional[str] = None, body_preview: Optional[str] = None, has_attachment: Optional[bool] = None, id: Optional[str] = None, internet_message_id: Optional[str] = None, conversation_id: Optional[str] = None, date_time_received: Optional[str] = None, is_read: Optional[bool] = None, attachments: Optional[List[ClientReceiveFileAttachment]] = None, is_html: Optional[bool] = None)

Definition: ClientReceiveMessageStringEnums

Attributes

importance class-attribute instance-attribute
importance: Optional[str] = field(default=None, metadata={'wire_name': 'Importance'})

The importance of the message

from_ class-attribute instance-attribute
from_: Optional[str] = field(default=None, metadata={'wire_name': 'From'})

The mailbox owner and sender of the message

to class-attribute instance-attribute
to: Optional[str] = field(default=None, metadata={'wire_name': 'To'})

The recipients for the message

cc class-attribute instance-attribute
cc: Optional[str] = field(default=None, metadata={'wire_name': 'Cc'})

The Cc recipients for the message

bcc class-attribute instance-attribute
bcc: Optional[str] = field(default=None, metadata={'wire_name': 'Bcc'})

The Bcc recipients for the message

reply_to class-attribute instance-attribute
reply_to: Optional[str] = field(default=None, metadata={'wire_name': 'ReplyTo'})

The email addresses to use when replying

subject class-attribute instance-attribute
subject: Optional[str] = field(default=None, metadata={'wire_name': 'Subject'})

The subject of the message

body class-attribute instance-attribute
body: Optional[str] = field(default=None, metadata={'wire_name': 'Body'})

The body of the message

body_preview class-attribute instance-attribute
body_preview: Optional[str] = field(default=None, metadata={'wire_name': 'BodyPreview'})

The preview of the message

has_attachment class-attribute instance-attribute
has_attachment: Optional[bool] = field(default=None, metadata={'wire_name': 'HasAttachment'})

Indicates whether the message has attachments

id class-attribute instance-attribute
id: Optional[str] = field(default=None, metadata={'wire_name': 'Id'})

The unique identifier of the message

internet_message_id class-attribute instance-attribute
internet_message_id: Optional[str] = field(default=None, metadata={'wire_name': 'InternetMessageId'})

The message ID in the format specified by RFC2822

conversation_id class-attribute instance-attribute
conversation_id: Optional[str] = field(default=None, metadata={'wire_name': 'ConversationId'})

The Id of the conversation the email belongs to

date_time_received class-attribute instance-attribute
date_time_received: Optional[str] = field(default=None, metadata={'wire_name': 'DateTimeReceived'})

The date and time the message was received

is_read class-attribute instance-attribute
is_read: Optional[bool] = field(default=None, metadata={'wire_name': 'IsRead'})

Indicates whether the message has been read

attachments class-attribute instance-attribute
attachments: Optional[List[ClientReceiveFileAttachment]] = field(default=None, metadata={'wire_name': 'Attachments'})

The file attachments for the message

is_html class-attribute instance-attribute
is_html: Optional[bool] = field(default=None, metadata={'wire_name': 'IsHtml'})

Is Html?

ClientReceiveFileAttachment dataclass

ClientReceiveFileAttachment(id: Optional[str] = None, name: Optional[str] = None, content_bytes: Optional[str] = None, content_type: Optional[str] = None, size: Optional[int] = None, is_inline: Optional[bool] = None, last_modified_date_time: Optional[str] = None, content_id: Optional[str] = None)

Definition: ClientReceiveFileAttachment

Attributes

id class-attribute instance-attribute
id: Optional[str] = field(default=None, metadata={'wire_name': 'Id'})

Attachment Id

name class-attribute instance-attribute
name: Optional[str] = field(default=None, metadata={'wire_name': 'Name'})

Attachment name

content_bytes class-attribute instance-attribute
content_bytes: Optional[str] = field(default=None, metadata={'wire_name': 'ContentBytes'})

Attachment content

content_type class-attribute instance-attribute
content_type: Optional[str] = field(default=None, metadata={'wire_name': 'ContentType'})

Attachment content type

size class-attribute instance-attribute
size: Optional[int] = field(default=None, metadata={'wire_name': 'Size'})

The size in bytes of the attachment

is_inline class-attribute instance-attribute
is_inline: Optional[bool] = field(default=None, metadata={'wire_name': 'IsInline'})

Set to true if this is an inline attachment

last_modified_date_time class-attribute instance-attribute
last_modified_date_time: Optional[str] = field(default=None, metadata={'wire_name': 'LastModifiedDateTime'})

The date and time when the attachment was last modified

content_id class-attribute instance-attribute
content_id: Optional[str] = field(default=None, metadata={'wire_name': 'ContentId'})

Content Id

SendEmailInput dataclass

SendEmailInput(to: Optional[str] = None, subject: Optional[str] = None, body: Optional[str] = None, from_: Optional[str] = None, cc: Optional[str] = None, bcc: Optional[str] = None, attachments: Optional[List[ClientSendAttachment]] = None, sensitivity: Optional[str] = None, reply_to: Optional[str] = None, importance: Optional[str] = None)

Definition: ClientSendHtmlMessage

Attributes

to class-attribute instance-attribute
to: Optional[str] = field(default=None, metadata={'wire_name': 'To'})

Specify email addresses separated by semicolons like someone@contoso.com

subject class-attribute instance-attribute
subject: Optional[str] = field(default=None, metadata={'wire_name': 'Subject'})

Specify the subject of the mail

body class-attribute instance-attribute
body: Optional[str] = field(default=None, metadata={'wire_name': 'Body'})

Specify the body of the mail

from_ class-attribute instance-attribute
from_: Optional[str] = field(default=None, metadata={'wire_name': 'From'})

Email address to send mail from (requires "Send as" or "Send on behalf of" permission for that mailbox). For more info on granting permissions please refer https://docs.microsoft.com/office365/admin/manage/send-email-as-distribution-list

cc class-attribute instance-attribute
cc: Optional[str] = field(default=None, metadata={'wire_name': 'Cc'})

Specify email addresses separated by semicolons like someone@contoso.com

bcc class-attribute instance-attribute
bcc: Optional[str] = field(default=None, metadata={'wire_name': 'Bcc'})

Specify email addresses separated by semicolons like someone@contoso.com

attachments class-attribute instance-attribute
attachments: Optional[List[ClientSendAttachment]] = field(default=None, metadata={'wire_name': 'Attachments'})

Attachments

sensitivity class-attribute instance-attribute
sensitivity: Optional[str] = field(default=None, metadata={'wire_name': 'Sensitivity'})

Sensitivity

reply_to class-attribute instance-attribute
reply_to: Optional[str] = field(default=None, metadata={'wire_name': 'ReplyTo'})

The email addresses to use when replying

importance class-attribute instance-attribute
importance: Optional[str] = field(default=None, metadata={'wire_name': 'Importance'})

Importance

DraftEmailInput dataclass

DraftEmailInput(to: Optional[str] = None, subject: Optional[str] = None, body: Optional[str] = None, from_: Optional[str] = None, cc: Optional[str] = None, bcc: Optional[str] = None, attachments: Optional[List[ClientSendAttachment]] = None, sensitivity: Optional[str] = None, reply_to: Optional[str] = None, importance: Optional[str] = None)

Definition: ClientDraftHtmlMessage

Attributes

to class-attribute instance-attribute
to: Optional[str] = field(default=None, metadata={'wire_name': 'To'})

Specify email addresses separated by semicolons like someone@contoso.com

subject class-attribute instance-attribute
subject: Optional[str] = field(default=None, metadata={'wire_name': 'Subject'})

Specify the subject of the mail

body class-attribute instance-attribute
body: Optional[str] = field(default=None, metadata={'wire_name': 'Body'})

Specify the body of the mail

from_ class-attribute instance-attribute
from_: Optional[str] = field(default=None, metadata={'wire_name': 'From'})

Email address to send mail from (requires "Send as" or "Send on behalf of" permission for that mailbox). For more info on granting permissions please refer https://docs.microsoft.com/office365/admin/manage/send-email-as-distribution-list

cc class-attribute instance-attribute
cc: Optional[str] = field(default=None, metadata={'wire_name': 'Cc'})

Specify email addresses separated by semicolons like someone@contoso.com

bcc class-attribute instance-attribute
bcc: Optional[str] = field(default=None, metadata={'wire_name': 'Bcc'})

Specify email addresses separated by semicolons like someone@contoso.com

attachments class-attribute instance-attribute
attachments: Optional[List[ClientSendAttachment]] = field(default=None, metadata={'wire_name': 'Attachments'})

Attachments

sensitivity class-attribute instance-attribute
sensitivity: Optional[str] = field(default=None, metadata={'wire_name': 'Sensitivity'})

Sensitivity

reply_to class-attribute instance-attribute
reply_to: Optional[str] = field(default=None, metadata={'wire_name': 'ReplyTo'})

The email addresses to use when replying

importance class-attribute instance-attribute
importance: Optional[str] = field(default=None, metadata={'wire_name': 'Importance'})

Importance

BatchItemFailureResult dataclass

BatchItemFailureResult(message_id: Optional[str] = None, error: Optional[str] = None)

Definition: BatchItemFailureResult

Attributes

message_id class-attribute instance-attribute
message_id: Optional[str] = field(default=None, metadata={'wire_name': 'MessageId'})

The ID of the failed message.

error class-attribute instance-attribute
error: Optional[str] = field(default=None, metadata={'wire_name': 'Error'})

The error message of the failure.

BatchResponseClientReceiveMessage dataclass

BatchResponseClientReceiveMessage(value: Optional[List[ClientReceiveMessage]] = None)

Definition: BatchResponse[ClientReceiveMessage]

Attributes

value class-attribute instance-attribute
value: Optional[List[ClientReceiveMessage]] = None

A list of the response objects

ClientReceiveMessage dataclass

ClientReceiveMessage(from_: Optional[str] = None, to: Optional[str] = None, cc: Optional[str] = None, bcc: Optional[str] = None, reply_to: Optional[str] = None, subject: Optional[str] = None, body: Optional[str] = None, importance: Optional[int] = None, body_preview: Optional[str] = None, has_attachment: Optional[bool] = None, id: Optional[str] = None, internet_message_id: Optional[str] = None, conversation_id: Optional[str] = None, date_time_received: Optional[str] = None, is_read: Optional[bool] = None, attachments: Optional[List[ClientReceiveFileAttachment]] = None, is_html: Optional[bool] = None)

Definition: ClientReceiveMessage

Attributes

from_ class-attribute instance-attribute
from_: Optional[str] = field(default=None, metadata={'wire_name': 'From'})

The mailbox owner and sender of the message

to class-attribute instance-attribute
to: Optional[str] = field(default=None, metadata={'wire_name': 'To'})

The recipients for the message

cc class-attribute instance-attribute
cc: Optional[str] = field(default=None, metadata={'wire_name': 'Cc'})

The Cc recipients for the message

bcc class-attribute instance-attribute
bcc: Optional[str] = field(default=None, metadata={'wire_name': 'Bcc'})

The Bcc recipients for the message

reply_to class-attribute instance-attribute
reply_to: Optional[str] = field(default=None, metadata={'wire_name': 'ReplyTo'})

The email addresses to use when replying

subject class-attribute instance-attribute
subject: Optional[str] = field(default=None, metadata={'wire_name': 'Subject'})

The subject of the message

body class-attribute instance-attribute
body: Optional[str] = field(default=None, metadata={'wire_name': 'Body'})

The body of the message

importance class-attribute instance-attribute
importance: Optional[int] = field(default=None, metadata={'wire_name': 'Importance'})

The importance of the message (0 - Low, 1 - Normal, 2 - High)

body_preview class-attribute instance-attribute
body_preview: Optional[str] = field(default=None, metadata={'wire_name': 'BodyPreview'})

The preview of the message

has_attachment class-attribute instance-attribute
has_attachment: Optional[bool] = field(default=None, metadata={'wire_name': 'HasAttachment'})

Indicates whether the message has attachments

id class-attribute instance-attribute
id: Optional[str] = field(default=None, metadata={'wire_name': 'Id'})

The unique identifier of the message

internet_message_id class-attribute instance-attribute
internet_message_id: Optional[str] = field(default=None, metadata={'wire_name': 'InternetMessageId'})

The message ID in the format specified by RFC2822

conversation_id class-attribute instance-attribute
conversation_id: Optional[str] = field(default=None, metadata={'wire_name': 'ConversationId'})

The Id of the conversation the email belongs to

date_time_received class-attribute instance-attribute
date_time_received: Optional[str] = field(default=None, metadata={'wire_name': 'DateTimeReceived'})

The date and time the message was received

is_read class-attribute instance-attribute
is_read: Optional[bool] = field(default=None, metadata={'wire_name': 'IsRead'})

Indicates whether the message has been read

attachments class-attribute instance-attribute
attachments: Optional[List[ClientReceiveFileAttachment]] = field(default=None, metadata={'wire_name': 'Attachments'})

The file attachments for the message

is_html class-attribute instance-attribute
is_html: Optional[bool] = field(default=None, metadata={'wire_name': 'IsHtml'})

Is Html?

GraphClientReceiveFileAttachment dataclass

GraphClientReceiveFileAttachment(id: Optional[str] = None, name: Optional[str] = None, content_bytes: Optional[str] = None, content_type: Optional[str] = None, size: Optional[int] = None, is_inline: Optional[bool] = None, last_modified_date_time: Optional[str] = None, content_id: Optional[str] = None)

Definition: GraphClientReceiveFileAttachment

Attributes

id class-attribute instance-attribute
id: Optional[str] = None

Attachment Id

name class-attribute instance-attribute
name: Optional[str] = None

Attachment name

content_bytes class-attribute instance-attribute
content_bytes: Optional[str] = field(default=None, metadata={'wire_name': 'contentBytes'})

Attachment content

content_type class-attribute instance-attribute
content_type: Optional[str] = field(default=None, metadata={'wire_name': 'contentType'})

Attachment content type

size class-attribute instance-attribute
size: Optional[int] = None

The size in bytes of the attachment

is_inline class-attribute instance-attribute
is_inline: Optional[bool] = field(default=None, metadata={'wire_name': 'isInline'})

Set to true if this is an inline attachment

last_modified_date_time class-attribute instance-attribute
last_modified_date_time: Optional[str] = field(default=None, metadata={'wire_name': 'lastModifiedDateTime'})

The date and time when the attachment was last modified

content_id class-attribute instance-attribute
content_id: Optional[str] = field(default=None, metadata={'wire_name': 'contentId'})

Content Id

ReplyMessage dataclass

ReplyMessage(to: Optional[str] = None, cc: Optional[str] = None, bcc: Optional[str] = None, subject: Optional[str] = None, body: Optional[str] = None, reply_all: Optional[bool] = None, is_html: Optional[bool] = None, importance: Optional[str] = None, attachments: Optional[List[ClientSendAttachment]] = None)

Definition: ReplyMessage

Attributes

to class-attribute instance-attribute
to: Optional[str] = field(default=None, metadata={'wire_name': 'To'})

Example: recipient1@domain.com; recipient2@domain.com

cc class-attribute instance-attribute
cc: Optional[str] = field(default=None, metadata={'wire_name': 'Cc'})

Example: recipient1@domain.com; recipient2@domain.com

bcc class-attribute instance-attribute
bcc: Optional[str] = field(default=None, metadata={'wire_name': 'Bcc'})

Example: recipient1@domain.com; recipient2@domain.com

subject class-attribute instance-attribute
subject: Optional[str] = field(default=None, metadata={'wire_name': 'Subject'})

Email subject (if empty, the original subject used).

body class-attribute instance-attribute
body: Optional[str] = field(default=None, metadata={'wire_name': 'Body'})

Content of the email.

reply_all class-attribute instance-attribute
reply_all: Optional[bool] = field(default=None, metadata={'wire_name': 'ReplyAll'})

True to reply to all recipients. (default: False)

is_html class-attribute instance-attribute
is_html: Optional[bool] = field(default=None, metadata={'wire_name': 'IsHtml'})

True to send the reply as HTML. (default: True)

importance class-attribute instance-attribute
importance: Optional[str] = field(default=None, metadata={'wire_name': 'Importance'})

Pick an importance. (default: Low)

attachments class-attribute instance-attribute
attachments: Optional[List[ClientSendAttachment]] = field(default=None, metadata={'wire_name': 'Attachments'})

Details of attachments to be sent along with the reply.

ReplyEmailInput dataclass

ReplyEmailInput(to: Optional[str] = None, cc: Optional[str] = None, bcc: Optional[str] = None, subject: Optional[str] = None, body: Optional[str] = None, reply_all: Optional[bool] = None, importance: Optional[str] = None, attachments: Optional[List[ClientSendAttachment]] = None)

Definition: ReplyHtmlMessage

Attributes

to class-attribute instance-attribute
to: Optional[str] = field(default=None, metadata={'wire_name': 'To'})

Example: recipient1@domain.com; recipient2@domain.com

cc class-attribute instance-attribute
cc: Optional[str] = field(default=None, metadata={'wire_name': 'Cc'})

Example: recipient1@domain.com; recipient2@domain.com

bcc class-attribute instance-attribute
bcc: Optional[str] = field(default=None, metadata={'wire_name': 'Bcc'})

Example: recipient1@domain.com; recipient2@domain.com

subject class-attribute instance-attribute
subject: Optional[str] = field(default=None, metadata={'wire_name': 'Subject'})

Email subject (if empty, the original subject used).

body class-attribute instance-attribute
body: Optional[str] = field(default=None, metadata={'wire_name': 'Body'})

Content of the email.

reply_all class-attribute instance-attribute
reply_all: Optional[bool] = field(default=None, metadata={'wire_name': 'ReplyAll'})

True to reply to all recipients. (default: False)

importance class-attribute instance-attribute
importance: Optional[str] = field(default=None, metadata={'wire_name': 'Importance'})

Pick an importance. (default: Low)

attachments class-attribute instance-attribute
attachments: Optional[List[ClientSendAttachment]] = field(default=None, metadata={'wire_name': 'Attachments'})

Details of attachments to be sent along with the reply.

TriggerBatchResponseClientReceiveMessage dataclass

TriggerBatchResponseClientReceiveMessage(value: Optional[List[ClientReceiveMessage]] = None)

Definition: TriggerBatchResponse[ClientReceiveMessage]

Attributes

value class-attribute instance-attribute
value: Optional[List[ClientReceiveMessage]] = None

A list of the response objects

BatchResponseSensitivityLabel dataclass

BatchResponseSensitivityLabel(value: Optional[List[SensitivityLabel]] = None)

Definition: BatchResponse[SensitivityLabel]

Attributes

value class-attribute instance-attribute
value: Optional[List[SensitivityLabel]] = None

A list of the response objects

SensitivityLabel dataclass

SensitivityLabel(id: Optional[str] = None, display_name: Optional[str] = None, applicable_to: Optional[str] = None, sub_labels: Optional[List[SensitivityLabel]] = None)

Definition: SensitivityLabel

Attributes

id class-attribute instance-attribute
id: Optional[str] = field(default=None, metadata={'wire_name': 'Id'})

Gets or sets the identifier.

display_name class-attribute instance-attribute
display_name: Optional[str] = field(default=None, metadata={'wire_name': 'DisplayName'})

Gets or sets the display name.

applicable_to class-attribute instance-attribute
applicable_to: Optional[str] = field(default=None, metadata={'wire_name': 'ApplicableTo'})

Gets or sets the applicable to.

sub_labels class-attribute instance-attribute
sub_labels: Optional[List[SensitivityLabel]] = field(default=None, metadata={'wire_name': 'SubLabels'})

Gets or sets sub labels.

TriggerBatchResponseReceiveMessageMetadata dataclass

TriggerBatchResponseReceiveMessageMetadata(value: Optional[List[ReceiveMessageMetadata]] = None)

Definition: TriggerBatchResponse[ReceiveMessageMetadata]

Attributes

value class-attribute instance-attribute
value: Optional[List[ReceiveMessageMetadata]] = None

A list of the response objects

ReceiveMessageMetadata dataclass

ReceiveMessageMetadata(from_: Optional[str] = None, to: Optional[str] = None, cc: Optional[str] = None, bcc: Optional[str] = None, reply_to: Optional[str] = None, subject: Optional[str] = None, importance: Optional[int] = None, has_attachment: Optional[bool] = None, id: Optional[str] = None, date_time_received: Optional[str] = None, is_read: Optional[bool] = None)

Definition: ReceiveMessageMetadata

Attributes

from_ class-attribute instance-attribute
from_: Optional[str] = field(default=None, metadata={'wire_name': 'From'})

The mailbox owner and sender of the message

to class-attribute instance-attribute
to: Optional[str] = field(default=None, metadata={'wire_name': 'To'})

The recipients for the message

cc class-attribute instance-attribute
cc: Optional[str] = field(default=None, metadata={'wire_name': 'Cc'})

The Cc recipients for the message

bcc class-attribute instance-attribute
bcc: Optional[str] = field(default=None, metadata={'wire_name': 'Bcc'})

The Bcc recipients for the message

reply_to class-attribute instance-attribute
reply_to: Optional[str] = field(default=None, metadata={'wire_name': 'ReplyTo'})

The email addresses to use when replying

subject class-attribute instance-attribute
subject: Optional[str] = field(default=None, metadata={'wire_name': 'Subject'})

The subject of the message

importance class-attribute instance-attribute
importance: Optional[int] = field(default=None, metadata={'wire_name': 'Importance'})

The importance of the message (0 - Low, 1 - Normal, 2 - High)

has_attachment class-attribute instance-attribute
has_attachment: Optional[bool] = field(default=None, metadata={'wire_name': 'HasAttachment'})

Indicates whether the message has attachments

id class-attribute instance-attribute
id: Optional[str] = field(default=None, metadata={'wire_name': 'Id'})

The unique identifier of the message

date_time_received class-attribute instance-attribute
date_time_received: Optional[str] = field(default=None, metadata={'wire_name': 'DateTimeReceived'})

The date and time the message was received

is_read class-attribute instance-attribute
is_read: Optional[bool] = field(default=None, metadata={'wire_name': 'IsRead'})

Indicates whether the message has been read

DataSetsMetadata dataclass

DataSetsMetadata(tabular: Optional[TabularDataSetsMetadata] = None, blob: Optional[BlobDataSetsMetadata] = None)

Definition: DataSetsMetadata

TabularDataSetsMetadata dataclass

TabularDataSetsMetadata(source: Optional[str] = None, display_name: Optional[str] = None, url_encoding: Optional[str] = None, table_display_name: Optional[str] = None, table_plural_name: Optional[str] = None)

Definition: TabularDataSetsMetadata

Attributes

source class-attribute instance-attribute
source: Optional[str] = None

Dataset source

display_name class-attribute instance-attribute
display_name: Optional[str] = field(default=None, metadata={'wire_name': 'displayName'})

Dataset display name

url_encoding class-attribute instance-attribute
url_encoding: Optional[str] = field(default=None, metadata={'wire_name': 'urlEncoding'})

Dataset url encoding

table_display_name class-attribute instance-attribute
table_display_name: Optional[str] = field(default=None, metadata={'wire_name': 'tableDisplayName'})

Table display name

table_plural_name class-attribute instance-attribute
table_plural_name: Optional[str] = field(default=None, metadata={'wire_name': 'tablePluralName'})

Table plural display name

BlobDataSetsMetadata dataclass

BlobDataSetsMetadata(source: Optional[str] = None, display_name: Optional[str] = None, url_encoding: Optional[str] = None)

Definition: BlobDataSetsMetadata

Attributes

source class-attribute instance-attribute
source: Optional[str] = None

Blob dataset source

display_name class-attribute instance-attribute
display_name: Optional[str] = field(default=None, metadata={'wire_name': 'displayName'})

Blob dataset display name

url_encoding class-attribute instance-attribute
url_encoding: Optional[str] = field(default=None, metadata={'wire_name': 'urlEncoding'})

Blob dataset url encoding

OptionsEmailSubscription dataclass

OptionsEmailSubscription(notification_url: Optional[str] = None, message: Optional[MessageWithOptions] = None)

Definition: OptionsEmailSubscription

Attributes

notification_url class-attribute instance-attribute
notification_url: Optional[str] = field(default=None, metadata={'wire_name': 'NotificationUrl'})

Gets or sets callback url to flow engine. It is expected as part of request

MessageWithOptions dataclass

MessageWithOptions(to: Optional[str] = None, subject: Optional[str] = None, options: Optional[str] = None, header_text: Optional[str] = None, selection_text: Optional[str] = None, body: Optional[str] = None, importance: Optional[str] = None, attachments: Optional[List[ClientSendAttachment]] = None, use_only_h_t_m_l_message: Optional[bool] = None, hide_h_t_m_l_message: Optional[bool] = None, show_h_t_m_l_confirmation_dialog: Optional[bool] = None, hide_microsoft_footer: Optional[bool] = None)

Definition: MessageWithOptions

Attributes

to class-attribute instance-attribute
to: Optional[str] = field(default=None, metadata={'wire_name': 'To'})

Specify email addresses separated by semicolons like someone@contoso.com

subject class-attribute instance-attribute
subject: Optional[str] = field(default=None, metadata={'wire_name': 'Subject'})

Subject of the email

options class-attribute instance-attribute
options: Optional[str] = field(default=None, metadata={'wire_name': 'Options'})

List of comma separated options for the email response

header_text class-attribute instance-attribute
header_text: Optional[str] = field(default=None, metadata={'wire_name': 'HeaderText'})

Header text for email body

selection_text class-attribute instance-attribute
selection_text: Optional[str] = field(default=None, metadata={'wire_name': 'SelectionText'})

Header text for users options selection

body class-attribute instance-attribute
body: Optional[str] = field(default=None, metadata={'wire_name': 'Body'})

Body of the email

importance class-attribute instance-attribute
importance: Optional[str] = field(default=None, metadata={'wire_name': 'Importance'})

Importance

attachments class-attribute instance-attribute
attachments: Optional[List[ClientSendAttachment]] = field(default=None, metadata={'wire_name': 'Attachments'})

Attachments

use_only_h_t_m_l_message class-attribute instance-attribute
use_only_h_t_m_l_message: Optional[bool] = field(default=None, metadata={'wire_name': 'UseOnlyHTMLMessage'})

Use only HTML message

hide_h_t_m_l_message class-attribute instance-attribute
hide_h_t_m_l_message: Optional[bool] = field(default=None, metadata={'wire_name': 'HideHTMLMessage'})

If set to Yes, then the email body is hidden and only message card is displayed. Email clients which do not support actionable messages will display HTML message regardless of the parameter value.

show_h_t_m_l_confirmation_dialog class-attribute instance-attribute
show_h_t_m_l_confirmation_dialog: Optional[bool] = field(default=None, metadata={'wire_name': 'ShowHTMLConfirmationDialog'})

If set to Yes then a dialog wil be shown to confirm selected option of HTML message

hide_microsoft_footer: Optional[bool] = field(default=None, metadata={'wire_name': 'HideMicrosoftFooter'})

If set to Yes, then the Microsoft footer is hidden in the email body.

ApprovalEmailResponse dataclass

ApprovalEmailResponse(selected_option: Optional[str] = None, user_email_address: Optional[str] = None, user_tenant_id: Optional[str] = None, user_id: Optional[str] = None)

Definition: ApprovalEmailResponse

Attributes

selected_option class-attribute instance-attribute
selected_option: Optional[str] = field(default=None, metadata={'wire_name': 'SelectedOption'})

User response

user_email_address class-attribute instance-attribute
user_email_address: Optional[str] = field(default=None, metadata={'wire_name': 'UserEmailAddress'})

User email address. The value is the user's email address for individual users and user ID for the members in Distribution Group or Mail Enabled Security Group.

user_tenant_id class-attribute instance-attribute
user_tenant_id: Optional[str] = field(default=None, metadata={'wire_name': 'UserTenantId'})

User tenant ID. The value is the tenant id of the user for both individual users and the members in Distribution Group or Mail Enabled Security Group.

user_id class-attribute instance-attribute
user_id: Optional[str] = field(default=None, metadata={'wire_name': 'UserId'})

User ID. The value is the user id for both individual users and the members in Distribution Group or Mail Enabled Security Group.

ApprovalEmailSubscription dataclass

ApprovalEmailSubscription(notification_url: Optional[str] = None, message: Optional[ApprovalMessage] = None)

Definition: ApprovalEmailSubscription

Attributes

notification_url class-attribute instance-attribute
notification_url: Optional[str] = field(default=None, metadata={'wire_name': 'NotificationUrl'})

Gets or sets callback url to flow engine. It is expected as part of request

ApprovalMessage dataclass

ApprovalMessage(to: Optional[str] = None, subject: Optional[str] = None, options: Optional[str] = None, header_text: Optional[str] = None, selection_text: Optional[str] = None, body: Optional[str] = None, importance: Optional[str] = None, attachments: Optional[List[ClientSendAttachment]] = None, use_only_h_t_m_l_message: Optional[bool] = None, hide_h_t_m_l_message: Optional[bool] = None, show_h_t_m_l_confirmation_dialog: Optional[bool] = None)

Definition: ApprovalMessage

Attributes

to class-attribute instance-attribute
to: Optional[str] = field(default=None, metadata={'wire_name': 'To'})

Specify email addresses separated by semicolons like someone@contoso.com

subject class-attribute instance-attribute
subject: Optional[str] = field(default=None, metadata={'wire_name': 'Subject'})

Subject

options class-attribute instance-attribute
options: Optional[str] = field(default=None, metadata={'wire_name': 'Options'})

User Options

header_text class-attribute instance-attribute
header_text: Optional[str] = field(default=None, metadata={'wire_name': 'HeaderText'})

Header text for email body

selection_text class-attribute instance-attribute
selection_text: Optional[str] = field(default=None, metadata={'wire_name': 'SelectionText'})

Header text for users options selection

body class-attribute instance-attribute
body: Optional[str] = field(default=None, metadata={'wire_name': 'Body'})

Body

importance class-attribute instance-attribute
importance: Optional[str] = field(default=None, metadata={'wire_name': 'Importance'})

Importance

attachments class-attribute instance-attribute
attachments: Optional[List[ClientSendAttachment]] = field(default=None, metadata={'wire_name': 'Attachments'})

Attachments

use_only_h_t_m_l_message class-attribute instance-attribute
use_only_h_t_m_l_message: Optional[bool] = field(default=None, metadata={'wire_name': 'UseOnlyHTMLMessage'})

Use only HTML message

hide_h_t_m_l_message class-attribute instance-attribute
hide_h_t_m_l_message: Optional[bool] = field(default=None, metadata={'wire_name': 'HideHTMLMessage'})

If set to Yes, then the email body is hidden and only message card is displayed. Email clients which do not support actionable messages will display HTML message regardless of the parameter value.

show_h_t_m_l_confirmation_dialog class-attribute instance-attribute
show_h_t_m_l_confirmation_dialog: Optional[bool] = field(default=None, metadata={'wire_name': 'ShowHTMLConfirmationDialog'})

If set to Yes then a dialog wil be shown to confirm selected option of HTML message

SharedMailboxClientSendMessage dataclass

SharedMailboxClientSendMessage(mailbox_address: Optional[str] = None, to: Optional[str] = None, subject: Optional[str] = None, body: Optional[str] = None, cc: Optional[str] = None, bcc: Optional[str] = None, attachments: Optional[List[ClientSendAttachment]] = None, sensitivity: Optional[str] = None, reply_to: Optional[str] = None, importance: Optional[str] = None, is_html: Optional[bool] = None)

Definition: SharedMailboxClientSendMessage

Attributes

mailbox_address class-attribute instance-attribute
mailbox_address: Optional[str] = field(default=None, metadata={'wire_name': 'MailboxAddress'})

Specify email address of a shared mailbox like someone@contoso.com

to class-attribute instance-attribute
to: Optional[str] = field(default=None, metadata={'wire_name': 'To'})

Specify email addresses separated by semicolons like someone@contoso.com

subject class-attribute instance-attribute
subject: Optional[str] = field(default=None, metadata={'wire_name': 'Subject'})

Specify the subject of the mail

body class-attribute instance-attribute
body: Optional[str] = field(default=None, metadata={'wire_name': 'Body'})

Specify the body of the mail

cc class-attribute instance-attribute
cc: Optional[str] = field(default=None, metadata={'wire_name': 'Cc'})

Specify email addresses separated by semicolons like someone@contoso.com

bcc class-attribute instance-attribute
bcc: Optional[str] = field(default=None, metadata={'wire_name': 'Bcc'})

Specify email addresses separated by semicolons like someone@contoso.com

attachments class-attribute instance-attribute
attachments: Optional[List[ClientSendAttachment]] = field(default=None, metadata={'wire_name': 'Attachments'})

Attachments

sensitivity class-attribute instance-attribute
sensitivity: Optional[str] = field(default=None, metadata={'wire_name': 'Sensitivity'})

Sensitivity

reply_to class-attribute instance-attribute
reply_to: Optional[str] = field(default=None, metadata={'wire_name': 'ReplyTo'})

The email addresses to use when replying

importance class-attribute instance-attribute
importance: Optional[str] = field(default=None, metadata={'wire_name': 'Importance'})

Importance

is_html class-attribute instance-attribute
is_html: Optional[bool] = field(default=None, metadata={'wire_name': 'IsHtml'})

Is Html?

SharedMailboxSendEmailInput dataclass

SharedMailboxSendEmailInput(mailbox_address: Optional[str] = None, to: Optional[str] = None, subject: Optional[str] = None, body: Optional[str] = None, cc: Optional[str] = None, bcc: Optional[str] = None, attachments: Optional[List[ClientSendAttachment]] = None, sensitivity: Optional[str] = None, reply_to: Optional[str] = None, importance: Optional[str] = None)

Definition: SharedMailboxClientSendHtmlMessage

Attributes

mailbox_address class-attribute instance-attribute
mailbox_address: Optional[str] = field(default=None, metadata={'wire_name': 'MailboxAddress'})

Specify email address of a shared mailbox like someone@contoso.com

to class-attribute instance-attribute
to: Optional[str] = field(default=None, metadata={'wire_name': 'To'})

Specify email addresses separated by semicolons like someone@contoso.com

subject class-attribute instance-attribute
subject: Optional[str] = field(default=None, metadata={'wire_name': 'Subject'})

Specify the subject of the mail

body class-attribute instance-attribute
body: Optional[str] = field(default=None, metadata={'wire_name': 'Body'})

Specify the body of the mail

cc class-attribute instance-attribute
cc: Optional[str] = field(default=None, metadata={'wire_name': 'Cc'})

Specify email addresses separated by semicolons like someone@contoso.com

bcc class-attribute instance-attribute
bcc: Optional[str] = field(default=None, metadata={'wire_name': 'Bcc'})

Specify email addresses separated by semicolons like someone@contoso.com

attachments class-attribute instance-attribute
attachments: Optional[List[ClientSendAttachment]] = field(default=None, metadata={'wire_name': 'Attachments'})

Attachments

sensitivity class-attribute instance-attribute
sensitivity: Optional[str] = field(default=None, metadata={'wire_name': 'Sensitivity'})

Sensitivity

reply_to class-attribute instance-attribute
reply_to: Optional[str] = field(default=None, metadata={'wire_name': 'ReplyTo'})

The email addresses to use when replying

importance class-attribute instance-attribute
importance: Optional[str] = field(default=None, metadata={'wire_name': 'Importance'})

Importance

SubscriptionPayloadOutlookReceiveMessage dataclass

SubscriptionPayloadOutlookReceiveMessage(value: Optional[List[SubscriptionPayloadEntityOutlookReceiveMessage]] = None)

Definition: SubscriptionPayload[OutlookReceiveMessage]

Attributes

value class-attribute instance-attribute
value: Optional[List[SubscriptionPayloadEntityOutlookReceiveMessage]] = None

List of values

SubscriptionPayloadEntityOutlookReceiveMessage dataclass

SubscriptionPayloadEntityOutlookReceiveMessage(sequence_number: Optional[int] = None, change_type: Optional[str] = None, client_state: Optional[str] = None, resource: Optional[str] = None, resource_data: Optional[OutlookReceiveMessage] = None)

Definition: SubscriptionPayloadEntity[OutlookReceiveMessage]

Attributes

sequence_number class-attribute instance-attribute
sequence_number: Optional[int] = field(default=None, metadata={'wire_name': 'SequenceNumber'})

Sequence number

change_type class-attribute instance-attribute
change_type: Optional[str] = field(default=None, metadata={'wire_name': 'ChangeType'})

Change type

client_state class-attribute instance-attribute
client_state: Optional[str] = field(default=None, metadata={'wire_name': 'ClientState'})

Client state

resource class-attribute instance-attribute
resource: Optional[str] = field(default=None, metadata={'wire_name': 'Resource'})

Resource

OutlookReceiveAttachment dataclass

OutlookReceiveAttachment(type_: Optional[str] = None, id: Optional[str] = None, name: Optional[str] = None, content_bytes: Optional[str] = None, content_type: Optional[str] = None, size: Optional[int] = None, permission: Optional[str] = None, provider_type: Optional[str] = None, source_url: Optional[str] = None, is_inline: Optional[bool] = None, last_modified_date_time: Optional[str] = None, content_id: Optional[str] = None)

Definition: OutlookReceiveAttachment

Attributes

type_ class-attribute instance-attribute
type_: Optional[str] = field(default=None, metadata={'wire_name': '@odata.type'})

OData type

id class-attribute instance-attribute
id: Optional[str] = field(default=None, metadata={'wire_name': 'Id'})

Attachment Id

name class-attribute instance-attribute
name: Optional[str] = field(default=None, metadata={'wire_name': 'Name'})

Attachment name

content_bytes class-attribute instance-attribute
content_bytes: Optional[str] = field(default=None, metadata={'wire_name': 'ContentBytes'})

Attachment content

content_type class-attribute instance-attribute
content_type: Optional[str] = field(default=None, metadata={'wire_name': 'ContentType'})

Attachment content type

size class-attribute instance-attribute
size: Optional[int] = field(default=None, metadata={'wire_name': 'Size'})

Attachment size in bytes

permission class-attribute instance-attribute
permission: Optional[str] = field(default=None, metadata={'wire_name': 'Permission'})

Permission associated with a reference attachment

provider_type class-attribute instance-attribute
provider_type: Optional[str] = field(default=None, metadata={'wire_name': 'ProviderType'})

Provider for the reference attachment

source_url class-attribute instance-attribute
source_url: Optional[str] = field(default=None, metadata={'wire_name': 'SourceUrl'})

Reference attachment source url

is_inline class-attribute instance-attribute
is_inline: Optional[bool] = field(default=None, metadata={'wire_name': 'IsInline'})

Set to true if this is an inline attachment

last_modified_date_time class-attribute instance-attribute
last_modified_date_time: Optional[str] = field(default=None, metadata={'wire_name': 'LastModifiedDateTime'})

The date and time when the attachment was last modified

content_id class-attribute instance-attribute
content_id: Optional[str] = field(default=None, metadata={'wire_name': 'ContentId'})

Content Id

InternetMessageHeader dataclass

InternetMessageHeader(name: Optional[str] = None, value: Optional[str] = None)

Definition: InternetMessageHeader

Attributes

name class-attribute instance-attribute
name: Optional[str] = field(default=None, metadata={'wire_name': 'Name'})

Header name

value class-attribute instance-attribute
value: Optional[str] = field(default=None, metadata={'wire_name': 'Value'})

Header value

SubscriptionPayloadSubscriptionEvent dataclass

SubscriptionPayloadSubscriptionEvent(value: Optional[List[SubscriptionPayloadEntitySubscriptionEvent]] = None)

Definition: SubscriptionPayload[SubscriptionEvent]

Attributes

value class-attribute instance-attribute
value: Optional[List[SubscriptionPayloadEntitySubscriptionEvent]] = None

List of values

SubscriptionPayloadEntitySubscriptionEvent dataclass

SubscriptionPayloadEntitySubscriptionEvent(sequence_number: Optional[int] = None, change_type: Optional[str] = None, client_state: Optional[str] = None, resource: Optional[str] = None, resource_data: Optional[SubscriptionEvent] = None)

Definition: SubscriptionPayloadEntity[SubscriptionEvent]

Attributes

sequence_number class-attribute instance-attribute
sequence_number: Optional[int] = field(default=None, metadata={'wire_name': 'SequenceNumber'})

Sequence number

change_type class-attribute instance-attribute
change_type: Optional[str] = field(default=None, metadata={'wire_name': 'ChangeType'})

Change type

client_state class-attribute instance-attribute
client_state: Optional[str] = field(default=None, metadata={'wire_name': 'ClientState'})

Client state

resource class-attribute instance-attribute
resource: Optional[str] = field(default=None, metadata={'wire_name': 'Resource'})

Resource

SubscriptionEvent dataclass

SubscriptionEvent(id: Optional[str] = None)

Definition: SubscriptionEvent

Attributes

id class-attribute instance-attribute
id: Optional[str] = field(default=None, metadata={'wire_name': 'Id'})

The Event's unique identifier

EntityListResponseTable dataclass

EntityListResponseTable(value: Optional[List[Table]] = None)

Definition: EntityListResponse[Table]

Attributes

value class-attribute instance-attribute
value: Optional[List[Table]] = None

List of values

Table dataclass

Table(name: Optional[str] = None, display_name: Optional[str] = None, dynamic_properties: Optional[Dict[str, Any]] = None)

Definition: Table

Attributes

name class-attribute instance-attribute
name: Optional[str] = field(default=None, metadata={'wire_name': 'Name'})

The name of the table. The name is used at runtime.

display_name class-attribute instance-attribute
display_name: Optional[str] = field(default=None, metadata={'wire_name': 'DisplayName'})

The display name of the table.

dynamic_properties class-attribute instance-attribute
dynamic_properties: Optional[Dict[str, Any]] = field(default=None, metadata={'wire_name': 'DynamicProperties'})

Additional table properties provided by the connector to the clients.

EntityListResponseCalendarEventBackend dataclass

EntityListResponseCalendarEventBackend(value: Optional[List[CalendarEventBackend]] = None)

Definition: EntityListResponse[CalendarEventBackend]

Attributes

value class-attribute instance-attribute
value: Optional[List[CalendarEventBackend]] = None

List of values

EntityListResponseCalendarEventClientReceiveStringEnums dataclass

EntityListResponseCalendarEventClientReceiveStringEnums(value: Optional[List[CalendarEventClientReceiveStringEnums]] = None)

Definition: EntityListResponse[CalendarEventClientReceiveStringEnums]

Attributes

value class-attribute instance-attribute
value: Optional[List[CalendarEventClientReceiveStringEnums]] = None

List of values

CalendarEventClient dataclass

CalendarEventClient(subject: Optional[str] = None, start: Optional[str] = None, end: Optional[str] = None, time_zone: Optional[str] = None, required_attendees: Optional[str] = None, optional_attendees: Optional[str] = None, resource_attendees: Optional[str] = None, body: Optional[str] = None, is_html: Optional[bool] = None, location: Optional[str] = None, importance: Optional[str] = None, is_all_day: Optional[bool] = None, recurrence: Optional[str] = None, recurrence_end: Optional[str] = None, number_of_occurrences: Optional[int] = None, reminder: Optional[int] = None, show_as: Optional[str] = None, response_requested: Optional[bool] = None)

Definition: CalendarEventClient

Attributes

subject class-attribute instance-attribute
subject: Optional[str] = field(default=None, metadata={'wire_name': 'Subject'})

Event subject

start class-attribute instance-attribute
start: Optional[str] = field(default=None, metadata={'wire_name': 'Start'})

Start time of the event (example: '2016-11-01T14:30:00Z')

end class-attribute instance-attribute
end: Optional[str] = field(default=None, metadata={'wire_name': 'End'})

End time of the event (example: '2016-11-01T15:30:00Z')

time_zone class-attribute instance-attribute
time_zone: Optional[str] = field(default=None, metadata={'wire_name': 'TimeZone'})

Time zone of the event

required_attendees class-attribute instance-attribute
required_attendees: Optional[str] = field(default=None, metadata={'wire_name': 'RequiredAttendees'})

Required attendees for the event separated by semicolons

optional_attendees class-attribute instance-attribute
optional_attendees: Optional[str] = field(default=None, metadata={'wire_name': 'OptionalAttendees'})

Optional attendees for the event separated by semicolons

resource_attendees class-attribute instance-attribute
resource_attendees: Optional[str] = field(default=None, metadata={'wire_name': 'ResourceAttendees'})

Resource attendees for the event separated by semicolons

body class-attribute instance-attribute
body: Optional[str] = field(default=None, metadata={'wire_name': 'Body'})

Body of the message associated with the event

is_html class-attribute instance-attribute
is_html: Optional[bool] = field(default=None, metadata={'wire_name': 'IsHtml'})

Set to true if the body is Html

location class-attribute instance-attribute
location: Optional[str] = field(default=None, metadata={'wire_name': 'Location'})

Location of the event

importance class-attribute instance-attribute
importance: Optional[str] = field(default=None, metadata={'wire_name': 'Importance'})

The importance of the event: Low, Normal, or High

is_all_day class-attribute instance-attribute
is_all_day: Optional[bool] = field(default=None, metadata={'wire_name': 'IsAllDay'})

Set to true if the event lasts all day

recurrence class-attribute instance-attribute
recurrence: Optional[str] = field(default=None, metadata={'wire_name': 'Recurrence'})

The recurrence pattern for the event

recurrence_end class-attribute instance-attribute
recurrence_end: Optional[str] = field(default=None, metadata={'wire_name': 'RecurrenceEnd'})

End time of the recurrence

number_of_occurrences class-attribute instance-attribute
number_of_occurrences: Optional[int] = field(default=None, metadata={'wire_name': 'NumberOfOccurrences'})

How many times to repeat the event

reminder class-attribute instance-attribute
reminder: Optional[int] = field(default=None, metadata={'wire_name': 'Reminder'})

Time in minutes before event start to remind

show_as class-attribute instance-attribute
show_as: Optional[str] = field(default=None, metadata={'wire_name': 'ShowAs'})

Status to show during the event

response_requested class-attribute instance-attribute
response_requested: Optional[bool] = field(default=None, metadata={'wire_name': 'ResponseRequested'})

Set to true if the sender would like a response when the event is accepted or declined

CalendarEventHtmlClient dataclass

CalendarEventHtmlClient(subject: Optional[str] = None, start: Optional[str] = None, end: Optional[str] = None, time_zone: Optional[str] = None, required_attendees: Optional[str] = None, optional_attendees: Optional[str] = None, resource_attendees: Optional[str] = None, body: Optional[str] = None, location: Optional[str] = None, importance: Optional[str] = None, is_all_day: Optional[bool] = None, recurrence: Optional[str] = None, recurrence_end: Optional[str] = None, number_of_occurrences: Optional[int] = None, reminder: Optional[int] = None, show_as: Optional[str] = None, response_requested: Optional[bool] = None)

Definition: CalendarEventHtmlClient

Attributes

subject class-attribute instance-attribute
subject: Optional[str] = field(default=None, metadata={'wire_name': 'Subject'})

Event subject

start class-attribute instance-attribute
start: Optional[str] = field(default=None, metadata={'wire_name': 'Start'})

Start time of the event (example: '2016-11-01T14:30:00Z')

end class-attribute instance-attribute
end: Optional[str] = field(default=None, metadata={'wire_name': 'End'})

End time of the event (example: '2016-11-01T15:30:00Z')

time_zone class-attribute instance-attribute
time_zone: Optional[str] = field(default=None, metadata={'wire_name': 'TimeZone'})

Time zone of the event

required_attendees class-attribute instance-attribute
required_attendees: Optional[str] = field(default=None, metadata={'wire_name': 'RequiredAttendees'})

Required attendees for the event separated by semicolons

optional_attendees class-attribute instance-attribute
optional_attendees: Optional[str] = field(default=None, metadata={'wire_name': 'OptionalAttendees'})

Optional attendees for the event separated by semicolons

resource_attendees class-attribute instance-attribute
resource_attendees: Optional[str] = field(default=None, metadata={'wire_name': 'ResourceAttendees'})

Resource attendees for the event separated by semicolons

body class-attribute instance-attribute
body: Optional[str] = field(default=None, metadata={'wire_name': 'Body'})

Body of the message associated with the event

location class-attribute instance-attribute
location: Optional[str] = field(default=None, metadata={'wire_name': 'Location'})

Location of the event

importance class-attribute instance-attribute
importance: Optional[str] = field(default=None, metadata={'wire_name': 'Importance'})

The importance of the event: Low, Normal, or High

is_all_day class-attribute instance-attribute
is_all_day: Optional[bool] = field(default=None, metadata={'wire_name': 'IsAllDay'})

Set to true if the event lasts all day

recurrence class-attribute instance-attribute
recurrence: Optional[str] = field(default=None, metadata={'wire_name': 'Recurrence'})

The recurrence pattern for the event

recurrence_end class-attribute instance-attribute
recurrence_end: Optional[str] = field(default=None, metadata={'wire_name': 'RecurrenceEnd'})

End time of the recurrence

number_of_occurrences class-attribute instance-attribute
number_of_occurrences: Optional[int] = field(default=None, metadata={'wire_name': 'NumberOfOccurrences'})

How many times to repeat the event

reminder class-attribute instance-attribute
reminder: Optional[int] = field(default=None, metadata={'wire_name': 'Reminder'})

Time in minutes before event start to remind

show_as class-attribute instance-attribute
show_as: Optional[str] = field(default=None, metadata={'wire_name': 'ShowAs'})

Status to show during the event

response_requested class-attribute instance-attribute
response_requested: Optional[bool] = field(default=None, metadata={'wire_name': 'ResponseRequested'})

Set to true if the sender would like a response when the event is accepted or declined

GraphCalendarEventClient dataclass

GraphCalendarEventClient(subject: Optional[str] = None, start: Optional[str] = None, end: Optional[str] = None, time_zone: Optional[str] = None, required_attendees: Optional[str] = None, optional_attendees: Optional[str] = None, resource_attendees: Optional[str] = None, body: Optional[str] = None, categories: Optional[List[str]] = None, location: Optional[str] = None, importance: Optional[str] = None, is_all_day: Optional[bool] = None, recurrence: Optional[str] = None, selected_days_of_week: Optional[List[str]] = None, recurrence_end: Optional[str] = None, number_of_occurences: Optional[int] = None, reminder_minutes_before_start: Optional[int] = None, is_reminder_on: Optional[bool] = None, show_as: Optional[str] = None, response_requested: Optional[bool] = None, sensitivity: Optional[str] = None)

Definition: GraphCalendarEventClient

Attributes

subject class-attribute instance-attribute
subject: Optional[str] = None

Event subject

start class-attribute instance-attribute
start: Optional[str] = None

Start time of the event (example: '2017-08-29T04:00:00')

end class-attribute instance-attribute
end: Optional[str] = None

End time of the event (example: '2017-08-29T05:00:00')

time_zone class-attribute instance-attribute
time_zone: Optional[str] = field(default=None, metadata={'wire_name': 'timeZone'})

Time zone of the event

required_attendees class-attribute instance-attribute
required_attendees: Optional[str] = field(default=None, metadata={'wire_name': 'requiredAttendees'})

Required attendees for the event separated by semicolons

optional_attendees class-attribute instance-attribute
optional_attendees: Optional[str] = field(default=None, metadata={'wire_name': 'optionalAttendees'})

Optional attendees for the event separated by semicolons

resource_attendees class-attribute instance-attribute
resource_attendees: Optional[str] = field(default=None, metadata={'wire_name': 'resourceAttendees'})

Resource attendees for the event separated by semicolons

body class-attribute instance-attribute
body: Optional[str] = None

Body of the message associated with the event

categories class-attribute instance-attribute
categories: Optional[List[str]] = None

The categories associated with the event

location class-attribute instance-attribute
location: Optional[str] = None

Location of the event

importance class-attribute instance-attribute
importance: Optional[str] = None

The importance of the event: low, normal, or high

is_all_day class-attribute instance-attribute
is_all_day: Optional[bool] = field(default=None, metadata={'wire_name': 'isAllDay'})

Set to true if the event lasts all day

recurrence class-attribute instance-attribute
recurrence: Optional[str] = None

The recurrence pattern for the event: none, daily, weekly, monthly or yearly

selected_days_of_week class-attribute instance-attribute
selected_days_of_week: Optional[List[str]] = field(default=None, metadata={'wire_name': 'selectedDaysOfWeek'})

Days of week for weekly recurrence

recurrence_end class-attribute instance-attribute
recurrence_end: Optional[str] = field(default=None, metadata={'wire_name': 'recurrenceEnd'})

End Date of the recurrence

number_of_occurences class-attribute instance-attribute
number_of_occurences: Optional[int] = field(default=None, metadata={'wire_name': 'numberOfOccurences'})

How many times to repeat the event

reminder_minutes_before_start class-attribute instance-attribute
reminder_minutes_before_start: Optional[int] = field(default=None, metadata={'wire_name': 'reminderMinutesBeforeStart'})

Time in minutes before event start to remind

is_reminder_on class-attribute instance-attribute
is_reminder_on: Optional[bool] = field(default=None, metadata={'wire_name': 'isReminderOn'})

Set to true if an alert is set to remind the user of the event.

show_as class-attribute instance-attribute
show_as: Optional[str] = field(default=None, metadata={'wire_name': 'showAs'})

Status to show during the event: free, tentative, busy, oof, workingElsewhere or unknown

response_requested class-attribute instance-attribute
response_requested: Optional[bool] = field(default=None, metadata={'wire_name': 'responseRequested'})

Set to true if the sender would like a response when the event is accepted or declined

sensitivity class-attribute instance-attribute
sensitivity: Optional[str] = None

The possible values are: normal, personal, private, confidential

CalendarEventListWithActionType dataclass

CalendarEventListWithActionType(value: Optional[List[CalendarEventClientWithActionType]] = None)

Definition: CalendarEventListWithActionType

Attributes

value class-attribute instance-attribute
value: Optional[List[CalendarEventClientWithActionType]] = None

List of calendar items

CalendarEventClientWithActionType dataclass

CalendarEventClientWithActionType(action_type: Optional[str] = None, is_added: Optional[bool] = None, is_updated: Optional[bool] = None, subject: Optional[str] = None, start: Optional[str] = None, end: Optional[str] = None, show_as: Optional[int] = None, recurrence: Optional[int] = None, response_type: Optional[int] = None, response_time: Optional[str] = None, i_cal_u_id: Optional[str] = None, importance: Optional[int] = None, id: Optional[str] = None, date_time_created: Optional[str] = None, date_time_last_modified: Optional[str] = None, organizer: Optional[str] = None, time_zone: Optional[str] = None, series_master_id: Optional[str] = None, categories: Optional[List[str]] = None, web_link: Optional[str] = None, required_attendees: Optional[str] = None, optional_attendees: Optional[str] = None, resource_attendees: Optional[str] = None, body: Optional[str] = None, is_html: Optional[bool] = None, location: Optional[str] = None, is_all_day: Optional[bool] = None, recurrence_end: Optional[str] = None, number_of_occurrences: Optional[int] = None, reminder: Optional[int] = None, response_requested: Optional[bool] = None)

Definition: CalendarEventClientWithActionType

Attributes

action_type class-attribute instance-attribute
action_type: Optional[str] = field(default=None, metadata={'wire_name': 'ActionType'})

Changed action type of the event - added, updated or deleted.

is_added class-attribute instance-attribute
is_added: Optional[bool] = field(default=None, metadata={'wire_name': 'IsAdded'})

Flag that indicates whether the event was added since the last poll of the trigger.

is_updated class-attribute instance-attribute
is_updated: Optional[bool] = field(default=None, metadata={'wire_name': 'IsUpdated'})

Flag that indicates whether the event was updated since the last poll of the trigger.

subject class-attribute instance-attribute
subject: Optional[str] = field(default=None, metadata={'wire_name': 'Subject'})

Event subject

start class-attribute instance-attribute
start: Optional[str] = field(default=None, metadata={'wire_name': 'Start'})

Start time of the event (example: '2016-11-01T14:30:00Z')

end class-attribute instance-attribute
end: Optional[str] = field(default=None, metadata={'wire_name': 'End'})

End time of the event (example: '2016-11-01T15:30:00Z')

show_as class-attribute instance-attribute
show_as: Optional[int] = field(default=None, metadata={'wire_name': 'ShowAs'})

Status to show during the event (Unknown - -1, Free - 0, Tentative - 1, Busy - 2, Oof - 3, WorkingElsewhere - 4)

recurrence class-attribute instance-attribute
recurrence: Optional[int] = field(default=None, metadata={'wire_name': 'Recurrence'})

The recurrence pattern for the event (None - 0, Daily - 1, Weekly - 2, Monthly - 3, Yearly - 4)

response_type class-attribute instance-attribute
response_type: Optional[int] = field(default=None, metadata={'wire_name': 'ResponseType'})

The response type of the event (None - 0, Organizer - 1, TentativelyAccepted - 2, Accepted - 3, Declined - 4, NotResponded - 5)

response_time class-attribute instance-attribute
response_time: Optional[str] = field(default=None, metadata={'wire_name': 'ResponseTime'})

The response time of the event

i_cal_u_id class-attribute instance-attribute
i_cal_u_id: Optional[str] = field(default=None, metadata={'wire_name': 'ICalUId'})

A unique identifier that is shared by all instances of an event across different calendars

importance class-attribute instance-attribute
importance: Optional[int] = field(default=None, metadata={'wire_name': 'Importance'})

The importance of the event (0 - Low, 1 - Normal, 2 - High)

id class-attribute instance-attribute
id: Optional[str] = field(default=None, metadata={'wire_name': 'Id'})

The event's unique identifier

date_time_created class-attribute instance-attribute
date_time_created: Optional[str] = field(default=None, metadata={'wire_name': 'DateTimeCreated'})

The date and time that the event was created

date_time_last_modified class-attribute instance-attribute
date_time_last_modified: Optional[str] = field(default=None, metadata={'wire_name': 'DateTimeLastModified'})

The date and time that the event was last modified

organizer class-attribute instance-attribute
organizer: Optional[str] = field(default=None, metadata={'wire_name': 'Organizer'})

The organizer of the event

time_zone class-attribute instance-attribute
time_zone: Optional[str] = field(default=None, metadata={'wire_name': 'TimeZone'})

Time zone of the event

series_master_id class-attribute instance-attribute
series_master_id: Optional[str] = field(default=None, metadata={'wire_name': 'SeriesMasterId'})

Unique identifier for Series Master event type

categories class-attribute instance-attribute
categories: Optional[List[str]] = field(default=None, metadata={'wire_name': 'Categories'})

The categories associated with the event

web_link: Optional[str] = field(default=None, metadata={'wire_name': 'WebLink'})

The URL to open the event in Outlook Web App

required_attendees class-attribute instance-attribute
required_attendees: Optional[str] = field(default=None, metadata={'wire_name': 'RequiredAttendees'})

Required attendees for the event separated by semicolons

optional_attendees class-attribute instance-attribute
optional_attendees: Optional[str] = field(default=None, metadata={'wire_name': 'OptionalAttendees'})

Optional attendees for the event separated by semicolons

resource_attendees class-attribute instance-attribute
resource_attendees: Optional[str] = field(default=None, metadata={'wire_name': 'ResourceAttendees'})

Resource attendees for the event separated by semicolons

body class-attribute instance-attribute
body: Optional[str] = field(default=None, metadata={'wire_name': 'Body'})

Body of the message associated with the event

is_html class-attribute instance-attribute
is_html: Optional[bool] = field(default=None, metadata={'wire_name': 'IsHtml'})

Set to true if the body is Html

location class-attribute instance-attribute
location: Optional[str] = field(default=None, metadata={'wire_name': 'Location'})

Location of the event

is_all_day class-attribute instance-attribute
is_all_day: Optional[bool] = field(default=None, metadata={'wire_name': 'IsAllDay'})

Set to true if the event lasts all day

recurrence_end class-attribute instance-attribute
recurrence_end: Optional[str] = field(default=None, metadata={'wire_name': 'RecurrenceEnd'})

End time of the recurrence

number_of_occurrences class-attribute instance-attribute
number_of_occurrences: Optional[int] = field(default=None, metadata={'wire_name': 'NumberOfOccurrences'})

How many times to repeat the event

reminder class-attribute instance-attribute
reminder: Optional[int] = field(default=None, metadata={'wire_name': 'Reminder'})

Time in minutes before event start to remind

response_requested class-attribute instance-attribute
response_requested: Optional[bool] = field(default=None, metadata={'wire_name': 'ResponseRequested'})

Set to true if the sender would like a response when the event is accepted or declined

GraphCalendarEventClientWithActionType dataclass

GraphCalendarEventClientWithActionType(action_type: Optional[str] = None, is_added: Optional[bool] = None, is_updated: Optional[bool] = None, subject: Optional[str] = None, start: Optional[str] = None, end: Optional[str] = None, start_with_time_zone: Optional[str] = None, end_with_time_zone: Optional[str] = None, body: Optional[str] = None, is_html: Optional[bool] = None, response_type: Optional[str] = None, response_time: Optional[str] = None, id: Optional[str] = None, created_date_time: Optional[str] = None, last_modified_date_time: Optional[str] = None, organizer: Optional[str] = None, time_zone: Optional[str] = None, series_master_id: Optional[str] = None, i_cal_u_id: Optional[str] = None, categories: Optional[List[str]] = None, web_link: Optional[str] = None, required_attendees: Optional[str] = None, optional_attendees: Optional[str] = None, resource_attendees: Optional[str] = None, location: Optional[str] = None, importance: Optional[str] = None, is_all_day: Optional[bool] = None, recurrence: Optional[str] = None, recurrence_end: Optional[str] = None, number_of_occurences: Optional[int] = None, reminder_minutes_before_start: Optional[int] = None, is_reminder_on: Optional[bool] = None, show_as: Optional[str] = None, response_requested: Optional[bool] = None, sensitivity: Optional[str] = None)

Definition: GraphCalendarEventClientWithActionType

Attributes

action_type class-attribute instance-attribute
action_type: Optional[str] = field(default=None, metadata={'wire_name': 'ActionType'})

Changed action type of the event - added, updated or deleted.

is_added class-attribute instance-attribute
is_added: Optional[bool] = field(default=None, metadata={'wire_name': 'IsAdded'})

Flag that indicates whether the event was added since the last poll of the trigger.

is_updated class-attribute instance-attribute
is_updated: Optional[bool] = field(default=None, metadata={'wire_name': 'IsUpdated'})

Flag that indicates whether the event was updated since the last poll of the trigger.

subject class-attribute instance-attribute
subject: Optional[str] = None

Event subject

start class-attribute instance-attribute
start: Optional[str] = None

Start time of the event (example: '2017-08-29T04:00:00.0000000')

end class-attribute instance-attribute
end: Optional[str] = None

End time of the event (example: '2017-08-29T05:00:00.0000000')

start_with_time_zone class-attribute instance-attribute
start_with_time_zone: Optional[str] = field(default=None, metadata={'wire_name': 'startWithTimeZone'})

Start time of the event with time zone (example: '2017-08-29T04:00:00.0000000+00:00')

end_with_time_zone class-attribute instance-attribute
end_with_time_zone: Optional[str] = field(default=None, metadata={'wire_name': 'endWithTimeZone'})

End time of the event with time zone (example: '2017-08-29T05:00:00.0000000+00:00')

body class-attribute instance-attribute
body: Optional[str] = None

Body of the message associated with the event

is_html class-attribute instance-attribute
is_html: Optional[bool] = field(default=None, metadata={'wire_name': 'isHtml'})

Set to true if the body is Html

response_type class-attribute instance-attribute
response_type: Optional[str] = field(default=None, metadata={'wire_name': 'responseType'})

The response type of the event (none, organizer, tentativelyAccepted, accepted, declined or notResponded)

response_time class-attribute instance-attribute
response_time: Optional[str] = field(default=None, metadata={'wire_name': 'responseTime'})

The response time of the event

id class-attribute instance-attribute
id: Optional[str] = None

The event's unique identifier

created_date_time class-attribute instance-attribute
created_date_time: Optional[str] = field(default=None, metadata={'wire_name': 'createdDateTime'})

The date and time that the event was created

last_modified_date_time class-attribute instance-attribute
last_modified_date_time: Optional[str] = field(default=None, metadata={'wire_name': 'lastModifiedDateTime'})

The date and time that the event was last modified

organizer class-attribute instance-attribute
organizer: Optional[str] = None

The organizer of the event

time_zone class-attribute instance-attribute
time_zone: Optional[str] = field(default=None, metadata={'wire_name': 'timeZone'})

Time zone of the event

series_master_id class-attribute instance-attribute
series_master_id: Optional[str] = field(default=None, metadata={'wire_name': 'seriesMasterId'})

Unique identifier for Series Master event type

i_cal_u_id class-attribute instance-attribute
i_cal_u_id: Optional[str] = field(default=None, metadata={'wire_name': 'iCalUId'})

A unique identifier for an event across calendars. This ID is different for each occurrence in a recurring series

categories class-attribute instance-attribute
categories: Optional[List[str]] = None

The categories associated with the event

web_link: Optional[str] = field(default=None, metadata={'wire_name': 'webLink'})

The URL to open the event in Outlook Web App

required_attendees class-attribute instance-attribute
required_attendees: Optional[str] = field(default=None, metadata={'wire_name': 'requiredAttendees'})

Required attendees for the event separated by semicolons

optional_attendees class-attribute instance-attribute
optional_attendees: Optional[str] = field(default=None, metadata={'wire_name': 'optionalAttendees'})

Optional attendees for the event separated by semicolons

resource_attendees class-attribute instance-attribute
resource_attendees: Optional[str] = field(default=None, metadata={'wire_name': 'resourceAttendees'})

Resource attendees for the event separated by semicolons

location class-attribute instance-attribute
location: Optional[str] = None

Location of the event

importance class-attribute instance-attribute
importance: Optional[str] = None

The importance of the event: low, normal, or high

is_all_day class-attribute instance-attribute
is_all_day: Optional[bool] = field(default=None, metadata={'wire_name': 'isAllDay'})

Set to true if the event lasts all day

recurrence class-attribute instance-attribute
recurrence: Optional[str] = None

The recurrence pattern for the event: none, daily, weekly, monthly or yearly

recurrence_end class-attribute instance-attribute
recurrence_end: Optional[str] = field(default=None, metadata={'wire_name': 'recurrenceEnd'})

End Date of the recurrence

number_of_occurences class-attribute instance-attribute
number_of_occurences: Optional[int] = field(default=None, metadata={'wire_name': 'numberOfOccurences'})

How many times to repeat the event

reminder_minutes_before_start class-attribute instance-attribute
reminder_minutes_before_start: Optional[int] = field(default=None, metadata={'wire_name': 'reminderMinutesBeforeStart'})

Time in minutes before event start to remind

is_reminder_on class-attribute instance-attribute
is_reminder_on: Optional[bool] = field(default=None, metadata={'wire_name': 'isReminderOn'})

Set to true if an alert is set to remind the user of the event.

show_as class-attribute instance-attribute
show_as: Optional[str] = field(default=None, metadata={'wire_name': 'showAs'})

Status to show during the event: free, tentative, busy, oof, workingElsewhere or unknown

response_requested class-attribute instance-attribute
response_requested: Optional[bool] = field(default=None, metadata={'wire_name': 'responseRequested'})

Set to true if the sender would like a response when the event is accepted or declined

sensitivity class-attribute instance-attribute
sensitivity: Optional[str] = None

The possible values are: normal, personal, private, confidential

GraphContactFolder dataclass

GraphContactFolder(id: Optional[str] = None, display_name: Optional[str] = None, parent_folder_id: Optional[str] = None)

Definition: GraphContactFolder

Attributes

id class-attribute instance-attribute
id: Optional[str] = None

The ID of the contacts folder

display_name class-attribute instance-attribute
display_name: Optional[str] = field(default=None, metadata={'wire_name': 'displayName'})

The name of the contacts folder

parent_folder_id class-attribute instance-attribute
parent_folder_id: Optional[str] = field(default=None, metadata={'wire_name': 'parentFolderId'})

The ID of the parent folder

DataSetsList dataclass

DataSetsList(value: Optional[List[DataSet]] = None)

Definition: DataSetsList

Attributes

value class-attribute instance-attribute
value: Optional[List[DataSet]] = None

List of datasets

DataSet dataclass

DataSet(name: Optional[str] = None, display_name: Optional[str] = None, query: Optional[List[PassThroughNativeQuery]] = None)

Definition: DataSet

Attributes

name class-attribute instance-attribute
name: Optional[str] = field(default=None, metadata={'wire_name': 'Name'})

Dataset name

display_name class-attribute instance-attribute
display_name: Optional[str] = field(default=None, metadata={'wire_name': 'DisplayName'})

Dataset display name

query class-attribute instance-attribute
query: Optional[List[PassThroughNativeQuery]] = None

Pass-through Native Queries

Procedure dataclass

Procedure(name: Optional[str] = None, display_name: Optional[str] = None)

Definition: Procedure

Attributes

name class-attribute instance-attribute
name: Optional[str] = field(default=None, metadata={'wire_name': 'Name'})

Procedure name

display_name class-attribute instance-attribute
display_name: Optional[str] = field(default=None, metadata={'wire_name': 'DisplayName'})

Procedure display name

PassThroughNativeQuery dataclass

PassThroughNativeQuery(language: Optional[str] = None)

Definition: PassThroughNativeQuery

Attributes

language class-attribute instance-attribute
language: Optional[str] = field(default=None, metadata={'wire_name': 'Language'})

Query language

AutomaticRepliesSettingClient dataclass

AutomaticRepliesSettingClient(status: Optional[str] = None, external_audience: Optional[str] = None, scheduled_start_date_time: Optional[Dict[str, Any]] = None, scheduled_end_date_time: Optional[Dict[str, Any]] = None, internal_reply_message: Optional[str] = None, external_reply_message: Optional[str] = None)

Definition: AutomaticRepliesSettingClient

Attributes

status class-attribute instance-attribute
status: Optional[str] = None

Automatic reply setting status

external_audience class-attribute instance-attribute
external_audience: Optional[str] = field(default=None, metadata={'wire_name': 'externalAudience'})

The audience that will see the external reply message

scheduled_start_date_time class-attribute instance-attribute
scheduled_start_date_time: Optional[Dict[str, Any]] = field(default=None, metadata={'wire_name': 'scheduledStartDateTime'})

Scheduled start time (example: '2017-08-29T04:00:00.0000000')

scheduled_end_date_time class-attribute instance-attribute
scheduled_end_date_time: Optional[Dict[str, Any]] = field(default=None, metadata={'wire_name': 'scheduledEndDateTime'})

Scheduled end time (example: '2017-08-29T05:00:00.0000000')

internal_reply_message class-attribute instance-attribute
internal_reply_message: Optional[str] = field(default=None, metadata={'wire_name': 'internalReplyMessage'})

Message for people within your organization

external_reply_message class-attribute instance-attribute
external_reply_message: Optional[str] = field(default=None, metadata={'wire_name': 'externalReplyMessage'})

Message for people outside your organization

MailTipsClientReceive dataclass

MailTipsClientReceive(automatic_replies: Optional[MailTipsAutomaticReplies] = None, delivery_restricted: Optional[bool] = None, external_member_count: Optional[int] = None, is_moderated: Optional[bool] = None, mailbox_full: Optional[bool] = None, max_message_size: Optional[int] = None, total_member_count: Optional[int] = None)

Definition: MailTipsClientReceive

Attributes

delivery_restricted class-attribute instance-attribute
delivery_restricted: Optional[bool] = field(default=None, metadata={'wire_name': 'deliveryRestricted'})

Is delivery restricted

external_member_count class-attribute instance-attribute
external_member_count: Optional[int] = field(default=None, metadata={'wire_name': 'externalMemberCount'})

Number of external members

is_moderated class-attribute instance-attribute
is_moderated: Optional[bool] = field(default=None, metadata={'wire_name': 'isModerated'})

Is moderated

mailbox_full class-attribute instance-attribute
mailbox_full: Optional[bool] = field(default=None, metadata={'wire_name': 'mailboxFull'})

Is mailbox full

max_message_size class-attribute instance-attribute
max_message_size: Optional[int] = field(default=None, metadata={'wire_name': 'maxMessageSize'})

Maximum message size

total_member_count class-attribute instance-attribute
total_member_count: Optional[int] = field(default=None, metadata={'wire_name': 'totalMemberCount'})

Total member count

MailTipsAutomaticReplies dataclass

MailTipsAutomaticReplies(message: Optional[str] = None)

Definition: MailTipsAutomaticReplies

Attributes

message class-attribute instance-attribute
message: Optional[str] = None

Automatic replies message

UpdateEmailFlag dataclass

UpdateEmailFlag(flag: Optional[Dict[str, Any]] = None)

Definition: UpdateEmailFlag

Attributes

flag class-attribute instance-attribute
flag: Optional[Dict[str, Any]] = None

Flag status

ResponseToEventInvite dataclass

ResponseToEventInvite(comment: Optional[str] = None, send_response: Optional[bool] = None)

Definition: ResponseToEventInvite

Attributes

comment class-attribute instance-attribute
comment: Optional[str] = field(default=None, metadata={'wire_name': 'Comment'})

Comment

send_response class-attribute instance-attribute
send_response: Optional[bool] = field(default=None, metadata={'wire_name': 'SendResponse'})

Send response to organizer?

DirectForwardMessage dataclass

DirectForwardMessage(comment: Optional[str] = None, to_recipients: Optional[str] = None)

Definition: DirectForwardMessage

Attributes

comment class-attribute instance-attribute
comment: Optional[str] = field(default=None, metadata={'wire_name': 'Comment'})

Comment

to_recipients class-attribute instance-attribute
to_recipients: Optional[str] = field(default=None, metadata={'wire_name': 'ToRecipients'})

Semicolon separated list of recipients to forward the message to

LocationConstraint dataclass

LocationConstraint(is_required: Optional[bool] = None, suggest_location: Optional[bool] = None, locations: Optional[List[Dict[str, Any]]] = None)

Definition: LocationConstraint

Attributes

is_required class-attribute instance-attribute
is_required: Optional[bool] = field(default=None, metadata={'wire_name': 'IsRequired'})

Should a meeting location be returned for the meeting?

suggest_location class-attribute instance-attribute
suggest_location: Optional[bool] = field(default=None, metadata={'wire_name': 'SuggestLocation'})

Should the response provide one or more meeting location suggestions?

locations class-attribute instance-attribute
locations: Optional[List[Dict[str, Any]]] = field(default=None, metadata={'wire_name': 'Locations'})

Locations

DateTimeTimeZone dataclass

DateTimeTimeZone(date_time: Optional[str] = None, time_zone: Optional[str] = None)

Definition: DateTimeTimeZone

Attributes

date_time class-attribute instance-attribute
date_time: Optional[str] = field(default=None, metadata={'wire_name': 'dateTime'})

DateTime (example: '2017-08-29T04:00:00.0000000')

time_zone class-attribute instance-attribute
time_zone: Optional[str] = field(default=None, metadata={'wire_name': 'timeZone'})

TimeZone (example: 'Pacific Standard Time')

EmailAddressV2 dataclass

EmailAddressV2(name: Optional[str] = None, address: Optional[str] = None)

Definition: EmailAddress_V2

PhysicalAddress dataclass

PhysicalAddress(street: Optional[str] = None, city: Optional[str] = None, state: Optional[str] = None, country_or_region: Optional[str] = None, postal_code: Optional[str] = None)

Definition: PhysicalAddress

Attributes

street class-attribute instance-attribute
street: Optional[str] = None

The contact's street address.

city class-attribute instance-attribute
city: Optional[str] = None

The contact's city.

state class-attribute instance-attribute
state: Optional[str] = None

The contact's state.

country_or_region class-attribute instance-attribute
country_or_region: Optional[str] = field(default=None, metadata={'wire_name': 'countryOrRegion'})

The contact's country of region.

postal_code class-attribute instance-attribute
postal_code: Optional[str] = field(default=None, metadata={'wire_name': 'postalCode'})

The contact's postal code.

Contact dataclass

Contact(id: Optional[str] = None, parent_folder_id: Optional[str] = None, birthday: Optional[str] = None, file_as: Optional[str] = None, display_name: Optional[str] = None, given_name: Optional[str] = None, initials: Optional[str] = None, middle_name: Optional[str] = None, nick_name: Optional[str] = None, surname: Optional[str] = None, title: Optional[str] = None, generation: Optional[str] = None, email_addresses: Optional[List[EmailAddressV2]] = None, im_addresses: Optional[List[str]] = None, job_title: Optional[str] = None, company_name: Optional[str] = None, department: Optional[str] = None, office_location: Optional[str] = None, profession: Optional[str] = None, business_home_page: Optional[str] = None, assistant_name: Optional[str] = None, manager: Optional[str] = None, home_phones: Optional[List[str]] = None, business_phones: Optional[List[str]] = None, mobile_phone: Optional[str] = None, home_address: Optional[PhysicalAddress] = None, business_address: Optional[PhysicalAddress] = None, other_address: Optional[PhysicalAddress] = None, yomi_company_name: Optional[str] = None, yomi_given_name: Optional[str] = None, yomi_surname: Optional[str] = None, categories: Optional[List[str]] = None, change_key: Optional[str] = None, created_date_time: Optional[str] = None, last_modified_date_time: Optional[str] = None)

Definition: Contact

Attributes

id class-attribute instance-attribute
id: Optional[str] = None

The contact's unique identifier.

parent_folder_id class-attribute instance-attribute
parent_folder_id: Optional[str] = field(default=None, metadata={'wire_name': 'parentFolderId'})

The ID of the contact's parent folder

birthday class-attribute instance-attribute
birthday: Optional[str] = None

The contact's birthday

file_as class-attribute instance-attribute
file_as: Optional[str] = field(default=None, metadata={'wire_name': 'fileAs'})

The name the contact is filed under

display_name class-attribute instance-attribute
display_name: Optional[str] = field(default=None, metadata={'wire_name': 'displayName'})

The contact's display name

given_name class-attribute instance-attribute
given_name: Optional[str] = field(default=None, metadata={'wire_name': 'givenName'})

The contact's given name

initials class-attribute instance-attribute
initials: Optional[str] = None

The contact's initials

middle_name class-attribute instance-attribute
middle_name: Optional[str] = field(default=None, metadata={'wire_name': 'middleName'})

The contact's middle name

nick_name class-attribute instance-attribute
nick_name: Optional[str] = field(default=None, metadata={'wire_name': 'nickName'})

The contact's nickname

surname class-attribute instance-attribute
surname: Optional[str] = None

The contact's surname

title class-attribute instance-attribute
title: Optional[str] = None

The contact's title

generation class-attribute instance-attribute
generation: Optional[str] = None

The contact's generation

email_addresses class-attribute instance-attribute
email_addresses: Optional[List[EmailAddressV2]] = field(default=None, metadata={'wire_name': 'emailAddresses'})

The contact's email addresses

im_addresses class-attribute instance-attribute
im_addresses: Optional[List[str]] = field(default=None, metadata={'wire_name': 'imAddresses'})

The contact's instant messaging (IM) addresses

job_title class-attribute instance-attribute
job_title: Optional[str] = field(default=None, metadata={'wire_name': 'jobTitle'})

The contact's job title

company_name class-attribute instance-attribute
company_name: Optional[str] = field(default=None, metadata={'wire_name': 'companyName'})

The name of the contact's company

department class-attribute instance-attribute
department: Optional[str] = None

The contact's department

office_location class-attribute instance-attribute
office_location: Optional[str] = field(default=None, metadata={'wire_name': 'officeLocation'})

The location of the contact's office

profession class-attribute instance-attribute
profession: Optional[str] = None

The contact's profession

business_home_page class-attribute instance-attribute
business_home_page: Optional[str] = field(default=None, metadata={'wire_name': 'businessHomePage'})

The business home page of the contact

assistant_name class-attribute instance-attribute
assistant_name: Optional[str] = field(default=None, metadata={'wire_name': 'assistantName'})

The name of the contact's assistant

manager class-attribute instance-attribute
manager: Optional[str] = None

The name of the contact's manager

home_phones class-attribute instance-attribute
home_phones: Optional[List[str]] = field(default=None, metadata={'wire_name': 'homePhones'})

The contact's home phone numbers

business_phones class-attribute instance-attribute
business_phones: Optional[List[str]] = field(default=None, metadata={'wire_name': 'businessPhones'})

The contact's business phone numbers

mobile_phone class-attribute instance-attribute
mobile_phone: Optional[str] = field(default=None, metadata={'wire_name': 'mobilePhone'})

The contact's mobile phone number

yomi_company_name class-attribute instance-attribute
yomi_company_name: Optional[str] = field(default=None, metadata={'wire_name': 'yomiCompanyName'})

The phonetic Japanese company name of the contact

yomi_given_name class-attribute instance-attribute
yomi_given_name: Optional[str] = field(default=None, metadata={'wire_name': 'yomiGivenName'})

The phonetic Japanese given name (first name) of the contact

yomi_surname class-attribute instance-attribute
yomi_surname: Optional[str] = field(default=None, metadata={'wire_name': 'yomiSurname'})

The phonetic Japanese surname (last name) of the contact

categories class-attribute instance-attribute
categories: Optional[List[str]] = None

The categories associated with the contact

change_key class-attribute instance-attribute
change_key: Optional[str] = field(default=None, metadata={'wire_name': 'changeKey'})

Identifies the version of the event object

created_date_time class-attribute instance-attribute
created_date_time: Optional[str] = field(default=None, metadata={'wire_name': 'createdDateTime'})

The time the contact was created

last_modified_date_time class-attribute instance-attribute
last_modified_date_time: Optional[str] = field(default=None, metadata={'wire_name': 'lastModifiedDateTime'})

The time the contact was modified

SensitivityLabelMetadata dataclass

SensitivityLabelMetadata(sensitivity_label_id: Optional[str] = None, name: Optional[str] = None, display_name: Optional[str] = None, tooltip: Optional[str] = None, priority: Optional[int] = None, color: Optional[str] = None, is_encrypted: Optional[bool] = None, is_enabled: Optional[bool] = None, is_parent: Optional[bool] = None, parent_sensitivity_label_id: Optional[str] = None)

Definition: sensitivityLabelMetadata

Attributes

sensitivity_label_id class-attribute instance-attribute
sensitivity_label_id: Optional[str] = field(default=None, metadata={'wire_name': 'sensitivityLabelId'})

SensitivityLabel Id.

name class-attribute instance-attribute
name: Optional[str] = None

SensitivityLabel name.

display_name class-attribute instance-attribute
display_name: Optional[str] = field(default=None, metadata={'wire_name': 'displayName'})

SensitivityLabel displayName info

tooltip class-attribute instance-attribute
tooltip: Optional[str] = None

SensitivityLabel details on tooltip.

priority class-attribute instance-attribute
priority: Optional[int] = None

SensitivityLabel priority.

color class-attribute instance-attribute
color: Optional[str] = None

SensitivityLabel color.

is_encrypted class-attribute instance-attribute
is_encrypted: Optional[bool] = field(default=None, metadata={'wire_name': 'isEncrypted'})

is SensitivityLabel Encrypted.

is_enabled class-attribute instance-attribute
is_enabled: Optional[bool] = field(default=None, metadata={'wire_name': 'isEnabled'})

Whether SensitivityLabel is Enabled.

is_parent class-attribute instance-attribute
is_parent: Optional[bool] = field(default=None, metadata={'wire_name': 'isParent'})

Whether SensitivityLabel is Parent.

parent_sensitivity_label_id class-attribute instance-attribute
parent_sensitivity_label_id: Optional[str] = field(default=None, metadata={'wire_name': 'parentSensitivityLabelId'})

Parent SensitivityLabel Id.

MCPQueryRequest dataclass

MCPQueryRequest(jsonrpc: Optional[str] = None, id: Optional[str] = None, method: Optional[str] = None, params: Optional[Dict[str, Any]] = None, result: Optional[Dict[str, Any]] = None, error: Optional[Dict[str, Any]] = None, callback_endpoint: Optional[str] = None)

Definition: MCPQueryRequest

Office365Client

Office365Client(connection_runtime_url: str, token_provider: Optional[TokenProvider] = None, options: Optional[ConnectorClientOptions] = None)

Bases: ConnectorClientBase

Typed client for office365 connector.

Initialize a Office365Client.

Parameters:

Name Type Description Default
connection_runtime_url str

The connection runtime URL from Azure Portal.

required
token_provider Optional[TokenProvider]

Optional token provider. Defaults to ManagedIdentityTokenProvider.

None
options Optional[ConnectorClientOptions]

Optional connector client options.

None

Methods:

get_outlook_category_names_async async
get_outlook_category_names_async() -> dict[str, Any] | None

Get Outlook category names

This operation gets Outlook category display names.

draft_email_async async
draft_email_async(input: DraftEmailInput, message_id: Optional[str] = None, draft_type: Optional[str] = None, comment: Optional[str] = None) -> dict[str, Any] | None

Draft an email message

This operation drafts an email message.

update_draft_email_async async
update_draft_email_async(input: DraftEmailInput, message_id: str) -> None

Updates an email Draft message

This operation updates an an email Draft message.

send_draft_email_async async
send_draft_email_async(message_id: str) -> None

Send a Draft message

This operation sends a Draft message.

assign_category_async async
assign_category_async(message_id: str, category: str) -> None

Assigns an Outlook category

This operation assigns an Outlook category to an email.

assign_category_bulk_async async
assign_category_bulk_async(input: AssignCategoryBulkInput, category_name: str) -> dict[str, Any] | None

Assign a category to multiple emails

This operation assigns an Outlook category to multiple emails.

send_mail_with_options_async async
send_mail_with_options_async(input: OptionsEmailSubscription) -> dict[str, Any] | None

Send email with options

This operation sends an email with multiple options and waits for the recipient to respond back with one of the options. Please refer to the following link regarding the support of actionable messages in different mail clients: https://docs.microsoft.com/outlook/actionable-messages/#outlook-version-requirements-for-actionable-messages.

send_approval_mail_async async
send_approval_mail_async(input: ApprovalEmailSubscription) -> dict[str, Any] | None

Send approval email

This operation sends an approval email and waits for a response from the recipient. Please refer to the following link regarding the support of actionable messages in different mail clients: https://docs.microsoft.com/outlook/actionable-messages/#outlook-version-requirements-for-actionable-messages.

update_my_contact_photo_async async
update_my_contact_photo_async(input: bytes, folder: str, id: str) -> None

Update my contact's photo

Updates the photo of the specified contact of the current user. The size of the photo must be less than 4 MB.

http_request_async async
http_request_async(input: bytes) -> dict[str, Any] | None

Send an HTTP request

Construct a Microsoft Graph REST API request to invoke. These segments are supported: 1st segement: /me, /users/ 2nd segment: messages, mailFolders, events, calendar, calendars, outlook, inferenceClassification. Learn more: https://docs.microsoft.com/en-us/graph/use-the-api.

mcp_emails_management_async async
mcp_emails_management_async(input: MCPQueryRequest, session_id: Optional[str] = None) -> dict[str, Any] | None

Email Management MCP Server (deprecated)

This MCP server manages email messages from your Office 365 account

mcp_meeting_management_async async
mcp_meeting_management_async(input: MCPQueryRequest, session_id: Optional[str] = None) -> dict[str, Any] | None

Meeting Management MCP Server (deprecated)

This MCP server manages events, calendars and meetings

mcp_contacts_management_async async
mcp_contacts_management_async(input: MCPQueryRequest, session_id: Optional[str] = None) -> dict[str, Any] | None

Contact Management MCP Server

This MCP server manages contacts

calendar_delete_item_async async
calendar_delete_item_async(calendar: str, event: str) -> None

Delete event

This operation deletes an event in a calendar.

calendar_get_item_async async
calendar_get_item_async(table: str, id: str) -> dict[str, Any] | None

Get event

This operation gets a specific event from a calendar using Graph API.

calendar_get_items_async async
calendar_get_items_async(table: str, filter: Optional[str] = None, orderby: Optional[str] = None, top: Optional[int] = None, skip: Optional[int] = None) -> dict[str, Any] | None

Get events

This operation gets events from a calendar using Graph API.

calendar_get_tables_async async
calendar_get_tables_async() -> dict[str, Any] | None

Get calendars

This operation lists available calendars.

calendar_patch_item_async async
calendar_patch_item_async(input: GraphCalendarEventClient, table: str, id: str) -> dict[str, Any] | None

Update event

This operation updates an event in a calendar using Graph API.

calendar_post_item_async async
calendar_post_item_async(input: GraphCalendarEventClient, table: str) -> dict[str, Any] | None

Create event

This operation creates a new event in a calendar.

contact_delete_item_async async
contact_delete_item_async(folder: str, id: str) -> None

Delete contact

This operation deletes a contact from a contacts folder.

contact_get_item_async async
contact_get_item_async(folder: str, id: str) -> dict[str, Any] | None

Get contact

This operation gets a specific contact from a contacts folder.

contact_get_items_async async
contact_get_items_async(folder: str, filter: Optional[str] = None, orderby: Optional[str] = None, top: Optional[int] = None, skip: Optional[int] = None) -> dict[str, Any] | None

Get contacts

This operation gets contacts from a contacts folder.

contact_get_tables_async async
contact_get_tables_async() -> dict[str, Any] | None

Get contact folders

This operation lists available contacts folders using Graph API

contact_patch_item_async async
contact_patch_item_async(input: Contact, folder: str, id: str) -> dict[str, Any] | None

Update contact

This operation updates a contact in a contacts folder.

contact_post_item_async async
contact_post_item_async(input: Contact, folder: str) -> dict[str, Any] | None

Create contact

This operation creates a new contact in a contacts folder.

delete_email_async async
delete_email_async(message_id: str, mailbox_address: Optional[str] = None) -> None

Delete email

This operation deletes an email by id.

export_email_async async
export_email_async(message_id: str, mailbox_address: Optional[str] = None) -> bytes

Export email

Export the content of the email in the EML file format.

find_meeting_times_async async
find_meeting_times_async(input: FindMeetingTimesInput) -> dict[str, Any] | None

Find meeting times

Find meeting time suggestions based on organizer, attendee availability, and time or location constraints

flag_async async
flag_async(input: UpdateEmailFlag, message_id: str, mailbox_address: Optional[str] = None) -> None

Flag email

This operation updates an email flag.

forward_email_async async
forward_email_async(input: DirectForwardMessage, message_id: str, mailbox_address: Optional[str] = None, extract_sensitivity_label: Optional[bool] = None, fetch_sensitivity_label_metadata: Optional[bool] = None) -> None

Forward an email

Forward an email.

get_attachment_async async
get_attachment_async(message_id: str, attachment_id: str, mailbox_address: Optional[str] = None, extract_sensitivity_label: Optional[bool] = None, fetch_sensitivity_label_metadata: Optional[bool] = None) -> dict[str, Any] | None

Get Attachment

This operation gets an email attachment by id.

get_email_async async
get_email_async(message_id: str, mailbox_address: Optional[str] = None, include_attachments: Optional[bool] = None, internet_message_id: Optional[str] = None, extract_sensitivity_label: Optional[bool] = None, fetch_sensitivity_label_metadata: Optional[bool] = None) -> dict[str, Any] | None

Get email

This operation gets an email by id.

get_emails_async async
get_emails_async(folder_path: Optional[str] = None, to: Optional[str] = None, cc: Optional[str] = None, to_or_cc: Optional[str] = None, from_: Optional[str] = None, importance: Optional[str] = None, fetch_only_with_attachment: Optional[bool] = None, subject_filter: Optional[str] = None, fetch_only_unread: Optional[bool] = None, mailbox_address: Optional[str] = None, include_attachments: Optional[bool] = None, search_query: Optional[str] = None, top: Optional[int] = None) -> dict[str, Any] | None

Get emails

This operation gets emails from a folder via graph apis. Please note that filtering related to these fields: To, Cc, To Or Cc, From, Importance, Fetch Only With Attachments, Subject Filter, is performed using first 250 items in a given mail folder. To avoid that limitation you can use 'Search Query' field.

get_events_calendar_view_async async
get_events_calendar_view_async(calendar_id: str, start_date_time_utc: str, end_date_time_utc: str, filter: Optional[str] = None, orderby: Optional[str] = None, top: Optional[int] = None, skip: Optional[int] = None, search: Optional[str] = None) -> dict[str, Any] | None

Get calendar view of events

This operation gets all events (including instances of recurrences) in a calendar using Graph API. Recurrence property is null in this case.

get_mail_tips_async async
get_mail_tips_async(input: GetMailTipsInput) -> dict[str, Any] | None

Get mail tips for a mailbox

Get mail tips for a mailbox such as automatic replies / OOF message or if the mailbox is full. This is not available in GccHigh and Mooncake.

get_room_lists_async async
get_room_lists_async() -> dict[str, Any] | None

Get room lists

Get all the room lists defined in the user's tenant

get_rooms_async async
get_rooms_async() -> dict[str, Any] | None

Get rooms

Get all the meeting rooms defined in the user's tenant

get_rooms_in_room_list_async async
get_rooms_in_room_list_async(room_list: str) -> dict[str, Any] | None

Get rooms in room list

Get the meeting rooms in a specific room list

mark_as_read_async async
mark_as_read_async(input: MarkAsReadInput, message_id: str, mailbox_address: Optional[str] = None) -> None

Mark as read or unread

This operation marks an email as read/unread.

move_async async
move_async(message_id: str, folder_path: str, mailbox_address: Optional[str] = None) -> dict[str, Any] | None

Move email

This operation moves an email to the specified folder within the same mailbox.

reply_to_async async
reply_to_async(input: ReplyEmailInput, message_id: str, mailbox_address: Optional[str] = None) -> None

Reply to email

This operation replies to an email.

respond_to_event_async async
respond_to_event_async(input: ResponseToEventInvite, event_id: str, response: str) -> None

Respond to an event invite

Respond to an event invite.

send_email_async async
send_email_async(input: SendEmailInput) -> None

Send an email

This operation sends an email message.

set_automatic_replies_setting_async async
set_automatic_replies_setting_async(input: SetAutomaticRepliesSettingInput) -> dict[str, Any] | None

Set up automatic replies

Set the automatic replies setting for your mailbox.

shared_mailbox_send_email_async async
shared_mailbox_send_email_async(input: SharedMailboxSendEmailInput) -> None

Send an email from a shared mailbox

This operation sends an email from a shared mailbox. Your account should have permission to access the mailbox for this operation to succeed.