Documentation

Office365 extends AbstractOffice365
in package
implements HttpClientInterface

Office 365 mail client class

Tags
category

Pop

author

Nick Sagona, III dev@nolainteractive.com

copyright

Copyright (c) 2009-2024 NOLA Interactive, LLC. (http://www.nolainteractive.com)

license

http://www.popphp.org/license New BSD License

version
4.0.0

Table of Contents

Interfaces

HttpClientInterface
Http client interface

Properties

$accountId  : string|null
Account ID
$baseUri  : string|null
Base URL
$client  : mixed
Client
$clientId  : string|null
Client ID
$clientSecret  : string|null
Client Secret
$scope  : string|null
Scope
$tenantId  : string|null
Tenant ID
$token  : string|null
Token
$tokenExpires  : string|null
Token expires
$tokenRequestUri  : string|null
Token request URI
$username  : string|null
Account username

Methods

__construct()  : mixed
Create Office 365 object
createClient()  : AbstractHttp
Create client
getAccountId()  : string|null
Get account ID
getAttachment()  : mixed
Get message attachment
getAttachments()  : mixed
Get message attachments
getClient()  : mixed
Get client
getClientId()  : string|null
Get client ID
getClientSecret()  : string|null
Get client ID
getMessage()  : mixed
Get messages
getMessages()  : mixed
Get messages
getScope()  : string|null
Get scope ID
getTenantId()  : string|null
Get tenant ID
getToken()  : string|null
Get token
getTokenExpires()  : string|null
Get token expires
getUsername()  : string|null
Get account username
hasAccountId()  : bool
Has account ID
hasClient()  : bool
Has client
hasClientId()  : bool
Has client ID
hasClientSecret()  : bool
Has client ID
hasScope()  : bool
Has scope ID
hasTenantId()  : bool
Has tenant ID
hasToken()  : bool
Has token
hasTokenExpires()  : bool
Has token expires
hasUsername()  : bool
Has account username
isTokenExpired()  : bool
Check if token is expired
markAsRead()  : Office365
Mark message as read
markAsUnread()  : Office365
Mark message as unread
parseOptions()  : array<string|int, mixed>
Parse options
requestToken()  : AbstractHttpClient
Request token
setAccountId()  : AbstractHttpClient
Set account ID
setClient()  : AbstractHttp
Set client
setClientId()  : AbstractHttpClient
Set client ID
setClientSecret()  : AbstractHttpClient
Set client secret
setScope()  : AbstractHttpClient
Set scope
setTenantId()  : AbstractOffice365
Set tenant ID
setToken()  : AbstractHttpClient
Set token
setTokenExpires()  : AbstractHttpClient
Set token expires
setUsername()  : AbstractHttpClient
Set account username
verifyToken()  : bool
Verify token and refresh is expired

Properties

$tokenRequestUri

Token request URI

protected string|null $tokenRequestUri = null

Methods

__construct()

Create Office 365 object

public __construct([array<string|int, mixed>|string|null $options = null ]) : mixed
Parameters
$options : array<string|int, mixed>|string|null = null

createClient()

Create client

public abstract createClient(array<string|int, mixed>|string $options) : AbstractHttp
Parameters
$options : array<string|int, mixed>|string
Return values
AbstractHttp

getAccountId()

Get account ID

public getAccountId() : string|null
Return values
string|null

getAttachment()

Get message attachment

public getAttachment(string $messageId, string $attachmentId[, string $folder = 'Inbox' ]) : mixed
Parameters
$messageId : string
$attachmentId : string
$folder : string = 'Inbox'
Tags
throws
Exception|Exception|Exception|Exception

getAttachments()

Get message attachments

public getAttachments(string $messageId[, string $folder = 'Inbox' ]) : mixed
Parameters
$messageId : string
$folder : string = 'Inbox'
Tags
throws
Exception|Exception|Exception|Exception

getClientId()

Get client ID

public getClientId() : string|null
Return values
string|null

getClientSecret()

Get client ID

public getClientSecret() : string|null
Return values
string|null

getMessages()

Get messages

public getMessages([string $folder = 'Inbox' ][, array<string|int, mixed> $search = [] ][, int $limit = 10 ]) : mixed
Parameters
$folder : string = 'Inbox'
$search : array<string|int, mixed> = []
$limit : int = 10
Tags
throws
Exception|Exception|Exception|Exception

getScope()

Get scope ID

public getScope() : string|null
Return values
string|null

getTenantId()

Get tenant ID

public getTenantId() : string|null
Return values
string|null

getTokenExpires()

Get token expires

public getTokenExpires() : string|null
Return values
string|null

getUsername()

Get account username

public getUsername() : string|null
Return values
string|null

hasClient()

Has client

public hasClient() : bool
Return values
bool

hasClientSecret()

Has client ID

public hasClientSecret() : bool
Return values
bool

hasTokenExpires()

Has token expires

public hasTokenExpires() : bool
Return values
bool

hasUsername()

Has account username

public hasUsername() : bool
Return values
bool

isTokenExpired()

Check if token is expired

public isTokenExpired() : bool
Return values
bool

parseOptions()

Parse options

public parseOptions(array<string|int, mixed>|string $options) : array<string|int, mixed>
Parameters
$options : array<string|int, mixed>|string
Tags
throws
Exception
Return values
array<string|int, mixed>

verifyToken()

Verify token and refresh is expired

public verifyToken() : bool
Return values
bool 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results