Class IosEasEmailProfileConfiguration

  • All Implemented Interfaces:
    com.github.davidmoten.odata.client.ODataEntityType, com.github.davidmoten.odata.client.ODataType

    public class IosEasEmailProfileConfiguration
    extends EasEmailProfileConfigurationBase
    implements com.github.davidmoten.odata.client.ODataEntityType
    “By providing configurations in this profile you can instruct the native email client on iOS devices to communicate with an Exchange server and get email, contacts, calendar, reminders, and notes. Furthermore, you can also specify how much email to sync and how often the device should sync.”
    • Field Detail

      • accountName

        protected String accountName
      • blockMovingMessagesToOtherEmailAccounts

        protected Boolean blockMovingMessagesToOtherEmailAccounts
      • blockSendingEmailFromThirdPartyApps

        protected Boolean blockSendingEmailFromThirdPartyApps
      • blockSyncingRecentlyUsedEmailAddresses

        protected Boolean blockSyncingRecentlyUsedEmailAddresses
      • easServicesUserOverrideEnabled

        protected Boolean easServicesUserOverrideEnabled
      • hostName

        protected String hostName
      • perAppVPNProfileId

        protected String perAppVPNProfileId
      • requireSmime

        protected Boolean requireSmime
      • requireSsl

        protected Boolean requireSsl
      • smimeEnablePerMessageSwitch

        protected Boolean smimeEnablePerMessageSwitch
      • smimeEncryptByDefaultEnabled

        protected Boolean smimeEncryptByDefaultEnabled
      • smimeEncryptByDefaultUserOverrideEnabled

        protected Boolean smimeEncryptByDefaultUserOverrideEnabled
      • smimeEncryptionCertificateUserOverrideEnabled

        protected Boolean smimeEncryptionCertificateUserOverrideEnabled
      • smimeSigningCertificateUserOverrideEnabled

        protected Boolean smimeSigningCertificateUserOverrideEnabled
      • smimeSigningEnabled

        protected Boolean smimeSigningEnabled
      • smimeSigningUserOverrideEnabled

        protected Boolean smimeSigningUserOverrideEnabled
      • useOAuth

        protected Boolean useOAuth
    • Constructor Detail

      • IosEasEmailProfileConfiguration

        protected IosEasEmailProfileConfiguration()
    • Method Detail

      • builderIosEasEmailProfileConfiguration

        public static IosEasEmailProfileConfiguration.Builder builderIosEasEmailProfileConfiguration()
        Returns a builder which is used to create a new instance of this class (given that this class is immutable).
        Returns:
        a new Builder for this class
      • getChangedFields

        public com.github.davidmoten.odata.client.internal.ChangedFields getChangedFields()
        Specified by:
        getChangedFields in interface com.github.davidmoten.odata.client.ODataEntityType
        Overrides:
        getChangedFields in class EasEmailProfileConfigurationBase
      • postInject

        public void postInject​(boolean addKeysToContextPath)
        Specified by:
        postInject in interface com.github.davidmoten.odata.client.ODataType
        Overrides:
        postInject in class EasEmailProfileConfigurationBase
      • getAccountName

        public Optional<String> getAccountName()
        “Account name.”
        Returns:
        property accountName
      • withAccountName

        public IosEasEmailProfileConfiguration withAccountName​(String accountName)
        Returns an immutable copy of this with just the accountName field changed. Field description below. The field name is also added to an internal map of changed fields in the returned object so that when this. patch() is called (if available)on the returned object only the changed fields are submitted.

        “Account name.”

        Parameters:
        accountName - new value of accountName field (as defined in service metadata)
        Returns:
        immutable copy of this with just the accountName field changed
      • getAuthenticationMethod

        public Optional<EasAuthenticationMethod> getAuthenticationMethod()
        “Authentication method for this Email profile.”
        Returns:
        property authenticationMethod
      • withAuthenticationMethod

        public IosEasEmailProfileConfiguration withAuthenticationMethod​(EasAuthenticationMethod authenticationMethod)
        Returns an immutable copy of this with just the authenticationMethod field changed. Field description below. The field name is also added to an internal map of changed fields in the returned object so that when this.patch() is called (if available)on the returned object only the changed fields are submitted.

        “Authentication method for this Email profile.”

        Parameters:
        authenticationMethod - new value of authenticationMethod field (as defined in service metadata)
        Returns:
        immutable copy of this with just the authenticationMethod field changed
      • getBlockMovingMessagesToOtherEmailAccounts

        public Optional<Boolean> getBlockMovingMessagesToOtherEmailAccounts()
        “Indicates whether or not to block moving messages to other email accounts.”
        Returns:
        property blockMovingMessagesToOtherEmailAccounts
      • withBlockMovingMessagesToOtherEmailAccounts

        public IosEasEmailProfileConfiguration withBlockMovingMessagesToOtherEmailAccounts​(Boolean blockMovingMessagesToOtherEmailAccounts)
        Returns an immutable copy of this with just the blockMovingMessagesToOtherEmailAccounts field changed. Field description below. The field name is also added to an internal map of changed fields in the returned object so that when this.patch() is called (if available)on the returned object only the changed fields are submitted.

        “Indicates whether or not to block moving messages to other email accounts.”

        Parameters:
        blockMovingMessagesToOtherEmailAccounts - new value of blockMovingMessagesToOtherEmailAccounts field (as defined in service metadata)
        Returns:
        immutable copy of this with just the blockMovingMessagesToOtherEmailAccounts field changed
      • getBlockSendingEmailFromThirdPartyApps

        public Optional<Boolean> getBlockSendingEmailFromThirdPartyApps()
        “Indicates whether or not to block sending email from third party apps.”
        Returns:
        property blockSendingEmailFromThirdPartyApps
      • withBlockSendingEmailFromThirdPartyApps

        public IosEasEmailProfileConfiguration withBlockSendingEmailFromThirdPartyApps​(Boolean blockSendingEmailFromThirdPartyApps)
        Returns an immutable copy of this with just the blockSendingEmailFromThirdPartyApps field changed. Field description below. The field name is also added to an internal map of changed fields in the returned object so that when this.patch() is called (if available)on the returned object only the changed fields are submitted.

        “Indicates whether or not to block sending email from third party apps.”

        Parameters:
        blockSendingEmailFromThirdPartyApps - new value of blockSendingEmailFromThirdPartyApps field (as defined in service metadata)
        Returns:
        immutable copy of this with just the blockSendingEmailFromThirdPartyApps field changed
      • getBlockSyncingRecentlyUsedEmailAddresses

        public Optional<Boolean> getBlockSyncingRecentlyUsedEmailAddresses()
        “Indicates whether or not to block syncing recently used email addresses, for instance - when composing new email.”
        Returns:
        property blockSyncingRecentlyUsedEmailAddresses
      • withBlockSyncingRecentlyUsedEmailAddresses

        public IosEasEmailProfileConfiguration withBlockSyncingRecentlyUsedEmailAddresses​(Boolean blockSyncingRecentlyUsedEmailAddresses)
        Returns an immutable copy of this with just the blockSyncingRecentlyUsedEmailAddresses field changed. Field description below. The field name is also added to an internal map of changed fields in the returned object so that when this.patch() is called (if available)on the returned object only the changed fields are submitted.

        “Indicates whether or not to block syncing recently used email addresses, for instance - when composing new email.”

        Parameters:
        blockSyncingRecentlyUsedEmailAddresses - new value of blockSyncingRecentlyUsedEmailAddresses field (as defined in service metadata)
        Returns:
        immutable copy of this with just the blockSyncingRecentlyUsedEmailAddresses field changed
      • getDurationOfEmailToSync

        public Optional<EmailSyncDuration> getDurationOfEmailToSync()
        “Duration of time email should be synced back to.”
        Returns:
        property durationOfEmailToSync
      • withDurationOfEmailToSync

        public IosEasEmailProfileConfiguration withDurationOfEmailToSync​(EmailSyncDuration durationOfEmailToSync)
        Returns an immutable copy of this with just the durationOfEmailToSync field changed. Field description below. The field name is also added to an internal map of changed fields in the returned object so that when this.patch() is called (if available)on the returned object only the changed fields are submitted.

        “Duration of time email should be synced back to.”

        Parameters:
        durationOfEmailToSync - new value of durationOfEmailToSync field (as defined in service metadata)
        Returns:
        immutable copy of this with just the durationOfEmailToSync field changed
      • getEasServices

        public Optional<EasServices> getEasServices()
        “Exchange data to sync.”
        Returns:
        property easServices
      • withEasServices

        public IosEasEmailProfileConfiguration withEasServices​(EasServices easServices)
        Returns an immutable copy of this with just the easServices field changed. Field description below. The field name is also added to an internal map of changed fields in the returned object so that when this. patch() is called (if available)on the returned object only the changed fields are submitted.

        “Exchange data to sync.”

        Parameters:
        easServices - new value of easServices field (as defined in service metadata)
        Returns:
        immutable copy of this with just the easServices field changed
      • getEasServicesUserOverrideEnabled

        public Optional<Boolean> getEasServicesUserOverrideEnabled()
        “Allow users to change sync settings.”
        Returns:
        property easServicesUserOverrideEnabled
      • withEasServicesUserOverrideEnabled

        public IosEasEmailProfileConfiguration withEasServicesUserOverrideEnabled​(Boolean easServicesUserOverrideEnabled)
        Returns an immutable copy of this with just the easServicesUserOverrideEnabled field changed. Field description below. The field name is also added to an internal map of changed fields in the returned object so that when this.patch() is called (if available)on the returned object only the changed fields are submitted.

        “Allow users to change sync settings.”

        Parameters:
        easServicesUserOverrideEnabled - new value of easServicesUserOverrideEnabled field (as defined in service metadata)
        Returns:
        immutable copy of this with just the easServicesUserOverrideEnabled field changed
      • getEmailAddressSource

        public Optional<UserEmailSource> getEmailAddressSource()
        “Email attribute that is picked from AAD and injected into this profile before installing on the device.”
        Returns:
        property emailAddressSource
      • withEmailAddressSource

        public IosEasEmailProfileConfiguration withEmailAddressSource​(UserEmailSource emailAddressSource)
        Returns an immutable copy of this with just the emailAddressSource field changed. Field description below. The field name is also added to an internal map of changed fields in the returned object so that when this.patch() is called (if available)on the returned object only the changed fields are submitted.

        “Email attribute that is picked from AAD and injected into this profile before installing on the device.”

        Parameters:
        emailAddressSource - new value of emailAddressSource field (as defined in service metadata)
        Returns:
        immutable copy of this with just the emailAddressSource field changed
      • getEncryptionCertificateType

        public Optional<EmailCertificateType> getEncryptionCertificateType()
        “Encryption Certificate type for this Email profile.”
        Returns:
        property encryptionCertificateType
      • withEncryptionCertificateType

        public IosEasEmailProfileConfiguration withEncryptionCertificateType​(EmailCertificateType encryptionCertificateType)
        Returns an immutable copy of this with just the encryptionCertificateType field changed. Field description below. The field name is also added to an internal map of changed fields in the returned object so that when this.patch() is called (if available)on the returned object only the changed fields are submitted.

        “Encryption Certificate type for this Email profile.”

        Parameters:
        encryptionCertificateType - new value of encryptionCertificateType field (as defined in service metadata)
        Returns:
        immutable copy of this with just the encryptionCertificateType field changed
      • getHostName

        public Optional<String> getHostName()
        “Exchange location that (URL) that the native mail app connects to.”
        Returns:
        property hostName
      • withHostName

        public IosEasEmailProfileConfiguration withHostName​(String hostName)
        Returns an immutable copy of this with just the hostName field changed. Field description below. The field name is also added to an internal map of changed fields in the returned object so that when this.patch() is called (if available)on the returned object only the changed fields are submitted.

        “Exchange location that (URL) that the native mail app connects to.”

        Parameters:
        hostName - new value of hostName field (as defined in service metadata)
        Returns:
        immutable copy of this with just the hostName field changed
      • getPerAppVPNProfileId

        public Optional<String> getPerAppVPNProfileId()
        “Profile ID of the Per-App VPN policy to be used to access emails from the native Mail client”
        Returns:
        property perAppVPNProfileId
      • withPerAppVPNProfileId

        public IosEasEmailProfileConfiguration withPerAppVPNProfileId​(String perAppVPNProfileId)
        Returns an immutable copy of this with just the perAppVPNProfileId field changed. Field description below. The field name is also added to an internal map of changed fields in the returned object so that when this.patch() is called (if available)on the returned object only the changed fields are submitted.

        “Profile ID of the Per-App VPN policy to be used to access emails from the native Mail client”

        Parameters:
        perAppVPNProfileId - new value of perAppVPNProfileId field (as defined in service metadata)
        Returns:
        immutable copy of this with just the perAppVPNProfileId field changed
      • getRequireSmime

        public Optional<Boolean> getRequireSmime()
        “Indicates whether or not to use S/MIME certificate.”
        Returns:
        property requireSmime
      • withRequireSmime

        public IosEasEmailProfileConfiguration withRequireSmime​(Boolean requireSmime)
        Returns an immutable copy of this with just the requireSmime field changed. Field description below. The field name is also added to an internal map of changed fields in the returned object so that when this. patch() is called (if available)on the returned object only the changed fields are submitted.

        “Indicates whether or not to use S/MIME certificate.”

        Parameters:
        requireSmime - new value of requireSmime field (as defined in service metadata)
        Returns:
        immutable copy of this with just the requireSmime field changed
      • getRequireSsl

        public Optional<Boolean> getRequireSsl()
        “Indicates whether or not to use SSL.”
        Returns:
        property requireSsl
      • withRequireSsl

        public IosEasEmailProfileConfiguration withRequireSsl​(Boolean requireSsl)
        Returns an immutable copy of this with just the requireSsl field changed. Field description below. The field name is also added to an internal map of changed fields in the returned object so that when this.patch() is called (if available)on the returned object only the changed fields are submitted.

        “Indicates whether or not to use SSL.”

        Parameters:
        requireSsl - new value of requireSsl field (as defined in service metadata)
        Returns:
        immutable copy of this with just the requireSsl field changed
      • getSigningCertificateType

        public Optional<EmailCertificateType> getSigningCertificateType()
        “Signing Certificate type for this Email profile.”
        Returns:
        property signingCertificateType
      • withSigningCertificateType

        public IosEasEmailProfileConfiguration withSigningCertificateType​(EmailCertificateType signingCertificateType)
        Returns an immutable copy of this with just the signingCertificateType field changed. Field description below. The field name is also added to an internal map of changed fields in the returned object so that when this.patch() is called (if available)on the returned object only the changed fields are submitted.

        “Signing Certificate type for this Email profile.”

        Parameters:
        signingCertificateType - new value of signingCertificateType field (as defined in service metadata)
        Returns:
        immutable copy of this with just the signingCertificateType field changed
      • getSmimeEnablePerMessageSwitch

        public Optional<Boolean> getSmimeEnablePerMessageSwitch()
        “Indicates whether or not to allow unencrypted emails.”
        Returns:
        property smimeEnablePerMessageSwitch
      • withSmimeEnablePerMessageSwitch

        public IosEasEmailProfileConfiguration withSmimeEnablePerMessageSwitch​(Boolean smimeEnablePerMessageSwitch)
        Returns an immutable copy of this with just the smimeEnablePerMessageSwitch field changed. Field description below. The field name is also added to an internal map of changed fields in the returned object so that when this.patch() is called (if available)on the returned object only the changed fields are submitted.

        “Indicates whether or not to allow unencrypted emails.”

        Parameters:
        smimeEnablePerMessageSwitch - new value of smimeEnablePerMessageSwitch field (as defined in service metadata)
        Returns:
        immutable copy of this with just the smimeEnablePerMessageSwitch field changed
      • getSmimeEncryptByDefaultEnabled

        public Optional<Boolean> getSmimeEncryptByDefaultEnabled()
        “If set to true S/MIME encryption is enabled by default.”
        Returns:
        property smimeEncryptByDefaultEnabled
      • withSmimeEncryptByDefaultEnabled

        public IosEasEmailProfileConfiguration withSmimeEncryptByDefaultEnabled​(Boolean smimeEncryptByDefaultEnabled)
        Returns an immutable copy of this with just the smimeEncryptByDefaultEnabled field changed. Field description below. The field name is also added to an internal map of changed fields in the returned object so that when this.patch() is called (if available)on the returned object only the changed fields are submitted.

        “If set to true S/MIME encryption is enabled by default.”

        Parameters:
        smimeEncryptByDefaultEnabled - new value of smimeEncryptByDefaultEnabled field (as defined in service metadata)
        Returns:
        immutable copy of this with just the smimeEncryptByDefaultEnabled field changed
      • getSmimeEncryptByDefaultUserOverrideEnabled

        public Optional<Boolean> getSmimeEncryptByDefaultUserOverrideEnabled()
        “If set to true, the user can toggle the encryption by default setting.”
        Returns:
        property smimeEncryptByDefaultUserOverrideEnabled
      • withSmimeEncryptByDefaultUserOverrideEnabled

        public IosEasEmailProfileConfiguration withSmimeEncryptByDefaultUserOverrideEnabled​(Boolean smimeEncryptByDefaultUserOverrideEnabled)
        Returns an immutable copy of this with just the smimeEncryptByDefaultUserOverrideEnabled field changed. Field description below . The field name is also added to an internal map of changed fields in the returned object so that when this.patch() is called (if available)on the returned object only the changed fields are submitted.

        “If set to true, the user can toggle the encryption by default setting.”

        Parameters:
        smimeEncryptByDefaultUserOverrideEnabled - new value of smimeEncryptByDefaultUserOverrideEnabled field (as defined in service metadata)
        Returns:
        immutable copy of this with just the smimeEncryptByDefaultUserOverrideEnabled field changed
      • getSmimeEncryptionCertificateUserOverrideEnabled

        public Optional<Boolean> getSmimeEncryptionCertificateUserOverrideEnabled()
        “If set to true the user can select the S/MIME encryption identity.”
        Returns:
        property smimeEncryptionCertificateUserOverrideEnabled
      • withSmimeEncryptionCertificateUserOverrideEnabled

        public IosEasEmailProfileConfiguration withSmimeEncryptionCertificateUserOverrideEnabled​(Boolean smimeEncryptionCertificateUserOverrideEnabled)
        Returns an immutable copy of this with just the smimeEncryptionCertificateUserOverrideEnabled field changed. Field description below. The field name is also added to an internal map of changed fields in the returned object so that when this.patch() is called (if available)on the returned object only the changed fields are submitted.

        “If set to true the user can select the S/MIME encryption identity.”

        Parameters:
        smimeEncryptionCertificateUserOverrideEnabled - new value of smimeEncryptionCertificateUserOverrideEnabled field (as defined in service metadata)
        Returns:
        immutable copy of this with just the smimeEncryptionCertificateUserOverrideEnabled field changed
      • getSmimeSigningCertificateUserOverrideEnabled

        public Optional<Boolean> getSmimeSigningCertificateUserOverrideEnabled()
        “If set to true, the user can select the signing identity.”
        Returns:
        property smimeSigningCertificateUserOverrideEnabled
      • withSmimeSigningCertificateUserOverrideEnabled

        public IosEasEmailProfileConfiguration withSmimeSigningCertificateUserOverrideEnabled​(Boolean smimeSigningCertificateUserOverrideEnabled)
        Returns an immutable copy of this with just the smimeSigningCertificateUserOverrideEnabled field changed. Field description below. The field name is also added to an internal map of changed fields in the returned object so that when this.patch() is called (if available)on the returned object only the changed fields are submitted.

        “If set to true, the user can select the signing identity.”

        Parameters:
        smimeSigningCertificateUserOverrideEnabled - new value of smimeSigningCertificateUserOverrideEnabled field (as defined in service metadata)
        Returns:
        immutable copy of this with just the smimeSigningCertificateUserOverrideEnabled field changed
      • getSmimeSigningEnabled

        public Optional<Boolean> getSmimeSigningEnabled()
        “If set to true S/MIME signing is enabled for this account”
        Returns:
        property smimeSigningEnabled
      • withSmimeSigningEnabled

        public IosEasEmailProfileConfiguration withSmimeSigningEnabled​(Boolean smimeSigningEnabled)
        Returns an immutable copy of this with just the smimeSigningEnabled field changed. Field description below. The field name is also added to an internal map of changed fields in the returned object so that when this.patch() is called (if available)on the returned object only the changed fields are submitted.

        “If set to true S/MIME signing is enabled for this account”

        Parameters:
        smimeSigningEnabled - new value of smimeSigningEnabled field (as defined in service metadata)
        Returns:
        immutable copy of this with just the smimeSigningEnabled field changed
      • getSmimeSigningUserOverrideEnabled

        public Optional<Boolean> getSmimeSigningUserOverrideEnabled()
        “If set to true, the user can toggle S/MIME signing on or off.”
        Returns:
        property smimeSigningUserOverrideEnabled
      • withSmimeSigningUserOverrideEnabled

        public IosEasEmailProfileConfiguration withSmimeSigningUserOverrideEnabled​(Boolean smimeSigningUserOverrideEnabled)
        Returns an immutable copy of this with just the smimeSigningUserOverrideEnabled field changed. Field description below. The field name is also added to an internal map of changed fields in the returned object so that when this.patch() is called (if available)on the returned object only the changed fields are submitted.

        “If set to true, the user can toggle S/MIME signing on or off.”

        Parameters:
        smimeSigningUserOverrideEnabled - new value of smimeSigningUserOverrideEnabled field (as defined in service metadata)
        Returns:
        immutable copy of this with just the smimeSigningUserOverrideEnabled field changed
      • getUseOAuth

        public Optional<Boolean> getUseOAuth()
        “Specifies whether the connection should use OAuth for authentication.”
        Returns:
        property useOAuth
      • withUseOAuth

        public IosEasEmailProfileConfiguration withUseOAuth​(Boolean useOAuth)
        Returns an immutable copy of this with just the useOAuth field changed. Field description below. The field name is also added to an internal map of changed fields in the returned object so that when this.patch() is called (if available)on the returned object only the changed fields are submitted.

        “Specifies whether the connection should use OAuth for authentication.”

        Parameters:
        useOAuth - new value of useOAuth field (as defined in service metadata)
        Returns:
        immutable copy of this with just the useOAuth field changed
      • getDerivedCredentialSettings

        public DeviceManagementDerivedCredentialSettingsRequest getDerivedCredentialSettings()
        “Tenant level settings for the Derived Credentials to be used for authentication.”
        Returns:
        navigational property derivedCredentialSettings
      • getIdentityCertificate

        public IosCertificateProfileBaseRequest getIdentityCertificate()
        “Identity certificate.”
        Returns:
        navigational property identityCertificate
      • getSmimeEncryptionCertificate

        public IosCertificateProfileRequest getSmimeEncryptionCertificate()
        “S/MIME encryption certificate.”
        Returns:
        navigational property smimeEncryptionCertificate
      • getSmimeSigningCertificate

        public IosCertificateProfileRequest getSmimeSigningCertificate()
        “S/MIME signing certificate.”
        Returns:
        navigational property smimeSigningCertificate
      • getUnmappedFields

        public com.github.davidmoten.odata.client.UnmappedFields getUnmappedFields()
        Specified by:
        getUnmappedFields in interface com.github.davidmoten.odata.client.ODataType
        Overrides:
        getUnmappedFields in class EasEmailProfileConfigurationBase
      • patch

        public IosEasEmailProfileConfiguration patch()
        Submits only changed fields for update and returns an immutable copy of this with changed fields reset.
        Overrides:
        patch in class EasEmailProfileConfigurationBase
        Returns:
        a copy of this with changed fields reset
        Throws:
        com.github.davidmoten.odata.client.ClientException - if HTTP response is not as expected
      • put

        public IosEasEmailProfileConfiguration put()
        Submits all fields for update and returns an immutable copy of this with changed fields reset (they were ignored anyway).
        Overrides:
        put in class EasEmailProfileConfigurationBase
        Returns:
        a copy of this with changed fields reset
        Throws:
        com.github.davidmoten.odata.client.ClientException - if HTTP response is not as expected