Office365 Class

Properties   Methods   Events   Config Settings   Errors  

The Office365 class provides an easy way to manage sending and receiving mail in Microsoft 365. The class also includes support for creating, listing, and managing contacts.

Syntax

class cloudmail.Office365

Remarks

This class provides an easy to use interface for Office365 using the Microsoft Graph API v1.0. To use the class, first set the authorization property to a valid OAuth token. The Office365 class can be used for sending or creating new messages; retrieving, moving, or copying existing messages; creating, deleting, or copying folders; and several other functionalities supported by the Microsoft Graph API.

This class requires authentication via OAuth 2.0. First, perform OAuth authentication using the o_auth property to set the appropriate fields for the chosen o_auth_client_profile and o_auth_grant_type.

The class has the following defaults:

Additionally, depending on how the application is registered (Ex. Multi-tenant) and what o_auth_grant_type is selected (Ex. Client Credentials and Password), it may be required to use the tenant ID rather than "common" in the o_auth_server_auth_url and o_auth_server_token_url properties. In the case of Client Credentials and Password grant types, it is also required to use the "default" scopes of the app registration. See below for examples of the modified URLs and scopes:

Below is a brief description of the different o_auth_client_profile and o_auth_grant_type values that are supported by this class. For a more in-depth description of what needs to be set, refer to the service documentation.

Application Profile

This profile encompasses the most basic grant types that OAuth supports. When this profile is set, all the requests and response handling is done by the class. Depending on the grant type, this may involve launching a browser so a user can login to authenticate with a authorization server. It may also involve starting an embedded web server to receive a response from a redirect.

To start the authentication and authorization process, the authorize method should be called. If the authorization and authentication was successful, then the o_auth_access_token property will be populated. Additionally, if a refresh token was provided the o_auth_refresh_token property will be populated as well. These values of the fields are for informational purposes. The class will also cache these tokens along with when the o_auth_access_token will be expired. When a method that makes requests to the service provider is called or the authorize method is called the class will automatically check to see if the access token is expired. If it is, it will then automatically try to get a new o_auth_access_token. If the authorize method was not used and user interaction would be required, the class will throw an error which can be caught. When user interaction is needed depends on what grant type is set in the o_auth_grant_type property. To force the component to only check the access token when the authorize method is called, the OAuthAutomaticRefresh configuration setting can be set to false.

A brief description of the supported values for the o_auth_grant_type property are below. For more information, see the service documentation.

Authorization Code

When using the Authorization Code grant type, the class will use an authorization code to get an access token. For this o_auth_grant_type the class expects a o_auth_client_id, o_auth_client_secret, o_auth_server_auth_url, and o_auth_server_token_url to be set. When the authorize method is called, the component will start the embedded web server and launch the browser so the user can authorize the application. Once the user authorizes, the service provider will redirect them to the embedded web server and the class will parse the authorization code, setting the o_auth_authorization_code property, from the redirect. Immediately, the class will make a request to the token server to exchange the authorization code for an access token. The token server will return an access token and possibly a refresh token. If the o_auth_refresh_token property is set, or a refresh token is cached, then the class will not launch the browser and use the refresh token in its request to the token server instead of an authorization code.

Example: Office365 office365 = new Office365(); office365.OAuth.ClientProfile = CloudOAuthClientProfiles.cocpApplication; office365.OAuth.GrantType = OAuthSettingsGrantTypes.cogtAuthorizationCode; office365.OAuth.ClientId = CLIENT_ID; office365.OAuth.ClientSecret = CLIENT_SECRET; office365.Authorize();

Client Credentials

When using the Client Credentials grant type, the class will act as a service instead of authorizing and authenticating as a user. This allows for the class to avoid user interaction. This is typically used when running in an application that can not have user access. This grant type requires additional set up to be done in the service providers portal before it can be used. For this o_auth_grant_type the class expects a o_auth_client_id, o_auth_client_secret, and o_auth_server_token_url to be set. When the authorize method is called, the component will make a request to the token server for an access token. The token server will return an access token if the application has the authorization to do so. When this access token is expired, the component will automatically (see above for detailed description) make a new request to get a fresh one.

Implicit

Note: This grant type is considered insecure and should only be used when necessary.

When using the Implicit grant type, the class will request the authorization server to get an access token. For this o_auth_grant_type the class expects a o_auth_client_id, o_auth_client_secret, and o_auth_server_auth_url to be set. When the authorize method is called, the component will start the embedded web server and launch the browser so the user can authorize the application. Once the user authorizes, the service provider will redirect them to the embedded web server and the class will parse the access token from the redirect.

A disadvantage of the grant type is that can not use a refresh token to silently get a new access token. Most service providers offer a way to silently get a new access token. See the service documentation for specifics. This means the class will not be able to automatically get a fresh token once it expires.

Password

Note: This grant type is considered insecure and should only be used when necessary.

When using the Resource Owner Password Credentials grant type, the class will authenticate as the resource owner. This allows for the class to avoid user interaction. This grant type often has specific limitations put on it by the service provider. See the service documentation for more details.

For this o_auth_grant_type the class requires OAuthPasswordGrantUsername, o_auth_client_secret, and o_auth_server_token_url to be set. The o_auth_client_secret should be set to the password of the account instead of a typical secret. In some cases, the o_auth_client_id also needs to be set. When the authorize method is called, the component will make a request to the token server for an access token using the username and password. The token server will return an access token if the authentication was successful. When this access token is expired, the component will automatically (see above for detailed description) make a new request to get a fresh one.

Web Profile

This profile is similar to setting the class to the Application profile and Authorization Code grant type except the class will not launch the browser. It is typically used in situations where there is a back-end that is supporting some front end. This profile expects that o_auth_client_id, o_auth_client_secret, o_auth_server_auth_url, o_auth_server_token_url, and the o_auth_return_url properties to be set. Before calling the authorize method, the o_auth_web_auth_url property should be queried to get a URL. This URL should be used to redirect the user to the authorization page for the service provider. The redirect_uri parameter of this URL is mapped to the o_auth_return_url property. The o_auth_return_url property should be set to some web server that will parse the authorization code out of the query parameter from the redirect. Once the authorization code is parsed, it should be passed back to the server where it is then set to the o_auth_authorization_code property. Once that is set, the authorize method can be called to exchange the authorization code for an access token and refresh token if provided. The class will then cache these values like normal and use them to make requests. If the o_auth_refresh_token field is set, or a refresh token is cached, then the authorize method can immediately be called to make a request to the token server to get a new access token.

External OAuth Support

For complex profiles or grant types, or for more control of the flow, it is possible to perform OAuth authentication using the OAuth class or a separate process. Once complete you should have an authorization string which looks like:

Bearer ACCESS_TOKEN_VALUE

Assign this value to the authorization property before attempting any operations. Setting the authorization property will cause the class to ignore the values set in the o_auth property.

For Example: Oauth oauth = new Oauth(); oauth.ClientId = "CLIENT_ID"; oauth.ClientSecret = "CLIENT_SECRET"; oauth.ServerAuthURL = "https://login.microsoftonline.com/common/oauth2/v2.0/authorize"; oauth.ServerTokenURL = "https://login.microsoftonline.com/common/oauth2/v2.0/token"; oauth.AuthorizationScope = "offline_access user.read mail.readwrite mail.send mailboxsettings.readwrite user.readwrite Contacts.Read Contacts.ReadWrite"; oauth.GrantType = OauthGrantTypes.ogtAuthorizationCode; office365.Authorization = oauth.GetAuthorization(); Consult the documentation for the service for more information about supported scope values and more details on OAuth authentication.

Sending Messages

There are two methods for sending new messages using the Office365 component. The send_mail method will send a message directly. Alternatively, you can create a message draft and then send an existing draft using the send_draft method. In both cases the properties of the new message are assigned through the Message properties (message_subject, message_body_content, message_cc, etc.).

Sending a Message with SendDraft: office365.MessageSubject = "Subject Text"; office365.MessageImportance = "Low"; office365.MessageBodyContentType = "TEXT"; office365.MessageBodyContent = "Body Text."; office365.MessageTo = "email@example.com"; office365.CreateDraft(0, ""); string messageId = office365.MessageInfo[0].Id; office365.SendDraft(messageId);

There are also methods for replying or forwarding messages using the Office365 component. The reply, reply_all, and forward method will send a reply or forward directly. Similarly, you can create a reply or forward draft and then send an existing draft using the send_draft method. Unlike creating a new message, only the direct methods use the Message properties (message_subject, message_body_content, message_cc, etc.). When using create_draft, the draft must first be made then updated using the message_info properties and update method.

Sending a Reply with SendDraft: //Create the reply draft string originalMessageId = "Message ID"; office365.CreateDraft(1, oringialMessageId); //Set the new draft MessageInfo fields with desired options office365.MessageInfo[0].To = "email@example.com"; office365.MessageInfo[0].Subject = "Subject Text"; office365.MessageInfo[0].BodyContentType = "TEXT"; office365.MessageInfo[0].BodyContent = "Body Text"; //Update the draft office365.Update(office365.MessageInfo[0].Id); //Send the draft office365.SendDraft(office365.MessageInfo[0].Id);

Receiving Messages

Information about messages fetched by the component can be accessed through the message_info properties. message_info properties is populated when the list_messages, retrieve_message, search, or list_changes methods are called.

The list_messages and list_changes methods will respectively list the messages or changed messages in a folder specified by a folderId. To get the ID of a folder, folders can be traversed and read using the list_folders method and the folders properties.

Listing Messages in a Folder: // Get the folder ID string folderId = ""; office365.ListFolders(""); // Lists the root child folders. for (int i = 0; i < office365.Folders.Count; i++) { if (office365.Folders[i].DisplayName.Equals("SpecificFolderName")) { folderId = office365.Folders[i].Id; break; } } // List folder messages office365.ListMessages(folderId, "");

By default, the component will fetch one page of 100 messages when list_messages is called. If additional messages remain in the folder, the list_messages_marker property will be populated. If list_messages is then called again on the same folder the next page of messages will be fetched. The example below populates message_info properties with all the messages in a particular folder. do { office365.ListMessages(folderId); } while (office365.ListMessagesMarker.Length > 0);

The message page size may also be changed by using the MessagePageSize configuration setting.

Listing Contact Folders

To list the contact folders of a user use the list_contact_folders method. It populates the contact_folders collection with the retrieved folders. For each retrieved folder the on_contact_folder_list event is fired.

Example (List All Contact Folders):

office365.ListContactFolders(); // List root folders. foreach(OLContactFolder folder in office365.ContactFolders){ folder.Id; // Folder id folder.Name; // Folder name }

Listing Contacts

Use the list_contacts to populate the contacts collection with the the contacts that are in a specified folder. Providing an empty string as folderId retrieves the contacts from the default Contacts folder of the signed-in user. For each retrieved contact the on_contact_list event is fired.

Example (List All Contacts in a Folder) office365.ListContactFolders(""); //List root folders (no need to do this if you already have a Folder Id) office365.ListContacts(office365.ContactFolders[0].Id); //Lists contacts

Example (List all Contacts in the default Contacts folder):

office365.ListContacts("");

If the number of contacts exceeds the page size, the list_contacts_marker will be populated. You can call ListContacts again to retrieve the next page of contacts. These contacts will be added to the end of the contacts collection.

Example (List all Contacts Pages in the default Contacts folder): do{ office365.ListContacts(""); } while(!office365.ListContactsMarker.isEmpty());

Creating and Updating Contacts

To create a new contact use the create_contact method and specify the first name, last name, email address and the id of the folder, where the contact will be created. The newly created contact is added at the end of the contacts collection.

Example (Create a Contact in the default folder (Contacts))

office365.CreateContact("Pavel", "Bansky", "pavelb@contoso.com", "");

Example (Create a Contact in a Folder)

office365.ListContactFolders(""); //This method populates the ContactFolder collection with the contact folders under the root folder. office365.CreateContact("Pavel", "Bansky", "pavelb@contoso.com", office365.ContactFolders[0].Id); // Created the contact in the first folder in the ContactFolders collection. After creating a contact with basic information, select the contact to be edited in the contacts collection, edit its fields and make a call to the update_contact method. To edit the newly created contact select the last contact of the collection.

Example (Update a contact)

office365.CreateContact("Pavel", "Bansky", "pavelb@contoso.com", "");// Create a contact in the main contacts folder. // Set a company name office365.Contacts[0].CompanyName = "Volkswagen"; // Set notes office365.Contacts[0].Notes = "testNotes"; // Set multiple phone numbers office365.Contacts[0].PhonesCount = 2; office365.Contacts[0].PhoneIndex = 0; office365.Contacts[0].PhoneType = TOLPhoneTypes.ptMobile; office365.Contacts[0].PhoneNumber = "0123456789"; office365.Contacts[0].PhoneIndex = 1; office365.Contacts[0].PhoneType = TOLPhoneTypes.ptBusiness; office365.Contacts[0].PhoneNumber = "9876543210"; // Update the contact office365.UpdateContact(0); The OLContact type used in the contacts collection includes the most commonly used fields for contacts. Refer to the OLContact type for a complete list of fields. If you need to add other fields, you can use the set_contact_field method. For a complete list of fields a contact can have please refer to the Microsoft Graph API documentation.

Example (Add Other Fields To A Contact) // Set birthday office365.SetContactField(0, "/json/birthday", "2024-05-21", 2); // The last argument is the type of the field. 2 (String) // Set business address office365.SetContactField(0, "/json/businessAddress", "{\"street\":\"string\",\"city\":\"string\",\"state\":\"string\",\"countryOrRegion\":\"string\",\"postalCode\":\"string\"}", 0); // 0 (Object) // Update the contact office365.UpdateContact(0);

Retrieving Contacts

To retrieve a contact use the get_contact method and provide the Id of the contact as the argument. The contact is added to the end of the contacts collection.

Example (Retrieve a Contact)

// Retrieve a contact by its ID string contactId = "12345"; // Replace with the actual contact ID office365.GetContact(contactId); // Access the retrieved contact var retrievedContact = office365.Contacts[office365.Contacts.Count - 1]; retrievedContact.FirstName; //first name retrievedContact.LastName; //last name retrievedContact.EmailAddressIndex=0; //set the index to zero to retrieve access the first email address retrievedContact.EmailAddress; //first email address value retrievedContact.PhonesIndex=0; //set the index to zero to retrieve access the first phone number retrievedContact.PhoneNumber; //first phone number value office365.GetContactField(office365.Contacts.Count - 1, "/json/birthday"); //birthday of the contact office365.GetContactField(office365.Contacts.Count - 1, "/json/middleName"); //middle name of the contact

Deleting Contacts

To delete a contact use the delete_contact method and provide the Id of the contact as the argument. The contact is also removed from the contacts collection.

Example (Delete a Contact)

// List contacts and search for a contact with the name "John Doe" office365.ListContacts("folder_id"); for (int i = 0; i < office365.Contacts.Count; i++) { if (office365.Contacts[i].DisplayName == "John Doe") { //Delete the contact office365.DeleteContact(office365.Contacts[i].Id); break; } }

Property List

---

The following is the full list of the properties of the class with short descriptions. Click on the links for further details.

Method List

---

The following is the full list of the methods of the class with short descriptions. Click on the links for further details.

Event List

---

The following is the full list of the events fired by the class with short descriptions. Click on the links for further details.

Config Settings

---

The following is a list of config settings for the class with short descriptions. Click on the links for further details.

attachment_count Property

The number of records in the Attachment arrays.

Syntax

def get_attachment_count() -> int: ...
def set_attachment_count(value: int) -> None: ...

attachment_count = property(get_attachment_count, set_attachment_count)

Default Value

0

Remarks

This property controls the size of the following arrays:

• attachment_attachment_type
• attachment_content_id
• attachment_content_location
• attachment_content_type
• attachment_data
• attachment_file_name
• attachment_id
• attachment_is_inline
• attachment_last_modified_date
• attachment_name
• attachment_parent_index
• attachment_size

The array indices start at 0 and end at attachment_count - 1.

attachment_attachment_type Property

This property contains the attachment type of the attachment.

Syntax

def get_attachment_attachment_type(attachment_index: int) -> str: ...

Default Value

""

Remarks

This field contains the attachment type of the attachment.

The attachment_index parameter specifies the index of the item in the array. The size of the array is controlled by the attachment_count property.

This property is read-only.

attachment_content_id Property

This property contains the value of the unique content identifier of the attachment.

Syntax

def get_attachment_content_id(attachment_index: int) -> str: ...
def set_attachment_content_id(attachment_index: int, value: str) -> None: ...

Default Value

""

Remarks

This field contains the value of the unique content identifier of the attachment.

The attachment_index parameter specifies the index of the item in the array. The size of the array is controlled by the attachment_count property.

attachment_content_location Property

This property contains the content location of the attachment.

Syntax

def get_attachment_content_location(attachment_index: int) -> str: ...

Default Value

""

Remarks

This field contains the content location of the attachment. It is generally null, as it is no longer supported in the Microsoft Graph API.

The attachment_index parameter specifies the index of the item in the array. The size of the array is controlled by the attachment_count property.

This property is read-only.

attachment_content_type Property

This property contains the content type of the attachment.

Syntax

def get_attachment_content_type(attachment_index: int) -> str: ...

Default Value

""

Remarks

This field contains the content type of the attachment.

The attachment_index parameter specifies the index of the item in the array. The size of the array is controlled by the attachment_count property.

This property is read-only.

attachment_data Property

This property contains the raw data of the attachment.

Syntax

def get_attachment_data(attachment_index: int) -> bytes: ...
def set_attachment_data(attachment_index: int, value: bytes) -> None: ...

Default Value

""

Remarks

This field contains the raw data of the attachment.

The attachment_index parameter specifies the index of the item in the array. The size of the array is controlled by the attachment_count property.

attachment_file_name Property

This property contains the local file name associated with the attachment.

Syntax

def get_attachment_file_name(attachment_index: int) -> str: ...
def set_attachment_file_name(attachment_index: int, value: str) -> None: ...

Default Value

""

Remarks

This field contains the local file name associated with the attachment.

The attachment_index parameter specifies the index of the item in the array. The size of the array is controlled by the attachment_count property.

attachment_id Property

This property contains the attachment identifier of the attachment.

Syntax

def get_attachment_id(attachment_index: int) -> str: ...

Default Value

""

Remarks

This field contains the attachment identifier of the attachment.

The attachment_index parameter specifies the index of the item in the array. The size of the array is controlled by the attachment_count property.

This property is read-only.

attachment_is_inline Property

This property is true if the attachment is an inline attachment.

Syntax

def get_attachment_is_inline(attachment_index: int) -> bool: ...
def set_attachment_is_inline(attachment_index: int, value: bool) -> None: ...

Default Value

FALSE

Remarks

This field is true if the attachment is an inline attachment.

The attachment_index parameter specifies the index of the item in the array. The size of the array is controlled by the attachment_count property.

attachment_last_modified_date Property

This property contains the date and time when the attachment was last modified.

Syntax

def get_attachment_last_modified_date(attachment_index: int) -> str: ...
def set_attachment_last_modified_date(attachment_index: int, value: str) -> None: ...

Default Value

""

Remarks

This field contains the date and time when the attachment was last modified.

The attachment_index parameter specifies the index of the item in the array. The size of the array is controlled by the attachment_count property.

attachment_name Property

This property contains the name of the attachment.

Syntax

def get_attachment_name(attachment_index: int) -> str: ...
def set_attachment_name(attachment_index: int, value: str) -> None: ...

Default Value

""

Remarks

This field contains the name of the attachment.

The attachment_index parameter specifies the index of the item in the array. The size of the array is controlled by the attachment_count property.

