Office365
Attributes
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
dataclass
Response for Get Outlook category names
Attributes
class-attribute
instance-attribute
The ID of the Outlook Category.
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 | Mapping[str, Any]]] = None, to_recipients: Optional[List[Recipient | Mapping[str, Any]]] = None, cc_recipients: Optional[List[Recipient | Mapping[str, Any]]] = None, bcc_recipients: Optional[List[Recipient | Mapping[str, Any]]] = None, reply_to: Optional[List[Recipient | Mapping[str, Any]]] = None, subject: Optional[str] = None, body: Optional[ItemBody | Mapping[str, Any]] = None, from_: Optional[Recipient | Mapping[str, Any]] = None, importance: Optional[str] = None, internet_message_headers: Optional[List[InternetMessageHeader | Mapping[str, Any]]] = None)
Response for Draft an email message
Attributes
class-attribute
instance-attribute
internet_message_id: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'InternetMessageId'})
Internet Message Id
class-attribute
instance-attribute
body_preview: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'BodyPreview'})
Body preview
class-attribute
instance-attribute
Id
class-attribute
instance-attribute
conversation_id: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'ConversationId'})
Conversation Id
class-attribute
instance-attribute
has_attachments: Optional[bool] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'HasAttachments'})
Has attachments
class-attribute
instance-attribute
is_read: Optional[bool] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'IsRead'})
Is read
class-attribute
instance-attribute
created_date_time: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'CreatedDateTime'})
Created date and time
class-attribute
instance-attribute
received_date_time: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'ReceivedDateTime'})
Received date and time
class-attribute
instance-attribute
last_modified_date_time: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'LastModifiedDateTime'})
Last modified date and time
class-attribute
instance-attribute
attachments: Optional[List[OutlookReceiveAttachment | Mapping[str, Any]]] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Attachments'})
Attachments
class-attribute
instance-attribute
to_recipients: Optional[List[Recipient | Mapping[str, Any]]] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'ToRecipients'})
To Recipient
class-attribute
instance-attribute
cc_recipients: Optional[List[Recipient | Mapping[str, Any]]] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'CcRecipients'})
Cc Recipients
class-attribute
instance-attribute
bcc_recipients: Optional[List[Recipient | Mapping[str, Any]]] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'BccRecipients'})
Bcc Recipients
class-attribute
instance-attribute
reply_to: Optional[List[Recipient | Mapping[str, Any]]] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'ReplyTo'})
The email addresses to use when replying
class-attribute
instance-attribute
subject: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Subject'})
Subject
dataclass
BatchOperationResult(*, success_count: Optional[int] = None, failures: Optional[List[BatchItemFailureResult | Mapping[str, Any]]] = None)
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
class-attribute
instance-attribute
Id of the subscription
class-attribute
instance-attribute
Resource of the subscription request
dataclass
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)
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
class-attribute
instance-attribute
Event subject
class-attribute
instance-attribute
Start time of the event (example: '2017-08-29T04:00:00.0000000')
class-attribute
instance-attribute
End time of the event (example: '2017-08-29T05:00:00.0000000')
class-attribute
instance-attribute
start_with_time_zone: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'startWithTimeZone'})
Start time of the event with time zone (example: '2017-08-29T04:00:00.0000000+00:00')
class-attribute
instance-attribute
end_with_time_zone: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'endWithTimeZone'})
End time of the event with time zone (example: '2017-08-29T05:00:00.0000000+00:00')
class-attribute
instance-attribute
Body of the message associated with the event
class-attribute
instance-attribute
is_html: Optional[bool] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'isHtml'})
Set to true if the body is Html
class-attribute
instance-attribute
response_type: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'responseType'})
The response type of the event (none, organizer, tentativelyAccepted, accepted, declined or notResponded)
class-attribute
instance-attribute
response_time: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'responseTime'})
The response time of the event
class-attribute
instance-attribute
The event's unique identifier
class-attribute
instance-attribute
created_date_time: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'createdDateTime'})
The date and time that the event was created
class-attribute
instance-attribute
last_modified_date_time: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'lastModifiedDateTime'})
The date and time that the event was last modified
class-attribute
instance-attribute
The organizer of the event
class-attribute
instance-attribute
time_zone: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'timeZone'})
Time zone of the event
class-attribute
instance-attribute
series_master_id: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'seriesMasterId'})
Unique identifier for Series Master event type
class-attribute
instance-attribute
i_cal_u_id: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'iCalUId'})
A unique identifier for an event across calendars. This ID is different for each occurrence in a recurring series
class-attribute
instance-attribute
The categories associated with the event
class-attribute
instance-attribute
web_link: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'webLink'})
The URL to open the event in Outlook Web App
class-attribute
instance-attribute
required_attendees: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'requiredAttendees'})
Required attendees for the event separated by semicolons
class-attribute
instance-attribute
optional_attendees: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'optionalAttendees'})
Optional attendees for the event separated by semicolons
class-attribute
instance-attribute
resource_attendees: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'resourceAttendees'})
Resource attendees for the event separated by semicolons
class-attribute
instance-attribute
Location of the event
class-attribute
instance-attribute
The importance of the event: low, normal, or high
class-attribute
instance-attribute
is_all_day: Optional[bool] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'isAllDay'})
Set to true if the event lasts all day
class-attribute
instance-attribute
The recurrence pattern for the event: none, daily, weekly, monthly or yearly
class-attribute
instance-attribute
recurrence_end: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'recurrenceEnd'})
End Date of the recurrence
class-attribute
instance-attribute
number_of_occurences: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'numberOfOccurences'})
How many times to repeat the event
class-attribute
instance-attribute
reminder_minutes_before_start: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'reminderMinutesBeforeStart'})
Time in minutes before event start to remind
class-attribute
instance-attribute
is_reminder_on: Optional[bool] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'isReminderOn'})
Set to true if an alert is set to remind the user of the event.
class-attribute
instance-attribute
show_as: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'showAs'})
Status to show during the event: free, tentative, busy, oof, workingElsewhere or unknown
dataclass
dataclass
dataclass
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 | Mapping[str, Any]]] = 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 | Mapping[str, Any]] = None, business_address: Optional[PhysicalAddress | Mapping[str, Any]] = None, other_address: Optional[PhysicalAddress | Mapping[str, Any]] = 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
class-attribute
instance-attribute
The contact's unique identifier.
class-attribute
instance-attribute
parent_folder_id: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'parentFolderId'})
The ID of the contact's parent folder
class-attribute
instance-attribute
The contact's birthday
class-attribute
instance-attribute
file_as: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'fileAs'})
The name the contact is filed under
class-attribute
instance-attribute
display_name: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'displayName'})
The contact's display name
class-attribute
instance-attribute
given_name: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'givenName'})
The contact's given name
class-attribute
instance-attribute
The contact's initials
class-attribute
instance-attribute
middle_name: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'middleName'})
The contact's middle name
class-attribute
instance-attribute
nick_name: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'nickName'})
The contact's nickname
class-attribute
instance-attribute
The contact's surname
class-attribute
instance-attribute
The contact's title
class-attribute
instance-attribute
The contact's generation
class-attribute
instance-attribute
email_addresses: Optional[List[EmailAddressV2 | Mapping[str, Any]]] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'emailAddresses'})
The contact's email addresses
class-attribute
instance-attribute
im_addresses: Optional[List[str]] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'imAddresses'})
The contact's instant messaging (IM) addresses
class-attribute
instance-attribute
job_title: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'jobTitle'})
The contact's job title
class-attribute
instance-attribute
company_name: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'companyName'})
The name of the contact's company
class-attribute
instance-attribute
The contact's department
class-attribute
instance-attribute
office_location: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'officeLocation'})
The location of the contact's office
class-attribute
instance-attribute
The contact's profession
class-attribute
instance-attribute
business_home_page: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'businessHomePage'})
The business home page of the contact
class-attribute
instance-attribute
assistant_name: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'assistantName'})
The name of the contact's assistant
class-attribute
instance-attribute
The name of the contact's manager
class-attribute
instance-attribute
home_phones: Optional[List[str]] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'homePhones'})
The contact's home phone numbers
class-attribute
instance-attribute
business_phones: Optional[List[str]] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'businessPhones'})
The contact's business phone numbers
class-attribute
instance-attribute
mobile_phone: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'mobilePhone'})
The contact's mobile phone number
class-attribute
instance-attribute
yomi_company_name: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'yomiCompanyName'})
The phonetic Japanese company name of the contact
class-attribute
instance-attribute
yomi_given_name: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'yomiGivenName'})
The phonetic Japanese given name (first name) of the contact
class-attribute
instance-attribute
yomi_surname: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'yomiSurname'})
The phonetic Japanese surname (last name) of the contact
class-attribute
instance-attribute
The categories associated with the contact
class-attribute
instance-attribute
change_key: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'changeKey'})
Identifies the version of the event object
dataclass
EntityListResponseContactResponse(*, value: Optional[List[ContactResponse | Mapping[str, Any]]] = None, next_link: Optional[str] = None)
dataclass
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
class-attribute
instance-attribute
required_attendees: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'RequiredAttendees'})
List of semicolon separated email addresses
class-attribute
instance-attribute
optional_attendees: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'OptionalAttendees'})
List of semicolon separated email addresses
class-attribute
instance-attribute
resource_attendees: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'ResourceAttendees'})
Resource attendees for the event separated by semicolons
class-attribute
instance-attribute
meeting_duration: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'MeetingDuration'})
Duration of the meeting in minutes
class-attribute
instance-attribute
Start time for meeting time suggestions
class-attribute
instance-attribute
End time for meeting time suggestions
class-attribute
instance-attribute
max_candidates: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'MaxCandidates'})
The maximum number of meeting suggestions to return in the response
class-attribute
instance-attribute
minimum_attendee_percentage: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'MinimumAttendeePercentage'})
The minimum required confidence for a time slot to be returned in the response
dataclass
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 | Mapping[str, Any]]] = None)
Response for Get Attachment
Attributes
class-attribute
instance-attribute
Id of the attachment.
class-attribute
instance-attribute
Name of attachment.
class-attribute
instance-attribute
content_type: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'contentType'})
Content type of attachment.
class-attribute
instance-attribute
Size of attachment.
class-attribute
instance-attribute
content_bytes: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'contentBytes'})
Content of attachment.
class-attribute
instance-attribute
is_inline: Optional[bool] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'isInline'})
Set to true if this is an inline attachment.
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 | Mapping[str, Any]]] = None, is_html: Optional[bool] = None, sensitivity_label_info: Optional[List[SensitivityLabelMetadata | Mapping[str, Any]]] = None)
Response for Get email
Attributes
class-attribute
instance-attribute
The mailbox owner and sender of the message
class-attribute
instance-attribute
to_recipients: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'toRecipients'})
The recipients for the message
class-attribute
instance-attribute
cc_recipients: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'ccRecipients'})
The Cc recipients for the message
class-attribute
instance-attribute
bcc_recipients: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'bccRecipients'})
The Bcc recipients for the message
class-attribute
instance-attribute
reply_to: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'replyTo'})
The email addresses to use when replying
class-attribute
instance-attribute
The subject of the message
class-attribute
instance-attribute
The body of the message
class-attribute
instance-attribute
The importance of the message (low, normal, high)
class-attribute
instance-attribute
body_preview: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'bodyPreview'})
The preview of the message
class-attribute
instance-attribute
has_attachments: Optional[bool] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'hasAttachments'})
Indicates whether the message has attachments
class-attribute
instance-attribute
The unique identifier of the message
class-attribute
instance-attribute
internet_message_id: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'internetMessageId'})
The message ID in the format specified by RFC2822
class-attribute
instance-attribute
conversation_id: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'conversationId'})
The Id of the conversation the email belongs to
class-attribute
instance-attribute
received_date_time: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'receivedDateTime'})
The date and time the message was received
class-attribute
instance-attribute
is_read: Optional[bool] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'isRead'})
Indicates whether the message has been read
dataclass
dataclass
dataclass
Get mail tips for a mailbox
Attributes
class-attribute
instance-attribute
Flags that represents the mailtips.
dataclass
Response for Get mail tips for a mailbox
dataclass
dataclass
dataclass
dataclass
dataclass
dataclass
SetAutomaticRepliesSettingInput(*, automatic_replies_setting: Optional[AutomaticRepliesSettingClient | Mapping[str, Any]] = None)
Set up automatic replies
dataclass
SetAutomaticRepliesSettingResponse(*, automatic_replies_setting: Optional[AutomaticRepliesSettingClient | Mapping[str, Any]] = None)
Response for Set up automatic replies
dataclass
TableMetadata(*, name: Optional[str] = None, title: Optional[str] = None, x_ms_permission: Optional[str] = None, x_ms_capabilities: Optional[TableCapabilitiesMetadata | Mapping[str, Any]] = None, schema: Optional[ObjectEntity | Mapping[str, Any]] = None, referenced_entities: Optional[ObjectEntity | Mapping[str, Any]] = None, web_url: Optional[str] = None)
Definition: TableMetadata
Attributes
class-attribute
instance-attribute
Table name
class-attribute
instance-attribute
Table title
dataclass
TableCapabilitiesMetadata(*, sort_restrictions: Optional[TableSortRestrictionsMetadata | Mapping[str, Any]] = None, filter_restrictions: Optional[TableFilterRestrictionsMetadata | Mapping[str, Any]] = None, select_restrictions: Optional[TableSelectRestrictionsMetadata | Mapping[str, Any]] = 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
class-attribute
instance-attribute
is_only_server_pagable: Optional[bool] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'isOnlyServerPagable'})
Server paging restrictions
dataclass
dataclass
TableSortRestrictionsMetadata(*, sortable: Optional[bool] = None, unsortable_properties: Optional[List[str]] = None, ascending_only_properties: Optional[List[str]] = None)
Definition: TableSortRestrictionsMetadata
Attributes
class-attribute
instance-attribute
Indicates whether this table has sortable columns
dataclass
TableFilterRestrictionsMetadata(*, filterable: Optional[bool] = None, non_filterable_properties: Optional[List[str]] = None, required_properties: Optional[List[str]] = None)
Definition: TableFilterRestrictionsMetadata
Attributes
class-attribute
instance-attribute
Indicates whether this table has filterable columns
dataclass
dataclass
dataclass
CalendarEventBackend(end: str, start: str, subject: str, *, id: Optional[str] = None, attendees: Optional[List[Attendee | Mapping[str, Any]]] = None, body: Optional[ItemBody | Mapping[str, Any]] = 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_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 | Mapping[str, Any]] = None, organizer: Optional[Recipient | Mapping[str, Any]] = None, recurrence: Optional[PatternedRecurrence | Mapping[str, Any]] = None, reminder: Optional[int] = None, response_requested: Optional[bool] = None, response_status: Optional[ResponseStatus | Mapping[str, Any]] = None, series_master_id: Optional[str] = None, show_as: Optional[str] = None, start_time_zone: Optional[str] = None, type_: Optional[str] = None, web_link: Optional[str] = None, reason: Optional[str] = None)
Definition: CalendarEventBackend
Attributes
class-attribute
instance-attribute
The Event's unique identifier
class-attribute
instance-attribute
attendees: Optional[List[Attendee | Mapping[str, Any]]] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Attendees'})
List of attendees for the event
class-attribute
instance-attribute
body_preview: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'BodyPreview'})
The preview of the message associated with the event
class-attribute
instance-attribute
categories: Optional[List[str]] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Categories'})
The categories associated with the event
class-attribute
instance-attribute
change_key: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'ChangeKey'})
This property identifies the version of the event object. Every time the event is changed, ChangeKey changes as well.
class-attribute
instance-attribute
date_time_created: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'DateTimeCreated'})
The date and time that the event was created
class-attribute
instance-attribute
date_time_last_modified: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'DateTimeLastModified'})
The date and time that the event was last modified
class-attribute
instance-attribute
The end time of the event
class-attribute
instance-attribute
end_time_zone: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'EndTimeZone'})
This property specifies the time zone of the meeting end time. The value must be as defined in Windows (example: 'Pacific Standard Time').
class-attribute
instance-attribute
has_attachments: Optional[bool] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'HasAttachments'})
Set to true if the event has attachments
class-attribute
instance-attribute
i_cal_u_id: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'ICalUId'})
A unique identifier that is shared by all instances of an event across different calendars
class-attribute
instance-attribute
importance: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Importance'})
The importance of the event: Low, Normal, or High
class-attribute
instance-attribute
is_all_day: Optional[bool] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'IsAllDay'})
Set to true if the event lasts all day
class-attribute
instance-attribute
is_cancelled: Optional[bool] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'IsCancelled'})
Set to true if the event has been canceled
class-attribute
instance-attribute
is_organizer: Optional[bool] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'IsOrganizer'})
Set to true if the message sender is also the organizer
class-attribute
instance-attribute
reminder: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Reminder'})
Time in minutes before event start to remind
class-attribute
instance-attribute
response_requested: Optional[bool] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'ResponseRequested'})
Set to true if the sender would like a response when the event is accepted or declined
class-attribute
instance-attribute
series_master_id: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'SeriesMasterId'})
Unique identifier for Series Master event type
class-attribute
instance-attribute
show_as: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'ShowAs'})
Shows as free or busy
class-attribute
instance-attribute
The start time of the event
class-attribute
instance-attribute
start_time_zone: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'StartTimeZone'})
This property specifies the time zone of the meeting start time. The value must be as defined in Windows (example: 'Pacific Standard Time').
class-attribute
instance-attribute
Event subject
class-attribute
instance-attribute
The event type: Single Instance, Occurrence, Exception, or Series Master
dataclass
Attendee(*, status: Optional[ResponseStatus | Mapping[str, Any]] = None, type_: Optional[str] = None, email_address: Optional[EmailAddress | Mapping[str, Any]] = None)
Definition: Attendee
dataclass
Definition: ItemBody
dataclass
Location(*, display_name: Optional[str] = None, address: Optional[PhysicalAddress | Mapping[str, Any]] = None, coordinates: Optional[GeoCoordinates | Mapping[str, Any]] = None)
Definition: Location
dataclass
Definition: Recipient
dataclass
PatternedRecurrence(*, pattern: Optional[RecurrencePattern | Mapping[str, Any]] = None, range: Optional[RecurrenceRange | Mapping[str, Any]] = None)
Definition: PatternedRecurrence
dataclass
Definition: ResponseStatus
dataclass
Definition: EmailAddress
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
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
dataclass
RecurrenceRange(*, type_: Optional[str] = None, start_date: Optional[str] = None, end_date: Optional[str] = None, number_of_occurrences: Optional[int] = None)
Definition: RecurrenceRange
dataclass
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
class-attribute
instance-attribute
subject: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Subject'})
Event subject
class-attribute
instance-attribute
Start time of the event (example: '2016-11-01T14:30:00Z')
class-attribute
instance-attribute
End time of the event (example: '2016-11-01T15:30:00Z')
class-attribute
instance-attribute
show_as: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'ShowAs'})
Status to show during the event (Unknown - -1, Free - 0, Tentative - 1, Busy - 2, Oof - 3, WorkingElsewhere - 4)
class-attribute
instance-attribute
recurrence: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Recurrence'})
The recurrence pattern for the event (None - 0, Daily - 1, Weekly - 2, Monthly - 3, Yearly - 4)
class-attribute
instance-attribute
response_type: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'ResponseType'})
The response type of the event (None - 0, Organizer - 1, TentativelyAccepted - 2, Accepted - 3, Declined - 4, NotResponded - 5)
class-attribute
instance-attribute
response_time: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'ResponseTime'})
The response time of the event
class-attribute
instance-attribute
i_cal_u_id: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'ICalUId'})
A unique identifier that is shared by all instances of an event across different calendars
class-attribute
instance-attribute
importance: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Importance'})
The importance of the event (0 - Low, 1 - Normal, 2 - High)
class-attribute
instance-attribute
The event's unique identifier
class-attribute
instance-attribute
date_time_created: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'DateTimeCreated'})
The date and time that the event was created
class-attribute
instance-attribute
date_time_last_modified: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'DateTimeLastModified'})
The date and time that the event was last modified
class-attribute
instance-attribute
organizer: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Organizer'})
The organizer of the event
class-attribute
instance-attribute
time_zone: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'TimeZone'})
Time zone of the event
class-attribute
instance-attribute
series_master_id: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'SeriesMasterId'})
Unique identifier for Series Master event type
class-attribute
instance-attribute
categories: Optional[List[str]] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Categories'})
The categories associated with the event
class-attribute
instance-attribute
web_link: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'WebLink'})
The URL to open the event in Outlook Web App
class-attribute
instance-attribute
required_attendees: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'RequiredAttendees'})
Required attendees for the event separated by semicolons
class-attribute
instance-attribute
optional_attendees: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'OptionalAttendees'})
Optional attendees for the event separated by semicolons
class-attribute
instance-attribute
resource_attendees: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'ResourceAttendees'})
Resource attendees for the event separated by semicolons
class-attribute
instance-attribute
Body of the message associated with the event
class-attribute
instance-attribute
is_html: Optional[bool] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'IsHtml'})
Set to true if the body is Html
class-attribute
instance-attribute
location: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Location'})
Location of the event
class-attribute
instance-attribute
is_all_day: Optional[bool] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'IsAllDay'})
Set to true if the event lasts all day
class-attribute
instance-attribute
recurrence_end: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'RecurrenceEnd'})
End time of the recurrence
class-attribute
instance-attribute
number_of_occurrences: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'NumberOfOccurrences'})
How many times to repeat the event
dataclass
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
class-attribute
instance-attribute
importance: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Importance'})
The importance of the event: Low, Normal, or High
class-attribute
instance-attribute
response_type: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'ResponseType'})
The response type of the event: None, Organizer, TentativelyAccepted, Accepted, Declined or NotResponded
class-attribute
instance-attribute
recurrence: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Recurrence'})
The recurrence pattern for the event
class-attribute
instance-attribute
show_as: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'ShowAs'})
Status to show during the event
class-attribute
instance-attribute
subject: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Subject'})
Event subject
class-attribute
instance-attribute
Start time of the event (example: '2016-11-01T14:30:00Z')
class-attribute
instance-attribute
End time of the event (example: '2016-11-01T15:30:00Z')
class-attribute
instance-attribute
response_time: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'ResponseTime'})
The response time of the event
class-attribute
instance-attribute
i_cal_u_id: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'ICalUId'})
A unique identifier that is shared by all instances of an event across different calendars
class-attribute
instance-attribute
The event's unique identifier
class-attribute
instance-attribute
date_time_created: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'DateTimeCreated'})
The date and time that the event was created
class-attribute
instance-attribute
date_time_last_modified: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'DateTimeLastModified'})
The date and time that the event was last modified
class-attribute
instance-attribute
organizer: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Organizer'})
The organizer of the event
class-attribute
instance-attribute
time_zone: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'TimeZone'})
Time zone of the event
class-attribute
instance-attribute
series_master_id: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'SeriesMasterId'})
Unique identifier for Series Master event type
class-attribute
instance-attribute
categories: Optional[List[str]] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Categories'})
The categories associated with the event
class-attribute
instance-attribute
web_link: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'WebLink'})
The URL to open the event in Outlook Web App
class-attribute
instance-attribute
required_attendees: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'RequiredAttendees'})
Required attendees for the event separated by semicolons
class-attribute
instance-attribute
optional_attendees: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'OptionalAttendees'})
Optional attendees for the event separated by semicolons
class-attribute
instance-attribute
resource_attendees: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'ResourceAttendees'})
Resource attendees for the event separated by semicolons
class-attribute
instance-attribute
Body of the message associated with the event
class-attribute
instance-attribute
is_html: Optional[bool] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'IsHtml'})
Set to true if the body is Html
class-attribute
instance-attribute
location: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Location'})
Location of the event
class-attribute
instance-attribute
is_all_day: Optional[bool] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'IsAllDay'})
Set to true if the event lasts all day
class-attribute
instance-attribute
recurrence_end: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'RecurrenceEnd'})
End time of the recurrence
class-attribute
instance-attribute
number_of_occurrences: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'NumberOfOccurrences'})
How many times to repeat the event
dataclass
dataclass
dataclass
FilePickerFile(*, id: Optional[str] = None, display_name: Optional[str] = None, is_folder: Optional[bool] = None, path: Optional[str] = None)
Definition: FilePickerFile
Attributes
class-attribute
instance-attribute
Uniquely identifies the file
class-attribute
instance-attribute
display_name: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'DisplayName'})
Display name for the file
dataclass
ClientSendMessage(to: str, subject: str, body: str, *, from_: Optional[str] = None, cc: Optional[str] = None, bcc: Optional[str] = None, attachments: Optional[List[ClientSendAttachment | Mapping[str, Any]]] = None, sensitivity: Optional[str] = None, reply_to: Optional[str] = None, importance: Optional[str] = None, is_html: Optional[bool] = None)
Definition: ClientSendMessage
Attributes
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
class-attribute
instance-attribute
Specify email addresses separated by semicolons like someone@contoso.com
class-attribute
instance-attribute
Specify email addresses separated by semicolons like someone@contoso.com
class-attribute
instance-attribute
Specify email addresses separated by semicolons like someone@contoso.com
class-attribute
instance-attribute
Specify the subject of the mail
class-attribute
instance-attribute
Specify the body of the mail
class-attribute
instance-attribute
attachments: Optional[List[ClientSendAttachment | Mapping[str, Any]]] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Attachments'})
Attachments
class-attribute
instance-attribute
sensitivity: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Sensitivity'})
Sensitivity
class-attribute
instance-attribute
reply_to: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'ReplyTo'})
The email addresses to use when replying
dataclass
Definition: ClientSendAttachment
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 | Mapping[str, Any]]] = None, is_html: Optional[bool] = None)
Definition: ClientReceiveMessageStringEnums
Attributes
class-attribute
instance-attribute
importance: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Importance'})
The importance of the message
class-attribute
instance-attribute
The mailbox owner and sender of the message
class-attribute
instance-attribute
The recipients for the message
class-attribute
instance-attribute
The Cc recipients for the message
class-attribute
instance-attribute
The Bcc recipients for the message
class-attribute
instance-attribute
reply_to: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'ReplyTo'})
The email addresses to use when replying
class-attribute
instance-attribute
subject: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Subject'})
The subject of the message
class-attribute
instance-attribute
The body of the message
class-attribute
instance-attribute
body_preview: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'BodyPreview'})
The preview of the message
class-attribute
instance-attribute
has_attachment: Optional[bool] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'HasAttachment'})
Indicates whether the message has attachments
class-attribute
instance-attribute
The unique identifier of the message
class-attribute
instance-attribute
internet_message_id: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'InternetMessageId'})
The message ID in the format specified by RFC2822
class-attribute
instance-attribute
conversation_id: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'ConversationId'})
The Id of the conversation the email belongs to
class-attribute
instance-attribute
date_time_received: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'DateTimeReceived'})
The date and time the message was received
class-attribute
instance-attribute
is_read: Optional[bool] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'IsRead'})
Indicates whether the message has been read
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
class-attribute
instance-attribute
Attachment Id
class-attribute
instance-attribute
Attachment name
class-attribute
instance-attribute
content_bytes: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'ContentBytes'})
Attachment content
class-attribute
instance-attribute
content_type: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'ContentType'})
Attachment content type
class-attribute
instance-attribute
The size in bytes of the attachment
class-attribute
instance-attribute
is_inline: Optional[bool] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'IsInline'})
Set to true if this is an inline attachment
dataclass
SendEmailInput(to: str, subject: str, body: str, *, from_: Optional[str] = None, cc: Optional[str] = None, bcc: Optional[str] = None, attachments: Optional[List[ClientSendAttachment | Mapping[str, Any]]] = None, sensitivity: Optional[str] = None, reply_to: Optional[str] = None, importance: Optional[str] = None)
Definition: ClientSendHtmlMessage
Attributes
class-attribute
instance-attribute
Specify email addresses separated by semicolons like someone@contoso.com
class-attribute
instance-attribute
Specify the subject of the mail
class-attribute
instance-attribute
Specify the body of the mail
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
class-attribute
instance-attribute
Specify email addresses separated by semicolons like someone@contoso.com
class-attribute
instance-attribute
Specify email addresses separated by semicolons like someone@contoso.com
class-attribute
instance-attribute
attachments: Optional[List[ClientSendAttachment | Mapping[str, Any]]] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Attachments'})
Attachments
class-attribute
instance-attribute
sensitivity: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Sensitivity'})
Sensitivity
dataclass
DraftEmailInput(to: str, subject: str, body: str, *, from_: Optional[str] = None, cc: Optional[str] = None, bcc: Optional[str] = None, attachments: Optional[List[ClientSendAttachment | Mapping[str, Any]]] = None, sensitivity: Optional[str] = None, reply_to: Optional[str] = None, importance: Optional[str] = None)
Definition: ClientDraftHtmlMessage
Attributes
class-attribute
instance-attribute
Specify email addresses separated by semicolons like someone@contoso.com
class-attribute
instance-attribute
Specify the subject of the mail
class-attribute
instance-attribute
Specify the body of the mail
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
class-attribute
instance-attribute
Specify email addresses separated by semicolons like someone@contoso.com
class-attribute
instance-attribute
Specify email addresses separated by semicolons like someone@contoso.com
class-attribute
instance-attribute
attachments: Optional[List[ClientSendAttachment | Mapping[str, Any]]] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Attachments'})
Attachments
class-attribute
instance-attribute
sensitivity: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Sensitivity'})
Sensitivity
dataclass
dataclass
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 | Mapping[str, Any]]] = None, is_html: Optional[bool] = None)
Definition: ClientReceiveMessage
Attributes
class-attribute
instance-attribute
The mailbox owner and sender of the message
class-attribute
instance-attribute
The recipients for the message
class-attribute
instance-attribute
The Cc recipients for the message
class-attribute
instance-attribute
The Bcc recipients for the message
class-attribute
instance-attribute
reply_to: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'ReplyTo'})
The email addresses to use when replying
class-attribute
instance-attribute
subject: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Subject'})
The subject of the message
class-attribute
instance-attribute
The body of the message
class-attribute
instance-attribute
importance: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Importance'})
The importance of the message (0 - Low, 1 - Normal, 2 - High)
class-attribute
instance-attribute
body_preview: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'BodyPreview'})
The preview of the message
class-attribute
instance-attribute
has_attachment: Optional[bool] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'HasAttachment'})
Indicates whether the message has attachments
class-attribute
instance-attribute
The unique identifier of the message
class-attribute
instance-attribute
internet_message_id: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'InternetMessageId'})
The message ID in the format specified by RFC2822
class-attribute
instance-attribute
conversation_id: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'ConversationId'})
The Id of the conversation the email belongs to
class-attribute
instance-attribute
date_time_received: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'DateTimeReceived'})
The date and time the message was received
class-attribute
instance-attribute
is_read: Optional[bool] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'IsRead'})
Indicates whether the message has been read
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
class-attribute
instance-attribute
Attachment Id
class-attribute
instance-attribute
Attachment name
class-attribute
instance-attribute
content_bytes: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'contentBytes'})
Attachment content
class-attribute
instance-attribute
content_type: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'contentType'})
Attachment content type
class-attribute
instance-attribute
The size in bytes of the attachment
class-attribute
instance-attribute
is_inline: Optional[bool] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'isInline'})
Set to true if this is an inline attachment
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 | Mapping[str, Any]]] = None)
Definition: ReplyMessage
Attributes
class-attribute
instance-attribute
Example: recipient1@domain.com; recipient2@domain.com
class-attribute
instance-attribute
Example: recipient1@domain.com; recipient2@domain.com
class-attribute
instance-attribute
Example: recipient1@domain.com; recipient2@domain.com
class-attribute
instance-attribute
subject: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Subject'})
Email subject (if empty, the original subject used).
class-attribute
instance-attribute
Content of the email.
class-attribute
instance-attribute
reply_all: Optional[bool] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'ReplyAll'})
True to reply to all recipients. (default: False)
class-attribute
instance-attribute
is_html: Optional[bool] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'IsHtml'})
True to send the reply as HTML. (default: True)
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 | Mapping[str, Any]]] = None)
Definition: ReplyHtmlMessage
Attributes
class-attribute
instance-attribute
Example: recipient1@domain.com; recipient2@domain.com
class-attribute
instance-attribute
Example: recipient1@domain.com; recipient2@domain.com
class-attribute
instance-attribute
Example: recipient1@domain.com; recipient2@domain.com
class-attribute
instance-attribute
subject: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Subject'})
Email subject (if empty, the original subject used).
class-attribute
instance-attribute
Content of the email.
class-attribute
instance-attribute
reply_all: Optional[bool] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'ReplyAll'})
True to reply to all recipients. (default: False)
dataclass
dataclass
dataclass
SensitivityLabel(*, id: Optional[str] = None, display_name: Optional[str] = None, applicable_to: Optional[str] = None, sub_labels: Optional[List[SensitivityLabel | Mapping[str, Any]]] = None)
Definition: SensitivityLabel
Attributes
class-attribute
instance-attribute
Gets or sets the identifier.
class-attribute
instance-attribute
display_name: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'DisplayName'})
Gets or sets the display name.
dataclass
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
class-attribute
instance-attribute
The mailbox owner and sender of the message
class-attribute
instance-attribute
The recipients for the message
class-attribute
instance-attribute
The Cc recipients for the message
class-attribute
instance-attribute
The Bcc recipients for the message
class-attribute
instance-attribute
reply_to: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'ReplyTo'})
The email addresses to use when replying
class-attribute
instance-attribute
subject: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Subject'})
The subject of the message
class-attribute
instance-attribute
importance: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Importance'})
The importance of the message (0 - Low, 1 - Normal, 2 - High)
class-attribute
instance-attribute
has_attachment: Optional[bool] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'HasAttachment'})
Indicates whether the message has attachments
class-attribute
instance-attribute
The unique identifier of the message
dataclass
DataSetsMetadata(*, tabular: Optional[TabularDataSetsMetadata | Mapping[str, Any]] = None, blob: Optional[BlobDataSetsMetadata | Mapping[str, Any]] = None)
Definition: DataSetsMetadata
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
class-attribute
instance-attribute
Dataset source
class-attribute
instance-attribute
display_name: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'displayName'})
Dataset display name
class-attribute
instance-attribute
url_encoding: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'urlEncoding'})
Dataset url encoding
dataclass
BlobDataSetsMetadata(*, source: Optional[str] = None, display_name: Optional[str] = None, url_encoding: Optional[str] = None)
dataclass
dataclass
MessageWithOptions(to: str, *, 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 | Mapping[str, Any]]] = 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
class-attribute
instance-attribute
Specify email addresses separated by semicolons like someone@contoso.com
class-attribute
instance-attribute
subject: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Subject'})
Subject of the email
class-attribute
instance-attribute
options: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Options'})
List of comma separated options for the email response
class-attribute
instance-attribute
header_text: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'HeaderText'})
Header text for email body
class-attribute
instance-attribute
selection_text: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'SelectionText'})
Header text for users options selection
class-attribute
instance-attribute
Body of the email
class-attribute
instance-attribute
importance: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Importance'})
Importance
class-attribute
instance-attribute
attachments: Optional[List[ClientSendAttachment | Mapping[str, Any]]] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Attachments'})
Attachments
class-attribute
instance-attribute
use_only_h_t_m_l_message: Optional[bool] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'UseOnlyHTMLMessage'})
Use only HTML message
class-attribute
instance-attribute
hide_h_t_m_l_message: Optional[bool] = dataclass_field(default=None, kw_only=True, 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.
class-attribute
instance-attribute
show_h_t_m_l_confirmation_dialog: Optional[bool] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'ShowHTMLConfirmationDialog'})
If set to Yes then a dialog wil be shown to confirm selected option of HTML message
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
class-attribute
instance-attribute
selected_option: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'SelectedOption'})
User response
class-attribute
instance-attribute
user_email_address: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'UserEmailAddress'})
User email address. The value is the user's email address for individual users and user ID for the members in Distribution Group or Mail Enabled Security Group.
class-attribute
instance-attribute
user_tenant_id: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'UserTenantId'})
User tenant ID. The value is the tenant id of the user for both individual users and the members in Distribution Group or Mail Enabled Security Group.
dataclass
dataclass
ApprovalMessage(to: str, *, 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 | Mapping[str, Any]]] = 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
class-attribute
instance-attribute
Specify email addresses separated by semicolons like someone@contoso.com
class-attribute
instance-attribute
subject: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Subject'})
Subject
class-attribute
instance-attribute
options: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Options'})
User Options
class-attribute
instance-attribute
header_text: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'HeaderText'})
Header text for email body
class-attribute
instance-attribute
selection_text: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'SelectionText'})
Header text for users options selection
class-attribute
instance-attribute
Body
class-attribute
instance-attribute
importance: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Importance'})
Importance
class-attribute
instance-attribute
attachments: Optional[List[ClientSendAttachment | Mapping[str, Any]]] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Attachments'})
Attachments
class-attribute
instance-attribute
use_only_h_t_m_l_message: Optional[bool] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'UseOnlyHTMLMessage'})
Use only HTML message
class-attribute
instance-attribute
hide_h_t_m_l_message: Optional[bool] = dataclass_field(default=None, kw_only=True, 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.
class-attribute
instance-attribute
show_h_t_m_l_confirmation_dialog: Optional[bool] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'ShowHTMLConfirmationDialog'})
If set to Yes then a dialog wil be shown to confirm selected option of HTML message
dataclass
SharedMailboxClientSendMessage(mailbox_address: str, to: str, subject: str, body: str, *, cc: Optional[str] = None, bcc: Optional[str] = None, attachments: Optional[List[ClientSendAttachment | Mapping[str, Any]]] = None, sensitivity: Optional[str] = None, reply_to: Optional[str] = None, importance: Optional[str] = None, is_html: Optional[bool] = None)
Definition: SharedMailboxClientSendMessage
Attributes
class-attribute
instance-attribute
Specify email address of a shared mailbox like someone@contoso.com
class-attribute
instance-attribute
Specify email addresses separated by semicolons like someone@contoso.com
class-attribute
instance-attribute
Specify the subject of the mail
class-attribute
instance-attribute
Specify the body of the mail
class-attribute
instance-attribute
Specify email addresses separated by semicolons like someone@contoso.com
class-attribute
instance-attribute
Specify email addresses separated by semicolons like someone@contoso.com
class-attribute
instance-attribute
attachments: Optional[List[ClientSendAttachment | Mapping[str, Any]]] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Attachments'})
Attachments
class-attribute
instance-attribute
sensitivity: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Sensitivity'})
Sensitivity
class-attribute
instance-attribute
reply_to: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'ReplyTo'})
The email addresses to use when replying
dataclass
SharedMailboxSendEmailInput(mailbox_address: str, to: str, subject: str, body: str, *, cc: Optional[str] = None, bcc: Optional[str] = None, attachments: Optional[List[ClientSendAttachment | Mapping[str, Any]]] = None, sensitivity: Optional[str] = None, reply_to: Optional[str] = None, importance: Optional[str] = None)
Definition: SharedMailboxClientSendHtmlMessage
Attributes
class-attribute
instance-attribute
Specify email address of a shared mailbox like someone@contoso.com
class-attribute
instance-attribute
Specify email addresses separated by semicolons like someone@contoso.com
class-attribute
instance-attribute
Specify the subject of the mail
class-attribute
instance-attribute
Specify the body of the mail
class-attribute
instance-attribute
Specify email addresses separated by semicolons like someone@contoso.com
class-attribute
instance-attribute
Specify email addresses separated by semicolons like someone@contoso.com
class-attribute
instance-attribute
attachments: Optional[List[ClientSendAttachment | Mapping[str, Any]]] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Attachments'})
Attachments
class-attribute
instance-attribute
sensitivity: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Sensitivity'})
Sensitivity
dataclass
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 | Mapping[str, Any]] = None)
Definition: SubscriptionPayloadEntity[OutlookReceiveMessage]
Attributes
class-attribute
instance-attribute
sequence_number: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'SequenceNumber'})
Sequence number
class-attribute
instance-attribute
change_type: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'ChangeType'})
Change type
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
class-attribute
instance-attribute
type_: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': '@odata.type'})
OData type
class-attribute
instance-attribute
Attachment Id
class-attribute
instance-attribute
Attachment name
class-attribute
instance-attribute
content_bytes: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'ContentBytes'})
Attachment content
class-attribute
instance-attribute
content_type: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'ContentType'})
Attachment content type
class-attribute
instance-attribute
Attachment size in bytes
class-attribute
instance-attribute
permission: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Permission'})
Permission associated with a reference attachment
class-attribute
instance-attribute
provider_type: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'ProviderType'})
Provider for the reference attachment
class-attribute
instance-attribute
source_url: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'SourceUrl'})
Reference attachment source url
class-attribute
instance-attribute
is_inline: Optional[bool] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'IsInline'})
Set to true if this is an inline attachment
dataclass
Definition: InternetMessageHeader
Attributes
class-attribute
instance-attribute
Header name
dataclass
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 | Mapping[str, Any]] = None)
Definition: SubscriptionPayloadEntity[SubscriptionEvent]
Attributes
class-attribute
instance-attribute
sequence_number: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'SequenceNumber'})
Sequence number
class-attribute
instance-attribute
change_type: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'ChangeType'})
Change type
dataclass
dataclass
dataclass
Table(*, name: Optional[str] = None, display_name: Optional[str] = None, dynamic_properties: Optional[Dict[str, ObjectEntity | Mapping[str, Any]]] = None)
Definition: Table
dataclass
dataclass
dataclass
CalendarEventClient(subject: str, start: str, end: str, *, 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
class-attribute
instance-attribute
Event subject
class-attribute
instance-attribute
Start time of the event (example: '2016-11-01T14:30:00Z')
class-attribute
instance-attribute
End time of the event (example: '2016-11-01T15:30:00Z')
class-attribute
instance-attribute
time_zone: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'TimeZone'})
Time zone of the event
class-attribute
instance-attribute
required_attendees: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'RequiredAttendees'})
Required attendees for the event separated by semicolons
class-attribute
instance-attribute
optional_attendees: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'OptionalAttendees'})
Optional attendees for the event separated by semicolons
class-attribute
instance-attribute
resource_attendees: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'ResourceAttendees'})
Resource attendees for the event separated by semicolons
class-attribute
instance-attribute
Body of the message associated with the event
class-attribute
instance-attribute
is_html: Optional[bool] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'IsHtml'})
Set to true if the body is Html
class-attribute
instance-attribute
location: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Location'})
Location of the event
class-attribute
instance-attribute
importance: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Importance'})
The importance of the event: Low, Normal, or High
class-attribute
instance-attribute
is_all_day: Optional[bool] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'IsAllDay'})
Set to true if the event lasts all day
class-attribute
instance-attribute
recurrence: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Recurrence'})
The recurrence pattern for the event
class-attribute
instance-attribute
recurrence_end: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'RecurrenceEnd'})
End time of the recurrence
class-attribute
instance-attribute
number_of_occurrences: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'NumberOfOccurrences'})
How many times to repeat the event
class-attribute
instance-attribute
reminder: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Reminder'})
Time in minutes before event start to remind
dataclass
CalendarEventHtmlClient(subject: str, start: str, end: str, *, 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
class-attribute
instance-attribute
Event subject
class-attribute
instance-attribute
Start time of the event (example: '2016-11-01T14:30:00Z')
class-attribute
instance-attribute
End time of the event (example: '2016-11-01T15:30:00Z')
class-attribute
instance-attribute
time_zone: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'TimeZone'})
Time zone of the event
class-attribute
instance-attribute
required_attendees: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'RequiredAttendees'})
Required attendees for the event separated by semicolons
class-attribute
instance-attribute
optional_attendees: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'OptionalAttendees'})
Optional attendees for the event separated by semicolons
class-attribute
instance-attribute
resource_attendees: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'ResourceAttendees'})
Resource attendees for the event separated by semicolons
class-attribute
instance-attribute
Body of the message associated with the event
class-attribute
instance-attribute
location: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Location'})
Location of the event
class-attribute
instance-attribute
importance: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Importance'})
The importance of the event: Low, Normal, or High
class-attribute
instance-attribute
is_all_day: Optional[bool] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'IsAllDay'})
Set to true if the event lasts all day
class-attribute
instance-attribute
recurrence: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Recurrence'})
The recurrence pattern for the event
class-attribute
instance-attribute
recurrence_end: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'RecurrenceEnd'})
End time of the recurrence
class-attribute
instance-attribute
number_of_occurrences: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'NumberOfOccurrences'})
How many times to repeat the event
class-attribute
instance-attribute
reminder: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Reminder'})
Time in minutes before event start to remind
dataclass
GraphCalendarEventClient(subject: str, start: str, end: str, time_zone: str, *, 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
class-attribute
instance-attribute
Time zone of the event
class-attribute
instance-attribute
required_attendees: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'requiredAttendees'})
Required attendees for the event separated by semicolons
class-attribute
instance-attribute
optional_attendees: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'optionalAttendees'})
Optional attendees for the event separated by semicolons
class-attribute
instance-attribute
resource_attendees: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'resourceAttendees'})
Resource attendees for the event separated by semicolons
class-attribute
instance-attribute
Body of the message associated with the event
class-attribute
instance-attribute
The categories associated with the event
class-attribute
instance-attribute
Location of the event
class-attribute
instance-attribute
The importance of the event: low, normal, or high
class-attribute
instance-attribute
is_all_day: Optional[bool] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'isAllDay'})
Set to true if the event lasts all day
class-attribute
instance-attribute
The recurrence pattern for the event: none, daily, weekly, monthly or yearly
class-attribute
instance-attribute
selected_days_of_week: Optional[List[str]] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'selectedDaysOfWeek'})
Days of week for weekly recurrence
class-attribute
instance-attribute
recurrence_end: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'recurrenceEnd'})
End Date of the recurrence
class-attribute
instance-attribute
number_of_occurences: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'numberOfOccurences'})
How many times to repeat the event
class-attribute
instance-attribute
reminder_minutes_before_start: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'reminderMinutesBeforeStart'})
Time in minutes before event start to remind
class-attribute
instance-attribute
is_reminder_on: Optional[bool] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'isReminderOn'})
Set to true if an alert is set to remind the user of the event.
class-attribute
instance-attribute
show_as: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'showAs'})
Status to show during the event: free, tentative, busy, oof, workingElsewhere or unknown
dataclass
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
class-attribute
instance-attribute
action_type: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'ActionType'})
Changed action type of the event - added, updated or deleted.
class-attribute
instance-attribute
is_added: Optional[bool] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'IsAdded'})
Flag that indicates whether the event was added since the last poll of the trigger.
class-attribute
instance-attribute
is_updated: Optional[bool] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'IsUpdated'})
Flag that indicates whether the event was updated since the last poll of the trigger.
class-attribute
instance-attribute
subject: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Subject'})
Event subject
class-attribute
instance-attribute
Start time of the event (example: '2016-11-01T14:30:00Z')
class-attribute
instance-attribute
End time of the event (example: '2016-11-01T15:30:00Z')
class-attribute
instance-attribute
show_as: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'ShowAs'})
Status to show during the event (Unknown - -1, Free - 0, Tentative - 1, Busy - 2, Oof - 3, WorkingElsewhere - 4)
class-attribute
instance-attribute
recurrence: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Recurrence'})
The recurrence pattern for the event (None - 0, Daily - 1, Weekly - 2, Monthly - 3, Yearly - 4)
class-attribute
instance-attribute
response_type: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'ResponseType'})
The response type of the event (None - 0, Organizer - 1, TentativelyAccepted - 2, Accepted - 3, Declined - 4, NotResponded - 5)
class-attribute
instance-attribute
response_time: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'ResponseTime'})
The response time of the event
class-attribute
instance-attribute
i_cal_u_id: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'ICalUId'})
A unique identifier that is shared by all instances of an event across different calendars
class-attribute
instance-attribute
importance: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Importance'})
The importance of the event (0 - Low, 1 - Normal, 2 - High)
class-attribute
instance-attribute
The event's unique identifier
class-attribute
instance-attribute
date_time_created: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'DateTimeCreated'})
The date and time that the event was created
class-attribute
instance-attribute
date_time_last_modified: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'DateTimeLastModified'})
The date and time that the event was last modified
class-attribute
instance-attribute
organizer: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Organizer'})
The organizer of the event
class-attribute
instance-attribute
time_zone: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'TimeZone'})
Time zone of the event
class-attribute
instance-attribute
series_master_id: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'SeriesMasterId'})
Unique identifier for Series Master event type
class-attribute
instance-attribute
categories: Optional[List[str]] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Categories'})
The categories associated with the event
class-attribute
instance-attribute
web_link: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'WebLink'})
The URL to open the event in Outlook Web App
class-attribute
instance-attribute
required_attendees: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'RequiredAttendees'})
Required attendees for the event separated by semicolons
class-attribute
instance-attribute
optional_attendees: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'OptionalAttendees'})
Optional attendees for the event separated by semicolons
class-attribute
instance-attribute
resource_attendees: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'ResourceAttendees'})
Resource attendees for the event separated by semicolons
class-attribute
instance-attribute
Body of the message associated with the event
class-attribute
instance-attribute
is_html: Optional[bool] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'IsHtml'})
Set to true if the body is Html
class-attribute
instance-attribute
location: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'Location'})
Location of the event
class-attribute
instance-attribute
is_all_day: Optional[bool] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'IsAllDay'})
Set to true if the event lasts all day
class-attribute
instance-attribute
recurrence_end: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'RecurrenceEnd'})
End time of the recurrence
class-attribute
instance-attribute
number_of_occurrences: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'NumberOfOccurrences'})
How many times to repeat the event
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
class-attribute
instance-attribute
action_type: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'ActionType'})
Changed action type of the event - added, updated or deleted.
class-attribute
instance-attribute
is_added: Optional[bool] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'IsAdded'})
Flag that indicates whether the event was added since the last poll of the trigger.
class-attribute
instance-attribute
is_updated: Optional[bool] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'IsUpdated'})
Flag that indicates whether the event was updated since the last poll of the trigger.
class-attribute
instance-attribute
Event subject
class-attribute
instance-attribute
Start time of the event (example: '2017-08-29T04:00:00.0000000')
class-attribute
instance-attribute
End time of the event (example: '2017-08-29T05:00:00.0000000')
class-attribute
instance-attribute
start_with_time_zone: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'startWithTimeZone'})
Start time of the event with time zone (example: '2017-08-29T04:00:00.0000000+00:00')
class-attribute
instance-attribute
end_with_time_zone: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'endWithTimeZone'})
End time of the event with time zone (example: '2017-08-29T05:00:00.0000000+00:00')
class-attribute
instance-attribute
Body of the message associated with the event
class-attribute
instance-attribute
is_html: Optional[bool] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'isHtml'})
Set to true if the body is Html
class-attribute
instance-attribute
response_type: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'responseType'})
The response type of the event (none, organizer, tentativelyAccepted, accepted, declined or notResponded)
class-attribute
instance-attribute
response_time: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'responseTime'})
The response time of the event
class-attribute
instance-attribute
The event's unique identifier
class-attribute
instance-attribute
created_date_time: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'createdDateTime'})
The date and time that the event was created
class-attribute
instance-attribute
last_modified_date_time: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'lastModifiedDateTime'})
The date and time that the event was last modified
class-attribute
instance-attribute
The organizer of the event
class-attribute
instance-attribute
time_zone: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'timeZone'})
Time zone of the event
class-attribute
instance-attribute
series_master_id: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'seriesMasterId'})
Unique identifier for Series Master event type
class-attribute
instance-attribute
i_cal_u_id: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'iCalUId'})
A unique identifier for an event across calendars. This ID is different for each occurrence in a recurring series
class-attribute
instance-attribute
The categories associated with the event
class-attribute
instance-attribute
web_link: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'webLink'})
The URL to open the event in Outlook Web App
class-attribute
instance-attribute
required_attendees: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'requiredAttendees'})
Required attendees for the event separated by semicolons
class-attribute
instance-attribute
optional_attendees: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'optionalAttendees'})
Optional attendees for the event separated by semicolons
class-attribute
instance-attribute
resource_attendees: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'resourceAttendees'})
Resource attendees for the event separated by semicolons
class-attribute
instance-attribute
Location of the event
class-attribute
instance-attribute
The importance of the event: low, normal, or high
class-attribute
instance-attribute
is_all_day: Optional[bool] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'isAllDay'})
Set to true if the event lasts all day
class-attribute
instance-attribute
The recurrence pattern for the event: none, daily, weekly, monthly or yearly
class-attribute
instance-attribute
recurrence_end: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'recurrenceEnd'})
End Date of the recurrence
class-attribute
instance-attribute
number_of_occurences: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'numberOfOccurences'})
How many times to repeat the event
class-attribute
instance-attribute
reminder_minutes_before_start: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'reminderMinutesBeforeStart'})
Time in minutes before event start to remind
class-attribute
instance-attribute
is_reminder_on: Optional[bool] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'isReminderOn'})
Set to true if an alert is set to remind the user of the event.
class-attribute
instance-attribute
show_as: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'showAs'})
Status to show during the event: free, tentative, busy, oof, workingElsewhere or unknown
dataclass
GraphContactFolder(*, id: Optional[str] = None, display_name: Optional[str] = None, parent_folder_id: Optional[str] = None)
Definition: GraphContactFolder
dataclass
dataclass
DataSet(*, name: Optional[str] = None, display_name: Optional[str] = None, query: Optional[List[PassThroughNativeQuery | Mapping[str, Any]]] = None)
dataclass
Definition: Procedure
Attributes
class-attribute
instance-attribute
Procedure name
dataclass
dataclass
AutomaticRepliesSettingClient(status: str, external_audience: str, *, 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
class-attribute
instance-attribute
The audience that will see the external reply message
class-attribute
instance-attribute
scheduled_start_date_time: Optional[Dict[str, Any]] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'scheduledStartDateTime'})
Scheduled start time (example: '2017-08-29T04:00:00.0000000')
class-attribute
instance-attribute
scheduled_end_date_time: Optional[Dict[str, Any]] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'scheduledEndDateTime'})
Scheduled end time (example: '2017-08-29T05:00:00.0000000')
dataclass
MailTipsClientReceive(*, automatic_replies: Optional[MailTipsAutomaticReplies | Mapping[str, Any]] = 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
class-attribute
instance-attribute
delivery_restricted: Optional[bool] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'deliveryRestricted'})
Is delivery restricted
class-attribute
instance-attribute
external_member_count: Optional[int] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'externalMemberCount'})
Number of external members
class-attribute
instance-attribute
is_moderated: Optional[bool] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'isModerated'})
Is moderated
class-attribute
instance-attribute
mailbox_full: Optional[bool] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'mailboxFull'})
Is mailbox full
dataclass
dataclass
dataclass
dataclass
dataclass
LocationConstraint(*, is_required: Optional[bool] = None, suggest_location: Optional[bool] = None, locations: Optional[List[Dict[str, Any]]] = None)
Definition: LocationConstraint
Attributes
class-attribute
instance-attribute
is_required: Optional[bool] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'IsRequired'})
Should a meeting location be returned for the meeting?
dataclass
dataclass
Definition: EmailAddress_V2
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
class-attribute
instance-attribute
The contact's street address.
class-attribute
instance-attribute
The contact's city.
class-attribute
instance-attribute
The contact's state.
dataclass
Contact(given_name: str, home_phones: List[str], *, id: Optional[str] = None, parent_folder_id: Optional[str] = None, birthday: Optional[str] = None, file_as: Optional[str] = None, display_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 | Mapping[str, Any]]] = 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, business_phones: Optional[List[str]] = None, mobile_phone: Optional[str] = None, home_address: Optional[PhysicalAddress | Mapping[str, Any]] = None, business_address: Optional[PhysicalAddress | Mapping[str, Any]] = None, other_address: Optional[PhysicalAddress | Mapping[str, Any]] = 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
class-attribute
instance-attribute
The contact's unique identifier.
class-attribute
instance-attribute
parent_folder_id: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'parentFolderId'})
The ID of the contact's parent folder
class-attribute
instance-attribute
The contact's birthday
class-attribute
instance-attribute
file_as: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'fileAs'})
The name the contact is filed under
class-attribute
instance-attribute
display_name: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'displayName'})
The contact's display name
class-attribute
instance-attribute
The contact's given name
class-attribute
instance-attribute
The contact's initials
class-attribute
instance-attribute
middle_name: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'middleName'})
The contact's middle name
class-attribute
instance-attribute
nick_name: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'nickName'})
The contact's nickname
class-attribute
instance-attribute
The contact's surname
class-attribute
instance-attribute
The contact's title
class-attribute
instance-attribute
The contact's generation
class-attribute
instance-attribute
email_addresses: Optional[List[EmailAddressV2 | Mapping[str, Any]]] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'emailAddresses'})
The contact's email addresses
class-attribute
instance-attribute
im_addresses: Optional[List[str]] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'imAddresses'})
The contact's instant messaging (IM) addresses
class-attribute
instance-attribute
job_title: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'jobTitle'})
The contact's job title
class-attribute
instance-attribute
company_name: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'companyName'})
The name of the contact's company
class-attribute
instance-attribute
The contact's department
class-attribute
instance-attribute
office_location: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'officeLocation'})
The location of the contact's office
class-attribute
instance-attribute
The contact's profession
class-attribute
instance-attribute
business_home_page: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'businessHomePage'})
The business home page of the contact
class-attribute
instance-attribute
assistant_name: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'assistantName'})
The name of the contact's assistant
class-attribute
instance-attribute
The name of the contact's manager
class-attribute
instance-attribute
The contact's home phone numbers
class-attribute
instance-attribute
business_phones: Optional[List[str]] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'businessPhones'})
The contact's business phone numbers
class-attribute
instance-attribute
mobile_phone: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'mobilePhone'})
The contact's mobile phone number
class-attribute
instance-attribute
yomi_company_name: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'yomiCompanyName'})
The phonetic Japanese company name of the contact
class-attribute
instance-attribute
yomi_given_name: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'yomiGivenName'})
The phonetic Japanese given name (first name) of the contact
class-attribute
instance-attribute
yomi_surname: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'yomiSurname'})
The phonetic Japanese surname (last name) of the contact
class-attribute
instance-attribute
The categories associated with the contact
class-attribute
instance-attribute
change_key: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'changeKey'})
Identifies the version of the event object
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
class-attribute
instance-attribute
sensitivity_label_id: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'sensitivityLabelId'})
SensitivityLabel Id.
class-attribute
instance-attribute
SensitivityLabel name.
class-attribute
instance-attribute
display_name: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'displayName'})
SensitivityLabel displayName info
class-attribute
instance-attribute
SensitivityLabel details on tooltip.
class-attribute
instance-attribute
SensitivityLabel priority.
class-attribute
instance-attribute
SensitivityLabel color.
class-attribute
instance-attribute
is_encrypted: Optional[bool] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'isEncrypted'})
is SensitivityLabel Encrypted.
class-attribute
instance-attribute
is_enabled: Optional[bool] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'isEnabled'})
Whether SensitivityLabel is Enabled.
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(connection_runtime_url: str, credential: AsyncTokenCredential | AzureKeyCredential, *, max_retry_attempts: int = 3, timeout: float = 30.0, use_exponential_backoff: bool = True, initial_retry_delay_seconds: float = 0.5, maximum_retry_delay_seconds: float = 120.0, retry_jitter_factor: float = 0.1, retry_unsafe_http_methods: bool = False, transport: Optional[AsyncHttpTransport] = None, **kwargs: Any)
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 |
credential
|
AsyncTokenCredential | AzureKeyCredential
|
Caller-owned Azure Core credential. |
required |
max_retry_attempts
|
int
|
The maximum number of request attempts. |
3
|
timeout
|
float
|
The network timeout in seconds for each request. The value configures Azure Core retry and transport deadlines. Nonpositive values disable SDK and transport deadlines. |
30.0
|
use_exponential_backoff
|
bool
|
Whether retries use exponential backoff. |
True
|
initial_retry_delay_seconds
|
float
|
The initial retry delay in seconds. |
0.5
|
maximum_retry_delay_seconds
|
float
|
The maximum retry delay in seconds. |
120.0
|
retry_jitter_factor
|
float
|
The jitter fraction applied to retry delays. |
0.1
|
retry_unsafe_http_methods
|
bool
|
Whether unsafe HTTP methods may be retried. |
False
|
transport
|
Optional[AsyncHttpTransport]
|
Optional Azure Core async HTTP transport closed by the client through its asynchronous lifecycle. |
None
|
**kwargs
|
Any
|
Optional Azure Core pipeline policy settings. |
{}
|
Methods:
list_outlook_category_names(*, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> AsyncItemPaged[dict[str, Any]]
Get Outlook category names
This operation gets Outlook category display names.
Returns a single-page Azure Core async collection.
Swagger operation ID: GetOutlookCategoryNames.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
timeout
|
Optional[float]
|
The request timeout in seconds. |
None
|
headers
|
Optional[Mapping[str, str]]
|
Additional HTTP request headers. |
None
|
client_request_id
|
Optional[str]
|
A caller-provided request identifier. |
None
|
response_hook
|
Optional[ConnectorResponseHook]
|
A callback invoked with the connector response. |
None
|
Returns:
| Type | Description |
|---|---|
AsyncItemPaged[dict[str, Any]]
|
AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector
results. Consume it with |
Raises:
| Type | Description |
|---|---|
ConnectorException
|
If the connector request fails. |
async
draft_email(input: DraftEmailInput | Mapping[str, Any], *, message_id: Optional[str] = None, draft_type: Optional[str] = None, comment: Optional[str] = None, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None
Draft an email message
This operation drafts an email message.
Swagger operation ID: DraftEmail.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
input
|
DraftEmailInput | Mapping[str, Any]
|
The request body. Mapping keys use serialized Swagger wire names. |
required |
message_id
|
Optional[str]
|
Message Id. |
None
|
draft_type
|
Optional[str]
|
Draft Type. |
None
|
comment
|
Optional[str]
|
Draft Comment. |
None
|
timeout
|
Optional[float]
|
The request timeout in seconds. |
None
|
headers
|
Optional[Mapping[str, str]]
|
Additional HTTP request headers. |
None
|
client_request_id
|
Optional[str]
|
A caller-provided request identifier. |
None
|
response_hook
|
Optional[ConnectorResponseHook]
|
A callback invoked with the connector response. |
None
|
Returns:
| Type | Description |
|---|---|
dict[str, Any] | None
|
dict[str, Any] | None: The connector operation result. |
Raises:
| Type | Description |
|---|---|
ConnectorException
|
If the connector request fails. |
async
update_draft_email(input: DraftEmailInput | Mapping[str, Any], message_id: str, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> None
Updates an email Draft message
This operation updates an an email Draft message.
Swagger operation ID: UpdateDraftEmail.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
input
|
DraftEmailInput | Mapping[str, Any]
|
The request body. Mapping keys use serialized Swagger wire names. |
required |
message_id
|
str
|
Message Id. |
required |
timeout
|
Optional[float]
|
The request timeout in seconds. |
None
|
headers
|
Optional[Mapping[str, str]]
|
Additional HTTP request headers. |
None
|
client_request_id
|
Optional[str]
|
A caller-provided request identifier. |
None
|
response_hook
|
Optional[ConnectorResponseHook]
|
A callback invoked with the connector response. |
None
|
Returns:
| Name | Type | Description |
|---|---|---|
None |
None
|
The operation completes without a response body. |
Raises:
| Type | Description |
|---|---|
ConnectorException
|
If the connector request fails. |
async
send_draft_email(message_id: str, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> None
Send a Draft message
This operation sends a Draft message.
Swagger operation ID: SendDraftEmail.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
message_id
|
str
|
Message Id. |
required |
timeout
|
Optional[float]
|
The request timeout in seconds. |
None
|
headers
|
Optional[Mapping[str, str]]
|
Additional HTTP request headers. |
None
|
client_request_id
|
Optional[str]
|
A caller-provided request identifier. |
None
|
response_hook
|
Optional[ConnectorResponseHook]
|
A callback invoked with the connector response. |
None
|
Returns:
| Name | Type | Description |
|---|---|---|
None |
None
|
The operation completes without a response body. |
Raises:
| Type | Description |
|---|---|
ConnectorException
|
If the connector request fails. |
async
assign_category(message_id: str, category: str, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> None
Assigns an Outlook category
This operation assigns an Outlook category to an email.
Swagger operation ID: AssignCategory.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
message_id
|
str
|
Message Id. |
required |
category
|
str
|
Category. |
required |
timeout
|
Optional[float]
|
The request timeout in seconds. |
None
|
headers
|
Optional[Mapping[str, str]]
|
Additional HTTP request headers. |
None
|
client_request_id
|
Optional[str]
|
A caller-provided request identifier. |
None
|
response_hook
|
Optional[ConnectorResponseHook]
|
A callback invoked with the connector response. |
None
|
Returns:
| Name | Type | Description |
|---|---|---|
None |
None
|
The operation completes without a response body. |
Raises:
| Type | Description |
|---|---|
ConnectorException
|
If the connector request fails. |
async
assign_category_bulk(input: AssignCategoryBulkInput, category_name: str, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None
Assign a category to multiple emails
This operation assigns an Outlook category to multiple emails.
Swagger operation ID: AssignCategoryBulk.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
input
|
AssignCategoryBulkInput
|
The request body. |
required |
category_name
|
str
|
Category Name. |
required |
timeout
|
Optional[float]
|
The request timeout in seconds. |
None
|
headers
|
Optional[Mapping[str, str]]
|
Additional HTTP request headers. |
None
|
client_request_id
|
Optional[str]
|
A caller-provided request identifier. |
None
|
response_hook
|
Optional[ConnectorResponseHook]
|
A callback invoked with the connector response. |
None
|
Returns:
| Type | Description |
|---|---|
dict[str, Any] | None
|
dict[str, Any] | None: The connector operation result. |
Raises:
| Type | Description |
|---|---|
ConnectorException
|
If the connector request fails. |
async
send_mail_with_options(input: OptionsEmailSubscription | Mapping[str, Any], *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None
Send email with options
This operation sends an email with multiple options and waits for the recipient to respond back with one of the options. Please refer to the following link regarding the support of actionable messages in different mail clients: https://docs.microsoft.com/outlook/actionable-messages/#outlook-version-requirements-for-actionable-messages.
Swagger operation ID: SendMailWithOptions.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
input
|
OptionsEmailSubscription | Mapping[str, Any]
|
The request body. Mapping keys use serialized Swagger wire names. |
required |
timeout
|
Optional[float]
|
The request timeout in seconds. |
None
|
headers
|
Optional[Mapping[str, str]]
|
Additional HTTP request headers. |
None
|
client_request_id
|
Optional[str]
|
A caller-provided request identifier. |
None
|
response_hook
|
Optional[ConnectorResponseHook]
|
A callback invoked with the connector response. |
None
|
Returns:
| Type | Description |
|---|---|
dict[str, Any] | None
|
dict[str, Any] | None: The connector operation result. |
Raises:
| Type | Description |
|---|---|
ConnectorException
|
If the connector request fails. |
async
send_approval_mail(input: ApprovalEmailSubscription | Mapping[str, Any], *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None
Send approval email
This operation sends an approval email and waits for a response from the recipient. Please refer to the following link regarding the support of actionable messages in different mail clients: https://docs.microsoft.com/outlook/actionable-messages/#outlook-version-requirements-for-actionable-messages.
Swagger operation ID: SendApprovalMail.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
input
|
ApprovalEmailSubscription | Mapping[str, Any]
|
The request body. Mapping keys use serialized Swagger wire names. |
required |
timeout
|
Optional[float]
|
The request timeout in seconds. |
None
|
headers
|
Optional[Mapping[str, str]]
|
Additional HTTP request headers. |
None
|
client_request_id
|
Optional[str]
|
A caller-provided request identifier. |
None
|
response_hook
|
Optional[ConnectorResponseHook]
|
A callback invoked with the connector response. |
None
|
Returns:
| Type | Description |
|---|---|
dict[str, Any] | None
|
dict[str, Any] | None: The connector operation result. |
Raises:
| Type | Description |
|---|---|
ConnectorException
|
If the connector request fails. |
async
update_my_contact_photo(input: bytes, folder: str, id: str, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> None
Update my contact's photo
Updates the photo of the specified contact of the current user. The size of the photo must be less than 4 MB.
Swagger operation ID: UpdateMyContactPhoto.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
input
|
bytes
|
The binary request body. |
required |
folder
|
str
|
Select a contacts folder. |
required |
id
|
str
|
Unique identifier of a contact to update photo. |
required |
timeout
|
Optional[float]
|
The request timeout in seconds. |
None
|
headers
|
Optional[Mapping[str, str]]
|
Additional HTTP request headers. |
None
|
client_request_id
|
Optional[str]
|
A caller-provided request identifier. |
None
|
response_hook
|
Optional[ConnectorResponseHook]
|
A callback invoked with the connector response. |
None
|
Returns:
| Name | Type | Description |
|---|---|---|
None |
None
|
The operation completes without a response body. |
Raises:
| Type | Description |
|---|---|
ConnectorException
|
If the connector request fails. |
async
http_request(input: bytes, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None
Send an HTTP request
Construct a Microsoft Graph REST API request to invoke. These segments
are supported: 1st segement: /me, /users/
Swagger operation ID: HttpRequest.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
input
|
bytes
|
The binary request body. |
required |
timeout
|
Optional[float]
|
The request timeout in seconds. |
None
|
headers
|
Optional[Mapping[str, str]]
|
Additional HTTP request headers. |
None
|
client_request_id
|
Optional[str]
|
A caller-provided request identifier. |
None
|
response_hook
|
Optional[ConnectorResponseHook]
|
A callback invoked with the connector response. |
None
|
Returns:
| Type | Description |
|---|---|
dict[str, Any] | None
|
dict[str, Any] | None: The connector operation result. |
Raises:
| Type | Description |
|---|---|
ConnectorException
|
If the connector request fails. |
async
mcp_emails_management(input: MCPQueryRequest | Mapping[str, Any], *, session_id: Optional[str] = None, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None
Email Management MCP Server (deprecated)
This MCP server manages email messages from your Office 365 account
Swagger operation ID: mcp_EmailsManagement.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
input
|
MCPQueryRequest | Mapping[str, Any]
|
The request body. Mapping keys use serialized Swagger wire names. |
required |
session_id
|
Optional[str]
|
sessionId. |
None
|
timeout
|
Optional[float]
|
The request timeout in seconds. |
None
|
headers
|
Optional[Mapping[str, str]]
|
Additional HTTP request headers. |
None
|
client_request_id
|
Optional[str]
|
A caller-provided request identifier. |
None
|
response_hook
|
Optional[ConnectorResponseHook]
|
A callback invoked with the connector response. |
None
|
Returns:
| Type | Description |
|---|---|
dict[str, Any] | None
|
dict[str, Any] | None: The connector operation result. |
Raises:
| Type | Description |
|---|---|
ConnectorException
|
If the connector request fails. |
async
mcp_meeting_management(input: MCPQueryRequest | Mapping[str, Any], *, session_id: Optional[str] = None, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None
Meeting Management MCP Server (deprecated)
This MCP server manages events, calendars and meetings
Swagger operation ID: mcp_MeetingManagement.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
input
|
MCPQueryRequest | Mapping[str, Any]
|
The request body. Mapping keys use serialized Swagger wire names. |
required |
session_id
|
Optional[str]
|
sessionId. |
None
|
timeout
|
Optional[float]
|
The request timeout in seconds. |
None
|
headers
|
Optional[Mapping[str, str]]
|
Additional HTTP request headers. |
None
|
client_request_id
|
Optional[str]
|
A caller-provided request identifier. |
None
|
response_hook
|
Optional[ConnectorResponseHook]
|
A callback invoked with the connector response. |
None
|
Returns:
| Type | Description |
|---|---|
dict[str, Any] | None
|
dict[str, Any] | None: The connector operation result. |
Raises:
| Type | Description |
|---|---|
ConnectorException
|
If the connector request fails. |
async
mcp_contacts_management(input: MCPQueryRequest | Mapping[str, Any], *, session_id: Optional[str] = None, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None
Contact Management MCP Server
This MCP server manages contacts
Swagger operation ID: mcp_ContactsManagement.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
input
|
MCPQueryRequest | Mapping[str, Any]
|
The request body. Mapping keys use serialized Swagger wire names. |
required |
session_id
|
Optional[str]
|
sessionId. |
None
|
timeout
|
Optional[float]
|
The request timeout in seconds. |
None
|
headers
|
Optional[Mapping[str, str]]
|
Additional HTTP request headers. |
None
|
client_request_id
|
Optional[str]
|
A caller-provided request identifier. |
None
|
response_hook
|
Optional[ConnectorResponseHook]
|
A callback invoked with the connector response. |
None
|
Returns:
| Type | Description |
|---|---|
dict[str, Any] | None
|
dict[str, Any] | None: The connector operation result. |
Raises:
| Type | Description |
|---|---|
ConnectorException
|
If the connector request fails. |
async
calendar_delete_item(calendar: str, event: str, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> None
Delete event
This operation deletes an event in a calendar.
Swagger operation ID: CalendarDeleteItem_V2.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
calendar
|
str
|
Select a calendar. |
required |
event
|
str
|
Select an event. |
required |
timeout
|
Optional[float]
|
The request timeout in seconds. |
None
|
headers
|
Optional[Mapping[str, str]]
|
Additional HTTP request headers. |
None
|
client_request_id
|
Optional[str]
|
A caller-provided request identifier. |
None
|
response_hook
|
Optional[ConnectorResponseHook]
|
A callback invoked with the connector response. |
None
|
Returns:
| Name | Type | Description |
|---|---|---|
None |
None
|
The operation completes without a response body. |
Raises:
| Type | Description |
|---|---|
ConnectorException
|
If the connector request fails. |
async
calendar_get_item(table: str, id: str, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None
Get event
This operation gets a specific event from a calendar using Graph API.
Swagger operation ID: V3CalendarGetItem.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
table
|
str
|
Select a calendar. |
required |
id
|
str
|
Select an event. |
required |
timeout
|
Optional[float]
|
The request timeout in seconds. |
None
|
headers
|
Optional[Mapping[str, str]]
|
Additional HTTP request headers. |
None
|
client_request_id
|
Optional[str]
|
A caller-provided request identifier. |
None
|
response_hook
|
Optional[ConnectorResponseHook]
|
A callback invoked with the connector response. |
None
|
Returns:
| Type | Description |
|---|---|
dict[str, Any] | None
|
dict[str, Any] | None: The connector operation result. |
Raises:
| Type | Description |
|---|---|
ConnectorException
|
If the connector request fails. |
list_calendar_get_items(table: str, *, filter: Optional[str] = None, orderby: Optional[str] = None, top: Optional[int] = None, skip: Optional[int] = None, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> AsyncItemPaged[dict[str, Any]]
Get events
This operation gets events from a calendar using Graph API.
Returns a single-page Azure Core async collection.
Swagger operation ID: V4CalendarGetItems.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
table
|
str
|
Select a calendar. |
required |
filter
|
Optional[str]
|
An ODATA filter query to restrict the entries returned (e.g. stringColumn eq 'string' OR numberColumn lt 123). |
None
|
orderby
|
Optional[str]
|
An ODATA orderBy query for specifying the order of entries. |
None
|
top
|
Optional[int]
|
Total number of entries to retrieve (default = all). |
None
|
skip
|
Optional[int]
|
The number of entries to skip (default = 0). |
None
|
timeout
|
Optional[float]
|
The request timeout in seconds. |
None
|
headers
|
Optional[Mapping[str, str]]
|
Additional HTTP request headers. |
None
|
client_request_id
|
Optional[str]
|
A caller-provided request identifier. |
None
|
response_hook
|
Optional[ConnectorResponseHook]
|
A callback invoked with the connector response. |
None
|
Returns:
| Type | Description |
|---|---|
AsyncItemPaged[dict[str, Any]]
|
AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector
results. Consume it with |
Raises:
| Type | Description |
|---|---|
ConnectorException
|
If the connector request fails. |
list_calendar_get_tables(*, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> AsyncItemPaged[dict[str, Any]]
Get calendars
This operation lists available calendars.
Returns a single-page Azure Core async collection.
Swagger operation ID: CalendarGetTables_V2.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
timeout
|
Optional[float]
|
The request timeout in seconds. |
None
|
headers
|
Optional[Mapping[str, str]]
|
Additional HTTP request headers. |
None
|
client_request_id
|
Optional[str]
|
A caller-provided request identifier. |
None
|
response_hook
|
Optional[ConnectorResponseHook]
|
A callback invoked with the connector response. |
None
|
Returns:
| Type | Description |
|---|---|
AsyncItemPaged[dict[str, Any]]
|
AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector
results. Consume it with |
Raises:
| Type | Description |
|---|---|
ConnectorException
|
If the connector request fails. |
async
calendar_patch_item(input: GraphCalendarEventClient | Mapping[str, Any], table: str, id: str, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None
Update event
This operation updates an event in a calendar using Graph API.
Swagger operation ID: V4CalendarPatchItem.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
input
|
GraphCalendarEventClient | Mapping[str, Any]
|
The request body. Mapping keys use serialized Swagger wire names. |
required |
table
|
str
|
Select a calendar. |
required |
id
|
str
|
Select an event. |
required |
timeout
|
Optional[float]
|
The request timeout in seconds. |
None
|
headers
|
Optional[Mapping[str, str]]
|
Additional HTTP request headers. |
None
|
client_request_id
|
Optional[str]
|
A caller-provided request identifier. |
None
|
response_hook
|
Optional[ConnectorResponseHook]
|
A callback invoked with the connector response. |
None
|
Returns:
| Type | Description |
|---|---|
dict[str, Any] | None
|
dict[str, Any] | None: The connector operation result. |
Raises:
| Type | Description |
|---|---|
ConnectorException
|
If the connector request fails. |
async
calendar_post_item(input: GraphCalendarEventClient | Mapping[str, Any], table: str, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None
Create event
This operation creates a new event in a calendar.
Swagger operation ID: V4CalendarPostItem.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
input
|
GraphCalendarEventClient | Mapping[str, Any]
|
The request body. Mapping keys use serialized Swagger wire names. |
required |
table
|
str
|
Select a calendar. |
required |
timeout
|
Optional[float]
|
The request timeout in seconds. |
None
|
headers
|
Optional[Mapping[str, str]]
|
Additional HTTP request headers. |
None
|
client_request_id
|
Optional[str]
|
A caller-provided request identifier. |
None
|
response_hook
|
Optional[ConnectorResponseHook]
|
A callback invoked with the connector response. |
None
|
Returns:
| Type | Description |
|---|---|
dict[str, Any] | None
|
dict[str, Any] | None: The connector operation result. |
Raises:
| Type | Description |
|---|---|
ConnectorException
|
If the connector request fails. |
async
contact_delete_item(folder: str, id: str, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> None
Delete contact
This operation deletes a contact from a contacts folder.
Swagger operation ID: ContactDeleteItem_V2.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
folder
|
str
|
Select a contacts folder. |
required |
id
|
str
|
Unique identifier of contact to delete. |
required |
timeout
|
Optional[float]
|
The request timeout in seconds. |
None
|
headers
|
Optional[Mapping[str, str]]
|
Additional HTTP request headers. |
None
|
client_request_id
|
Optional[str]
|
A caller-provided request identifier. |
None
|
response_hook
|
Optional[ConnectorResponseHook]
|
A callback invoked with the connector response. |
None
|
Returns:
| Name | Type | Description |
|---|---|---|
None |
None
|
The operation completes without a response body. |
Raises:
| Type | Description |
|---|---|
ConnectorException
|
If the connector request fails. |
async
contact_get_item(folder: str, id: str, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None
Get contact
This operation gets a specific contact from a contacts folder.
Swagger operation ID: ContactGetItem_V2.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
folder
|
str
|
Select a contacts folder. |
required |
id
|
str
|
Unique identifier of a contact to retrieve. |
required |
timeout
|
Optional[float]
|
The request timeout in seconds. |
None
|
headers
|
Optional[Mapping[str, str]]
|
Additional HTTP request headers. |
None
|
client_request_id
|
Optional[str]
|
A caller-provided request identifier. |
None
|
response_hook
|
Optional[ConnectorResponseHook]
|
A callback invoked with the connector response. |
None
|
Returns:
| Type | Description |
|---|---|
dict[str, Any] | None
|
dict[str, Any] | None: The connector operation result. |
Raises:
| Type | Description |
|---|---|
ConnectorException
|
If the connector request fails. |
list_contact_get_items(folder: str, *, filter: Optional[str] = None, orderby: Optional[str] = None, top: Optional[int] = None, skip: Optional[int] = None, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> AsyncItemPaged[dict[str, Any]]
Get contacts
This operation gets contacts from a contacts folder.
Returns an Azure Core async pager that follows the connector continuation URL.
Swagger operation ID: ContactGetItems_V2.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
folder
|
str
|
Unique identifier of the contacts folder to retrieve. |
required |
filter
|
Optional[str]
|
An ODATA filter query to restrict the entries returned (e.g. stringColumn eq 'string' OR numberColumn lt 123). |
None
|
orderby
|
Optional[str]
|
An ODATA orderBy query for specifying the order of entries. |
None
|
top
|
Optional[int]
|
Total number of entries to retrieve (default = all). |
None
|
skip
|
Optional[int]
|
The number of entries to skip (default = 0). |
None
|
timeout
|
Optional[float]
|
The request timeout in seconds. |
None
|
headers
|
Optional[Mapping[str, str]]
|
Additional HTTP request headers. |
None
|
client_request_id
|
Optional[str]
|
A caller-provided request identifier. |
None
|
response_hook
|
Optional[ConnectorResponseHook]
|
A callback invoked with the connector response. |
None
|
Returns:
| Type | Description |
|---|---|
AsyncItemPaged[dict[str, Any]]
|
AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector
results. Consume it with |
Raises:
| Type | Description |
|---|---|
ConnectorException
|
If the connector request fails. |
list_contact_get_tables(*, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> AsyncItemPaged[dict[str, Any]]
Get contact folders
This operation lists available contacts folders using Graph API
Returns a single-page Azure Core async collection.
Swagger operation ID: ContactGetTablesV2.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
timeout
|
Optional[float]
|
The request timeout in seconds. |
None
|
headers
|
Optional[Mapping[str, str]]
|
Additional HTTP request headers. |
None
|
client_request_id
|
Optional[str]
|
A caller-provided request identifier. |
None
|
response_hook
|
Optional[ConnectorResponseHook]
|
A callback invoked with the connector response. |
None
|
Returns:
| Type | Description |
|---|---|
AsyncItemPaged[dict[str, Any]]
|
AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector
results. Consume it with |
Raises:
| Type | Description |
|---|---|
ConnectorException
|
If the connector request fails. |
async
contact_patch_item(input: Contact | Mapping[str, Any], folder: str, id: str, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None
Update contact
This operation updates a contact in a contacts folder.
Swagger operation ID: ContactPatchItem_V2.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
input
|
Contact | Mapping[str, Any]
|
The request body. Mapping keys use serialized Swagger wire names. |
required |
folder
|
str
|
Select a contacts folder. |
required |
id
|
str
|
Unique identifier of contact to update. |
required |
timeout
|
Optional[float]
|
The request timeout in seconds. |
None
|
headers
|
Optional[Mapping[str, str]]
|
Additional HTTP request headers. |
None
|
client_request_id
|
Optional[str]
|
A caller-provided request identifier. |
None
|
response_hook
|
Optional[ConnectorResponseHook]
|
A callback invoked with the connector response. |
None
|
Returns:
| Type | Description |
|---|---|
dict[str, Any] | None
|
dict[str, Any] | None: The connector operation result. |
Raises:
| Type | Description |
|---|---|
ConnectorException
|
If the connector request fails. |
async
contact_post_item(input: Contact | Mapping[str, Any], folder: str, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None
Create contact
This operation creates a new contact in a contacts folder.
Swagger operation ID: ContactPostItem_V2.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
input
|
Contact | Mapping[str, Any]
|
The request body. Mapping keys use serialized Swagger wire names. |
required |
folder
|
str
|
Select a contacts folder. |
required |
timeout
|
Optional[float]
|
The request timeout in seconds. |
None
|
headers
|
Optional[Mapping[str, str]]
|
Additional HTTP request headers. |
None
|
client_request_id
|
Optional[str]
|
A caller-provided request identifier. |
None
|
response_hook
|
Optional[ConnectorResponseHook]
|
A callback invoked with the connector response. |
None
|
Returns:
| Type | Description |
|---|---|
dict[str, Any] | None
|
dict[str, Any] | None: The connector operation result. |
Raises:
| Type | Description |
|---|---|
ConnectorException
|
If the connector request fails. |
async
delete_email(message_id: str, *, mailbox_address: Optional[str] = None, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> None
Delete email
This operation deletes an email by id.
Swagger operation ID: DeleteEmail_V2.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
message_id
|
str
|
Id of the email to delete. |
required |
mailbox_address
|
Optional[str]
|
Address of the shared mailbox to delete mail from. |
None
|
timeout
|
Optional[float]
|
The request timeout in seconds. |
None
|
headers
|
Optional[Mapping[str, str]]
|
Additional HTTP request headers. |
None
|
client_request_id
|
Optional[str]
|
A caller-provided request identifier. |
None
|
response_hook
|
Optional[ConnectorResponseHook]
|
A callback invoked with the connector response. |
None
|
Returns:
| Name | Type | Description |
|---|---|---|
None |
None
|
The operation completes without a response body. |
Raises:
| Type | Description |
|---|---|
ConnectorException
|
If the connector request fails. |
async
export_email(message_id: str, *, mailbox_address: Optional[str] = None, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> bytes
Export email
Export the content of the email in the EML file format.
Swagger operation ID: ExportEmail_V2.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
message_id
|
str
|
Id of the email to export. |
required |
mailbox_address
|
Optional[str]
|
Address of the shared mailbox to export from. |
None
|
timeout
|
Optional[float]
|
The request timeout in seconds. |
None
|
headers
|
Optional[Mapping[str, str]]
|
Additional HTTP request headers. |
None
|
client_request_id
|
Optional[str]
|
A caller-provided request identifier. |
None
|
response_hook
|
Optional[ConnectorResponseHook]
|
A callback invoked with the connector response. |
None
|
Returns:
| Name | Type | Description |
|---|---|---|
bytes |
bytes
|
The connector operation result. |
Raises:
| Type | Description |
|---|---|
ConnectorException
|
If the connector request fails. |
async
find_meeting_times(input: FindMeetingTimesInput | Mapping[str, Any], *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None
Find meeting times
Find meeting time suggestions based on organizer, attendee availability, and time or location constraints
Swagger operation ID: FindMeetingTimes_V2.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
input
|
FindMeetingTimesInput | Mapping[str, Any]
|
The request body. Mapping keys use serialized Swagger wire names. |
required |
timeout
|
Optional[float]
|
The request timeout in seconds. |
None
|
headers
|
Optional[Mapping[str, str]]
|
Additional HTTP request headers. |
None
|
client_request_id
|
Optional[str]
|
A caller-provided request identifier. |
None
|
response_hook
|
Optional[ConnectorResponseHook]
|
A callback invoked with the connector response. |
None
|
Returns:
| Type | Description |
|---|---|
dict[str, Any] | None
|
dict[str, Any] | None: The connector operation result. |
Raises:
| Type | Description |
|---|---|
ConnectorException
|
If the connector request fails. |
async
flag(input: UpdateEmailFlag | Mapping[str, Any], message_id: str, *, mailbox_address: Optional[str] = None, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> None
Flag email
This operation updates an email flag.
Swagger operation ID: Flag_V2.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
input
|
UpdateEmailFlag | Mapping[str, Any]
|
The request body. Mapping keys use serialized Swagger wire names. |
required |
message_id
|
str
|
Id of the email to be flagged. |
required |
mailbox_address
|
Optional[str]
|
Address of the shared mailbox to update mail. |
None
|
timeout
|
Optional[float]
|
The request timeout in seconds. |
None
|
headers
|
Optional[Mapping[str, str]]
|
Additional HTTP request headers. |
None
|
client_request_id
|
Optional[str]
|
A caller-provided request identifier. |
None
|
response_hook
|
Optional[ConnectorResponseHook]
|
A callback invoked with the connector response. |
None
|
Returns:
| Name | Type | Description |
|---|---|---|
None |
None
|
The operation completes without a response body. |
Raises:
| Type | Description |
|---|---|
ConnectorException
|
If the connector request fails. |
async
forward_email(input: DirectForwardMessage | Mapping[str, Any], message_id: str, *, mailbox_address: Optional[str] = None, extract_sensitivity_label: Optional[bool] = None, fetch_sensitivity_label_metadata: Optional[bool] = None, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> None
Forward an email
Forward an email.
Swagger operation ID: ForwardEmail_V2.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
input
|
DirectForwardMessage | Mapping[str, Any]
|
The request body. Mapping keys use serialized Swagger wire names. |
required |
message_id
|
str
|
Id of the message to forward. (You can use 'Message Id' from trigger or 'Get Emails' action output). |
required |
mailbox_address
|
Optional[str]
|
Address of the shared mailbox to forward mail from. |
None
|
extract_sensitivity_label
|
Optional[bool]
|
Select if you want to extract Sensitivity label ( false, true). |
None
|
fetch_sensitivity_label_metadata
|
Optional[bool]
|
A boolean whether to fetch sensitivity label Metadata for associated LabelId. |
None
|
timeout
|
Optional[float]
|
The request timeout in seconds. |
None
|
headers
|
Optional[Mapping[str, str]]
|
Additional HTTP request headers. |
None
|
client_request_id
|
Optional[str]
|
A caller-provided request identifier. |
None
|
response_hook
|
Optional[ConnectorResponseHook]
|
A callback invoked with the connector response. |
None
|
Returns:
| Name | Type | Description |
|---|---|---|
None |
None
|
The operation completes without a response body. |
Raises:
| Type | Description |
|---|---|
ConnectorException
|
If the connector request fails. |
async
get_attachment(message_id: str, attachment_id: str, *, mailbox_address: Optional[str] = None, extract_sensitivity_label: Optional[bool] = None, fetch_sensitivity_label_metadata: Optional[bool] = None, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None
Get Attachment
This operation gets an email attachment by id.
Swagger operation ID: GetAttachment_V2.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
message_id
|
str
|
Id of the email. |
required |
attachment_id
|
str
|
Id of the attachment to download. |
required |
mailbox_address
|
Optional[str]
|
Address of the shared mailbox to retrieve attachment from. |
None
|
extract_sensitivity_label
|
Optional[bool]
|
Select if you want to extract Sensitivity label ( false, true). |
None
|
fetch_sensitivity_label_metadata
|
Optional[bool]
|
A boolean whether to fetch sensitivity label Metadata for associated LabelId. |
None
|
timeout
|
Optional[float]
|
The request timeout in seconds. |
None
|
headers
|
Optional[Mapping[str, str]]
|
Additional HTTP request headers. |
None
|
client_request_id
|
Optional[str]
|
A caller-provided request identifier. |
None
|
response_hook
|
Optional[ConnectorResponseHook]
|
A callback invoked with the connector response. |
None
|
Returns:
| Type | Description |
|---|---|
dict[str, Any] | None
|
dict[str, Any] | None: The connector operation result. |
Raises:
| Type | Description |
|---|---|
ConnectorException
|
If the connector request fails. |
async
get_email(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, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None
Get email
This operation gets an email by id.
Swagger operation ID: GetEmailV2.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
message_id
|
str
|
Id of the email. |
required |
mailbox_address
|
Optional[str]
|
Address of the shared mailbox to retrieve mail from. |
None
|
include_attachments
|
Optional[bool]
|
If set to true, attachments content will also be retrieved along with the email. |
None
|
internet_message_id
|
Optional[str]
|
Internet Message Id. |
None
|
extract_sensitivity_label
|
Optional[bool]
|
Select if you want to extract Sensitivity label ( false, true). |
None
|
fetch_sensitivity_label_metadata
|
Optional[bool]
|
A boolean whether to fetch sensitivity label Metadata for associated LabelId. |
None
|
timeout
|
Optional[float]
|
The request timeout in seconds. |
None
|
headers
|
Optional[Mapping[str, str]]
|
Additional HTTP request headers. |
None
|
client_request_id
|
Optional[str]
|
A caller-provided request identifier. |
None
|
response_hook
|
Optional[ConnectorResponseHook]
|
A callback invoked with the connector response. |
None
|
Returns:
| Type | Description |
|---|---|
dict[str, Any] | None
|
dict[str, Any] | None: The connector operation result. |
Raises:
| Type | Description |
|---|---|
ConnectorException
|
If the connector request fails. |
list_emails(*, 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, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> AsyncItemPaged[dict[str, Any]]
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.
Returns a single-page Azure Core async collection.
Swagger operation ID: GetEmailsV3.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
folder_path
|
Optional[str]
|
Mail folder to retrieve emails from (default: 'Inbox'). |
None
|
to
|
Optional[str]
|
Recipient email addresses separated by semicolons (If any match, the trigger will run). |
None
|
cc
|
Optional[str]
|
CC recipient email addresses separated by semicolons (If any match, the trigger will run). |
None
|
to_or_cc
|
Optional[str]
|
To or CC recipient email addresses separated by semicolons (If any match, the trigger will run). |
None
|
from_
|
Optional[str]
|
Sender email addresses separated by semicolons (If any match, the trigger will run). |
None
|
importance
|
Optional[str]
|
Importance of the email (Any, High, Normal, Low). |
None
|
fetch_only_with_attachment
|
Optional[bool]
|
If set to true, only emails with an attachment will be retrieved. Emails without any attachments will be skipped. If set to false, all emails will be retrieved. |
None
|
subject_filter
|
Optional[str]
|
String to look for in the subject line. |
None
|
fetch_only_unread
|
Optional[bool]
|
Retrieve only unread emails?. |
None
|
mailbox_address
|
Optional[str]
|
Address of the shared mailbox to retrieve mails from. |
None
|
include_attachments
|
Optional[bool]
|
If set to true, attachments content will also be retrieved along with the email. |
None
|
search_query
|
Optional[str]
|
Search query to filter emails. How to use '$search' parameter please refer to: https://docs.microsoft.com/graph/query-parameters#search-parameter. |
None
|
top
|
Optional[int]
|
Number of emails to retrieve (default: 10, max: 1000). |
None
|
timeout
|
Optional[float]
|
The request timeout in seconds. |
None
|
headers
|
Optional[Mapping[str, str]]
|
Additional HTTP request headers. |
None
|
client_request_id
|
Optional[str]
|
A caller-provided request identifier. |
None
|
response_hook
|
Optional[ConnectorResponseHook]
|
A callback invoked with the connector response. |
None
|
Returns:
| Type | Description |
|---|---|
AsyncItemPaged[dict[str, Any]]
|
AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector
results. Consume it with |
Raises:
| Type | Description |
|---|---|
ConnectorException
|
If the connector request fails. |
list_events_calendar_view(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, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> AsyncItemPaged[dict[str, Any]]
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.
Returns a single-page Azure Core async collection.
Swagger operation ID: GetEventsCalendarViewV3.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
calendar_id
|
str
|
Select a calendar. |
required |
start_date_time_utc
|
str
|
Start time in UTC (example: '2017-01-01T08:00:00'). |
required |
end_date_time_utc
|
str
|
End time in UTC (example: '2017-02-01T08:00:00'). |
required |
filter
|
Optional[str]
|
An ODATA filter query to restrict the entries returned (e.g. stringColumn eq 'string' OR numberColumn lt 123). |
None
|
orderby
|
Optional[str]
|
An ODATA orderBy query for specifying the order of entries. |
None
|
top
|
Optional[int]
|
Total number of entries to retrieve (default = all). |
None
|
skip
|
Optional[int]
|
The number of entries to skip (default = 0). |
None
|
search
|
Optional[str]
|
Search text for matching event body and subject. |
None
|
timeout
|
Optional[float]
|
The request timeout in seconds. |
None
|
headers
|
Optional[Mapping[str, str]]
|
Additional HTTP request headers. |
None
|
client_request_id
|
Optional[str]
|
A caller-provided request identifier. |
None
|
response_hook
|
Optional[ConnectorResponseHook]
|
A callback invoked with the connector response. |
None
|
Returns:
| Type | Description |
|---|---|
AsyncItemPaged[dict[str, Any]]
|
AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector
results. Consume it with |
Raises:
| Type | Description |
|---|---|
ConnectorException
|
If the connector request fails. |
list_mail_tips(input: GetMailTipsInput | Mapping[str, Any], *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> AsyncItemPaged[dict[str, Any]]
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.
Returns a single-page Azure Core async collection.
Swagger operation ID: GetMailTips_V2.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
input
|
GetMailTipsInput | Mapping[str, Any]
|
The request body. Mapping keys use serialized Swagger wire names. |
required |
timeout
|
Optional[float]
|
The request timeout in seconds. |
None
|
headers
|
Optional[Mapping[str, str]]
|
Additional HTTP request headers. |
None
|
client_request_id
|
Optional[str]
|
A caller-provided request identifier. |
None
|
response_hook
|
Optional[ConnectorResponseHook]
|
A callback invoked with the connector response. |
None
|
Returns:
| Type | Description |
|---|---|
AsyncItemPaged[dict[str, Any]]
|
AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector
results. Consume it with |
Raises:
| Type | Description |
|---|---|
ConnectorException
|
If the connector request fails. |
list_room_lists(*, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> AsyncItemPaged[dict[str, Any]]
Get room lists
Get all the room lists defined in the user's tenant
Returns a single-page Azure Core async collection.
Swagger operation ID: GetRoomLists_V2.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
timeout
|
Optional[float]
|
The request timeout in seconds. |
None
|
headers
|
Optional[Mapping[str, str]]
|
Additional HTTP request headers. |
None
|
client_request_id
|
Optional[str]
|
A caller-provided request identifier. |
None
|
response_hook
|
Optional[ConnectorResponseHook]
|
A callback invoked with the connector response. |
None
|
Returns:
| Type | Description |
|---|---|
AsyncItemPaged[dict[str, Any]]
|
AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector
results. Consume it with |
Raises:
| Type | Description |
|---|---|
ConnectorException
|
If the connector request fails. |
list_rooms(*, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> AsyncItemPaged[dict[str, Any]]
Get rooms
Get all the meeting rooms defined in the user's tenant
Returns a single-page Azure Core async collection.
Swagger operation ID: GetRooms_V2.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
timeout
|
Optional[float]
|
The request timeout in seconds. |
None
|
headers
|
Optional[Mapping[str, str]]
|
Additional HTTP request headers. |
None
|
client_request_id
|
Optional[str]
|
A caller-provided request identifier. |
None
|
response_hook
|
Optional[ConnectorResponseHook]
|
A callback invoked with the connector response. |
None
|
Returns:
| Type | Description |
|---|---|
AsyncItemPaged[dict[str, Any]]
|
AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector
results. Consume it with |
Raises:
| Type | Description |
|---|---|
ConnectorException
|
If the connector request fails. |
list_get_rooms_in_room(room_list: str, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> AsyncItemPaged[dict[str, Any]]
Get rooms in room list
Get the meeting rooms in a specific room list
Returns a single-page Azure Core async collection.
Swagger operation ID: GetRoomsInRoomList_V2.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
room_list
|
str
|
Room list to find rooms in. |
required |
timeout
|
Optional[float]
|
The request timeout in seconds. |
None
|
headers
|
Optional[Mapping[str, str]]
|
Additional HTTP request headers. |
None
|
client_request_id
|
Optional[str]
|
A caller-provided request identifier. |
None
|
response_hook
|
Optional[ConnectorResponseHook]
|
A callback invoked with the connector response. |
None
|
Returns:
| Type | Description |
|---|---|
AsyncItemPaged[dict[str, Any]]
|
AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector
results. Consume it with |
Raises:
| Type | Description |
|---|---|
ConnectorException
|
If the connector request fails. |
async
mark_as_read(input: MarkAsReadInput | Mapping[str, Any], message_id: str, *, mailbox_address: Optional[str] = None, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> None
Mark as read or unread
This operation marks an email as read/unread.
Swagger operation ID: MarkAsRead_V3.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
input
|
MarkAsReadInput | Mapping[str, Any]
|
The request body. Mapping keys use serialized Swagger wire names. |
required |
message_id
|
str
|
Id of the email to be marked. |
required |
mailbox_address
|
Optional[str]
|
Address of the shared mailbox to update mail. |
None
|
timeout
|
Optional[float]
|
The request timeout in seconds. |
None
|
headers
|
Optional[Mapping[str, str]]
|
Additional HTTP request headers. |
None
|
client_request_id
|
Optional[str]
|
A caller-provided request identifier. |
None
|
response_hook
|
Optional[ConnectorResponseHook]
|
A callback invoked with the connector response. |
None
|
Returns:
| Name | Type | Description |
|---|---|---|
None |
None
|
The operation completes without a response body. |
Raises:
| Type | Description |
|---|---|
ConnectorException
|
If the connector request fails. |
async
move(message_id: str, folder_path: str, *, mailbox_address: Optional[str] = None, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None
Move email
This operation moves an email to the specified folder within the same mailbox.
Swagger operation ID: MoveV2.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
message_id
|
str
|
Id of the email to be moved. |
required |
folder_path
|
str
|
Mail folder to move the email to. |
required |
mailbox_address
|
Optional[str]
|
Address of the shared mailbox to move mail from. |
None
|
timeout
|
Optional[float]
|
The request timeout in seconds. |
None
|
headers
|
Optional[Mapping[str, str]]
|
Additional HTTP request headers. |
None
|
client_request_id
|
Optional[str]
|
A caller-provided request identifier. |
None
|
response_hook
|
Optional[ConnectorResponseHook]
|
A callback invoked with the connector response. |
None
|
Returns:
| Type | Description |
|---|---|
dict[str, Any] | None
|
dict[str, Any] | None: The connector operation result. |
Raises:
| Type | Description |
|---|---|
ConnectorException
|
If the connector request fails. |
async
reply_to(input: ReplyEmailInput | Mapping[str, Any], message_id: str, *, mailbox_address: Optional[str] = None, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> None
Reply to email
This operation replies to an email.
Swagger operation ID: ReplyToV3.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
input
|
ReplyEmailInput | Mapping[str, Any]
|
The request body. Mapping keys use serialized Swagger wire names. |
required |
message_id
|
str
|
Id of the email to reply to. |
required |
mailbox_address
|
Optional[str]
|
Address of the shared mailbox to reply from. |
None
|
timeout
|
Optional[float]
|
The request timeout in seconds. |
None
|
headers
|
Optional[Mapping[str, str]]
|
Additional HTTP request headers. |
None
|
client_request_id
|
Optional[str]
|
A caller-provided request identifier. |
None
|
response_hook
|
Optional[ConnectorResponseHook]
|
A callback invoked with the connector response. |
None
|
Returns:
| Name | Type | Description |
|---|---|---|
None |
None
|
The operation completes without a response body. |
Raises:
| Type | Description |
|---|---|
ConnectorException
|
If the connector request fails. |
async
respond_to_event(input: ResponseToEventInvite | Mapping[str, Any], event_id: str, response: str, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> None
Respond to an event invite
Respond to an event invite.
Swagger operation ID: RespondToEvent_V2.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
input
|
ResponseToEventInvite | Mapping[str, Any]
|
The request body. Mapping keys use serialized Swagger wire names. |
required |
event_id
|
str
|
Id of the event to respond to. |
required |
response
|
str
|
Response for the event invite. |
required |
timeout
|
Optional[float]
|
The request timeout in seconds. |
None
|
headers
|
Optional[Mapping[str, str]]
|
Additional HTTP request headers. |
None
|
client_request_id
|
Optional[str]
|
A caller-provided request identifier. |
None
|
response_hook
|
Optional[ConnectorResponseHook]
|
A callback invoked with the connector response. |
None
|
Returns:
| Name | Type | Description |
|---|---|---|
None |
None
|
The operation completes without a response body. |
Raises:
| Type | Description |
|---|---|
ConnectorException
|
If the connector request fails. |
async
send_email(input: SendEmailInput | Mapping[str, Any], *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> None
Send an email
This operation sends an email message.
Swagger operation ID: SendEmailV2.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
input
|
SendEmailInput | Mapping[str, Any]
|
The request body. Mapping keys use serialized Swagger wire names. |
required |
timeout
|
Optional[float]
|
The request timeout in seconds. |
None
|
headers
|
Optional[Mapping[str, str]]
|
Additional HTTP request headers. |
None
|
client_request_id
|
Optional[str]
|
A caller-provided request identifier. |
None
|
response_hook
|
Optional[ConnectorResponseHook]
|
A callback invoked with the connector response. |
None
|
Returns:
| Name | Type | Description |
|---|---|---|
None |
None
|
The operation completes without a response body. |
Raises:
| Type | Description |
|---|---|
ConnectorException
|
If the connector request fails. |
async
set_automatic_replies_setting(input: SetAutomaticRepliesSettingInput | Mapping[str, Any], *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None
Set up automatic replies
Set the automatic replies setting for your mailbox.
Swagger operation ID: SetAutomaticRepliesSetting_V2.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
input
|
SetAutomaticRepliesSettingInput | Mapping[str, Any]
|
The request body. Mapping keys use serialized Swagger wire names. |
required |
timeout
|
Optional[float]
|
The request timeout in seconds. |
None
|
headers
|
Optional[Mapping[str, str]]
|
Additional HTTP request headers. |
None
|
client_request_id
|
Optional[str]
|
A caller-provided request identifier. |
None
|
response_hook
|
Optional[ConnectorResponseHook]
|
A callback invoked with the connector response. |
None
|
Returns:
| Type | Description |
|---|---|
dict[str, Any] | None
|
dict[str, Any] | None: The connector operation result. |
Raises:
| Type | Description |
|---|---|
ConnectorException
|
If the connector request fails. |
async
shared_mailbox_send_email(input: SharedMailboxSendEmailInput | Mapping[str, Any], *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> None
Send an email from a shared mailbox
This operation sends an email from a shared mailbox. Your account should have permission to access the mailbox for this operation to succeed.
Swagger operation ID: SharedMailboxSendEmailV2.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
input
|
SharedMailboxSendEmailInput | Mapping[str, Any]
|
The request body. Mapping keys use serialized Swagger wire names. |
required |
timeout
|
Optional[float]
|
The request timeout in seconds. |
None
|
headers
|
Optional[Mapping[str, str]]
|
Additional HTTP request headers. |
None
|
client_request_id
|
Optional[str]
|
A caller-provided request identifier. |
None
|
response_hook
|
Optional[ConnectorResponseHook]
|
A callback invoked with the connector response. |
None
|
Returns:
| Name | Type | Description |
|---|---|---|
None |
None
|
The operation completes without a response body. |
Raises:
| Type | Description |
|---|---|
ConnectorException
|
If the connector request fails. |