Office 365 / Outlook / Hotmail

Overview

• Image Support: No
• Attachment Support: Yes
• Message Character Limits:
  • Body: 32768

Account Setup

Because Microsoft has disabled Basic Authentication (Username/Password), you must register an application in Azure to generate the credentials Apprise needs (Client ID, Secret, etc).

1. From the Azure Portal go to App Registrations (alt link)

   • Use the search bar at the top of the Azure Portal and type App Registrations.
   • If you still can’t access anything, it’s possible your organization restricts you from doing so. You may need to reach out to your administrator in order to proceed.
     

2. Click Register an application

   ⚠️ Screen you may see if you do not have an Azure Account

   You must have an Azure account (specifically a subscription) for this area to work. Subscriptions are free, but they do still require you to put your credit card in. To create a subscription:

   • Go to: Azure Portal → Subscriptions
   • Click Add
   • Choose Azure subscription (Free)

   No resources need to be deployed. This simply completes tenant provisioning.

   After this, ensure you are viewing the correct directory:

   • Click your avatar (top right)
   • Select Switch directory
   • Choose the directory where the subscription was created. It's possible there is only one new subscription (the one you just created). Therefore you're already in the right place and can proceed with the steps below.
   • Give it a name (for example: Apprise Notifications)
   • Crucial: Select the 3rd option: Accounts in any organizational directory (Any Microsoft Entra ID tenant - Multitenant) and personal Microsoft accounts.
   • Click Register.

3. From here (the Overview panel) you can acquire both:

   • The Application (client) ID: our client_id for the azure://**/**/client_id/**/ and
   • The Object ID: our source for the azure://source/**/**/**/ and
   • The Directory (tenant) ID: our tenant_id for the azure://**/tenant_id/**/**/

4. To create your client_secret , expand the Manage tab on the left:

   • Click on Certificates & secrets -> Client secrets

   • Click New client secret

   • Provide a description (for example Apprise Secret) and an expiry

   • Click Add.

   • The client_secret is the value under the Value column. This will be placed in our final azure://**/**/**/client_secret part of our Apprise URL.

     This step causes the most failures

     Azure shows two values:

     Field	Use this?
     Secret Value	✅ Yes
     Secret ID	❌ No

     The Secret Value:

     • Is only visible once
     • Becomes masked after you leave the page
     • Is the actual password

     If unsure, simply regenerate the secret; you can delete the old and create a new one.

5. To set up permissions, expand the Manage tab on the left (if it is collapsed for whatever reason):

   • Click on API permissions. You will likely already have the User.Read permission set up (as a default). But we need to add more.
   • Click Add a permission.
   • Click on Microsoft Graph.
   • Click on Application Permissions and search for Mail.Send.
   • Once found; check the box (so that it can be added and click Add permissions.
   • You should also add the following Application Permission:
     • User.Read.All allows apprise to correctly look up use your Object ID the source.
     • Mail.ReadWrite (Optional) if you intend to send large attachments (> 3MB)

   Important: After adding, you must click Grant admin consent for for the permissions to take effect. For most this may read as Grant admin consent for Default Directory. This option is located right beside the Add a permission action you were previous using above.

6. Now you’re good to go. 🙂

Syntax

Valid syntax is as follows:

• o365://{source}/{tenant_id}/{client_id}/{client_secret}/
• o365://{source}/{tenant_id}/{client_id}/{client_secret}/{targets}
• azure://{source}/{tenant_id}/{client_id}/{client_secret}/
• azure://{source}/{tenant_id}/{client_id}/{client_secret}/{targets}

Parameter Breakdown

Variable	Required	Description
source	Yes	The Email Address or Object ID associated with the Azure Account you wish to send the email from.
tenant_id	Yes	The Tenant ID (Directory ID) associated with your App Registration.
client_id	Yes	The Client ID (Application ID) associated with your App Registration.
client_secret	Yes	The Client Secret you generated in the “Certificates & secrets” section.
from	No	If you want the email ReplyTo address to be something other than your own email address, you can specify it here.
to	No	Override the target email. By default, the email is sent to the address identified by the source (or the targets specified in the URL path).

Global Parameters

Variable	Description
overflow	This parameter can be set to either split, truncate, or upstream. This determines how Apprise delivers the message you pass it. By default this is set to upstream 👉 upstream: Do nothing at all; pass the message exactly as you received it to the service. 👉 truncate: Ensure that the message will fit within the service’s documented upstream message limit. If more information was passed then the defined limit, the overhead information is truncated. 👉 split: similar to truncate except if the message doesn’t fit within the service’s documented upstream message limit, it is split into smaller chunks and they are all delivered sequentially there-after.
format	This parameter can be set to either text, html, or markdown. Some services support the ability to post content by several different means. The default of this varies (it can be one of the 3 mentioned at any time depending on which service you choose). You can optionally force this setting to stray from the defaults if you wish. If the service doesn’t support different types of transmission formats, then this field is ignored.
verify	External requests made to secure locations (such as through the use of https) will have certificates associated with them. By default, Apprise will verify that these certificates are valid; if they are not then no notification will be sent to the source. In some occasions, a user might not have a certificate authority to verify the key against or they trust the source; in this case you will want to set this flag to no. By default it is set to yes.
cto	This stands for Socket Connect Timeout. This is the number of seconds Requests will wait for your client to establish a connection to a remote machine (corresponding to the connect()) call on the socket. The default value is 4.0 seconds.
rto	This stands for Socket Read Timeout. This is the number of seconds the client will wait for the server to send a response. The default value is 4.0 seconds.
emojis	Enable Emoji support (such as providing :+1: would translate to 👍). By default this is set to no. Note: Depending on server side settings, the administrator has the power to disable emoji support at a global level; but default this is not the case.
tz	Identify the IANA Time Zone Database you wish to operate as. By default this is detected based on the configuration the server hosting Apprise is running on. You can set this to things like America/Toronto, or any other properly formated Timezone describing your area.

Note

• If no targets are specified, then the notification is just sent to the address identified by {account_email}
• Unfortunately the client_secret contains a lot of characters that can drastically conflict with standard URL rules (and thus Apprise might have difficulty detecting your client secret). The ? and @ characters can get generated by Microsoft and will almost definitely cause you issues.
  • Consider encoding this client secret before putting it into your Apprise URL. Encoding the URL can be as simple as just pasting it into the form on this website.
  • You can also just manually escape these characters on your Apprise URL yourself manually (explained here). Simply swap all instances of: - ? with %3F - @ with %40 :::

Examples

Send an email notification to our your Office 365 account:

# Assuming our {tenant_id} is ab-cd-ef-gh
# Assuming our {account_email} is user@example.com
# Assuming our {client_id} is zz-yy-xx-ww
# Assuming our {client_secret} is rt/djdwjjd
apprise -vv -t "Test Message Title" -b "Test Message Body" \
   azure:///user@example.com/ab-cd-ef-gh/zz-yy-xx-ww/rt/djdwjjd