attachment_parent_index Property

Provides the index of the parent item attachment when the RequestNestedItemAttachments configuration setting is enabled.

Syntax

def get_attachment_parent_index(attachment_index: int) -> str: ...

Default Value

""

Remarks

Provides the index of the parent item attachment when the RequestNestedItemAttachments configuration setting is enabled. This index is generated by the class rather than by Microsoft and is designed to provide an intuitive mapping of the attachment structure.

If the attachment is a root attachment, then this index will be a single integer starting at 1. For the following intermediate and leaf attachments, the index will add a new integer separated by a . char.

For example, a message may contain the following attachments.

• RootFileAttachment.txt (1)
• RootItemAttachment (2)
  • IntermediateFileAttachment.txt (2.1)
  • IntermediateItemAttachment (2.2)
    • LeafFileAttachment.txt (2.2.1)

The attachment_index parameter specifies the index of the item in the array. The size of the array is controlled by the attachment_count property.

This property is read-only.

attachment_size Property

This property contains the size in bytes of the attachment.

Syntax

def get_attachment_size(attachment_index: int) -> int: ...
def set_attachment_size(attachment_index: int, value: int) -> None: ...

Default Value

0

Remarks

This field contains the size in bytes of the attachment.

The attachment_index parameter specifies the index of the item in the array. The size of the array is controlled by the attachment_count property.

authorization Property

An OAuth Authorization String.

Syntax

def get_authorization() -> str: ...
def set_authorization(value: str) -> None: ...

authorization = property(get_authorization, set_authorization)

Default Value

""

Remarks

This property is used to specify an OAuth authorization string. Setting it is a requirement for using the component.

Example

Oauth oauth = new Oauth(); oauth.ClientId = "YourClientId"; oauth.ClientSecret = "YourClientSecret"; oauth.ServerAuthURL = "https://login.microsoftonline.com/common/oauth2/v2.0/authorize"; oauth.ServerTokenURL = "https://login.microsoftonline.com/common/oauth2/v2.0/token"; oauth.AuthorizationScope = "user.read mail.readwrite mail.send mailboxsettings.readwrite"; oauth.GrantType = OauthGrantTypes.ogtAuthorizationCode; office365.Authorization = oauth.GetAuthorization();

category_count Property

The number of records in the Category arrays.

Syntax

def get_category_count() -> int: ...
def set_category_count(value: int) -> None: ...

category_count = property(get_category_count, set_category_count)

Default Value

0

Remarks

This property controls the size of the following arrays:

• category_color
• category_display_name
• category_id

The array indices start at 0 and end at category_count - 1.

category_color Property

This property contains the color of the category.

Syntax

def get_category_color(category_index: int) -> str: ...

Default Value

""

Remarks

This field contains the color of the category.

The category_index parameter specifies the index of the item in the array. The size of the array is controlled by the category_count property.

This property is read-only.

category_display_name Property

This property contains the display name of the category.

Syntax

def get_category_display_name(category_index: int) -> str: ...

Default Value

""

Remarks

This field contains the display name of the category.

The category_index parameter specifies the index of the item in the array. The size of the array is controlled by the category_count property.

This property is read-only.

category_id Property

This property contains the unique identifier of the category.

Syntax

def get_category_id(category_index: int) -> str: ...

Default Value

""

Remarks

This field contains the unique identifier of the category.

The category_index parameter specifies the index of the item in the array. The size of the array is controlled by the category_count property.

This property is read-only.

change_marker Property

The page marker for listing changed messages.

Syntax

def get_change_marker() -> str: ...
def set_change_marker(value: str) -> None: ...

change_marker = property(get_change_marker, set_change_marker)

Default Value

""

Remarks

This property is populated if there are still unlisted messages after list_changes is called. It contains the nextLink that will be included as an OData parameter if list_changes is called again on the same folder. This will cause the next page of changed messages to be listed.

Example (List All Changes of a Message)

do { office365.ListChanges(id, "", 100); } while (office365.ChangeMarker.Length > 0);

contact_folder_count Property

The number of records in the ContactFolder arrays.

Syntax

def get_contact_folder_count() -> int: ...
def set_contact_folder_count(value: int) -> None: ...

contact_folder_count = property(get_contact_folder_count, set_contact_folder_count)

Default Value

0

Remarks

This property controls the size of the following arrays:

• contact_folder_id
• contact_folder_name
• contact_folder_parent_folder_id

The array indices start at 0 and end at contact_folder_count - 1.

contact_folder_id Property

The unique identifier of the contact folder.

Syntax

def get_contact_folder_id(contact_folder_index: int) -> str: ...

Default Value

""

Remarks

The unique identifier of the contact folder.

The contact_folder_index parameter specifies the index of the item in the array. The size of the array is controlled by the contact_folder_count property.

This property is read-only.

contact_folder_name Property

The display name of the contact folder.

Syntax

def get_contact_folder_name(contact_folder_index: int) -> str: ...

Default Value

""

Remarks

The display name of the contact folder.

The contact_folder_index parameter specifies the index of the item in the array. The size of the array is controlled by the contact_folder_count property.

This property is read-only.

contact_folder_parent_folder_id Property

The unique identifier for the folder's parent.

Syntax

def get_contact_folder_parent_folder_id(contact_folder_index: int) -> str: ...

Default Value

""

Remarks

The unique identifier for the folder's parent.

The contact_folder_index parameter specifies the index of the item in the array. The size of the array is controlled by the contact_folder_count property.

This property is read-only.

contacts_count Property

The number of records in the Contact arrays.

Syntax

def get_contacts_count() -> int: ...
def set_contacts_count(value: int) -> None: ...

contacts_count = property(get_contacts_count, set_contacts_count)

Default Value

0

Remarks

This property controls the size of the following arrays:

• contact_company_name
• contact_display_name
• contact_email_address
• contact_email_addresses_count
• contact_email_address_index
• contact_first_name
• contact_folder_id
• contact_folder_name
• contact_folder_parent_folder_id
• contact_id
• contact_json
• contact_last_name
• contact_notes
• contact_parent_id
• contact_phone_index
• contact_phone_number
• contact_phones_count
• contact_phone_type

The array indices start at 0 and end at contacts_count - 1.

contact_company_name Property

The name of the contact's company.

Syntax

def get_contact_company_name(contact_index: int) -> str: ...
def set_contact_company_name(contact_index: int, value: str) -> None: ...

Default Value

""

Remarks

The name of the contact's company.

The contact_index parameter specifies the index of the item in the array. The size of the array is controlled by the contacts_count property.

contact_display_name Property

The contact's display name.

Syntax

def get_contact_display_name(contact_index: int) -> str: ...
def set_contact_display_name(contact_index: int, value: str) -> None: ...

Default Value

""

Remarks

The contact's display name.

The contact_index parameter specifies the index of the item in the array. The size of the array is controlled by the contacts_count property.

contact_email_address Property

The email address at the specified EmailAddressIndex.

Syntax

def get_contact_email_address(contact_index: int) -> str: ...
def set_contact_email_address(contact_index: int, value: str) -> None: ...

Default Value

""

Remarks

The email address at the specified EmailAddressIndex. For example, when updating a contact, setting EmailAddressIndex to 0 and then assigning "example@example.com" to this property will set the first email address of the contact. Similarly, when retrieving a contact, setting EmailAddressIndex to 0 allows you to read the first email address of the contact.

The contact_index parameter specifies the index of the item in the array. The size of the array is controlled by the contacts_count property.

contact_email_addresses_count Property

When retrieving contacts, it indicates the number of email addresses linked to the contact.

Syntax

def get_contact_email_addresses_count(contact_index: int) -> int: ...
def set_contact_email_addresses_count(contact_index: int, value: int) -> None: ...

Default Value

0

Remarks

When retrieving contacts, it indicates the number of email addresses linked to the contact. When creating or updating a contact, this property is set to the number of email addresses the contact will have.

The contact_index parameter specifies the index of the item in the array. The size of the array is controlled by the contacts_count property.

contact_email_address_index Property

Index of email address to get or set in the EmailAddress property.

Syntax

def get_contact_email_address_index(contact_index: int) -> int: ...
def set_contact_email_address_index(contact_index: int, value: int) -> None: ...

Default Value

0

Remarks

Index of email address to get or set in the EmailAddress property. For example, setting EmailAddressIndex to 0 and then assigning a value to this field sets the first email address of a contact. If you are retrieving a contact, setting EmailAddressIndex to 0, will populate EmailAddress with the first email address.

Example (Set the email addresses before updating a contact) office365.Contacts[0].EmailAddressesCount = 2; office365.Contacts[0].EmailAddressIndex = 0; office365.Contacts[0].EmailAddress = "email1@domain1.com"; // set the first email address of the contact office365.Contacts[0].EmailAddressIndex = 1; office365.Contacts[0].EmailAddress = "email2@domain2.com"; // set the second email address of the contact office365.UpdateContact(0);

