Office365
Attributes
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
Response for Get Outlook category names
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
id
class-attribute
instance-attribute
Id
conversation_id
class-attribute
instance-attribute
Conversation Id
has_attachments
class-attribute
instance-attribute
Has attachments
is_read
class-attribute
instance-attribute
Is read
created_date_time
class-attribute
instance-attribute
Created date and time
received_date_time
class-attribute
instance-attribute
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
The email addresses to use when replying
subject
class-attribute
instance-attribute
Subject
importance
class-attribute
instance-attribute
Importance
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
The count of messages processed successfully.
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
resource
class-attribute
instance-attribute
Resource of the subscription request
notification_type
class-attribute
instance-attribute
Notification Type
ObjectWithoutType
dataclass
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
start
class-attribute
instance-attribute
Start time of the event (example: '2017-08-29T04:00:00.0000000')
end
class-attribute
instance-attribute
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 time of the event with time zone (example: '2017-08-29T05:00:00.0000000+00:00')
body
class-attribute
instance-attribute
Body of the message associated with the event
is_html
class-attribute
instance-attribute
Set to true if the body is Html
response_type
class-attribute
instance-attribute
The response type of the event (none, organizer, tentativelyAccepted, accepted, declined or notResponded)
response_time
class-attribute
instance-attribute
The response time of the event
created_date_time
class-attribute
instance-attribute
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
The organizer of the event
time_zone
class-attribute
instance-attribute
Time zone of the event
series_master_id
class-attribute
instance-attribute
Unique identifier for Series Master event type
i_cal_u_id
class-attribute
instance-attribute
A unique identifier for an event across calendars. This ID is different for each occurrence in a recurring series
categories
class-attribute
instance-attribute
The categories associated with the event
web_link
class-attribute
instance-attribute
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
importance
class-attribute
instance-attribute
The importance of the event: low, normal, or high
is_all_day
class-attribute
instance-attribute
Set to true if the event lasts all day
recurrence
class-attribute
instance-attribute
The recurrence pattern for the event: none, daily, weekly, monthly or yearly
recurrence_end
class-attribute
instance-attribute
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
Set to true if an alert is set to remind the user of the event.
show_as
class-attribute
instance-attribute
Status to show during the event: free, tentative, busy, oof, workingElsewhere or unknown
GraphCalendarEventListClientReceive
dataclass
GraphCalendarEventListWithActionType
dataclass
CalendarGetTablesResponse
dataclass
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
parent_folder_id
class-attribute
instance-attribute
The ID of the contact's parent folder
file_as
class-attribute
instance-attribute
The name the contact is filed under
display_name
class-attribute
instance-attribute
The contact's display name
given_name
class-attribute
instance-attribute
The contact's given name
middle_name
class-attribute
instance-attribute
The contact's middle name
nick_name
class-attribute
instance-attribute
The contact's nickname
generation
class-attribute
instance-attribute
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
The contact's instant messaging (IM) addresses
job_title
class-attribute
instance-attribute
The contact's job title
company_name
class-attribute
instance-attribute
The name of the contact's company
department
class-attribute
instance-attribute
The contact's department
office_location
class-attribute
instance-attribute
The location of the contact's office
profession
class-attribute
instance-attribute
The contact's profession
business_home_page
class-attribute
instance-attribute
The business home page of the contact
assistant_name
class-attribute
instance-attribute
The name of the contact's assistant
manager
class-attribute
instance-attribute
The name of the contact's manager
home_phones
class-attribute
instance-attribute
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
The contact's mobile phone number
yomi_company_name
class-attribute
instance-attribute
The phonetic Japanese company name of the contact
yomi_given_name
class-attribute
instance-attribute
The phonetic Japanese given name (first name) of the contact
yomi_surname
class-attribute
instance-attribute
The phonetic Japanese surname (last name) of the contact
categories
class-attribute
instance-attribute
The categories associated with the contact
change_key
class-attribute
instance-attribute
Identifies the version of the event object
created_date_time
class-attribute
instance-attribute
The time the contact was created
EntityListResponseContactResponse
dataclass
EntityListResponseGraphContactFolder
dataclass
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
Duration of the meeting in minutes
start
class-attribute
instance-attribute
Start time for meeting time suggestions
end
class-attribute
instance-attribute
End time for meeting time suggestions
max_candidates
class-attribute
instance-attribute
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
FindMeetingTimesResponse
dataclass
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
content_type
class-attribute
instance-attribute
Content type of attachment.
content_bytes
class-attribute
instance-attribute
Content of attachment.
is_inline
class-attribute
instance-attribute
Set to true if this is an inline attachment.
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
The mailbox owner and sender of the message
to_recipients
class-attribute
instance-attribute
The recipients for the message
cc_recipients
class-attribute
instance-attribute
The Cc recipients for the message
bcc_recipients
class-attribute
instance-attribute
The Bcc recipients for the message
reply_to
class-attribute
instance-attribute
The email addresses to use when replying
importance
class-attribute
instance-attribute
The importance of the message (low, normal, high)
body_preview
class-attribute
instance-attribute
The preview of the message
has_attachments
class-attribute
instance-attribute
Indicates whether the message has attachments
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
The Id of the conversation the email belongs to
received_date_time
class-attribute
instance-attribute
The date and time the message was received
is_read
class-attribute
instance-attribute
Indicates whether the message has been read
attachments
class-attribute
instance-attribute
The file attachments for the message
BatchResponseGraphClientReceiveMessage
dataclass
EntityListResponseGraphCalendarEventClientReceive
dataclass
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
Flags that represents the mailtips.
GetMailTipsResponse
dataclass
Response for Get mail tips for a mailbox
GetRoomListsResponse
dataclass
GetRoomsResponse
dataclass
GetRoomsInRoomListResponse
dataclass
MarkAsReadInput
dataclass
TriggerBatchResponseGraphClientReceiveMessage
dataclass
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
x_ms_permission
class-attribute
instance-attribute
Table permission
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
ObjectEntity
dataclass
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
Indicates whether this table has sortable columns
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
Indicates whether this table has filterable columns
TableSelectRestrictionsMetadata
dataclass
CalendarEventList
dataclass
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
The Event's unique identifier
attendees
class-attribute
instance-attribute
List of attendees for the event
body_preview
class-attribute
instance-attribute
The preview of the message associated with the event
categories
class-attribute
instance-attribute
The categories associated with the event
change_key
class-attribute
instance-attribute
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
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
The end time of the event
end_time_zone
class-attribute
instance-attribute
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
Set to true if the event has attachments
i_cal_u_id
class-attribute
instance-attribute
A unique identifier that is shared by all instances of an event across different calendars
importance
class-attribute
instance-attribute
The importance of the event: Low, Normal, or High
is_all_day
class-attribute
instance-attribute
Set to true if the event lasts all day
is_cancelled
class-attribute
instance-attribute
Set to true if the event has been canceled
is_organizer
class-attribute
instance-attribute
Set to true if the message sender is also the organizer
reminder
class-attribute
instance-attribute
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
Unique identifier for Series Master event type
show_as
class-attribute
instance-attribute
Shows as free or busy
start
class-attribute
instance-attribute
The start time of the event
start_time_zone
class-attribute
instance-attribute
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
Event subject
type_
class-attribute
instance-attribute
The event type: Single Instance, Occurrence, Exception, or Series Master
web_link
class-attribute
instance-attribute
The preview of the message associated with the event
Attendee
dataclass
Attendee(status: Optional[ResponseStatus] = None, type_: Optional[str] = None, email_address: Optional[EmailAddress] = None)
Definition: Attendee
ItemBody
dataclass
Definition: ItemBody
Location
dataclass
Location(display_name: Optional[str] = None, address: Optional[PhysicalAddress] = None, coordinates: Optional[GeoCoordinates] = None)
Definition: Location
PatternedRecurrence
dataclass
PatternedRecurrence(pattern: Optional[RecurrencePattern] = None, range: Optional[RecurrenceRange] = None)
Definition: PatternedRecurrence
ResponseStatus
dataclass
Definition: ResponseStatus
EmailAddress
dataclass
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
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
Event subject
start
class-attribute
instance-attribute
Start time of the event (example: '2016-11-01T14:30:00Z')
end
class-attribute
instance-attribute
End time of the event (example: '2016-11-01T15:30:00Z')
show_as
class-attribute
instance-attribute
Status to show during the event (Unknown - -1, Free - 0, Tentative - 1, Busy - 2, Oof - 3, WorkingElsewhere - 4)
recurrence
class-attribute
instance-attribute
The recurrence pattern for the event (None - 0, Daily - 1, Weekly - 2, Monthly - 3, Yearly - 4)
response_type
class-attribute
instance-attribute
The response type of the event (None - 0, Organizer - 1, TentativelyAccepted - 2, Accepted - 3, Declined - 4, NotResponded - 5)
response_time
class-attribute
instance-attribute
The response time of the event
i_cal_u_id
class-attribute
instance-attribute
A unique identifier that is shared by all instances of an event across different calendars
importance
class-attribute
instance-attribute
The importance of the event (0 - Low, 1 - Normal, 2 - High)
id
class-attribute
instance-attribute
The event's unique identifier
date_time_created
class-attribute
instance-attribute
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
The organizer of the event
time_zone
class-attribute
instance-attribute
Time zone of the event
series_master_id
class-attribute
instance-attribute
Unique identifier for Series Master event type
categories
class-attribute
instance-attribute
The categories associated with the event
web_link
class-attribute
instance-attribute
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 of the message associated with the event
is_html
class-attribute
instance-attribute
Set to true if the body is Html
location
class-attribute
instance-attribute
Location of the event
is_all_day
class-attribute
instance-attribute
Set to true if the event lasts all day
recurrence_end
class-attribute
instance-attribute
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
Time in minutes before event start to remind
PaginatedListResponseCalendarEventClientReceiveStringEnums
dataclass
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
The importance of the event: Low, Normal, or High
response_type
class-attribute
instance-attribute
The response type of the event: None, Organizer, TentativelyAccepted, Accepted, Declined or NotResponded
recurrence
class-attribute
instance-attribute
The recurrence pattern for the event
show_as
class-attribute
instance-attribute
Status to show during the event
subject
class-attribute
instance-attribute
Event subject
start
class-attribute
instance-attribute
Start time of the event (example: '2016-11-01T14:30:00Z')
end
class-attribute
instance-attribute
End time of the event (example: '2016-11-01T15:30:00Z')
response_time
class-attribute
instance-attribute
The response time of the event
i_cal_u_id
class-attribute
instance-attribute
A unique identifier that is shared by all instances of an event across different calendars
id
class-attribute
instance-attribute
The event's unique identifier
date_time_created
class-attribute
instance-attribute
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
The organizer of the event
time_zone
class-attribute
instance-attribute
Time zone of the event
series_master_id
class-attribute
instance-attribute
Unique identifier for Series Master event type
categories
class-attribute
instance-attribute
The categories associated with the event
web_link
class-attribute
instance-attribute
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 of the message associated with the event
is_html
class-attribute
instance-attribute
Set to true if the body is Html
location
class-attribute
instance-attribute
Location of the event
is_all_day
class-attribute
instance-attribute
Set to true if the event lasts all day
recurrence_end
class-attribute
instance-attribute
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
Time in minutes before event start to remind
ClientSubscription
dataclass
EntityListResponseFilePickerFile
dataclass
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
Uniquely identifies the file
display_name
class-attribute
instance-attribute
Display name for the file
is_folder
class-attribute
instance-attribute
Set to true if the file is a folder
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
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
Specify email addresses separated by semicolons like someone@contoso.com
bcc
class-attribute
instance-attribute
Specify email addresses separated by semicolons like someone@contoso.com
to
class-attribute
instance-attribute
Specify email addresses separated by semicolons like someone@contoso.com
subject
class-attribute
instance-attribute
Specify the subject of the mail
body
class-attribute
instance-attribute
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
reply_to
class-attribute
instance-attribute
The email addresses to use when replying
importance
class-attribute
instance-attribute
Importance
ClientSendAttachment
dataclass
Definition: ClientSendAttachment
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
The importance of the message
from_
class-attribute
instance-attribute
The mailbox owner and sender of the message
to
class-attribute
instance-attribute
The recipients for the message
cc
class-attribute
instance-attribute
The Cc recipients for the message
bcc
class-attribute
instance-attribute
The Bcc recipients for the message
reply_to
class-attribute
instance-attribute
The email addresses to use when replying
subject
class-attribute
instance-attribute
The subject of the message
body
class-attribute
instance-attribute
The body of the message
body_preview
class-attribute
instance-attribute
The preview of the message
has_attachment
class-attribute
instance-attribute
Indicates whether the message has attachments
id
class-attribute
instance-attribute
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
The Id of the conversation the email belongs to
date_time_received
class-attribute
instance-attribute
The date and time the message was received
is_read
class-attribute
instance-attribute
Indicates whether the message has been read
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
Attachment Id
name
class-attribute
instance-attribute
Attachment name
content_bytes
class-attribute
instance-attribute
Attachment content
content_type
class-attribute
instance-attribute
Attachment content type
size
class-attribute
instance-attribute
The size in bytes of the attachment
is_inline
class-attribute
instance-attribute
Set to true if this is an inline attachment
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
Specify email addresses separated by semicolons like someone@contoso.com
subject
class-attribute
instance-attribute
Specify the subject of the mail
body
class-attribute
instance-attribute
Specify the body of the mail
from_
class-attribute
instance-attribute
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
Specify email addresses separated by semicolons like someone@contoso.com
bcc
class-attribute
instance-attribute
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
reply_to
class-attribute
instance-attribute
The email addresses to use when replying
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
Specify email addresses separated by semicolons like someone@contoso.com
subject
class-attribute
instance-attribute
Specify the subject of the mail
body
class-attribute
instance-attribute
Specify the body of the mail
from_
class-attribute
instance-attribute
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
Specify email addresses separated by semicolons like someone@contoso.com
bcc
class-attribute
instance-attribute
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
reply_to
class-attribute
instance-attribute
The email addresses to use when replying
BatchItemFailureResult
dataclass
Definition: BatchItemFailureResult
Attributes
message_id
class-attribute
instance-attribute
The ID of the failed message.
BatchResponseClientReceiveMessage
dataclass
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
The mailbox owner and sender of the message
to
class-attribute
instance-attribute
The recipients for the message
cc
class-attribute
instance-attribute
The Cc recipients for the message
bcc
class-attribute
instance-attribute
The Bcc recipients for the message
reply_to
class-attribute
instance-attribute
The email addresses to use when replying
subject
class-attribute
instance-attribute
The subject of the message
body
class-attribute
instance-attribute
The body of the message
importance
class-attribute
instance-attribute
The importance of the message (0 - Low, 1 - Normal, 2 - High)
body_preview
class-attribute
instance-attribute
The preview of the message
has_attachment
class-attribute
instance-attribute
Indicates whether the message has attachments
id
class-attribute
instance-attribute
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
The Id of the conversation the email belongs to
date_time_received
class-attribute
instance-attribute
The date and time the message was received
is_read
class-attribute
instance-attribute
Indicates whether the message has been read
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
content_bytes
class-attribute
instance-attribute
Attachment content
content_type
class-attribute
instance-attribute
Attachment content type
size
class-attribute
instance-attribute
The size in bytes of the attachment
is_inline
class-attribute
instance-attribute
Set to true if this is an inline attachment
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
Example: recipient1@domain.com; recipient2@domain.com
cc
class-attribute
instance-attribute
Example: recipient1@domain.com; recipient2@domain.com
bcc
class-attribute
instance-attribute
Example: recipient1@domain.com; recipient2@domain.com
subject
class-attribute
instance-attribute
Email subject (if empty, the original subject used).
body
class-attribute
instance-attribute
Content of the email.
reply_all
class-attribute
instance-attribute
True to reply to all recipients. (default: False)
is_html
class-attribute
instance-attribute
True to send the reply as HTML. (default: True)
importance
class-attribute
instance-attribute
Pick an importance. (default: Low)
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
Example: recipient1@domain.com; recipient2@domain.com
cc
class-attribute
instance-attribute
Example: recipient1@domain.com; recipient2@domain.com
bcc
class-attribute
instance-attribute
Example: recipient1@domain.com; recipient2@domain.com
subject
class-attribute
instance-attribute
Email subject (if empty, the original subject used).
body
class-attribute
instance-attribute
Content of the email.
reply_all
class-attribute
instance-attribute
True to reply to all recipients. (default: False)
importance
class-attribute
instance-attribute
Pick an importance. (default: Low)
TriggerBatchResponseClientReceiveMessage
dataclass
BatchResponseSensitivityLabel
dataclass
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
Gets or sets the identifier.
display_name
class-attribute
instance-attribute
Gets or sets the display name.
applicable_to
class-attribute
instance-attribute
Gets or sets the applicable to.
TriggerBatchResponseReceiveMessageMetadata
dataclass
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
The mailbox owner and sender of the message
to
class-attribute
instance-attribute
The recipients for the message
cc
class-attribute
instance-attribute
The Cc recipients for the message
bcc
class-attribute
instance-attribute
The Bcc recipients for the message
reply_to
class-attribute
instance-attribute
The email addresses to use when replying
subject
class-attribute
instance-attribute
The subject of the message
importance
class-attribute
instance-attribute
The importance of the message (0 - Low, 1 - Normal, 2 - High)
has_attachment
class-attribute
instance-attribute
Indicates whether the message has attachments
id
class-attribute
instance-attribute
The unique identifier of the message
date_time_received
class-attribute
instance-attribute
The date and time the message was received
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
display_name
class-attribute
instance-attribute
Dataset display name
url_encoding
class-attribute
instance-attribute
Dataset url encoding
table_display_name
class-attribute
instance-attribute
Table display name
BlobDataSetsMetadata
dataclass
BlobDataSetsMetadata(source: Optional[str] = None, display_name: Optional[str] = None, url_encoding: Optional[str] = None)
Definition: BlobDataSetsMetadata
Attributes
display_name
class-attribute
instance-attribute
Blob dataset display name
OptionsEmailSubscription
dataclass
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
Specify email addresses separated by semicolons like someone@contoso.com
subject
class-attribute
instance-attribute
Subject of the email
options
class-attribute
instance-attribute
List of comma separated options for the email response
header_text
class-attribute
instance-attribute
Header text for email body
selection_text
class-attribute
instance-attribute
Header text for users options selection
body
class-attribute
instance-attribute
Body of the email
importance
class-attribute
instance-attribute
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.
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
User response
user_email_address
class-attribute
instance-attribute
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. The value is the tenant id of the user for both individual users and the members in Distribution Group or Mail Enabled Security Group.
ApprovalEmailSubscription
dataclass
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
Specify email addresses separated by semicolons like someone@contoso.com
subject
class-attribute
instance-attribute
Subject
options
class-attribute
instance-attribute
User Options
header_text
class-attribute
instance-attribute
Header text for email body
selection_text
class-attribute
instance-attribute
Header text for users options selection
body
class-attribute
instance-attribute
Body
importance
class-attribute
instance-attribute
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.
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
Specify email address of a shared mailbox like someone@contoso.com
to
class-attribute
instance-attribute
Specify email addresses separated by semicolons like someone@contoso.com
subject
class-attribute
instance-attribute
Specify the subject of the mail
body
class-attribute
instance-attribute
Specify the body of the mail
cc
class-attribute
instance-attribute
Specify email addresses separated by semicolons like someone@contoso.com
bcc
class-attribute
instance-attribute
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
reply_to
class-attribute
instance-attribute
The email addresses to use when replying
importance
class-attribute
instance-attribute
Importance
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
Specify email address of a shared mailbox like someone@contoso.com
to
class-attribute
instance-attribute
Specify email addresses separated by semicolons like someone@contoso.com
subject
class-attribute
instance-attribute
Specify the subject of the mail
body
class-attribute
instance-attribute
Specify the body of the mail
cc
class-attribute
instance-attribute
Specify email addresses separated by semicolons like someone@contoso.com
bcc
class-attribute
instance-attribute
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
reply_to
class-attribute
instance-attribute
The email addresses to use when replying
SubscriptionPayloadOutlookReceiveMessage
dataclass
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
change_type
class-attribute
instance-attribute
Change type
client_state
class-attribute
instance-attribute
Client state
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
OData type
id
class-attribute
instance-attribute
Attachment Id
name
class-attribute
instance-attribute
Attachment name
content_bytes
class-attribute
instance-attribute
Attachment content
content_type
class-attribute
instance-attribute
Attachment content type
size
class-attribute
instance-attribute
Attachment size in bytes
permission
class-attribute
instance-attribute
Permission associated with a reference attachment
provider_type
class-attribute
instance-attribute
Provider for the reference attachment
source_url
class-attribute
instance-attribute
Reference attachment source url
is_inline
class-attribute
instance-attribute
Set to true if this is an inline attachment
InternetMessageHeader
dataclass
Definition: InternetMessageHeader
SubscriptionPayloadSubscriptionEvent
dataclass
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
change_type
class-attribute
instance-attribute
Change type
client_state
class-attribute
instance-attribute
Client state
SubscriptionEvent
dataclass
EntityListResponseTable
dataclass
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
The name of the table. The name is used at runtime.
display_name
class-attribute
instance-attribute
The display name of the table.
EntityListResponseCalendarEventBackend
dataclass
EntityListResponseCalendarEventClientReceiveStringEnums
dataclass
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
Event subject
start
class-attribute
instance-attribute
Start time of the event (example: '2016-11-01T14:30:00Z')
end
class-attribute
instance-attribute
End time of the event (example: '2016-11-01T15:30:00Z')
time_zone
class-attribute
instance-attribute
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 of the message associated with the event
is_html
class-attribute
instance-attribute
Set to true if the body is Html
location
class-attribute
instance-attribute
Location of the event
importance
class-attribute
instance-attribute
The importance of the event: Low, Normal, or High
is_all_day
class-attribute
instance-attribute
Set to true if the event lasts all day
recurrence
class-attribute
instance-attribute
The recurrence pattern for the event
recurrence_end
class-attribute
instance-attribute
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
Time in minutes before event start to remind
show_as
class-attribute
instance-attribute
Status to show during the event
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
Event subject
start
class-attribute
instance-attribute
Start time of the event (example: '2016-11-01T14:30:00Z')
end
class-attribute
instance-attribute
End time of the event (example: '2016-11-01T15:30:00Z')
time_zone
class-attribute
instance-attribute
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 of the message associated with the event
location
class-attribute
instance-attribute
Location of the event
importance
class-attribute
instance-attribute
The importance of the event: Low, Normal, or High
is_all_day
class-attribute
instance-attribute
Set to true if the event lasts all day
recurrence
class-attribute
instance-attribute
The recurrence pattern for the event
recurrence_end
class-attribute
instance-attribute
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
Time in minutes before event start to remind
show_as
class-attribute
instance-attribute
Status to show during the event
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
start
class-attribute
instance-attribute
Start time of the event (example: '2017-08-29T04:00:00')
end
class-attribute
instance-attribute
End time of the event (example: '2017-08-29T05:00:00')
time_zone
class-attribute
instance-attribute
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 of the message associated with the event
categories
class-attribute
instance-attribute
The categories associated with the event
importance
class-attribute
instance-attribute
The importance of the event: low, normal, or high
is_all_day
class-attribute
instance-attribute
Set to true if the event lasts all day
recurrence
class-attribute
instance-attribute
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
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
Set to true if an alert is set to remind the user of the event.
show_as
class-attribute
instance-attribute
Status to show during the event: free, tentative, busy, oof, workingElsewhere or unknown
CalendarEventListWithActionType
dataclass
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
Changed action type of the event - added, updated or deleted.
is_added
class-attribute
instance-attribute
Flag that indicates whether the event was added since the last poll of the trigger.
is_updated
class-attribute
instance-attribute
Flag that indicates whether the event was updated since the last poll of the trigger.
subject
class-attribute
instance-attribute
Event subject
start
class-attribute
instance-attribute
Start time of the event (example: '2016-11-01T14:30:00Z')
end
class-attribute
instance-attribute
End time of the event (example: '2016-11-01T15:30:00Z')
show_as
class-attribute
instance-attribute
Status to show during the event (Unknown - -1, Free - 0, Tentative - 1, Busy - 2, Oof - 3, WorkingElsewhere - 4)
recurrence
class-attribute
instance-attribute
The recurrence pattern for the event (None - 0, Daily - 1, Weekly - 2, Monthly - 3, Yearly - 4)
response_type
class-attribute
instance-attribute
The response type of the event (None - 0, Organizer - 1, TentativelyAccepted - 2, Accepted - 3, Declined - 4, NotResponded - 5)
response_time
class-attribute
instance-attribute
The response time of the event
i_cal_u_id
class-attribute
instance-attribute
A unique identifier that is shared by all instances of an event across different calendars
importance
class-attribute
instance-attribute
The importance of the event (0 - Low, 1 - Normal, 2 - High)
id
class-attribute
instance-attribute
The event's unique identifier
date_time_created
class-attribute
instance-attribute
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
The organizer of the event
time_zone
class-attribute
instance-attribute
Time zone of the event
series_master_id
class-attribute
instance-attribute
Unique identifier for Series Master event type
categories
class-attribute
instance-attribute
The categories associated with the event
web_link
class-attribute
instance-attribute
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 of the message associated with the event
is_html
class-attribute
instance-attribute
Set to true if the body is Html
location
class-attribute
instance-attribute
Location of the event
is_all_day
class-attribute
instance-attribute
Set to true if the event lasts all day
recurrence_end
class-attribute
instance-attribute
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
Time in minutes before event start to remind
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
Changed action type of the event - added, updated or deleted.
is_added
class-attribute
instance-attribute
Flag that indicates whether the event was added since the last poll of the trigger.
is_updated
class-attribute
instance-attribute
Flag that indicates whether the event was updated since the last poll of the trigger.
start
class-attribute
instance-attribute
Start time of the event (example: '2017-08-29T04:00:00.0000000')
end
class-attribute
instance-attribute
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 time of the event with time zone (example: '2017-08-29T05:00:00.0000000+00:00')
body
class-attribute
instance-attribute
Body of the message associated with the event
is_html
class-attribute
instance-attribute
Set to true if the body is Html
response_type
class-attribute
instance-attribute
The response type of the event (none, organizer, tentativelyAccepted, accepted, declined or notResponded)
response_time
class-attribute
instance-attribute
The response time of the event
created_date_time
class-attribute
instance-attribute
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
The organizer of the event
time_zone
class-attribute
instance-attribute
Time zone of the event
series_master_id
class-attribute
instance-attribute
Unique identifier for Series Master event type
i_cal_u_id
class-attribute
instance-attribute
A unique identifier for an event across calendars. This ID is different for each occurrence in a recurring series
categories
class-attribute
instance-attribute
The categories associated with the event
web_link
class-attribute
instance-attribute
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
importance
class-attribute
instance-attribute
The importance of the event: low, normal, or high
is_all_day
class-attribute
instance-attribute
Set to true if the event lasts all day
recurrence
class-attribute
instance-attribute
The recurrence pattern for the event: none, daily, weekly, monthly or yearly
recurrence_end
class-attribute
instance-attribute
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
Set to true if an alert is set to remind the user of the event.
show_as
class-attribute
instance-attribute
Status to show during the event: free, tentative, busy, oof, workingElsewhere or unknown
GraphContactFolder
dataclass
GraphContactFolder(id: Optional[str] = None, display_name: Optional[str] = None, parent_folder_id: Optional[str] = None)
Definition: GraphContactFolder
Attributes
display_name
class-attribute
instance-attribute
The name of the contacts folder
DataSetsList
dataclass
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
Dataset name
display_name
class-attribute
instance-attribute
Dataset display name
Procedure
dataclass
Definition: Procedure
PassThroughNativeQuery
dataclass
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
Automatic reply setting status
external_audience
class-attribute
instance-attribute
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')
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
mailbox_full
class-attribute
instance-attribute
Is mailbox full
max_message_size
class-attribute
instance-attribute
Maximum message size
MailTipsAutomaticReplies
dataclass
UpdateEmailFlag
dataclass
ResponseToEventInvite
dataclass
Definition: ResponseToEventInvite
Attributes
comment
class-attribute
instance-attribute
Comment
DirectForwardMessage
dataclass
Definition: DirectForwardMessage
Attributes
comment
class-attribute
instance-attribute
Comment
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
Should a meeting location be returned for the meeting?
suggest_location
class-attribute
instance-attribute
Should the response provide one or more meeting location suggestions?
DateTimeTimeZone
dataclass
Definition: DateTimeTimeZone
Attributes
date_time
class-attribute
instance-attribute
DateTime (example: '2017-08-29T04:00:00.0000000')
EmailAddressV2
dataclass
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
The contact's street address.
country_or_region
class-attribute
instance-attribute
The contact's country of region.
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
parent_folder_id
class-attribute
instance-attribute
The ID of the contact's parent folder
file_as
class-attribute
instance-attribute
The name the contact is filed under
display_name
class-attribute
instance-attribute
The contact's display name
given_name
class-attribute
instance-attribute
The contact's given name
middle_name
class-attribute
instance-attribute
The contact's middle name
nick_name
class-attribute
instance-attribute
The contact's nickname
generation
class-attribute
instance-attribute
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
The contact's instant messaging (IM) addresses
job_title
class-attribute
instance-attribute
The contact's job title
company_name
class-attribute
instance-attribute
The name of the contact's company
department
class-attribute
instance-attribute
The contact's department
office_location
class-attribute
instance-attribute
The location of the contact's office
profession
class-attribute
instance-attribute
The contact's profession
business_home_page
class-attribute
instance-attribute
The business home page of the contact
assistant_name
class-attribute
instance-attribute
The name of the contact's assistant
manager
class-attribute
instance-attribute
The name of the contact's manager
home_phones
class-attribute
instance-attribute
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
The contact's mobile phone number
yomi_company_name
class-attribute
instance-attribute
The phonetic Japanese company name of the contact
yomi_given_name
class-attribute
instance-attribute
The phonetic Japanese given name (first name) of the contact
yomi_surname
class-attribute
instance-attribute
The phonetic Japanese surname (last name) of the contact
categories
class-attribute
instance-attribute
The categories associated with the contact
change_key
class-attribute
instance-attribute
Identifies the version of the event object
created_date_time
class-attribute
instance-attribute
The time the contact was created
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.
display_name
class-attribute
instance-attribute
SensitivityLabel displayName info
tooltip
class-attribute
instance-attribute
SensitivityLabel details on tooltip.
priority
class-attribute
instance-attribute
SensitivityLabel priority.
is_encrypted
class-attribute
instance-attribute
is SensitivityLabel Encrypted.
is_enabled
class-attribute
instance-attribute
Whether SensitivityLabel is Enabled.
is_parent
class-attribute
instance-attribute
Whether SensitivityLabel is Parent.
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
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
Updates an email Draft message
This operation updates an an email Draft message.
send_draft_email_async
async
Send a Draft message
This operation sends a Draft message.
assign_category_async
async
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 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 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'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
Send an HTTP request
Construct a Microsoft Graph REST API request to invoke. These segments
are supported: 1st segement: /me, /users/
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
Delete event
This operation deletes an event in a calendar.
calendar_get_item_async
async
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
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
Create event
This operation creates a new event in a calendar.
contact_delete_item_async
async
Delete contact
This operation deletes a contact from a contacts folder.
contact_get_item_async
async
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
Get contact folders
This operation lists available contacts folders using Graph API
contact_patch_item_async
async
Update contact
This operation updates a contact in a contacts folder.
contact_post_item_async
async
Create contact
This operation creates a new contact in a contacts folder.
delete_email_async
async
Delete email
This operation deletes an email by id.
export_email_async
async
Export email
Export the content of the email in the EML file format.
find_meeting_times_async
async
Find meeting times
Find meeting time suggestions based on organizer, attendee availability, and time or location constraints
flag_async
async
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 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
Get all the room lists defined in the user's tenant
get_rooms_async
async
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
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 an event invite
Respond to an event invite.
send_email_async
async
Send an email
This operation sends an email message.