Example (Read email addresses of a retrieved contact) office365.GetContact(contactId); OLContact lastContact = office365.Contacts[office365.Contacts.Count - 1]; for(int i = 0; i < lastContact.EmailAddressesCount; i++){ lastContact.EmailAddressIndex = i; // set the index of the next email to read lastContact.EmailAddress; // read the next email address of the contact }

The contact_index parameter specifies the index of the item in the array. The size of the array is controlled by the contacts_count property.

contact_first_name Property

The contact's first name.

Syntax

def get_contact_first_name(contact_index: int) -> str: ...
def set_contact_first_name(contact_index: int, value: str) -> None: ...

Default Value

""

Remarks

The contact's first name.

The contact_index parameter specifies the index of the item in the array. The size of the array is controlled by the contacts_count property.

contact_id Property

The unique identifier of the contact.

Syntax

def get_contact_id(contact_index: int) -> str: ...

Default Value

""

Remarks

The unique identifier of the contact.

The contact_index parameter specifies the index of the item in the array. The size of the array is controlled by the contacts_count property.

This property is read-only.

contact_json Property

A JSON representation of the contact.

Syntax

def get_contact_json(contact_index: int) -> str: ...
def set_contact_json(contact_index: int, value: str) -> None: ...

Default Value

""

Remarks

A JSON representation of the contact. Change this field to set raw JSON content to send on the next update. Other fields values will be ignored in this case.

The contact_index parameter specifies the index of the item in the array. The size of the array is controlled by the contacts_count property.

contact_last_name Property

The contact's last name.

Syntax

def get_contact_last_name(contact_index: int) -> str: ...
def set_contact_last_name(contact_index: int, value: str) -> None: ...

Default Value

""

Remarks

The contact's last name.

The contact_index parameter specifies the index of the item in the array. The size of the array is controlled by the contacts_count property.

contact_notes Property

The user's notes about the contact.

Syntax

def get_contact_notes(contact_index: int) -> str: ...
def set_contact_notes(contact_index: int, value: str) -> None: ...

Default Value

""

Remarks

The user's notes about the contact.

The contact_index parameter specifies the index of the item in the array. The size of the array is controlled by the contacts_count property.

contact_parent_id Property

The ID of the contact's parent folder.

Syntax

def get_contact_parent_id(contact_index: int) -> str: ...
def set_contact_parent_id(contact_index: int, value: str) -> None: ...

Default Value

""

Remarks

The ID of the contact's parent folder.

The contact_index parameter specifies the index of the item in the array. The size of the array is controlled by the contacts_count property.

contact_phone_index Property

Index of phone number to get or set in the PhoneNumber property.

Syntax

def get_contact_phone_index(contact_index: int) -> int: ...
def set_contact_phone_index(contact_index: int, value: int) -> None: ...

Default Value

0

Remarks

Index of phone number to get or set in the PhoneNumber property. For example, setting PhoneIndex to 0 and then assigning a value to this field sets the first phone number of a contact. If you are retrieving a contact, setting PhoneIndex to 0, will populate PhoneNumber with the first phone number.

Example (Set the phone numbers before updating a contact): office365.Contacts[0].PhonesCount = 2; office365.Contacts[0].PhoneIndex = 0; office365.Contacts[0].PhoneNumber = "0123456789"; // set the first email address of the contact office365.Contacts[0].PhoneIndex = 1; office365.Contacts[0].PhoneNumber = "9876543210"; // set the second email address of the contact office365.UpdateContact(0);

Example (Read phone numbers of a retrieved contact): office365.GetContact(contactId); OLContact lastContact = office365.Contacts[office365.Contacts.Count - 1]; for(int i = 0; i < lastContact.PhonesCount; i++){ lastContact.PhoneIndex = i; // set the index of the next phone number to read lastContact.PhoneNumber; // read the next phone number of the contact }

The contact_index parameter specifies the index of the item in the array. The size of the array is controlled by the contacts_count property.

contact_phone_number Property

This property is used to get or set a phone number at the index specified by PhoneIndex.

Syntax

def get_contact_phone_number(contact_index: int) -> str: ...
def set_contact_phone_number(contact_index: int, value: str) -> None: ...

Default Value

""

Remarks

This property is used to get or set a phone number at the index specified by PhoneIndex. For example, setting PhoneIndex to 0 and then assigning "0123456789" to this property sets the first phone number of the contact. Similarly, after setting PhoneIndex to 0 you can read the first phone number of the contact.

The contact_index parameter specifies the index of the item in the array. The size of the array is controlled by the contacts_count property.

contact_phones_count Property

Number of the contact's phone numbers.

Syntax

def get_contact_phones_count(contact_index: int) -> int: ...
def set_contact_phones_count(contact_index: int, value: int) -> None: ...

Default Value

0

Remarks

Number of the contact's phone numbers.

When retrieving contacts, this property indicates the number of phone numbers linked to the contact. When updating a contact, this property is set to the number of phone numbers to be linked to the contact.

The contact_index parameter specifies the index of the item in the array. The size of the array is controlled by the contacts_count property.

contact_phone_type Property

The phone number type.

Syntax

def get_contact_phone_type(contact_index: int) -> int: ...
def set_contact_phone_type(contact_index: int, value: int) -> None: ...

Default Value

0

Remarks

The phone number type.

This property indicates the type of a contact's phone number selected by PhoneIndex. Possible values are:

• 0 (optHome)
• 1 (optBusiness)
• 2 (optMobile)

The contact_index parameter specifies the index of the item in the array. The size of the array is controlled by the contacts_count property.

firewall_auto_detect Property

Whether to automatically detect and use firewall system settings, if available.

Syntax

def get_firewall_auto_detect() -> bool: ...
def set_firewall_auto_detect(value: bool) -> None: ...

firewall_auto_detect = property(get_firewall_auto_detect, set_firewall_auto_detect)

Default Value

FALSE

Remarks

Whether to automatically detect and use firewall system settings, if available.

firewall_type Property

The type of firewall to connect through.

Syntax

def get_firewall_type() -> int: ...
def set_firewall_type(value: int) -> None: ...

firewall_type = property(get_firewall_type, set_firewall_type)

Default Value

0

Remarks

The type of firewall to connect through. The applicable values are as follows:

firewall_host Property

The name or IP address of the firewall (optional).

Syntax

def get_firewall_host() -> str: ...
def set_firewall_host(value: str) -> None: ...

firewall_host = property(get_firewall_host, set_firewall_host)

Default Value

""

Remarks

The name or IP address of the firewall (optional). If a firewall_host is given, the requested connections will be authenticated through the specified firewall when connecting.

If this property is set to a Domain Name, a DNS request is initiated. Upon successful termination of the request, this property is set to the corresponding address. If the search is not successful, the class fails with an error.

firewall_password Property

A password if authentication is to be used when connecting through the firewall.

Syntax

def get_firewall_password() -> str: ...
def set_firewall_password(value: str) -> None: ...

firewall_password = property(get_firewall_password, set_firewall_password)

Default Value

""

Remarks

A password if authentication is to be used when connecting through the firewall. If firewall_host is specified, the firewall_user and firewall_password properties are used to connect and authenticate to the given firewall. If the authentication fails, the class fails with an error.

firewall_port Property

The Transmission Control Protocol (TCP) port for the firewall Host .

Syntax

def get_firewall_port() -> int: ...
def set_firewall_port(value: int) -> None: ...

firewall_port = property(get_firewall_port, set_firewall_port)

Default Value

0

Remarks

The Transmission Control Protocol (TCP) port for the firewall firewall_host. See the description of the firewall_host property for details.

Note: This property is set automatically when firewall_type is set to a valid value. See the description of the firewall_type property for details.

firewall_user Property

A username if authentication is to be used when connecting through a firewall.

Syntax

def get_firewall_user() -> str: ...
def set_firewall_user(value: str) -> None: ...

firewall_user = property(get_firewall_user, set_firewall_user)

Default Value

""

Remarks

A username if authentication is to be used when connecting through a firewall. If firewall_host is specified, this property and the firewall_password property are used to connect and authenticate to the given Firewall. If the authentication fails, the class fails with an error.

folder_count Property

The number of records in the Folder arrays.

Syntax

def get_folder_count() -> int: ...
def set_folder_count(value: int) -> None: ...

folder_count = property(get_folder_count, set_folder_count)

Default Value

0

Remarks

This property controls the size of the following arrays:

• folder_child_folder_count
• folder_child_folders
• folder_display_name
• folder_id
• folder_message_rules
• folder_messages
• folder_multi_value_extended_properties
• folder_parent_folder_id
• folder_single_value_extended_properties
• folder_total_item_count
• folder_unread_item_count

The array indices start at 0 and end at folder_count - 1.

folder_child_folder_count Property

The number of child folders the folder has.

Syntax

def get_folder_child_folder_count(folder_index: int) -> int: ...

Default Value

0

Remarks

The number of child folders the folder has.

The folder_index parameter specifies the index of the item in the array. The size of the array is controlled by the folder_count property.

This property is read-only.

folder_child_folders Property

The child folders of the folder.

Syntax

def get_folder_child_folders(folder_index: int) -> str: ...

Default Value

""

Remarks

The child folders of the folder.

The folder_index parameter specifies the index of the item in the array. The size of the array is controlled by the folder_count property.

This property is read-only.

folder_display_name Property

The display name of the folder.

Syntax

def get_folder_display_name(folder_index: int) -> str: ...

Default Value

""

Remarks

The display name of the folder.

The folder_index parameter specifies the index of the item in the array. The size of the array is controlled by the folder_count property.

This property is read-only.

folder_id Property

The unique identifier of the folder.

Syntax

def get_folder_id(folder_index: int) -> str: ...

Default Value

""

Remarks

The unique identifier of the folder.

The folder_index parameter specifies the index of the item in the array. The size of the array is controlled by the folder_count property.

This property is read-only.

folder_message_rules Property

The message rules of the folder.

Syntax

def get_folder_message_rules(folder_index: int) -> str: ...

Default Value

""

Remarks

The message rules of the folder.

The folder_index parameter specifies the index of the item in the array. The size of the array is controlled by the folder_count property.

This property is read-only.

folder_messages Property

The messages contained in the folder.

Syntax

def get_folder_messages(folder_index: int) -> str: ...

Default Value

""

Remarks

The messages contained in the folder.

The folder_index parameter specifies the index of the item in the array. The size of the array is controlled by the folder_count property.

This property is read-only.

folder_multi_value_extended_properties Property

The multi-value extended properties defined for the folder.

Syntax

def get_folder_multi_value_extended_properties(folder_index: int) -> str: ...

Default Value

""

Remarks

The multi-value extended properties defined for the folder.

The folder_index parameter specifies the index of the item in the array. The size of the array is controlled by the folder_count property.

This property is read-only.

folder_parent_folder_id Property

The unique identifier for the folder's parent.

Syntax

def get_folder_parent_folder_id(folder_index: int) -> str: ...

Default Value

""

Remarks

The unique identifier for the folder's parent.

The folder_index parameter specifies the index of the item in the array. The size of the array is controlled by the folder_count property.

This property is read-only.

folder_single_value_extended_properties Property

The single-value extended properties defined for the folder.

Syntax

def get_folder_single_value_extended_properties(folder_index: int) -> str: ...

Default Value

""

Remarks

The single-value extended properties defined for the folder.

The folder_index parameter specifies the index of the item in the array. The size of the array is controlled by the folder_count property.

This property is read-only.

folder_total_item_count Property

The number of total items in the folder.

Syntax

def get_folder_total_item_count(folder_index: int) -> int: ...

Default Value

0

Remarks

The number of total items in the folder.

The folder_index parameter specifies the index of the item in the array. The size of the array is controlled by the folder_count property.

This property is read-only.

folder_unread_item_count Property

The number of unread items in the folder.

Syntax

def get_folder_unread_item_count(folder_index: int) -> int: ...

Default Value

0

Remarks

The number of unread items in the folder.

The folder_index parameter specifies the index of the item in the array. The size of the array is controlled by the folder_count property.

This property is read-only.

list_contacts_marker Property

The page marker for listing contacts.

Syntax

def get_list_contacts_marker() -> str: ...
def set_list_contacts_marker(value: str) -> None: ...

list_contacts_marker = property(get_list_contacts_marker, set_list_contacts_marker)

Default Value

""

Remarks

This property is populated if there are still unlisted contacts after list_contacts is called. It contains the nextLink that will be included as an OData parameter if list_contacts is called again on the same folder. This will cause the next page of contacts to be listed and added to the end of the contacts collection.

Example (List All Contacts in a Folder):

do { office365.ListContacts(folderId); } while (!office365.ListContactsMarker.isEmpty());

list_folders_marker Property

The page marker for listing folders.

Syntax

def get_list_folders_marker() -> str: ...
def set_list_folders_marker(value: str) -> None: ...

list_folders_marker = property(get_list_folders_marker, set_list_folders_marker)

Default Value

""

Remarks

This property is populated if there are still unlisted changes after list_folders is called. It contains the nextLink that will be included as an OData parameter if list_folders is called again on the same parent folder. This will cause the next page of folders to be listed.

Example (List All Folders in the Root Directory)

do { office365.ListFolders(""); } while (office365.ListFoldersMarker.Length > 0);

list_messages_marker Property

The page marker for listing messages.

Syntax

def get_list_messages_marker() -> str: ...
def set_list_messages_marker(value: str) -> None: ...

list_messages_marker = property(get_list_messages_marker, set_list_messages_marker)

Default Value

""

Remarks

This property is populated if there are still unlisted messages after list_messages is called. It contains the nextLink that will be included as an OData parameter if list_messages is called again on the same folder. This will cause the next page of messages to be listed.

Example (List All Messages in a Folder)

do { office365.ListMessages(folderId, filter); } while (office365.ListMessagesMarker.Length > 0);

message Property

Provides the raw message content.

Syntax

def get_message() -> bytes: ...

message = property(get_message, None)

Default Value

""

Remarks

This property is populated after calling retrieve_message_raw and holds the raw message content. This can be used to access the data before any processing is done by the class.

This property is read-only.

message_attachment_count Property

The number of records in the MessageAttachment arrays.

Syntax

def get_message_attachment_count() -> int: ...
def set_message_attachment_count(value: int) -> None: ...

message_attachment_count = property(get_message_attachment_count, set_message_attachment_count)

Default Value

0

Remarks

This property controls the size of the following arrays:

• message_attachment_attachment_type
• message_attachment_content_id
• message_attachment_content_location
• message_attachment_content_type
• message_attachment_data
• message_attachment_file_name
• message_attachment_id
• message_attachment_is_inline
• message_attachment_last_modified_date
• message_attachment_name
• message_attachment_parent_index
• message_attachment_size

The array indices start at 0 and end at message_attachment_count - 1.

message_attachment_attachment_type Property

This property contains the attachment type of the attachment.

Syntax

def get_message_attachment_attachment_type(message_attachment_index: int) -> str: ...

Default Value

""

Remarks

This field contains the attachment type of the attachment.

The message_attachment_index parameter specifies the index of the item in the array. The size of the array is controlled by the message_attachment_count property.

This property is read-only.

message_attachment_content_id Property

This property contains the value of the unique content identifier of the attachment.

Syntax

def get_message_attachment_content_id(message_attachment_index: int) -> str: ...
def set_message_attachment_content_id(message_attachment_index: int, value: str) -> None: ...

Default Value

""

Remarks

This field contains the value of the unique content identifier of the attachment.

The message_attachment_index parameter specifies the index of the item in the array. The size of the array is controlled by the message_attachment_count property.

message_attachment_content_location Property

This property contains the content location of the attachment.

Syntax

def get_message_attachment_content_location(message_attachment_index: int) -> str: ...

Default Value

""

Remarks

This field contains the content location of the attachment. It is generally null, as it is no longer supported in the Microsoft Graph API.

The message_attachment_index parameter specifies the index of the item in the array. The size of the array is controlled by the message_attachment_count property.

This property is read-only.

message_attachment_content_type Property

This property contains the content type of the attachment.

Syntax

def get_message_attachment_content_type(message_attachment_index: int) -> str: ...

Default Value

""

Remarks

This field contains the content type of the attachment.

The message_attachment_index parameter specifies the index of the item in the array. The size of the array is controlled by the message_attachment_count property.

This property is read-only.

message_attachment_data Property

This property contains the raw data of the attachment.

Syntax

def get_message_attachment_data(message_attachment_index: int) -> bytes: ...
def set_message_attachment_data(message_attachment_index: int, value: bytes) -> None: ...

Default Value

""

Remarks

This field contains the raw data of the attachment.

The message_attachment_index parameter specifies the index of the item in the array. The size of the array is controlled by the message_attachment_count property.

message_attachment_file_name Property

This property contains the local file name associated with the attachment.

Syntax

def get_message_attachment_file_name(message_attachment_index: int) -> str: ...
def set_message_attachment_file_name(message_attachment_index: int, value: str) -> None: ...

Default Value

""

Remarks

This field contains the local file name associated with the attachment.

The message_attachment_index parameter specifies the index of the item in the array. The size of the array is controlled by the message_attachment_count property.

message_attachment_id Property

This property contains the attachment identifier of the attachment.

Syntax

def get_message_attachment_id(message_attachment_index: int) -> str: ...

Default Value

""

Remarks

This field contains the attachment identifier of the attachment.

The message_attachment_index parameter specifies the index of the item in the array. The size of the array is controlled by the message_attachment_count property.

This property is read-only.

message_attachment_is_inline Property

This property is true if the attachment is an inline attachment.

Syntax

def get_message_attachment_is_inline(message_attachment_index: int) -> bool: ...
def set_message_attachment_is_inline(message_attachment_index: int, value: bool) -> None: ...

Default Value

FALSE

Remarks

This field is true if the attachment is an inline attachment.

The message_attachment_index parameter specifies the index of the item in the array. The size of the array is controlled by the message_attachment_count property.

message_attachment_last_modified_date Property

This property contains the date and time when the attachment was last modified.

Syntax

def get_message_attachment_last_modified_date(message_attachment_index: int) -> str: ...
def set_message_attachment_last_modified_date(message_attachment_index: int, value: str) -> None: ...

Default Value

""

Remarks

This field contains the date and time when the attachment was last modified.

The message_attachment_index parameter specifies the index of the item in the array. The size of the array is controlled by the message_attachment_count property.

message_attachment_name Property

This property contains the name of the attachment.

Syntax

def get_message_attachment_name(message_attachment_index: int) -> str: ...
def set_message_attachment_name(message_attachment_index: int, value: str) -> None: ...

Default Value

""

Remarks

This field contains the name of the attachment.

The message_attachment_index parameter specifies the index of the item in the array. The size of the array is controlled by the message_attachment_count property.

message_attachment_parent_index Property

Provides the index of the parent item attachment when the RequestNestedItemAttachments configuration setting is enabled.

Syntax

def get_message_attachment_parent_index(message_attachment_index: int) -> str: ...

Default Value

""

Remarks

Provides the index of the parent item attachment when the RequestNestedItemAttachments configuration setting is enabled. This index is generated by the class rather than by Microsoft and is designed to provide an intuitive mapping of the attachment structure.

If the attachment is a root attachment, then this index will be a single integer starting at 1. For the following intermediate and leaf attachments, the index will add a new integer separated by a . char.

For example, a message may contain the following attachments.

• RootFileAttachment.txt (1)
• RootItemAttachment (2)
  • IntermediateFileAttachment.txt (2.1)
  • IntermediateItemAttachment (2.2)
    • LeafFileAttachment.txt (2.2.1)

The message_attachment_index parameter specifies the index of the item in the array. The size of the array is controlled by the message_attachment_count property.

This property is read-only.

message_attachment_size Property

This property contains the size in bytes of the attachment.

Syntax

def get_message_attachment_size(message_attachment_index: int) -> int: ...
def set_message_attachment_size(message_attachment_index: int, value: int) -> None: ...

Default Value

0

Remarks

This field contains the size in bytes of the attachment.

The message_attachment_index parameter specifies the index of the item in the array. The size of the array is controlled by the message_attachment_count property.

message_bcc Property

A comma separated list of recipients for blind carbon copies for a message.

Syntax

def get_message_bcc() -> str: ...
def set_message_bcc(value: str) -> None: ...

message_bcc = property(get_message_bcc, set_message_bcc)

Default Value

""

Remarks

This property contains a comma separated list of destinations for blind carbon copies of a mail message. These recipients are added to a message created with create_draft or messages sent with send_mail.

Example (Add a Bcc Recipient)

office365.MessageBcc = "bbobbertson@bobmail.com"; office365.SendMail(True);

Example (Add a Bcc Recipient with a Name and Address)

office365.MessageBcc = "\"Brandrew Bobbertson\" bbobbertson@bobmail.com"; office365.SendMail(True);

message_body_content Property

The body content for a message.

Syntax

def get_message_body_content() -> str: ...
def set_message_body_content(value: str) -> None: ...

message_body_content = property(get_message_body_content, set_message_body_content)

Default Value

""

Remarks

This property contains the content of a message. These addresses are added to a message created with create_draft or messages sent with send_mail.

message_body_content_type Property

The body content type for a message.

Syntax

def get_message_body_content_type() -> str: ...
def set_message_body_content_type(value: str) -> None: ...

message_body_content_type = property(get_message_body_content_type, set_message_body_content_type)

Default Value

""

Remarks

This property contains the content type of a message. Valid values include text or html. These addresses are added to a message created with create_draft or messages sent with send_mail.

message_cc Property

A comma separated list of recipients for carbon copies for a message.

Syntax

def get_message_cc() -> str: ...
def set_message_cc(value: str) -> None: ...

message_cc = property(get_message_cc, set_message_cc)

Default Value

""

Remarks

This property contains a comma separated list of destinations for carbon copies of a mail message. These recipients are added to a message created with create_draft or messages sent with send_mail.

Example (Add a CC Recipient)

office365.MessageCc = "bbobbertson@bobmail.com"; office365.SendMail(True);

Example (Add a CC Recipient with a Name and Address)

office365.MessageCc = "\"Brandrew Bobbertson\" bbobbertson@bobmail.com"; office365.SendMail(True);

message_delivery_receipt Property

Whether or not a message will request a Delivery Receipt.

Syntax

def get_message_delivery_receipt() -> bool: ...
def set_message_delivery_receipt(value: bool) -> None: ...

message_delivery_receipt = property(get_message_delivery_receipt, set_message_delivery_receipt)

Default Value

FALSE

Remarks

This property determines whether or not messages created with create_draft or messages sent with send_mail will request a Delivery Receipt.

message_from Property

The author of a message.

Syntax

def get_message_from() -> str: ...
def set_message_from(value: str) -> None: ...

message_from = property(get_message_from, set_message_from)

Default Value

""

Remarks

This property contains the author of a message. This property is optional. If it is left blank, the message's author will be the Microsoft account used in authorization.

This property is applied to a message created with create_draft or messages sent with send_mail.

Example (Specify Message Author)

office365.MessageFrom = "stephen@company.com"; office365.SendMail(True);

Example (Specify Message Author - Name Included)

office365.MessageFrom = "\"Stephen Withavee\" stephen@company.com"; office365.SendMail(True);

message_importance Property

The importance of a message.

Syntax

def get_message_importance() -> str: ...
def set_message_importance(value: str) -> None: ...

message_importance = property(get_message_importance, set_message_importance)

Default Value

""

Remarks

This property determines the importance of messages created with create_draft or messages sent with send_mail. Valid values are Low, Normal, and High.

message_info_count Property

The number of records in the MessageInfo arrays.

Syntax

def get_message_info_count() -> int: ...
def set_message_info_count(value: int) -> None: ...

message_info_count = property(get_message_info_count, set_message_info_count)

Default Value

0

Remarks

This property controls the size of the following arrays:

• message_info_bcc
• message_info_body_content
• message_info_body_content_type
• message_info_body_preview
• message_info_categories
• message_info_cc
• message_info_conversation_id
• message_info_conversation_index
• message_info_created_date
• message_info_delivery_receipt_requested
• message_info_flag_status
• message_info_from
• message_info_has_attachments
• message_info_id
• message_info_importance
• message_info_inference_classification
• message_info_is_draft
• message_info_is_read
• message_info_json
• message_info_last_modified_date
• message_info_message_headers
• message_info_message_id
• message_info_parent_folder_id
• message_info_read_receipt_requested
• message_info_received_date
• message_info_reply_to
• message_info_sender
• message_info_sent_date
• message_info_subject
• message_info_to
• message_info_web_link

The array indices start at 0 and end at message_info_count - 1.

message_info_bcc Property

The BCc recipients of a message in a message info listing.

Syntax

def get_message_info_bcc(message_info_index: int) -> str: ...
def set_message_info_bcc(message_info_index: int, value: str) -> None: ...

Default Value

""

Remarks

The BCc recipients of a message in a message info listing.

The message_info_index parameter specifies the index of the item in the array. The size of the array is controlled by the message_info_count property.

message_info_body_content Property

The body content of a message in a message info listing.

Syntax

def get_message_info_body_content(message_info_index: int) -> str: ...
def set_message_info_body_content(message_info_index: int, value: str) -> None: ...

Default Value

""

Remarks

The body content of a message in a message info listing.

The message_info_index parameter specifies the index of the item in the array. The size of the array is controlled by the message_info_count property.

message_info_body_content_type Property

The body content type (e.

Syntax

def get_message_info_body_content_type(message_info_index: int) -> str: ...
def set_message_info_body_content_type(message_info_index: int, value: str) -> None: ...

Default Value

""

Remarks

The body content type (e.g. "HTML") of a message in a message info listing.

The message_info_index parameter specifies the index of the item in the array. The size of the array is controlled by the message_info_count property.

message_info_body_preview Property

The body preview of a message in a message info listing.

Syntax

def get_message_info_body_preview(message_info_index: int) -> str: ...

Default Value

""

Remarks

The body preview of a message in a message info listing.

The message_info_index parameter specifies the index of the item in the array. The size of the array is controlled by the message_info_count property.

This property is read-only.

message_info_categories Property

The categories of a message in a message info listing.

Syntax

def get_message_info_categories(message_info_index: int) -> str: ...
def set_message_info_categories(message_info_index: int, value: str) -> None: ...

Default Value

""

Remarks

The categories of a message in a message info listing.

The message_info_index parameter specifies the index of the item in the array. The size of the array is controlled by the message_info_count property.

message_info_cc Property

The Cc recipients of a message in a message info listing.

Syntax

def get_message_info_cc(message_info_index: int) -> str: ...
def set_message_info_cc(message_info_index: int, value: str) -> None: ...

Default Value

""

Remarks

The Cc recipients of a message in a message info listing.

The message_info_index parameter specifies the index of the item in the array. The size of the array is controlled by the message_info_count property.

message_info_conversation_id Property

The conversation unique identifier of a message in a message info listing.

Syntax

def get_message_info_conversation_id(message_info_index: int) -> str: ...

Default Value

""

Remarks

The conversation unique identifier of a message in a message info listing.

The message_info_index parameter specifies the index of the item in the array. The size of the array is controlled by the message_info_count property.

This property is read-only.

message_info_conversation_index Property

The conversation index of a message in a message info listing.

Syntax

def get_message_info_conversation_index(message_info_index: int) -> str: ...

Default Value

""

Remarks

The conversation index of a message in a message info listing.

The message_info_index parameter specifies the index of the item in the array. The size of the array is controlled by the message_info_count property.

This property is read-only.

message_info_created_date Property

The date created of a message in a message info listing.

Syntax

def get_message_info_created_date(message_info_index: int) -> str: ...

Default Value

""

Remarks

The date created of a message in a message info listing.

The message_info_index parameter specifies the index of the item in the array. The size of the array is controlled by the message_info_count property.

This property is read-only.

message_info_delivery_receipt_requested Property

Whether or not a delivery receipt was requested for a message in a message info listing.

Syntax

def get_message_info_delivery_receipt_requested(message_info_index: int) -> bool: ...
def set_message_info_delivery_receipt_requested(message_info_index: int, value: bool) -> None: ...

Default Value

FALSE

Remarks

Whether or not a delivery receipt was requested for a message in a message info listing.

The message_info_index parameter specifies the index of the item in the array. The size of the array is controlled by the message_info_count property.

message_info_flag_status Property

Message flag in a message info listing.

Syntax

def get_message_info_flag_status(message_info_index: int) -> str: ...
def set_message_info_flag_status(message_info_index: int, value: str) -> None: ...

Default Value

""

Remarks

Message flag in a message info listing. Example values include:

The message_info_index parameter specifies the index of the item in the array. The size of the array is controlled by the message_info_count property.

message_info_from Property

The sender of a message in a message info listing.

Syntax

def get_message_info_from(message_info_index: int) -> str: ...

Default Value

""

Remarks

The sender of a message in a message info listing.

The message_info_index parameter specifies the index of the item in the array. The size of the array is controlled by the message_info_count property.

This property is read-only.

message_info_has_attachments Property

Whether or not a message in a message info listing has attachments.

Syntax

def get_message_info_has_attachments(message_info_index: int) -> bool: ...

Default Value

FALSE

Remarks

Whether or not a message in a message info listing has attachments.

The message_info_index parameter specifies the index of the item in the array. The size of the array is controlled by the message_info_count property.

This property is read-only.

message_info_id Property

The unique identifier of a message in a message info listing set by Microsoft.

Syntax

def get_message_info_id(message_info_index: int) -> str: ...

Default Value

""

Remarks

The unique identifier of a message in a message info listing set by Microsoft.

The message_info_index parameter specifies the index of the item in the array. The size of the array is controlled by the message_info_count property.

This property is read-only.

message_info_importance Property

The importance of a message in a message info listing.

Syntax

def get_message_info_importance(message_info_index: int) -> str: ...
def set_message_info_importance(message_info_index: int, value: str) -> None: ...

Default Value

""

Remarks

The importance of a message in a message info listing.

The message_info_index parameter specifies the index of the item in the array. The size of the array is controlled by the message_info_count property.

message_info_inference_classification Property

The inference classification of a message in a message info listing.

Syntax

def get_message_info_inference_classification(message_info_index: int) -> str: ...

Default Value

""

Remarks

The inference classification of a message in a message info listing.

The message_info_index parameter specifies the index of the item in the array. The size of the array is controlled by the message_info_count property.

This property is read-only.

message_info_is_draft Property

Whether or not a message in a message info listing is a draft.

Syntax

def get_message_info_is_draft(message_info_index: int) -> bool: ...

Default Value

FALSE

Remarks

Whether or not a message in a message info listing is a draft.

The message_info_index parameter specifies the index of the item in the array. The size of the array is controlled by the message_info_count property.

This property is read-only.

message_info_is_read Property

Whether or not a message in a message info listing has been read.

Syntax

def get_message_info_is_read(message_info_index: int) -> bool: ...
def set_message_info_is_read(message_info_index: int, value: bool) -> None: ...

Default Value

FALSE

Remarks

Whether or not a message in a message info listing has been read.

The message_info_index parameter specifies the index of the item in the array. The size of the array is controlled by the message_info_count property.

message_info_json Property

The full JSON content of a message in a message info listing.

Syntax

def get_message_info_json(message_info_index: int) -> str: ...
def set_message_info_json(message_info_index: int, value: str) -> None: ...

Default Value

""

Remarks

The full JSON content of a message in a message info listing.

The message_info_index parameter specifies the index of the item in the array. The size of the array is controlled by the message_info_count property.

message_info_last_modified_date Property

The last modified date of a message in a message info listing.

Syntax

def get_message_info_last_modified_date(message_info_index: int) -> str: ...

Default Value

""

Remarks

The last modified date of a message in a message info listing.

The message_info_index parameter specifies the index of the item in the array. The size of the array is controlled by the message_info_count property.

This property is read-only.

message_info_message_headers Property

The message headers of a message in a message info listing.

Syntax

def get_message_info_message_headers(message_info_index: int) -> str: ...

Default Value

""

Remarks

The message headers of a message in a message info listing.

The message_info_index parameter specifies the index of the item in the array. The size of the array is controlled by the message_info_count property.

This property is read-only.

message_info_message_id Property

The internet message id for the message as described by rfc2822.

Syntax

def get_message_info_message_id(message_info_index: int) -> str: ...

Default Value

""

Remarks

The internet message id for the message as described by rfc2822.

The message_info_index parameter specifies the index of the item in the array. The size of the array is controlled by the message_info_count property.

This property is read-only.

message_info_parent_folder_id Property

The unique identifier of the parent folder of a message in a message info listing.

Syntax

def get_message_info_parent_folder_id(message_info_index: int) -> str: ...

Default Value

""

Remarks

The unique identifier of the parent folder of a message in a message info listing.

The message_info_index parameter specifies the index of the item in the array. The size of the array is controlled by the message_info_count property.

This property is read-only.

message_info_read_receipt_requested Property

Whether or not a read receipt was requested for a message in a message info listing.

Syntax

def get_message_info_read_receipt_requested(message_info_index: int) -> bool: ...
def set_message_info_read_receipt_requested(message_info_index: int, value: bool) -> None: ...

Default Value

FALSE

Remarks

Whether or not a read receipt was requested for a message in a message info listing.

The message_info_index parameter specifies the index of the item in the array. The size of the array is controlled by the message_info_count property.

message_info_received_date Property

The received date of a message in a message info listing.

Syntax

def get_message_info_received_date(message_info_index: int) -> str: ...

Default Value

""

Remarks

The received date of a message in a message info listing.

The message_info_index parameter specifies the index of the item in the array. The size of the array is controlled by the message_info_count property.

This property is read-only.

message_info_reply_to Property

Where to send replies for a message in a message info listing.

Syntax

def get_message_info_reply_to(message_info_index: int) -> str: ...
def set_message_info_reply_to(message_info_index: int, value: str) -> None: ...

Default Value

""

Remarks

Where to send replies for a message in a message info listing.

The message_info_index parameter specifies the index of the item in the array. The size of the array is controlled by the message_info_count property.

message_info_sender Property

The sender of a message in a message info listing.

Syntax

def get_message_info_sender(message_info_index: int) -> str: ...

Default Value

""

Remarks

The sender of a message in a message info listing.

The message_info_index parameter specifies the index of the item in the array. The size of the array is controlled by the message_info_count property.

This property is read-only.

message_info_sent_date Property

The date a message was sent for a message in a message info listing.

Syntax

def get_message_info_sent_date(message_info_index: int) -> str: ...

Default Value

""

Remarks

The date a message was sent for a message in a message info listing.

The message_info_index parameter specifies the index of the item in the array. The size of the array is controlled by the message_info_count property.

This property is read-only.

message_info_subject Property

The subject of a message in a message info listing.

Syntax

def get_message_info_subject(message_info_index: int) -> str: ...
def set_message_info_subject(message_info_index: int, value: str) -> None: ...

Default Value

""

Remarks

The subject of a message in a message info listing.

The message_info_index parameter specifies the index of the item in the array. The size of the array is controlled by the message_info_count property.

message_info_to Property

The recipients of a message in a message info listing.

Syntax

def get_message_info_to(message_info_index: int) -> str: ...
def set_message_info_to(message_info_index: int, value: str) -> None: ...

Default Value

""

Remarks

The recipients of a message in a message info listing.

The message_info_index parameter specifies the index of the item in the array. The size of the array is controlled by the message_info_count property.

message_info_web_link Property

The URL to open a message in a message info listing in Outlook on the web.

Syntax

def get_message_info_web_link(message_info_index: int) -> str: ...

Default Value

""

Remarks

The URL to open a message in a message info listing in Outlook on the web.

The message_info_index parameter specifies the index of the item in the array. The size of the array is controlled by the message_info_count property.

This property is read-only.

message_other_headers Property

The additional message headers for a message.

Syntax

def get_message_other_headers() -> str: ...
def set_message_other_headers(value: str) -> None: ...

message_other_headers = property(get_message_other_headers, set_message_other_headers)

Default Value

""

Remarks

This property contains additional message headers to the sent or created message. These addresses are added to a message created with create_draft or messages sent with send_mail.

message_read_receipt Property

Whether or not a message will request a Read Receipt.

Syntax

def get_message_read_receipt() -> bool: ...
def set_message_read_receipt(value: bool) -> None: ...

message_read_receipt = property(get_message_read_receipt, set_message_read_receipt)

Default Value

FALSE

Remarks

This property determines whether or not messages created with create_draft or messages sent with send_mail will request a Read Receipt.

message_reply_to Property

A mail address to reply to.

Syntax

def get_message_reply_to() -> str: ...
def set_message_reply_to(value: str) -> None: ...

message_reply_to = property(get_message_reply_to, set_message_reply_to)

Default Value

""

Remarks

This property contains a comma separated list of destinations for the ReplyTo property of a message. This property is optional. This property is useful when replies should be sent to addresses other than those in message_from. These recipients are added to a message created with create_draft or messages sent with send_mail.

message_subject Property

The subject of a message.

Syntax

def get_message_subject() -> str: ...
def set_message_subject(value: str) -> None: ...

message_subject = property(get_message_subject, set_message_subject)

Default Value

""

Remarks

This property contains the subject of a message. This property will be applied to a message created with create_draft or messages sent with send_mail.

message_to Property

A comma separated list of recipients for a message.

Syntax

def get_message_to() -> str: ...
def set_message_to(value: str) -> None: ...

message_to = property(get_message_to, set_message_to)

Default Value

""

Remarks

This property contains a comma separated list of destinations for a mail message. These recipients are added to a message created with create_draft or messages sent with send_mail.

Example (Add a Recipient)

office365.MessageCc = "bbobbertson@bobmail.com"; office365.SendMail(True);

Example (Add a Recipient with a Name and Address)

office365.MessageCc = "\"Brandrew Bobbertson\" bbobbertson@bobmail.com"; office365.SendMail(True);

next_change_marker Property

A marker indicating which page of changes to return in the future.

Syntax

def get_next_change_marker() -> str: ...
def set_next_change_marker(value: str) -> None: ...

next_change_marker = property(get_next_change_marker, set_next_change_marker)

Default Value

""

Remarks

This property will be populated when list_changes is called if there are no more changes to list. Refer to list_changes for more information.

o_auth_access_token Property

The access token returned by the authorization server.

Syntax

def get_o_auth_access_token() -> str: ...
def set_o_auth_access_token(value: str) -> None: ...

o_auth_access_token = property(get_o_auth_access_token, set_o_auth_access_token)

Default Value

""

Remarks

The access token returned by the authorization server. This is set when the class makes a request to the token server.

o_auth_authorization_code Property

The authorization code that is exchanged for an access token.

Syntax

def get_o_auth_authorization_code() -> str: ...
def set_o_auth_authorization_code(value: str) -> None: ...

o_auth_authorization_code = property(get_o_auth_authorization_code, set_o_auth_authorization_code)

Default Value

""

Remarks

The authorization code that is exchanged for an access token. This is required to be set when the o_auth_client_profile property is set to the Web profile. Otherwise, this field is for information purposes only.

o_auth_authorization_scope Property

The scope request or response parameter used during authorization.

Syntax

def get_o_auth_authorization_scope() -> str: ...
def set_o_auth_authorization_scope(value: str) -> None: ...

o_auth_authorization_scope = property(get_o_auth_authorization_scope, set_o_auth_authorization_scope)

Default Value

""

Remarks

The scope request or response parameter used during authorization.

o_auth_client_id Property

The id of the client assigned when registering the application.

Syntax

def get_o_auth_client_id() -> str: ...
def set_o_auth_client_id(value: str) -> None: ...

o_auth_client_id = property(get_o_auth_client_id, set_o_auth_client_id)

Default Value

""

Remarks

The id of the client assigned when registering the application.

o_auth_client_profile Property

The type of client that is requesting authorization.

Syntax

def get_o_auth_client_profile() -> int: ...
def set_o_auth_client_profile(value: int) -> None: ...

o_auth_client_profile = property(get_o_auth_client_profile, set_o_auth_client_profile)

Default Value

0

Remarks

The type of client that is requesting authorization. See the introduction section for more information. Possible values are:

o_auth_client_secret Property

The secret value for the client assigned when registering the application.

Syntax

def get_o_auth_client_secret() -> str: ...
def set_o_auth_client_secret(value: str) -> None: ...

o_auth_client_secret = property(get_o_auth_client_secret, set_o_auth_client_secret)

Default Value

""

Remarks

The secret value for the client assigned when registering the application.

o_auth_grant_type Property

The OAuth grant type used to acquire an OAuth access token.

Syntax

def get_o_auth_grant_type() -> int: ...
def set_o_auth_grant_type(value: int) -> None: ...

o_auth_grant_type = property(get_o_auth_grant_type, set_o_auth_grant_type)

Default Value

0

Remarks

The OAuth grant type used to acquire an OAuth access token. See the introduction section for more information. Possible values are:

o_auth_refresh_token Property

Specifies the refresh token received from or sent to the authorization server.

Syntax

def get_o_auth_refresh_token() -> str: ...
def set_o_auth_refresh_token(value: str) -> None: ...

o_auth_refresh_token = property(get_o_auth_refresh_token, set_o_auth_refresh_token)

Default Value

""

Remarks

Specifies the refresh token received from or sent to the authorization server. This property is set automatically if a refresh token is retrieved from the token server. If the OAuthAutomaticRefresh configuration setting is set to true, and the o_auth_grant_type property is set to a grant that can use refresh tokens.

o_auth_request_refresh_token Property

Specifies whether the class will request a refresh token during authorization.

Syntax

def get_o_auth_request_refresh_token() -> bool: ...
def set_o_auth_request_refresh_token(value: bool) -> None: ...

o_auth_request_refresh_token = property(get_o_auth_request_refresh_token, set_o_auth_request_refresh_token)

Default Value

TRUE

Remarks

Specifies whether the class will request a refresh token during authorization. By default, this value is True.

When True, the class will automatically add the necessary scopes or parameters to obtain a refresh token. When False, this property will have no effect. If the necessary scopes or parameters are specified manually, a refresh token can still be obtained.

Note: This property is only applicable when the o_auth_grant_type property is set to cogtAuthorizationCode.

o_auth_return_url Property

The URL where the user (browser) returns after authenticating.

Syntax

def get_o_auth_return_url() -> str: ...
def set_o_auth_return_url(value: str) -> None: ...

o_auth_return_url = property(get_o_auth_return_url, set_o_auth_return_url)

Default Value

""

Remarks

The URL where the user (browser) returns after authenticating. This property is mapped to the redirect_uri parameter when making a request to the authorization server. Typically, this is automatically set by the class when using the embedded web server. If the OAuthWebServerPort or OAuthWebServerHost configuration settings is set, then this property should be set to match. If using the Web client profile, this should be set to the place where the authorization code will be parsed out of the response after the user finishes authorizing.

o_auth_server_auth_url Property

The URL of the authorization server.

Syntax

def get_o_auth_server_auth_url() -> str: ...
def set_o_auth_server_auth_url(value: str) -> None: ...

o_auth_server_auth_url = property(get_o_auth_server_auth_url, set_o_auth_server_auth_url)

Default Value

""

Remarks

The URL of the authorization server.

o_auth_server_token_url Property

The URL of the token server used to obtain the access token.

Syntax

def get_o_auth_server_token_url() -> str: ...
def set_o_auth_server_token_url(value: str) -> None: ...

o_auth_server_token_url = property(get_o_auth_server_token_url, set_o_auth_server_token_url)

Default Value

""

Remarks

The URL of the token server used to obtain the access token.

o_auth_web_auth_url Property

The URL to which the user should be re-directed for authorization.

Syntax

def get_o_auth_web_auth_url() -> str: ...

o_auth_web_auth_url = property(get_o_auth_web_auth_url, None)

Default Value

""

Remarks

The URL to which the user should be re-directed for authorization. This field is used to get the URL that the user should be redirected to when using the Web client profile. See introduction section for more information.

This property is read-only.

proxy_auth_scheme Property

The type of authorization to perform when connecting to the proxy.

Syntax

def get_proxy_auth_scheme() -> int: ...
def set_proxy_auth_scheme(value: int) -> None: ...

proxy_auth_scheme = property(get_proxy_auth_scheme, set_proxy_auth_scheme)

Default Value

0

Remarks

The type of authorization to perform when connecting to the proxy. This is used only when the proxy_user and proxy_password properties are set.

proxy_auth_scheme should be set to authNone (3) when no authentication is expected.

By default, proxy_auth_scheme is authBasic (0), and if the proxy_user and proxy_password properties are set, the class will attempt basic authentication.

If proxy_auth_scheme is set to authDigest (1), digest authentication will be attempted instead.

If proxy_auth_scheme is set to authProprietary (2), then the authorization token will not be generated by the class. Look at the configuration file for the class being used to find more information about manually setting this token.

If proxy_auth_scheme is set to authNtlm (4), NTLM authentication will be used.

For security reasons, setting this property will clear the values of proxy_user and proxy_password.

proxy_auto_detect Property

Whether to automatically detect and use proxy system settings, if available.

Syntax

def get_proxy_auto_detect() -> bool: ...
def set_proxy_auto_detect(value: bool) -> None: ...

proxy_auto_detect = property(get_proxy_auto_detect, set_proxy_auto_detect)

Default Value

FALSE

Remarks

Whether to automatically detect and use proxy system settings, if available. The default value is False.

proxy_password Property

A password if authentication is to be used for the proxy.

Syntax

def get_proxy_password() -> str: ...
def set_proxy_password(value: str) -> None: ...

proxy_password = property(get_proxy_password, set_proxy_password)

Default Value

""

Remarks

A password if authentication is to be used for the proxy.

If proxy_auth_scheme is set to Basic Authentication, the proxy_user and proxy_password properties are Base64 encoded and the proxy authentication token will be generated in the form Basic [encoded-user-password].

If proxy_auth_scheme is set to Digest Authentication, the proxy_user and proxy_password properties are used to respond to the Digest Authentication challenge from the server.

If proxy_auth_scheme is set to NTLM Authentication, the proxy_user and proxy_password properties are used to authenticate through NTLM negotiation.

proxy_port Property

The Transmission Control Protocol (TCP) port for the proxy Server (default 80).

Syntax

def get_proxy_port() -> int: ...
def set_proxy_port(value: int) -> None: ...

proxy_port = property(get_proxy_port, set_proxy_port)

Default Value

80

Remarks

The Transmission Control Protocol (TCP) port for the proxy proxy_server (default 80). See the description of the proxy_server property for details.

proxy_server Property

If a proxy Server is given, then the HTTP request is sent to the proxy instead of the server otherwise specified.

Syntax

def get_proxy_server() -> str: ...
def set_proxy_server(value: str) -> None: ...

proxy_server = property(get_proxy_server, set_proxy_server)

Default Value

""

Remarks

If a proxy proxy_server is given, then the HTTP request is sent to the proxy instead of the server otherwise specified.

If the proxy_server property is set to a domain name, a DNS request is initiated. Upon successful termination of the request, the proxy_server property is set to the corresponding address. If the search is not successful, an error is returned.

proxy_ssl Property

When to use a Secure Sockets Layer (SSL) for the connection to the proxy.

Syntax

def get_proxy_ssl() -> int: ...
def set_proxy_ssl(value: int) -> None: ...

proxy_ssl = property(get_proxy_ssl, set_proxy_ssl)

Default Value

0

Remarks

When to use a Secure Sockets Layer (SSL) for the connection to the proxy. The applicable values are as follows:

proxy_user Property

A username if authentication is to be used for the proxy.

Syntax

def get_proxy_user() -> str: ...
def set_proxy_user(value: str) -> None: ...

proxy_user = property(get_proxy_user, set_proxy_user)

Default Value

""

Remarks

A username if authentication is to be used for the proxy.

If proxy_auth_scheme is set to Basic Authentication, the proxy_user and proxy_password properties are Base64 encoded and the proxy authentication token will be generated in the form Basic [encoded-user-password].

If proxy_auth_scheme is set to Digest Authentication, the proxy_user and proxy_password properties are used to respond to the Digest Authentication challenge from the server.

If proxy_auth_scheme is set to NTLM Authentication, the proxy_user and proxy_password properties are used to authenticate through NTLM negotiation.

select Property

The parts of a message that should be retrieved.

Syntax

def get_select() -> str: ...
def set_select(value: str) -> None: ...

select = property(get_select, set_select)

Default Value

""

Remarks

This property can be used to select specific message or attachment properties to retrieve when calling list_messages retrieve_message, list_attachments, or retrieve_attachment. Specify the message or attachment properties to be selected as a comma separated list.

When this property is an empty string, all message or attachment properties will be selected.

Messages

Selectable properties for messages include:

Example (Get the Subject and Sender of a Message)

office365.Select = "subject, sender"; office365.GetMessage(messageId);

Attachments

Due to limitations in the OData parameters, item attachments will always contain the entire list of properties.

Selectable properties for attachments include:

Example (Get the Name and Size of an attachment)

office365.Select = "name, size"; office365.ListAttachments(messageId);

ssl_accept_server_cert_effective_date Property

The date on which this certificate becomes valid.

Syntax

def get_ssl_accept_server_cert_effective_date() -> str: ...

ssl_accept_server_cert_effective_date = property(get_ssl_accept_server_cert_effective_date, None)

Default Value

""

Remarks

The date on which this certificate becomes valid. Before this date, it is not valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:

23-Jan-2000 15:00:00.

This property is read-only.

ssl_accept_server_cert_expiration_date Property

The date on which the certificate expires.

Syntax

def get_ssl_accept_server_cert_expiration_date() -> str: ...

ssl_accept_server_cert_expiration_date = property(get_ssl_accept_server_cert_expiration_date, None)

Default Value

""

Remarks

The date on which the certificate expires. After this date, the certificate will no longer be valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:

23-Jan-2001 15:00:00.

This property is read-only.

ssl_accept_server_cert_extended_key_usage Property

A comma-delimited list of extended key usage identifiers.

Syntax

def get_ssl_accept_server_cert_extended_key_usage() -> str: ...

ssl_accept_server_cert_extended_key_usage = property(get_ssl_accept_server_cert_extended_key_usage, None)

Default Value

""

Remarks

A comma-delimited list of extended key usage identifiers. These are the same as ASN.1 object identifiers (OIDs).

This property is read-only.

ssl_accept_server_cert_fingerprint Property

The hex-encoded, 16-byte MD5 fingerprint of the certificate.

Syntax

def get_ssl_accept_server_cert_fingerprint() -> str: ...

ssl_accept_server_cert_fingerprint = property(get_ssl_accept_server_cert_fingerprint, None)

Default Value

""

Remarks

The hex-encoded, 16-byte MD5 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: bc:2a:72:af:fe:58:17:43:7a:5f:ba:5a:7c:90:f7:02

This property is read-only.

ssl_accept_server_cert_fingerprint_sha1 Property

The hex-encoded, 20-byte SHA-1 fingerprint of the certificate.

Syntax

def get_ssl_accept_server_cert_fingerprint_sha1() -> str: ...

ssl_accept_server_cert_fingerprint_sha1 = property(get_ssl_accept_server_cert_fingerprint_sha1, None)

Default Value

""

Remarks

The hex-encoded, 20-byte SHA-1 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: 30:7b:fa:38:65:83:ff:da:b4:4e:07:3f:17:b8:a4:ed:80:be:ff:84

This property is read-only.

ssl_accept_server_cert_fingerprint_sha256 Property

The hex-encoded, 32-byte SHA-256 fingerprint of the certificate.

Syntax

def get_ssl_accept_server_cert_fingerprint_sha256() -> str: ...

ssl_accept_server_cert_fingerprint_sha256 = property(get_ssl_accept_server_cert_fingerprint_sha256, None)

Default Value

""

Remarks

The hex-encoded, 32-byte SHA-256 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: 6a:80:5c:33:a9:43:ea:b0:96:12:8a:64:96:30:ef:4a:8a:96:86:ce:f4:c7:be:10:24:8e:2b:60:9e:f3:59:53

This property is read-only.

ssl_accept_server_cert_issuer Property

The issuer of the certificate.

Syntax

def get_ssl_accept_server_cert_issuer() -> str: ...

ssl_accept_server_cert_issuer = property(get_ssl_accept_server_cert_issuer, None)

Default Value

""

Remarks

The issuer of the certificate. This property contains a string representation of the name of the issuing authority for the certificate.

This property is read-only.

ssl_accept_server_cert_private_key Property

The private key of the certificate (if available).

Syntax

def get_ssl_accept_server_cert_private_key() -> str: ...

ssl_accept_server_cert_private_key = property(get_ssl_accept_server_cert_private_key, None)

Default Value

""

Remarks

The private key of the certificate (if available). The key is provided as PEM/Base64-encoded data.

Note: The ssl_accept_server_cert_private_key may be available but not exportable. In this case, ssl_accept_server_cert_private_key returns an empty string.

This property is read-only.

ssl_accept_server_cert_private_key_available Property

Whether a PrivateKey is available for the selected certificate.

Syntax

def get_ssl_accept_server_cert_private_key_available() -> bool: ...

ssl_accept_server_cert_private_key_available = property(get_ssl_accept_server_cert_private_key_available, None)

Default Value

FALSE

Remarks

Whether a ssl_accept_server_cert_private_key is available for the selected certificate. If ssl_accept_server_cert_private_key_available is True, the certificate may be used for authentication purposes (e.g., server authentication).

This property is read-only.

ssl_accept_server_cert_private_key_container Property

The name of the PrivateKey container for the certificate (if available).

Syntax

def get_ssl_accept_server_cert_private_key_container() -> str: ...

ssl_accept_server_cert_private_key_container = property(get_ssl_accept_server_cert_private_key_container, None)

Default Value

""

Remarks

The name of the ssl_accept_server_cert_private_key container for the certificate (if available). This functionality is available only on Windows platforms.

This property is read-only.

ssl_accept_server_cert_public_key Property

The public key of the certificate.

Syntax

def get_ssl_accept_server_cert_public_key() -> str: ...

ssl_accept_server_cert_public_key = property(get_ssl_accept_server_cert_public_key, None)

Default Value

""

Remarks

The public key of the certificate. The key is provided as PEM/Base64-encoded data.

This property is read-only.

ssl_accept_server_cert_public_key_algorithm Property

The textual description of the certificate's public key algorithm.

Syntax

def get_ssl_accept_server_cert_public_key_algorithm() -> str: ...

ssl_accept_server_cert_public_key_algorithm = property(get_ssl_accept_server_cert_public_key_algorithm, None)

Default Value

""

Remarks

The textual description of the certificate's public key algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_DH") or an object identifier (OID) string representing the algorithm.

This property is read-only.

ssl_accept_server_cert_public_key_length Property

The length of the certificate's public key (in bits).

Syntax

def get_ssl_accept_server_cert_public_key_length() -> int: ...

ssl_accept_server_cert_public_key_length = property(get_ssl_accept_server_cert_public_key_length, None)

Default Value

0

Remarks

The length of the certificate's public key (in bits). Common values are 512, 1024, and 2048.

This property is read-only.

ssl_accept_server_cert_serial_number Property

The serial number of the certificate encoded as a string.

Syntax

def get_ssl_accept_server_cert_serial_number() -> str: ...

ssl_accept_server_cert_serial_number = property(get_ssl_accept_server_cert_serial_number, None)

Default Value

""

Remarks

The serial number of the certificate encoded as a string. The number is encoded as a series of hexadecimal digits, with each pair representing a byte of the serial number.

This property is read-only.

ssl_accept_server_cert_signature_algorithm Property

The text description of the certificate's signature algorithm.

Syntax

def get_ssl_accept_server_cert_signature_algorithm() -> str: ...

ssl_accept_server_cert_signature_algorithm = property(get_ssl_accept_server_cert_signature_algorithm, None)

Default Value

""

Remarks

The text description of the certificate's signature algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_MD5RSA") or an object identifier (OID) string representing the algorithm.

This property is read-only.

ssl_accept_server_cert_store Property

The name of the certificate store for the client certificate.

Syntax

def get_ssl_accept_server_cert_store() -> bytes: ...
def set_ssl_accept_server_cert_store(value: bytes) -> None: ...

ssl_accept_server_cert_store = property(get_ssl_accept_server_cert_store, set_ssl_accept_server_cert_store)

Default Value

"MY"

Remarks

The name of the certificate store for the client certificate.

The ssl_accept_server_cert_store_type property denotes the type of the certificate store specified by ssl_accept_server_cert_store. If the store is password-protected, specify the password in ssl_accept_server_cert_store_password.

ssl_accept_server_cert_store is used in conjunction with the ssl_accept_server_cert_subject property to specify client certificates. If ssl_accept_server_cert_store has a value, and ssl_accept_server_cert_subject or ssl_accept_server_cert_encoded is set, a search for a certificate is initiated. Please see the ssl_accept_server_cert_subject property for details.

Designations of certificate stores are platform dependent.

The following designations are the most common User and Machine certificate stores in Windows:

When the certificate store type is cstPFXFile, this property must be set to the name of the file. When the type is cstPFXBlob, the property must be set to the binary contents of a PFX file (i.e., PKCS#12 certificate store).

ssl_accept_server_cert_store_password Property

If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.

Syntax

def get_ssl_accept_server_cert_store_password() -> str: ...
def set_ssl_accept_server_cert_store_password(value: str) -> None: ...

ssl_accept_server_cert_store_password = property(get_ssl_accept_server_cert_store_password, set_ssl_accept_server_cert_store_password)

Default Value

""

Remarks

If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.

ssl_accept_server_cert_store_type Property

The type of certificate store for this certificate.

Syntax

def get_ssl_accept_server_cert_store_type() -> int: ...
def set_ssl_accept_server_cert_store_type(value: int) -> None: ...

ssl_accept_server_cert_store_type = property(get_ssl_accept_server_cert_store_type, set_ssl_accept_server_cert_store_type)

Default Value

0

Remarks

The type of certificate store for this certificate.

The class supports both public and private keys in a variety of formats. When the cstAuto value is used, the class will automatically determine the type. This property can take one of the following values:

ssl_accept_server_cert_subject_alt_names Property

Comma-separated lists of alternative subject names for the certificate.

Syntax

def get_ssl_accept_server_cert_subject_alt_names() -> str: ...

ssl_accept_server_cert_subject_alt_names = property(get_ssl_accept_server_cert_subject_alt_names, None)

Default Value

""

Remarks

Comma-separated lists of alternative subject names for the certificate.

This property is read-only.

ssl_accept_server_cert_thumbprint_md5 Property

The MD5 hash of the certificate.

Syntax

def get_ssl_accept_server_cert_thumbprint_md5() -> str: ...

ssl_accept_server_cert_thumbprint_md5 = property(get_ssl_accept_server_cert_thumbprint_md5, None)

Default Value

""

Remarks

The MD5 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

ssl_accept_server_cert_thumbprint_sha1 Property

The SHA-1 hash of the certificate.

Syntax

def get_ssl_accept_server_cert_thumbprint_sha1() -> str: ...

ssl_accept_server_cert_thumbprint_sha1 = property(get_ssl_accept_server_cert_thumbprint_sha1, None)

Default Value

""

Remarks

The SHA-1 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

ssl_accept_server_cert_thumbprint_sha256 Property

The SHA-256 hash of the certificate.

Syntax

def get_ssl_accept_server_cert_thumbprint_sha256() -> str: ...

ssl_accept_server_cert_thumbprint_sha256 = property(get_ssl_accept_server_cert_thumbprint_sha256, None)

Default Value

""

Remarks

The SHA-256 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

ssl_accept_server_cert_usage Property

The text description of UsageFlags .

Syntax

def get_ssl_accept_server_cert_usage() -> str: ...

ssl_accept_server_cert_usage = property(get_ssl_accept_server_cert_usage, None)

Default Value

""

Remarks

The text description of ssl_accept_server_cert_usage_flags.

This value will be one or more of the following strings and will be separated by commas:

• Digital Signature
• Non-Repudiation
• Key Encipherment
• Data Encipherment
• Key Agreement
• Certificate Signing
• CRL Signing
• Encipher Only

If the provider is OpenSSL, the value is a comma-separated list of X.509 certificate extension names.

This property is read-only.

ssl_accept_server_cert_usage_flags Property

The flags that show intended use for the certificate.

Syntax

def get_ssl_accept_server_cert_usage_flags() -> int: ...

ssl_accept_server_cert_usage_flags = property(get_ssl_accept_server_cert_usage_flags, None)

Default Value

0

Remarks

The flags that show intended use for the certificate. The value of ssl_accept_server_cert_usage_flags is a combination of the following flags:

Please see the ssl_accept_server_cert_usage property for a text representation of ssl_accept_server_cert_usage_flags.

This functionality currently is not available when the provider is OpenSSL.

This property is read-only.

ssl_accept_server_cert_version Property

The certificate's version number.

Syntax

def get_ssl_accept_server_cert_version() -> str: ...

ssl_accept_server_cert_version = property(get_ssl_accept_server_cert_version, None)

Default Value

""

Remarks

The certificate's version number. The possible values are the strings "V1", "V2", and "V3".

This property is read-only.

ssl_accept_server_cert_subject Property

The subject of the certificate used for client authentication.

Syntax

def get_ssl_accept_server_cert_subject() -> str: ...
def set_ssl_accept_server_cert_subject(value: str) -> None: ...

ssl_accept_server_cert_subject = property(get_ssl_accept_server_cert_subject, set_ssl_accept_server_cert_subject)

Default Value

""

Remarks

The subject of the certificate used for client authentication.

This property must be set after all other certificate properties are set. When this property is set, a search is performed in the current certificate store to locate a certificate with a matching subject.

If a matching certificate is found, the property is set to the full subject of the matching certificate.

If an exact match is not found, the store is searched for subjects containing the value of the property.

If a match is still not found, the property is set to an empty string, and no certificate is selected.

The special value "*" picks a random certificate in the certificate store.

The certificate subject is a comma-separated list of distinguished name fields and values. For instance, "CN=www.server.com, OU=test, C=US, E=support@nsoftware.com". Common fields and their meanings are as follows:

If a field value contains a comma, it must be quoted.

ssl_accept_server_cert_encoded Property

The certificate (PEM/Base64 encoded).

Syntax

def get_ssl_accept_server_cert_encoded() -> bytes: ...
def set_ssl_accept_server_cert_encoded(value: bytes) -> None: ...

ssl_accept_server_cert_encoded = property(get_ssl_accept_server_cert_encoded, set_ssl_accept_server_cert_encoded)

Default Value

""

Remarks

The certificate (PEM/Base64 encoded). This property is used to assign a specific certificate. The ssl_accept_server_cert_store and ssl_accept_server_cert_subject properties also may be used to specify a certificate.

When ssl_accept_server_cert_encoded is set, a search is initiated in the current ssl_accept_server_cert_store for the private key of the certificate. If the key is found, ssl_accept_server_cert_subject is updated to reflect the full subject of the selected certificate; otherwise, ssl_accept_server_cert_subject is set to an empty string.

ssl_cert_effective_date Property

The date on which this certificate becomes valid.

Syntax

def get_ssl_cert_effective_date() -> str: ...

ssl_cert_effective_date = property(get_ssl_cert_effective_date, None)

Default Value

""

Remarks

The date on which this certificate becomes valid. Before this date, it is not valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:

23-Jan-2000 15:00:00.

This property is read-only.

ssl_cert_expiration_date Property

The date on which the certificate expires.

Syntax

def get_ssl_cert_expiration_date() -> str: ...

ssl_cert_expiration_date = property(get_ssl_cert_expiration_date, None)

Default Value

""

Remarks

The date on which the certificate expires. After this date, the certificate will no longer be valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:

23-Jan-2001 15:00:00.

This property is read-only.

ssl_cert_extended_key_usage Property

A comma-delimited list of extended key usage identifiers.

Syntax

def get_ssl_cert_extended_key_usage() -> str: ...

ssl_cert_extended_key_usage = property(get_ssl_cert_extended_key_usage, None)

Default Value

""

Remarks

A comma-delimited list of extended key usage identifiers. These are the same as ASN.1 object identifiers (OIDs).

This property is read-only.

ssl_cert_fingerprint Property

The hex-encoded, 16-byte MD5 fingerprint of the certificate.

Syntax

def get_ssl_cert_fingerprint() -> str: ...

ssl_cert_fingerprint = property(get_ssl_cert_fingerprint, None)

Default Value

""

Remarks

The hex-encoded, 16-byte MD5 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: bc:2a:72:af:fe:58:17:43:7a:5f:ba:5a:7c:90:f7:02

This property is read-only.

ssl_cert_fingerprint_sha1 Property

The hex-encoded, 20-byte SHA-1 fingerprint of the certificate.

Syntax

def get_ssl_cert_fingerprint_sha1() -> str: ...

ssl_cert_fingerprint_sha1 = property(get_ssl_cert_fingerprint_sha1, None)

Default Value

""

Remarks

The hex-encoded, 20-byte SHA-1 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: 30:7b:fa:38:65:83:ff:da:b4:4e:07:3f:17:b8:a4:ed:80:be:ff:84

This property is read-only.

ssl_cert_fingerprint_sha256 Property

The hex-encoded, 32-byte SHA-256 fingerprint of the certificate.

Syntax

def get_ssl_cert_fingerprint_sha256() -> str: ...

ssl_cert_fingerprint_sha256 = property(get_ssl_cert_fingerprint_sha256, None)

Default Value

""

Remarks

The hex-encoded, 32-byte SHA-256 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: 6a:80:5c:33:a9:43:ea:b0:96:12:8a:64:96:30:ef:4a:8a:96:86:ce:f4:c7:be:10:24:8e:2b:60:9e:f3:59:53

This property is read-only.

ssl_cert_issuer Property

The issuer of the certificate.

Syntax

def get_ssl_cert_issuer() -> str: ...

ssl_cert_issuer = property(get_ssl_cert_issuer, None)

Default Value

""

Remarks

The issuer of the certificate. This property contains a string representation of the name of the issuing authority for the certificate.

This property is read-only.

ssl_cert_private_key Property

The private key of the certificate (if available).

Syntax

def get_ssl_cert_private_key() -> str: ...

ssl_cert_private_key = property(get_ssl_cert_private_key, None)

Default Value

""

Remarks

The private key of the certificate (if available). The key is provided as PEM/Base64-encoded data.

Note: The ssl_cert_private_key may be available but not exportable. In this case, ssl_cert_private_key returns an empty string.

This property is read-only.

ssl_cert_private_key_available Property

Whether a PrivateKey is available for the selected certificate.

Syntax

def get_ssl_cert_private_key_available() -> bool: ...

ssl_cert_private_key_available = property(get_ssl_cert_private_key_available, None)

Default Value

FALSE

Remarks

Whether a ssl_cert_private_key is available for the selected certificate. If ssl_cert_private_key_available is True, the certificate may be used for authentication purposes (e.g., server authentication).

This property is read-only.

ssl_cert_private_key_container Property

The name of the PrivateKey container for the certificate (if available).

Syntax

def get_ssl_cert_private_key_container() -> str: ...

ssl_cert_private_key_container = property(get_ssl_cert_private_key_container, None)

Default Value

""

Remarks

The name of the ssl_cert_private_key container for the certificate (if available). This functionality is available only on Windows platforms.

This property is read-only.

ssl_cert_public_key Property

The public key of the certificate.

Syntax

def get_ssl_cert_public_key() -> str: ...

ssl_cert_public_key = property(get_ssl_cert_public_key, None)

Default Value

""

Remarks

The public key of the certificate. The key is provided as PEM/Base64-encoded data.

This property is read-only.

ssl_cert_public_key_algorithm Property

The textual description of the certificate's public key algorithm.

Syntax

def get_ssl_cert_public_key_algorithm() -> str: ...

ssl_cert_public_key_algorithm = property(get_ssl_cert_public_key_algorithm, None)

Default Value

""

Remarks

The textual description of the certificate's public key algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_DH") or an object identifier (OID) string representing the algorithm.

This property is read-only.

ssl_cert_public_key_length Property

The length of the certificate's public key (in bits).

Syntax

def get_ssl_cert_public_key_length() -> int: ...

ssl_cert_public_key_length = property(get_ssl_cert_public_key_length, None)

Default Value

0

Remarks

The length of the certificate's public key (in bits). Common values are 512, 1024, and 2048.

This property is read-only.

ssl_cert_serial_number Property

The serial number of the certificate encoded as a string.

Syntax

def get_ssl_cert_serial_number() -> str: ...

ssl_cert_serial_number = property(get_ssl_cert_serial_number, None)

Default Value

""

Remarks

The serial number of the certificate encoded as a string. The number is encoded as a series of hexadecimal digits, with each pair representing a byte of the serial number.

This property is read-only.

ssl_cert_signature_algorithm Property

The text description of the certificate's signature algorithm.

Syntax

def get_ssl_cert_signature_algorithm() -> str: ...

ssl_cert_signature_algorithm = property(get_ssl_cert_signature_algorithm, None)

Default Value

""

Remarks

The text description of the certificate's signature algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_MD5RSA") or an object identifier (OID) string representing the algorithm.

This property is read-only.

ssl_cert_store Property

The name of the certificate store for the client certificate.

Syntax

def get_ssl_cert_store() -> bytes: ...
def set_ssl_cert_store(value: bytes) -> None: ...

ssl_cert_store = property(get_ssl_cert_store, set_ssl_cert_store)

Default Value

"MY"

Remarks

The name of the certificate store for the client certificate.

The ssl_cert_store_type property denotes the type of the certificate store specified by ssl_cert_store. If the store is password-protected, specify the password in ssl_cert_store_password.

ssl_cert_store is used in conjunction with the ssl_cert_subject property to specify client certificates. If ssl_cert_store has a value, and ssl_cert_subject or ssl_cert_encoded is set, a search for a certificate is initiated. Please see the ssl_cert_subject property for details.

Designations of certificate stores are platform dependent.

The following designations are the most common User and Machine certificate stores in Windows:

When the certificate store type is cstPFXFile, this property must be set to the name of the file. When the type is cstPFXBlob, the property must be set to the binary contents of a PFX file (i.e., PKCS#12 certificate store).

ssl_cert_store_password Property

If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.

Syntax

def get_ssl_cert_store_password() -> str: ...
def set_ssl_cert_store_password(value: str) -> None: ...

ssl_cert_store_password = property(get_ssl_cert_store_password, set_ssl_cert_store_password)

Default Value

""

Remarks

If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.

ssl_cert_store_type Property

The type of certificate store for this certificate.

Syntax

def get_ssl_cert_store_type() -> int: ...
def set_ssl_cert_store_type(value: int) -> None: ...

ssl_cert_store_type = property(get_ssl_cert_store_type, set_ssl_cert_store_type)

Default Value

0

Remarks

The type of certificate store for this certificate.

The class supports both public and private keys in a variety of formats. When the cstAuto value is used, the class will automatically determine the type. This property can take one of the following values:

ssl_cert_subject_alt_names Property

Comma-separated lists of alternative subject names for the certificate.

Syntax

def get_ssl_cert_subject_alt_names() -> str: ...

ssl_cert_subject_alt_names = property(get_ssl_cert_subject_alt_names, None)

Default Value

""

Remarks

Comma-separated lists of alternative subject names for the certificate.

This property is read-only.

ssl_cert_thumbprint_md5 Property

The MD5 hash of the certificate.

Syntax

def get_ssl_cert_thumbprint_md5() -> str: ...

ssl_cert_thumbprint_md5 = property(get_ssl_cert_thumbprint_md5, None)

Default Value

""

Remarks

The MD5 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

ssl_cert_thumbprint_sha1 Property

The SHA-1 hash of the certificate.

Syntax

def get_ssl_cert_thumbprint_sha1() -> str: ...

ssl_cert_thumbprint_sha1 = property(get_ssl_cert_thumbprint_sha1, None)

Default Value

""

Remarks

The SHA-1 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

ssl_cert_thumbprint_sha256 Property

The SHA-256 hash of the certificate.

Syntax

def get_ssl_cert_thumbprint_sha256() -> str: ...

ssl_cert_thumbprint_sha256 = property(get_ssl_cert_thumbprint_sha256, None)

Default Value

""

Remarks

The SHA-256 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

ssl_cert_usage Property

The text description of UsageFlags .

Syntax

def get_ssl_cert_usage() -> str: ...

ssl_cert_usage = property(get_ssl_cert_usage, None)

Default Value

""

Remarks

The text description of ssl_cert_usage_flags.

This value will be one or more of the following strings and will be separated by commas:

• Digital Signature
• Non-Repudiation
• Key Encipherment
• Data Encipherment
• Key Agreement
• Certificate Signing
• CRL Signing
• Encipher Only

If the provider is OpenSSL, the value is a comma-separated list of X.509 certificate extension names.

This property is read-only.

ssl_cert_usage_flags Property

The flags that show intended use for the certificate.

Syntax

def get_ssl_cert_usage_flags() -> int: ...

ssl_cert_usage_flags = property(get_ssl_cert_usage_flags, None)

Default Value

0

Remarks

The flags that show intended use for the certificate. The value of ssl_cert_usage_flags is a combination of the following flags:

Please see the ssl_cert_usage property for a text representation of ssl_cert_usage_flags.

This functionality currently is not available when the provider is OpenSSL.

This property is read-only.

ssl_cert_version Property

The certificate's version number.

Syntax

def get_ssl_cert_version() -> str: ...

ssl_cert_version = property(get_ssl_cert_version, None)

Default Value

""

Remarks

The certificate's version number. The possible values are the strings "V1", "V2", and "V3".

This property is read-only.

ssl_cert_subject Property

The subject of the certificate used for client authentication.

Syntax

def get_ssl_cert_subject() -> str: ...
def set_ssl_cert_subject(value: str) -> None: ...

ssl_cert_subject = property(get_ssl_cert_subject, set_ssl_cert_subject)

Default Value

""

Remarks

The subject of the certificate used for client authentication.

This property must be set after all other certificate properties are set. When this property is set, a search is performed in the current certificate store to locate a certificate with a matching subject.

If a matching certificate is found, the property is set to the full subject of the matching certificate.

If an exact match is not found, the store is searched for subjects containing the value of the property.

If a match is still not found, the property is set to an empty string, and no certificate is selected.

The special value "*" picks a random certificate in the certificate store.

The certificate subject is a comma-separated list of distinguished name fields and values. For instance, "CN=www.server.com, OU=test, C=US, E=support@nsoftware.com". Common fields and their meanings are as follows:

If a field value contains a comma, it must be quoted.

ssl_cert_encoded Property

The certificate (PEM/Base64 encoded).

Syntax

def get_ssl_cert_encoded() -> bytes: ...
def set_ssl_cert_encoded(value: bytes) -> None: ...

ssl_cert_encoded = property(get_ssl_cert_encoded, set_ssl_cert_encoded)

Default Value

""

Remarks

The certificate (PEM/Base64 encoded). This property is used to assign a specific certificate. The ssl_cert_store and ssl_cert_subject properties also may be used to specify a certificate.

When ssl_cert_encoded is set, a search is initiated in the current ssl_cert_store for the private key of the certificate. If the key is found, ssl_cert_subject is updated to reflect the full subject of the selected certificate; otherwise, ssl_cert_subject is set to an empty string.

ssl_provider Property

The Secure Sockets Layer/Transport Layer Security (SSL/TLS) implementation to use.

Syntax

def get_ssl_provider() -> int: ...
def set_ssl_provider(value: int) -> None: ...

ssl_provider = property(get_ssl_provider, set_ssl_provider)

Default Value

0

Remarks

This property specifies the SSL/TLS implementation to use. In most cases the default value of 0 (Automatic) is recommended and should not be changed. When set to 0 (Automatic), the class will select whether to use the platform implementation or the internal implementation depending on the operating system as well as the TLS version being used.

Possible values are as follows:

Additional Notes

In most cases using the default value (Automatic) is recommended. The class will select a provider depending on the current platform.

When Automatic is selected, on Windows, the class will use the platform implementation. On Linux/macOS, the class will use the internal implementation. When TLS 1.3 is enabled via SSLEnabledProtocols, the internal implementation is used on all platforms.

ssl_server_cert_effective_date Property

The date on which this certificate becomes valid.

Syntax

def get_ssl_server_cert_effective_date() -> str: ...

ssl_server_cert_effective_date = property(get_ssl_server_cert_effective_date, None)

Default Value

""

Remarks

The date on which this certificate becomes valid. Before this date, it is not valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:

23-Jan-2000 15:00:00.

This property is read-only.

ssl_server_cert_expiration_date Property

The date on which the certificate expires.

Syntax

def get_ssl_server_cert_expiration_date() -> str: ...

ssl_server_cert_expiration_date = property(get_ssl_server_cert_expiration_date, None)

Default Value

""

Remarks

The date on which the certificate expires. After this date, the certificate will no longer be valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:

23-Jan-2001 15:00:00.

This property is read-only.

ssl_server_cert_extended_key_usage Property

A comma-delimited list of extended key usage identifiers.

Syntax

def get_ssl_server_cert_extended_key_usage() -> str: ...

ssl_server_cert_extended_key_usage = property(get_ssl_server_cert_extended_key_usage, None)

Default Value

""

Remarks

A comma-delimited list of extended key usage identifiers. These are the same as ASN.1 object identifiers (OIDs).

This property is read-only.

ssl_server_cert_fingerprint Property

The hex-encoded, 16-byte MD5 fingerprint of the certificate.

Syntax

def get_ssl_server_cert_fingerprint() -> str: ...

ssl_server_cert_fingerprint = property(get_ssl_server_cert_fingerprint, None)

Default Value

""

Remarks

The hex-encoded, 16-byte MD5 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: bc:2a:72:af:fe:58:17:43:7a:5f:ba:5a:7c:90:f7:02

This property is read-only.

ssl_server_cert_fingerprint_sha1 Property

The hex-encoded, 20-byte SHA-1 fingerprint of the certificate.

Syntax

def get_ssl_server_cert_fingerprint_sha1() -> str: ...

ssl_server_cert_fingerprint_sha1 = property(get_ssl_server_cert_fingerprint_sha1, None)

Default Value

""

Remarks

The hex-encoded, 20-byte SHA-1 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: 30:7b:fa:38:65:83:ff:da:b4:4e:07:3f:17:b8:a4:ed:80:be:ff:84

This property is read-only.

ssl_server_cert_fingerprint_sha256 Property

The hex-encoded, 32-byte SHA-256 fingerprint of the certificate.

Syntax

def get_ssl_server_cert_fingerprint_sha256() -> str: ...

ssl_server_cert_fingerprint_sha256 = property(get_ssl_server_cert_fingerprint_sha256, None)

Default Value

""

Remarks

The hex-encoded, 32-byte SHA-256 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: 6a:80:5c:33:a9:43:ea:b0:96:12:8a:64:96:30:ef:4a:8a:96:86:ce:f4:c7:be:10:24:8e:2b:60:9e:f3:59:53

This property is read-only.

ssl_server_cert_issuer Property

The issuer of the certificate.

Syntax

def get_ssl_server_cert_issuer() -> str: ...

ssl_server_cert_issuer = property(get_ssl_server_cert_issuer, None)

Default Value

""

Remarks

The issuer of the certificate. This property contains a string representation of the name of the issuing authority for the certificate.

This property is read-only.

ssl_server_cert_private_key Property

The private key of the certificate (if available).

Syntax

def get_ssl_server_cert_private_key() -> str: ...

ssl_server_cert_private_key = property(get_ssl_server_cert_private_key, None)

Default Value

""

Remarks

The private key of the certificate (if available). The key is provided as PEM/Base64-encoded data.

Note: The ssl_server_cert_private_key may be available but not exportable. In this case, ssl_server_cert_private_key returns an empty string.

This property is read-only.

ssl_server_cert_private_key_available Property

Whether a PrivateKey is available for the selected certificate.

Syntax

def get_ssl_server_cert_private_key_available() -> bool: ...

ssl_server_cert_private_key_available = property(get_ssl_server_cert_private_key_available, None)

Default Value

FALSE

Remarks

Whether a ssl_server_cert_private_key is available for the selected certificate. If ssl_server_cert_private_key_available is True, the certificate may be used for authentication purposes (e.g., server authentication).

This property is read-only.

ssl_server_cert_private_key_container Property

The name of the PrivateKey container for the certificate (if available).

Syntax

def get_ssl_server_cert_private_key_container() -> str: ...

ssl_server_cert_private_key_container = property(get_ssl_server_cert_private_key_container, None)

Default Value

""

Remarks

The name of the ssl_server_cert_private_key container for the certificate (if available). This functionality is available only on Windows platforms.

This property is read-only.

ssl_server_cert_public_key Property

The public key of the certificate.

Syntax

def get_ssl_server_cert_public_key() -> str: ...

ssl_server_cert_public_key = property(get_ssl_server_cert_public_key, None)

Default Value

""

Remarks

The public key of the certificate. The key is provided as PEM/Base64-encoded data.

This property is read-only.

ssl_server_cert_public_key_algorithm Property

The textual description of the certificate's public key algorithm.

Syntax

def get_ssl_server_cert_public_key_algorithm() -> str: ...

ssl_server_cert_public_key_algorithm = property(get_ssl_server_cert_public_key_algorithm, None)

Default Value

""

Remarks

The textual description of the certificate's public key algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_DH") or an object identifier (OID) string representing the algorithm.

This property is read-only.

ssl_server_cert_public_key_length Property

The length of the certificate's public key (in bits).

Syntax

def get_ssl_server_cert_public_key_length() -> int: ...

ssl_server_cert_public_key_length = property(get_ssl_server_cert_public_key_length, None)

Default Value

0

Remarks

The length of the certificate's public key (in bits). Common values are 512, 1024, and 2048.

This property is read-only.

ssl_server_cert_serial_number Property

The serial number of the certificate encoded as a string.

Syntax

def get_ssl_server_cert_serial_number() -> str: ...

ssl_server_cert_serial_number = property(get_ssl_server_cert_serial_number, None)

Default Value

""

Remarks

The serial number of the certificate encoded as a string. The number is encoded as a series of hexadecimal digits, with each pair representing a byte of the serial number.

This property is read-only.

ssl_server_cert_signature_algorithm Property

The text description of the certificate's signature algorithm.

Syntax

def get_ssl_server_cert_signature_algorithm() -> str: ...

ssl_server_cert_signature_algorithm = property(get_ssl_server_cert_signature_algorithm, None)

Default Value

""

Remarks

The text description of the certificate's signature algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_MD5RSA") or an object identifier (OID) string representing the algorithm.

This property is read-only.

ssl_server_cert_store Property

The name of the certificate store for the client certificate.

Syntax

def get_ssl_server_cert_store() -> bytes: ...

ssl_server_cert_store = property(get_ssl_server_cert_store, None)

Default Value

"MY"

Remarks

The name of the certificate store for the client certificate.

The ssl_server_cert_store_type property denotes the type of the certificate store specified by ssl_server_cert_store. If the store is password-protected, specify the password in ssl_server_cert_store_password.

ssl_server_cert_store is used in conjunction with the ssl_server_cert_subject property to specify client certificates. If ssl_server_cert_store has a value, and ssl_server_cert_subject or ssl_server_cert_encoded is set, a search for a certificate is initiated. Please see the ssl_server_cert_subject property for details.

Designations of certificate stores are platform dependent.

The following designations are the most common User and Machine certificate stores in Windows:

When the certificate store type is cstPFXFile, this property must be set to the name of the file. When the type is cstPFXBlob, the property must be set to the binary contents of a PFX file (i.e., PKCS#12 certificate store).

This property is read-only.

ssl_server_cert_store_password Property

If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.

Syntax

def get_ssl_server_cert_store_password() -> str: ...

ssl_server_cert_store_password = property(get_ssl_server_cert_store_password, None)

Default Value

""

Remarks

If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.

This property is read-only.

ssl_server_cert_store_type Property

The type of certificate store for this certificate.

Syntax

def get_ssl_server_cert_store_type() -> int: ...

ssl_server_cert_store_type = property(get_ssl_server_cert_store_type, None)

Default Value

0

Remarks

The type of certificate store for this certificate.

The class supports both public and private keys in a variety of formats. When the cstAuto value is used, the class will automatically determine the type. This property can take one of the following values:

This property is read-only.

ssl_server_cert_subject_alt_names Property

Comma-separated lists of alternative subject names for the certificate.

Syntax

def get_ssl_server_cert_subject_alt_names() -> str: ...

ssl_server_cert_subject_alt_names = property(get_ssl_server_cert_subject_alt_names, None)

Default Value

""

Remarks

Comma-separated lists of alternative subject names for the certificate.

This property is read-only.

ssl_server_cert_thumbprint_md5 Property

The MD5 hash of the certificate.

Syntax

def get_ssl_server_cert_thumbprint_md5() -> str: ...

ssl_server_cert_thumbprint_md5 = property(get_ssl_server_cert_thumbprint_md5, None)

Default Value

""

Remarks

The MD5 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

ssl_server_cert_thumbprint_sha1 Property

The SHA-1 hash of the certificate.

Syntax

def get_ssl_server_cert_thumbprint_sha1() -> str: ...

ssl_server_cert_thumbprint_sha1 = property(get_ssl_server_cert_thumbprint_sha1, None)

Default Value

""

Remarks

The SHA-1 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

ssl_server_cert_thumbprint_sha256 Property

The SHA-256 hash of the certificate.

Syntax

def get_ssl_server_cert_thumbprint_sha256() -> str: ...

ssl_server_cert_thumbprint_sha256 = property(get_ssl_server_cert_thumbprint_sha256, None)

Default Value

""

Remarks

The SHA-256 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

ssl_server_cert_usage Property

The text description of UsageFlags .

Syntax

def get_ssl_server_cert_usage() -> str: ...

ssl_server_cert_usage = property(get_ssl_server_cert_usage, None)

Default Value

""

Remarks

The text description of ssl_server_cert_usage_flags.

This value will be one or more of the following strings and will be separated by commas:

• Digital Signature
• Non-Repudiation
• Key Encipherment
• Data Encipherment
• Key Agreement
• Certificate Signing
• CRL Signing
• Encipher Only

If the provider is OpenSSL, the value is a comma-separated list of X.509 certificate extension names.

This property is read-only.

ssl_server_cert_usage_flags Property

The flags that show intended use for the certificate.

Syntax

def get_ssl_server_cert_usage_flags() -> int: ...

ssl_server_cert_usage_flags = property(get_ssl_server_cert_usage_flags, None)

Default Value

0

Remarks

The flags that show intended use for the certificate. The value of ssl_server_cert_usage_flags is a combination of the following flags:

Please see the ssl_server_cert_usage property for a text representation of ssl_server_cert_usage_flags.

This functionality currently is not available when the provider is OpenSSL.

This property is read-only.

ssl_server_cert_version Property

The certificate's version number.

Syntax

def get_ssl_server_cert_version() -> str: ...

ssl_server_cert_version = property(get_ssl_server_cert_version, None)

Default Value

""

Remarks

The certificate's version number. The possible values are the strings "V1", "V2", and "V3".

This property is read-only.

ssl_server_cert_subject Property

The subject of the certificate used for client authentication.

Syntax

def get_ssl_server_cert_subject() -> str: ...

ssl_server_cert_subject = property(get_ssl_server_cert_subject, None)

Default Value

""

Remarks

The subject of the certificate used for client authentication.

This property must be set after all other certificate properties are set. When this property is set, a search is performed in the current certificate store to locate a certificate with a matching subject.

If a matching certificate is found, the property is set to the full subject of the matching certificate.

If an exact match is not found, the store is searched for subjects containing the value of the property.

If a match is still not found, the property is set to an empty string, and no certificate is selected.

The special value "*" picks a random certificate in the certificate store.

The certificate subject is a comma-separated list of distinguished name fields and values. For instance, "CN=www.server.com, OU=test, C=US, E=support@nsoftware.com". Common fields and their meanings are as follows:

If a field value contains a comma, it must be quoted.

This property is read-only.

ssl_server_cert_encoded Property

The certificate (PEM/Base64 encoded).

Syntax

def get_ssl_server_cert_encoded() -> bytes: ...

ssl_server_cert_encoded = property(get_ssl_server_cert_encoded, None)

Default Value

""

Remarks

The certificate (PEM/Base64 encoded). This property is used to assign a specific certificate. The ssl_server_cert_store and ssl_server_cert_subject properties also may be used to specify a certificate.

When ssl_server_cert_encoded is set, a search is initiated in the current ssl_server_cert_store for the private key of the certificate. If the key is found, ssl_server_cert_subject is updated to reflect the full subject of the selected certificate; otherwise, ssl_server_cert_subject is set to an empty string.

This property is read-only.

add_attachment Method

Adds a file attachment to an existing message.

Syntax

def add_attachment(message_id: str, name: str, local_file: str) -> None: ...

Remarks

This method adds a file attachment to an existing message, specified by the MessageId parameter. To add a more complex attachment, set the Name and LocalFile parameters and the class will use the first attachment in the message_attachments properties. As a note, this will not clear the message_attachments properties. If the file is larger than the value set in the AttachmentSimpleUploadLimit configuration, then the class will use an upload session to upload the attachment in fragments. The size of the fragments are specified in the AttachmentFragmentSize configuration.

This method is not used to add attachments to messages that are sent with the send_mail method.

Example (Adding a Simple Attachment to a New Draft)

office365.CreateDraft(0, ""); String messageId = office365.MessageInfo[0].Id; office365.AddAttachment(messageId, "file1.zip", "C:\file1.zip"); Example (Adding a Simple Attachment to a New Draft)

office365.MessageSubject = "Subject"; office365.MessageBodyContentType = "html"; office365.MessageBodyContent = "<p>Body</p><img src='cid:test1'>"; office365.MessageTo = "email@example.com"; office365.CreateDraft(0, ""); String messageId = office365.MessageInfo[0].Id; office365.AddAttachment(messageId, "file1.zip", "C:\file1.zip"); Example (Adding a Complex Attachment to a New Draft) office365.SetMessageSubject("Subject"); office365.SetMessageBodyContentType("HTML"); office365.SetMessageBodyContent("<p>Body</p><img src='cid:test1'>"); office365.SetMessageTo("email@example.com"); office365.CreateDraft(0,""); office365.SetMessageAttachmentCount(1); office365.SetMessageAttachmentFile(0, "./test.png"); office365.SetMessageAttachmentContentId(0, "test1"); office365.SetMessageAttachmentIsInline(0, true); office365.AddAttachment(office365.GetMessageInfoId(0), "", ""); office365.SendDraft(office365.GetMessageInfoId(0));

add_item_attachment Method

Adds an item attachment to an existing message.

Syntax

def add_item_attachment(message_id: str, msg_to_attach_id: str, item_json: str) -> None: ...

Remarks

Adds an item attachment to an existing message, specified by the MessageId parameter. Item attachments are non-file attachments, such as Outlook messages, events, and contacts. To add another message as an attachment, set the msgToAttachId parameter to its ID. To add an event or contact as an attachment, leave the msgToAttachId parameter empty and provide the full JSON.

This method is not used to add attachments to messages that are sent with the send_mail method.

Example (Adding an Existing Message to a New Draft)

office365.MessageSubject = "Subject"; office365.MessageBodyContentType = "text"; office365.MessageBodyContent = "Body"; office365.MessageTo = "email@example.com"; office365.CreateDraft(0, ""); String messageId = office365.MessageInfo[0].Id; office365.AddItemAttachment(messageId, "AAMkADNkNJp5JVnQIe9r0=", ""); Example (Adding an Event to a New Draft)

office365.MessageSubject = "Subject"; office365.MessageBodyContentType = "text"; office365.MessageBodyContent = "Body"; office365.MessageTo = "email@example.com"; office365.CreateDraft(0, ""); String messageId = office365.MessageInfo[0].Id; office365.AddItemAttachment(messageId, "", "{\"@odata.type\": \"#microsoft.graph.itemAttachment\", \"name\": \"Holiday event\", \"item\":{ \"@odata.type\": \"microsoft.graph.event\", \"subject\": \"Discuss gifts for children\", \"body\":{ \"content\": \"Let's look for funding!\"}, \"start\": {\"dateTime\": \"2016-12-02T18:00:00\"}, \"end\": {\"dateTime\": \"2016-12-02T19:00:00\"}}}");

authorize Method

Get the authorization string required to access the protected resource.

Syntax

def authorize() -> None: ...

Remarks

This method is used to get an access token that is required to access the protected resource. The method will act differently based on what is set in the o_auth_client_profile property and the o_auth_grant_type property. This method is not to be used in conjunction with the authorization property. It should instead be used when setting the o_auth property.

For more information, see the introduction section.

config Method

Sets or retrieves a configuration setting.

Syntax

def config(configuration_string: str) -> str: ...

Remarks

config is a generic method available in every class. It is used to set and retrieve configuration settings for the class.

These settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the class, access to these internal properties is provided through the config method.

To set a configuration setting named PROPERTY, you must call Config("PROPERTY=VALUE"), where VALUE is the value of the setting expressed as a string. For boolean values, use the strings "True", "False", "0", "1", "Yes", or "No" (case does not matter).

To read (query) the value of a configuration setting, you must call Config("PROPERTY"). The value will be returned as a string.

copy Method

Creates a copy of a message.

Syntax

def copy(id: str, destination_id: str) -> None: ...

Remarks

This method copies a message to a folder. id takes the ID of the message to be copied, and destinationId takes the ID of the folder the message will be copied to.

copy_folder Method

Copies a folder.

Syntax

def copy_folder(id: str, dest_folder_id: str) -> None: ...

Remarks

This method copies a folder to a new parent folder. Please note that two folders with the same name may not exist under the same parent folder. Since this method does not change the name of a folder, it is not possible to directly create a copy of a folder in the original folder's location.

create_category Method

Creates a new category.

Syntax

def create_category(display_name: str, color: str) -> None: ...

Remarks

This method creates a new Office365 category. The created category is added to the end of the categories properties.

Example

office365.CreateCategory(categoryName, "preset9");

create_contact Method

Creates a contact.

Syntax

def create_contact(first_name: str, last_name: str, email_address: str, parent_id: str) -> None: ...

Remarks

This method creates a new contact with the specified first name, last name, and email address. At least one of the arguments must be provided. If all parameters are null or empty, an error is thrown. The contact is added to the parent folder specified by ParentId. Set ParentId to empty string or null to create the contact in the default Contacts folder of the signed-in user. The new contact is added to the end of the contacts list.

After creating a contact with basic information, you can update it and set additional fields by editing the contact in the contacts collection and calling the update_contact method. For more details, refer to the update_contact method.

Example (Create a Contact in the Default Contacts Folder of the User)

office365.CreateContact("Pavel", "Bansky", "pavelb@contoso.com", ""); // Create the contact in the main contacts folder.

Example (Create a Contact in a Folder)

office365.ListContactFolders(""); //This method lists all contact folders in the root folder and populates the ContactFolder collection. office365.CreateContact("Pavel", "Bansky", "pavelb@contoso.com", office365.ContactFolders[0].Id); // Created the contact in the first folder in the ContactFolders collection.

Note that additional operations on a newly created contact may not be successful if performed immediately after creation. It is recommended to wait two or more second after creation before attempting further operations on the contact resource.

create_draft Method

Creates a new email draft.

Syntax

def create_draft(draft_type: int, id: str) -> None: ...

Remarks

This method creates a new draft in the Drafts folder. The created message's information, including the draft's message id, is also added to the message_info properties. As a note, this will not clear the properties but will add it to the end.

Valid values for DraftType :

Important Notes

When using DRAFTTYPE_MESSAGE, pass in an empty string as the id. The created draft will be built using the Message* properties (i.e. MessageTo, MessageSubject, MessageFrom, etc.).

When using DRAFTTYPE_REPLY, DRAFTTYPE_REPLYALL, or DRAFTTYPE_FORWARD the id parameter can be used to specify the message that is being replied to or forwarded. Also, the created draft will NOT be built with the Message* properties. Instead, the created draft will be empty (except for the From field). The update method can be used instead to fill in the different parts of the message.

Example (New Draft)

// Create a draft message office365.MessageSubject = "Subject Text"; office365.MessageImportance = "High"; office365.MessageBodyContentType = "TEXT"; office365.MessageBodyContent = "Body Text"; office365.MessageTo = "email@example.com"; office365.CreateDraft(0, ""); office365.SendDraft(office365.MessageInfo[0].Id); Example (Reply)

// Create the reply draft string originalMessageId = "Message ID"; office365.CreateDraft(1, originalMessageId); // Set the new draft MessageInfo fields with desired options office365.MessageInfo[0].To = "email@example.com"; office365.MessageInfo[0].Subject = "Subject Text"; office365.MessageInfo[0].BodyContentType = "TEXT"; office365.MessageInfo[0].BodyContent = "Body Text"; // Update the draft office365.Update(office365.MessageInfo[0].Id); // Send the draft office365.SendDraft(office365.MessageInfo[0].Id);

create_folder Method

Creates a new folder.

Syntax

def create_folder(folder_name: str, parent_folder_id: str) -> None: ...

Remarks

This method creates a new folder. To create a folder in the root directory set parentFolderId to an empty string.

delete Method

Deletes a message.

Syntax

def delete(id: str) -> None: ...

Remarks

This method is used to delete both drafts and messages in other folders. Deleted messages will be moved to the Deleted folder. id takes the message ID of the message to be deleted. This will not remove the message from the message_info properties.

delete_attachment Method

Deletes an attachment.

Syntax

def delete_attachment(id: str, attachment_id: str) -> None: ...

Remarks

This method deletes an attachment. id takes the ID of the message the attachment is attached to. attachmentId takes the attachment ID of an existing attachment. This will not delete the attachment from the attachments properties.

delete_category Method

Deletes a mail category.

Syntax

def delete_category(id: str) -> None: ...

Remarks

This method deletes a mail category from the current mailbox. This method will not update the categories properties.

delete_contact Method

Deletes a contact.

Syntax

def delete_contact(id: str) -> None: ...

Remarks

This method deletes a contact specified by its ID. The id parameter takes the contact ID of the contact to be deleted. The contact is also removed from the contacts collection.

Example (Delete a Contact)

// List contacts and search for a contact with the name "John Doe" office365.ListContacts("folder_id"); for (int i = 0; i < office365.Contacts.Count; i++) { if (office365.Contacts[i].DisplayName == "John Doe") { //Delete the contact office365.DeleteContact(office365.Contacts[i].Id); break; } }

delete_folder Method

Deletes a folder.

Syntax

def delete_folder(id: str) -> None: ...

Remarks

This method deletes a folder from the current mailbox. id takes the ID of an existing folder. This method will not update the folders properties.

forward Method

Forward a message.

Syntax

def forward(id: str, message_html: str, to_recipients: str) -> None: ...

Remarks

This method can be used to quickly forward a message specified by id to the recipients specified by toRecipients. The toRecipients parameter accepts a comma separated list of emails to forward the message to. The messageHTML parameter is the message body to include with the forward. If messageHTML is an empty string, then the following properties are used:

Example (Simple):

office365.Forward(messageId, "This is an email I am forwarding.", "someguy@gmail.com, notreal@nsoftware.com");

Example (Advanced):

office365.MessageSubject = "Subject for the reply"; office365.MessageImportance = "Low"; office365.MessageCc = "Example@email.com"; office365.MessageBcc = "Example@email.com"; office365.MessageBodyContent = "Reply Message body"; office365.Forward(messageId, "", "example@email.com, exampletwo@email.com"); This method forwards a message specified by id. toRecipients accepts a comma separated list of emails to forward the message to.

Example (Forwarding a Message to Two Addresses)

office365.Forward(messageId, "This is an email I am forwarding.", "someguy@gmail.com, notreal@nsoftware.com");

get_category Method

Retrieves a mail category.

Syntax

def get_category(id: str) -> None: ...

Remarks

This method retrieves a mail category.

The fetched category can be accessed through the categories properties. As a note, the class does not clear the properties and will append the category to the end of it.

get_contact Method

Retrieves the contact by Id.

Syntax

def get_contact(id: str) -> None: ...

Remarks

This method retrieves a contact specified by its ID and adds the contact to the end of the contacts list. If the contact already exists in the contacts collection, it will be removed and then added to the end, preventing duplication.

Example (Get a Contact)

// Retrieve a contact by its ID string contactId = "12345"; // Replace with the actual contact ID office365.GetContact(contactId); // Access the retrieved contact var retrievedContact = office365.Contacts[office365.Contacts.Count - 1]; retrievedContact.FirstName; //first name retrievedContact.LastName; //last name retrievedContact.EmailAddressIndex=0; //set the index to zero to retrieve access the first email address retrievedContact.EmailAddress; //first email address value retrievedContact.PhonesIndex=0; //set the index to zero to retrieve access the first phone number retrievedContact.PhoneNumber; //first phone number value office365.GetContactField(office365.Contacts.Count - 1, "/json/birthday"); //birthday of the contact office365.GetContactField(office365.Contacts.Count - 1, "/json/middleName"); //middle name of the contact

get_contact_field Method

Retrieves the contact property value by JSONPath.

Syntax

def get_contact_field(index: int, json_path: str) -> str: ...

Remarks

This method retrieves a specific field within the contact's JSON field. The first parameter, index, is an integer representing the index of the contact in the contacts collection from which to retrieve the field. The second parameter, JsonPath, is the JSON path to the field you want to retrieve. Please refer to XPath for more details on how to set the Json path. The method returns a string that represents the value of the specified JSON field.

Example (Access Fields of a Contact)

office365.GetContact("ContactId"); office365.GetContactField(office365.Contacts.Count - 1, "/json/birthday"); //birthday of the contact office365.GetContactField(office365.Contacts.Count - 1, "/json/middleName"); //middle name of the contact office365.GetContactField(office365.Contacts.Count - 1, "/json/homePhones/[1]"); //first home phone number of the contact office365.GetContactField(office365.Contacts.Count - 1, "/json/businessPhones/[2]"); //second business phone number of the contact office365.GetContactField(office365.Contacts.Count - 1, "/json/homeAddress/postalCode"); //postal code of the contact office365.GetContactField(office365.Contacts.Count - 1, "/json/homeAddress/street"); //street name of the contact

get_folder Method

Retrieves a folder.

Syntax

def get_folder(id: str) -> None: ...

Remarks

This method retrieves a folder.

The fetched folder can be accessed through the folders properties. As a note, the class does not clear the properties and will append the folder to the end of it.

interrupt Method

Interrupt the current method.

Syntax

def interrupt() -> None: ...

Remarks

If there is no method in progress, interrupt simply returns, doing nothing.

list_attachments Method

Lists all of a message's attachments.

Syntax

def list_attachments(id: str) -> None: ...

Remarks

This method lists all of a message's attachments. This method clears and populates the attachments properties. If the RequestNestedItemAttachments configuration setting is set to true (default false), the method will also list any nested attachments found within item attachments. //List messages with attachments office365.ListMessage("inbox", "hasAttachments eq true"); //List attachments of the first message office365.ListAttachments(office365.MessageInfo[0].Id);

list_categories Method

Lists all mail categories.

Syntax

def list_categories() -> None: ...

Remarks

This method lists all of the mail categories in the current mailbox. This method clears and populates the categories properties.

list_changes Method

Lists messages that have been changed within a specified folder.

Syntax

def list_changes(id: str, max_page_size: int) -> None: ...

Remarks

This method lists changed messages within the folder specified by id.

Starting from a Baseline State

For most use-cases, it is necessary to obtain a baseline state first in order to only list messages that have been changed after the baseline state was established.

To obtain a baseline state, ensure that both change_marker and next_change_marker are empty, and then call list_changes. Then follow the process described in the "General Usage" section (below) until change_marker is empty to list all the changed messages.

General Usage

When this method is called, it will use the change marker stored in either change_marker or next_change_marker (only one can be populated at a time) to request the next page of changes. This method causes the on_message_list event to fire once for each change, and will also populate the message_info properties.

If there are still more messages available to list when this method returns, the change_marker property will be populated. Continue to call this method until change_marker is empty to accumulate all pages of results in the message_info properties (Once there aren't any more changed messages available to list, the next_change_marker property will be populated instead).

When next_change_marker is populated, it is always populated with a value that (at the time of population) points to the most current state. (Since "the most current state" implies that there are no further changes to list, calling list_changes immediately after next_change_marker is populated will not return any further changes.)

list_contact_folders Method

Lists the contact folders found in the parent folder.

Syntax

def list_contact_folders(parent_folder_id: str) -> None: ...

Remarks

This method retrieves and lists the contact folders within the specified parent folder. It clears and then populates the contact_folders collection with the retrieved folders.

To list all contact folders in the root folder, set the parentFolderId parameter to an empty string.

Example (List All Contact Folders in the Root Folder):

office365.ListContactFolders(""); // List root folders. foreach(OLContactFolder folder in office365.ContactFolders){ folder.Id; // Folder id folder.Name; // Folder name folder.ParentFolderId; // Folder parent id } Example (List all Contact Sub Folders in a Folder):

office365.ListContactFolders(""); office365.ListContactFolders(office365.ContactFolders[0].Id); //List the sub folders of the first root folder. office365.ContactFolders[0]; // The first sub folder of the first root folder.

If the number of contact folders exceeds the page size, the ListContactFoldersMarker config value will be populated. You can call ListContactFolders again to retrieve the next page of folders. These folders will be added to the end of the contact_folders collection.

Example (List All Contact Folders Pages in the Root Folder):

do{ office365.ListContactFolders(""); // List root folders. } while (!office365.Config("ListContactFoldersMarker").IsEmpty());

list_contacts Method

Lists the contacts in a folder.

Syntax

def list_contacts(folder_id: str) -> None: ...

Remarks

This method retrieves and lists the contacts within the specified folder. It clears and then populates the contacts collection with the retrieved contacts. Providing an empty string as folderId retrieves the contacts from the default Contacts folder of the signed-in user.

Example (List All Contacts in a Folder) office365.ListContactFolders(""); // List root folders (no need to do this if you already have a Folder Id) office365.ListContacts(office365.ContactFolders[0].Id); //Lists contacts

Example (List all Contacts in the default Contacts folder): office365.ListContacts("");

If the number of contacts exceeds the page size, the list_contacts_marker will be populated. You can call ListContacts again to retrieve the next page of contacts. These contacts will be added to the end of the contacts collection.

Example (List all Contacts Pages in the default Contacts folder): do{ office365.ListContacts(""); } while(!office365.ListContactsMarker.isEmpty());

list_folders Method

Lists the folders found in the parent folder.

Syntax

def list_folders(parent_folder_id: str) -> None: ...

Remarks

This method lists the folders found in the parent folder. This method clears populates the folders properties.

Set parentFolderId to be an empty string to list all folders in the root folder.

If the number of folders is greater than the folder page size, list_folders_marker will be populated and calling list_folders again will list the next page of folders.

Example (List All Folders in the Root Folder)

office365.ListFolders("");

list_messages Method

Lists the messages in a folder.

Syntax

def list_messages(folder_id: str, filter: str) -> None: ...

Remarks

This method lists the messages found in the specified folder. This method clears and populates the message_info properties.

If the number of messages is greater than the message page size, list_messages_marker will be populated and calling list_messages again will list the next page of messages.

filter can be used to retrieve a specific subset of messages, or it can be left as an empty string to retrieve all messages in a folder. filter follows the OData protocol syntax.

Example (List All Messages in a Folder)

office365.ListMessages(folderId, "");

Example (List Unread Messages in a Folder)

office365.ListMessages(folderId, "isRead eq false");

Example (List Messages from a Specific Address)

office365.ListMessages(folderId, "from/emailAddress/address eq 'specific@address.com'");

Example (List Unread Messages from a Specific Address)

office365.ListMessages(folderId, "isRead eq false and from/emailAddress/address eq 'specific@address.com'");

move_folder Method

Moves a folder.

Syntax

def move_folder(id: str, dest_folder_id: str) -> None: ...

Remarks

This method moves a folder to a new parent folder. Please note that two folders with the same name may not exist under the same parent folder.

move_message Method

Moves a message.

Syntax

def move_message(id: str, destination_id: str) -> None: ...

Remarks

This method moves a message. destinationId refers to the folder ID where the message will be moved to.

rename_folder Method

Renames a folder.

Syntax

def rename_folder(folder_id: str, new_name: str) -> None: ...

Remarks

This method renames a folder. This method will not update the folders properties.

reply Method

Reply to a message.

Syntax

def reply(id: str, message_html: str) -> None: ...

Remarks

This method can be used to quickly reply to a message specified by id. The messageHTML parameter is the message body to include with the reply. If messageHTML is an empty string, then the following properties are used:

Example (Simple):

office365.ReplyAll(messageId, "Reply messageHTML");

Example (Advanced):

office365.MessageSubject = "Subject for the reply"; office365.MessageImportance = "Low"; office365.MessageCc = "Example@email.com"; office365.MessageBcc = "Example@email.com"; office365.MessageBodyContent = "Reply Message body"; office365.ReplyAll(messageId, "");

reply_all Method

ReplyAll to a message.

Syntax

def reply_all(id: str, message_html: str) -> None: ...

Remarks

This method can be used to quickly reply all to a message specified by id. The messageHTML parameter is the message body to include with the reply. If messageHTML is an empty string, then the following properties are used:

Example (Simple):

office365.ReplyAll(messageId, "ReplyAll messageHTML");

Example (Advanced):

office365.MessageSubject = "Subject for the reply"; office365.MessageImportance = "Low"; office365.MessageCc = "Example@email.com"; office365.MessageBcc = "Example@email.com"; office365.MessageBodyContent = "Reply Message body"; office365.ReplyAll(messageId, "");

reset Method

This method will reset the class.

Syntax

def reset() -> None: ...

Remarks

This method will reset the class's properties to their default values.

retrieve_attachment Method

Retrieves a message attachment.

Syntax

def retrieve_attachment(id: str, attachment_id: str) -> None: ...

Remarks

This method retrieves an attachment. id specifies the message ID for the message the attachment is attached to.

The fetched attachment can be accessed through the attachments properties. If the RequestNestedItemAttachments configuration setting is set to true (default false) and the attachment to be retrieved is an item attachment, the method will provide any nested attachments as well.

retrieve_message Method

Retrieves a message.

Syntax

def retrieve_message(id: str) -> None: ...

Remarks

This method retrieves a message.

Information about the retrieved message can be accessed through the message_info properties.

retrieve_message_raw Method

Retrieves the raw message of the specified message ID.

Syntax

def retrieve_message_raw(id: str) -> None: ...

Remarks

This method retrieves the RFC822-encoded text of the specified message ID. The text is stored in the message property.

search Method

Search for messages.

Syntax

def search(search_key: str) -> None: ...

Remarks

This method can be used to search for messages. Results are returned through the message_info properties. searchKey specifies a string to be searched for.

send_custom_request Method

Send a custom HTTP request.

Syntax

def send_custom_request(http_method: str, url: str, post_data: str) -> None: ...

Remarks

This method can be used to send a custom HTTP request to the server.

send_draft Method

Sends an existing draft.

Syntax

def send_draft(id: str) -> None: ...

Remarks

This method sends an existing draft. The id parameter takes the ID of the draft that is going to be sent. To create a draft see the create_draft method. As a note, the relevant properties are not cleared after the method is called. It is recommend to do so after calling this method.

Example (New Draft)

//Create a draft message office365.MessageSubject = "Subject Text"; office365.MessageImportance = "High"; office365.MessageBodyContentType = "TEXT"; office365.MessageBodyContent = "Body Text"; office365.MessageTo = "email@example.com"; office365.CreateDraft(0, ""); office365.SendDraft(office365.MessageInfo[0].Id); Example (Reply)

// Create the reply draft string originalMessageId = "Message ID"; office365.CreateDraft(1, originalMessageId); // Set the new draft MessageInfo fields with desired options office365.MessageInfo[0].To = "email@example.com"; office365.MessageInfo[0].Subject = "Subject Text"; office365.MessageInfo[0].BodyContentType = "TEXT"; office365.MessageInfo[0].BodyContent = "Body Text"; // Update the draft office365.Update(office365.MessageInfo[0].Id); // Send the draft office365.SendDraft(office365.MessageInfo[0].Id); Example (HTML with Attachments) office365.SetMessageSubject("Subject"); office365.SetMessageBodyContentType("HTML"); office365.SetMessageBodyContent("<p>Body</p><img src='cid:test1'>"); office365.SetMessageTo("email@example.com"); office365.CreateDraft(0,""); office365.SetMessageAttachmentCount(1); office365.SetMessageAttachmentFile(0, "./test.png"); office365.SetMessageAttachmentContentId(0, "test1"); office365.SetMessageAttachmentIsInline(0, true); office365.AddAttachment(office365.GetMessageInfoId(0), "", ""); office365.SendDraft(office365.GetMessageInfoId(0));

send_mail Method

Sends a new email.

Syntax

def send_mail(save_to_sent_items: bool) -> None: ...

Remarks

This method sends a new message. Use the Message* (excluding message_info properties and message) to set the fields of the message that will be sent. To add an attachment, use the message_attachments properties to add the attachment information. As a note, the relevant properties are not cleared after the method is called. It is recommend to do so after calling this method.

Example: Simple Email

office365.MessageSubject = "I saw a Tree"; office365.MessageImportance = "High"; office365.MessageBodyContentType = "TEXT"; office365.MessageBodyContent = "It was in my back yard initially. It was still there when I last checked."; office365.MessageTo = "TreeLookOut@gmail.com"; office365.SendMail(True); Example: HTML email with Attachments office365.SetMessageSubject("Subject"); office365.SetMessageBodyContentType("HTML"); office365.SetMessageBodyContent("<p>Body</p><img src='cid:test1'>"); office365.SetMessageTo("email@example.com"); //Set up attachments //Inline: office365.SetMessageAttachmentCount(2); office365.SetMessageAttachmentFile(0, "./test.png"); office365.SetMessageAttachmentName(0, "test picture"); office365.SetMessageAttachmentContentId(0, "test1"); office365.SetMessageAttachmentIsInline(0, true); //Normal office365.SetMessageAttachmentFile(1, "./test.txt"); office365.SetMessageAttachmentName(1, "test file"); office365.SendMail(true);

set_contact_field Method

Sets the contact field value by JSONPath.

Syntax

def set_contact_field(index: int, json_path: str, value: str, value_type: int) -> None: ...

Remarks

This method updates a specific field within the contact's JSON representation. The parameters for this method are as follows: the first parameter, index, is an integer representing the index of the contact in the contacts collection to be edited. The second parameter, JsonPath, specifies the JSON path to the field you want to set. Please refer to XPath for more details on how to set the Json path. The third parameter, Value, is the value to be assigned to the JSON field. The fourth parameter, ValueType, is the type of the value, which must be one of the defined types:

• 0 (Object)
• 1 (Array)
• 2 (String)
• 3 (Number)
• 4 (Bool)
• 5 (Null)
• 6 (Raw)

Example (Set/Edit Fields of a Contact before Updating): // Create a contact in the main contacts folder. office365.CreateContact("Pavel", "Bansky", "pavelb@contoso.com", ""); // Set company name office365.SetContactField(0, "/json/companyName", "nsoftware", 2); // 2 (String) // Set business address office365.SetContactField(0, "/json/businessAddress", "{\"street\":\"string\",\"city\":\"string\",\"state\":\"string\",\"countryOrRegion\":\"string\",\"postalCode\":\"string\"}", 0); // 0 (Object) office365.SetContactField(0, "/json/emailAddresses", "[{"name": "Garth", "address": "garth@contoso.com"}, {"name": "Garth", "address": "garth1@contoso.com"}]", 1); // 1 (Array) // Update the contact office365.UpdateContact(0);

update Method

Updates a message.

Syntax

def update(id: str) -> None: ...

Remarks

This property updates a message that has been edited in the message_info properties. The id takes the message's ID that should be updated. The following values can be updated from the OLMessageInfo type:

*Changing the JSON data will change the message as a whole.

Example (Reply Draft)

// Create the reply draft string originalMessageId = "Message ID"; office365.CreateDraft(1, originalMessageId); // Set the new draft MessageInfo fields with desired options office365.MessageInfo[0].To = "email@example.com"; office365.MessageInfo[0].Subject = "Subject Text"; office365.MessageInfo[0].BodyContentType = "TEXT"; office365.MessageInfo[0].BodyContent = "Body Text"; // Update the draft office365.Update(office365.MessageInfo[0].Id); // Send the draft office365.SendDraft(office365.MessageInfo[0].Id);

update_category Method

Updates a category.

Syntax

def update_category(id: str, color: str) -> None: ...

Remarks

This method changes an existing category's color. This method will not update the categories properties.

update_contact Method

Updates a contact.

Syntax

def update_contact(index: int) -> None: ...

Remarks

This method allows you to update an existing contact. The index parameter specifies the position of the contact in the contacts collection. The method uses this index to take all the data from the specified contact and update the corresponding contact on the server.

To update a contact, edit the desired contact fields within the contacts collection. Then, call the update_contact method with the index of the contact. Note that changing the JSON data will overwrite the entire contact, ignoring other field edits made before setting the JSON.

The OLContact type used in the contacts collection includes the most commonly used fields for contacts. Refer to the OLContact type for a complete list of fields. If you need to add other fields, you can use the set_contact_field method. For a complete list of fields a contact can have please refer to the Microsoft Graph API documentation.

Example: office365.CreateContact("Pavel", "Bansky", "pavelb@contoso.com", "");// Create a contact in the main contacts folder. // Set a company name office365.Contacts[0].CompanyName = "Volkswagen"; // Set notes office365.Contacts[0].Notes = "testNotes"; // Set multiple phone numbers office365.Contacts[0].PhonesCount = 2; office365.Contacts[0].PhoneIndex = 0; office365.Contacts[0].PhoneType = TOLPhoneTypes.ptMobile; office365.Contacts[0].PhoneNumber = "0123456789"; office365.Contacts[0].PhoneIndex = 1; office365.Contacts[0].PhoneType = TOLPhoneTypes.ptBusiness; office365.Contacts[0].PhoneNumber = "9876543210"; // Set birthday office365.SetContactField(0, "/json/birthday", "2024-05-21", 2); // The last argument is the type of the field. 2 (String) // Set business address office365.SetContactField(0, "/json/businessAddress", "{\"street\":\"string\",\"city\":\"string\",\"state\":\"string\",\"countryOrRegion\":\"string\",\"postalCode\":\"string\"}", 0); // 0 (Object) // Update the contact office365.UpdateContact(0);

on_attachment_list Event

Fired when an attachment is retrieved from the server.

Syntax

class Office365AttachmentListEventParams(object):
  @property
  def id() -> str: ...

  @property
  def name() -> str: ...

  @property
  def content_type() -> str: ...

  @property
  def content_location() -> str: ...

  @property
  def content_bytes() -> bytes: ...

  @property
  def content_id() -> str: ...

  @property
  def last_modified_date_time() -> str: ...

  @property
  def is_inline() -> bool: ...

  @property
  def size() -> int: ...

# In class Office365:
@property
def on_attachment_list() -> Callable[[Office365AttachmentListEventParams], None]: ...
@on_attachment_list.setter
def on_attachment_list(event_hook: Callable[[Office365AttachmentListEventParams], None]) -> None: ...

Remarks

The on_attachment_list event is fired for each attachment retrieved from the server when list_attachments is called.

on_category_list Event

Fired when an attachment is retrieved from the server.

Syntax

class Office365CategoryListEventParams(object):
  @property
  def id() -> str: ...

  @property
  def display_name() -> str: ...

  @property
  def color() -> str: ...

# In class Office365:
@property
def on_category_list() -> Callable[[Office365CategoryListEventParams], None]: ...
@on_category_list.setter
def on_category_list(event_hook: Callable[[Office365CategoryListEventParams], None]) -> None: ...

Remarks

The on_category_list event is fired for each attachment retrieved from the server when list_categories is called.

on_contact_folder_list Event

Fired when a contact folder is retrieved by the server.

Syntax

class Office365ContactFolderListEventParams(object):
  @property
  def id() -> str: ...

  @property
  def name() -> str: ...

  @property
  def parent_folder_id() -> str: ...

# In class Office365:
@property
def on_contact_folder_list() -> Callable[[Office365ContactFolderListEventParams], None]: ...
@on_contact_folder_list.setter
def on_contact_folder_list(event_hook: Callable[[Office365ContactFolderListEventParams], None]) -> None: ...

Remarks

The on_contact_folder_list event is fired for each contact folder retrieved from the server when list_contact_folders is called.

on_contact_list Event

Fired when a contact is retrieved from the server.

Syntax

class Office365ContactListEventParams(object):
  @property
  def id() -> str: ...

  @property
  def parent_id() -> str: ...

  @property
  def display_name() -> str: ...

  @property
  def first_email() -> str: ...

# In class Office365:
@property
def on_contact_list() -> Callable[[Office365ContactListEventParams], None]: ...
@on_contact_list.setter
def on_contact_list(event_hook: Callable[[Office365ContactListEventParams], None]) -> None: ...

Remarks

The on_contact_list event is fired for each contact retrieved from the server when list_contacts is called. This event provides the contact's Id, DisplayName, FirstEmail address, and the ParentId of the folder containing the contact.

on_error Event

Fired when information is available about errors during data delivery.

Syntax

class Office365ErrorEventParams(object):
  @property
  def error_code() -> int: ...

  @property
  def description() -> str: ...

# In class Office365:
@property
def on_error() -> Callable[[Office365ErrorEventParams], None]: ...
@on_error.setter
def on_error(event_hook: Callable[[Office365ErrorEventParams], None]) -> None: ...

Remarks

The on_error event is fired in case of exceptional conditions during message processing. Normally the class fails with an error.

The ErrorCode parameter contains an error code, and the Description parameter contains a textual description of the error. For a list of valid error codes and their descriptions, please refer to the Error Codes section.

on_folder_list Event

Fired when a folder is retrieved by the server.

Syntax

class Office365FolderListEventParams(object):
  @property
  def id() -> str: ...

  @property
  def display_name() -> str: ...

  @property
  def parent_folder_id() -> str: ...

  @property
  def child_folder_count() -> int: ...

  @property
  def unread_item_count() -> int: ...

  @property
  def total_item_count() -> int: ...

# In class Office365:
@property
def on_folder_list() -> Callable[[Office365FolderListEventParams], None]: ...
@on_folder_list.setter
def on_folder_list(event_hook: Callable[[Office365FolderListEventParams], None]) -> None: ...

Remarks

The on_folder_list event is fired for each folder retrieved from the server when list_folders is called.

on_log Event

Fired once for each log message.

Syntax

class Office365LogEventParams(object):
  @property
  def log_level() -> int: ...

  @property
  def message() -> str: ...

  @property
  def log_type() -> str: ...

# In class Office365:
@property
def on_log() -> Callable[[Office365LogEventParams], None]: ...
@on_log.setter
def on_log(event_hook: Callable[[Office365LogEventParams], None]) -> None: ...

Remarks

This event is fired once for each log message generated by the class. The verbosity is controlled by the LogLevel setting.

LogLevel indicates the level of message. Possible values are as follows:

The value 1 (Info) logs basic information, including the URL, HTTP version, and status details.

The value 2 (Verbose) logs additional information about the request and response.

The value 3 (Debug) logs the headers and body for both the request and response, as well as additional debug information (if any).

Message is the log entry.

LogType identifies the type of log entry. Possible values are as follows:

• "Info"
• "RequestHeaders"
• "ResponseHeaders"
• "RequestBody"
• "ResponseBody"
• "ProxyRequest"
• "ProxyResponse"
• "FirewallRequest"
• "FirewallResponse"

on_message_list Event

Fired when a message is retrieved from the server.

Syntax

class Office365MessageListEventParams(object):
  @property
  def id() -> str: ...

  @property
  def subject() -> str: ...

  @property
  def message_sender() -> str: ...

  @property
  def received_date_time() -> str: ...

  @property
  def sent_date_time() -> str: ...

  @property
  def has_attachments() -> bool: ...

  @property
  def body_content_type() -> str: ...

  @property
  def body_content() -> str: ...

  @property
  def body_preview() -> str: ...

# In class Office365:
@property
def on_message_list() -> Callable[[Office365MessageListEventParams], None]: ...
@on_message_list.setter
def on_message_list(event_hook: Callable[[Office365MessageListEventParams], None]) -> None: ...

Remarks

The on_message_list event is fired for each message retrieved from the server when list_messages is called.

on_ssl_server_authentication Event

Fired after the server presents its certificate to the client.

Syntax

class Office365SSLServerAuthenticationEventParams(object):
  @property
  def cert_encoded() -> bytes: ...

  @property
  def cert_subject() -> str: ...

  @property
  def cert_issuer() -> str: ...

  @property
  def status() -> str: ...

  @property
  def accept() -> bool: ...
  @accept.setter
  def accept(value) -> None: ...

# In class Office365:
@property
def on_ssl_server_authentication() -> Callable[[Office365SSLServerAuthenticationEventParams], None]: ...
@on_ssl_server_authentication.setter
def on_ssl_server_authentication(event_hook: Callable[[Office365SSLServerAuthenticationEventParams], None]) -> None: ...

Remarks

During this event, the client can decide whether or not to continue with the connection process. The Accept parameter is a recommendation on whether to continue or close the connection. This is just a suggestion: application software must use its own logic to determine whether or not to continue.

When Accept is False, Status shows why the verification failed (otherwise, Status contains the string OK). If it is decided to continue, you can override and accept the certificate by setting the Accept parameter to True.

on_ssl_status Event

Fired when secure connection progress messages are available.

Syntax

class Office365SSLStatusEventParams(object):
  @property
  def message() -> str: ...

# In class Office365:
@property
def on_ssl_status() -> Callable[[Office365SSLStatusEventParams], None]: ...
@on_ssl_status.setter
def on_ssl_status(event_hook: Callable[[Office365SSLStatusEventParams], None]) -> None: ...

Remarks

The event is fired for informational and logging purposes only. This event tracks the progress of the connection.

on_transfer Event

Fired while a document transfers (delivers document).

Syntax

class Office365TransferEventParams(object):
  @property
  def direction() -> int: ...

  @property
  def bytes_transferred() -> int: ...

  @property
  def percent_done() -> int: ...

  @property
  def text() -> bytes: ...

# In class Office365:
@property
def on_transfer() -> Callable[[Office365TransferEventParams], None]: ...
@on_transfer.setter
def on_transfer(event_hook: Callable[[Office365TransferEventParams], None]) -> None: ...

Remarks

The Text parameter contains the portion of the document text being received. It is empty if data are being posted to the server.

The BytesTransferred parameter contains the number of bytes transferred in this Direction since the beginning of the document text (excluding HTTP response headers).

The Direction parameter shows whether the client (0) or the server (1) is sending the data.

The PercentDone parameter shows the progress of the transfer in the corresponding direction. If PercentDone can not be calculated the value will be -1.

Note: Events are not re-entrant. Performing time-consuming operations within this event will prevent it from firing again in a timely manner and may affect overall performance.

Office365 Config Settings

The class accepts one or more of the following configuration settings. Configuration settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the class, access to these internal properties is provided through the config method.

Office365 Config Settings

OAuth Config Settings

HTTP Config Settings

TCPClient Config Settings

SSL Config Settings

Socket Config Settings

Base Config Settings

Office365 Errors

Office365 Errors