SPIncomingEmailService members

  • Article

Represents the service that is used in Microsoft SharePoint Foundation for incoming e-mail timer jobs.

The SPIncomingEmailService type exposes the following members.

Constructors

  Name Description
Public method SPIncomingEmailService() Reserved for internal use.
Public method SPIncomingEmailService(String, SPFarm) Initializes a new instance of the SPIncomingEmailService class based on the specified service name and server farm.

Top

Properties

  Name Description
Public property AliasPrefix The alias prefix that an administrator can choose to set for the farm, so that all email addresses on the farm can be consistent. It gives admins a way to control the name-polution of the corresponding AD objects that are created...
Public property Applications Gets the collection of service applications associated with the service. (Inherited from SPService.)
Public property AutoProvision Available in SharePoint 2016 and later. Gets (and in some scenarios sets) a Boolean value that indicates whether the service is enabled on the farm. (Inherited from SPService.)
Public property CanUpgrade Gets a value that indicates whether the object can be upgraded. (Inherited from SPPersistedUpgradableObject.)
Public property CompliantWithMinRole (Inherited from SPService.)
Public property DeploymentLocked (Inherited from SPPersistedObject.)
Public property Description (Overrides SPService.Description.)
Public property DirectoryManagementServiceUrl Gets or sets the URL of the SharePoint Directory Management SOAP Web service.
Public property DirectoryManagementServiceVersion The version of the remote Directory Management Service being used.
Public property DisplayName Gets the display name that describes the persisted object instance within the administrative user interface. (Inherited from SPPersistedObject.)
Public property DistributionGroupsEnabled Gets or sets a Boolean value that specifies whether to allow creation of distribution groups from SharePoint sites.
Public property DLsRequireAuthenticatedSenders Gets or sets a Boolean value that specifies whether to require authenticated senders for e-mail messages that are sent to distribution groups.
Public property DropFolder Gets or sets the drop folder that SharePoint Foundation checks for incoming e-mail messages that arrive from the Simple Mail Transfer Protocol (SMTP) service.
Public property Enabled Gets or sets a Boolean value that specifies whether to enable delivery of incoming e-mail.
Public property Farm Gets the server farm where the object resides. (Inherited from SPPersistedObject.)
Public property Hidden (Inherited from SPService.)
Public property Id Gets or sets the GUID that is associated with the object. (Inherited from SPPersistedObject.)
Public property Instances Gets a collection of all instances of the service in the server farm. (Inherited from SPService.)
Public property IsBackwardsCompatible Gets or sets a value that indicates whether the current object is backward compatible. (Inherited from SPPersistedUpgradableObject.)
Public property JobDefinitions Gets a collection of job definitions for this service. (Inherited from SPService.)
Public property JobHistoryEntries Gets an enumeration of the job history entries for this service. (Inherited from SPService.)
Public property MaxServerRelativeFileUrlLength The maximum number of characters to allow in the server-relative URL of a file created via an incoming email handler.
Public property Name Gets or sets a name that is used to uniquely identify two objects that have the same parent and class. (Inherited from SPPersistedObject.)
Public property NeedsUpgrade Gets or sets a Boolean value that specifies whether the object needs to be upgraded. (Inherited from SPPersistedUpgradableObject.)
Public property NeedsUpgradeIncludeChildren Gets a Boolean value that indicates whether the object should be upgraded, considering the children of the object. (Inherited from SPPersistedUpgradableObject.)
Public property Parent Gets the parent in the logical hierarchy of the configuration object tree. (Inherited from SPPersistedObject.)
Public property Properties Gets metadata for the persisted object. (Inherited from SPPersistedObject.)
Public property RemoteDirectoryManagementService Gets or sets a Boolean value that specifies whether to use a remote directory management service to create distribution groups and contacts.
Public property Required Gets a Boolean value that indicates whether an instance of the incoming e-mail service must be running on at least one computer in the server farm. (Overrides SPService.Required.)
Public property RetryDeliveryInterval Gets or sets the maximum duration, in hours, that undelivered messages remain in the drop folder before being deleted.
Public property RunningJobs Gets a collection of running jobs for this service. (Inherited from SPService.)
Public property ServerAddress Gets or sets the name of the server where incoming e-mail messages are received.
Public property ServerDisplayAddress Gets or sets the suffix of the e-mail server address that is displayed in the administrative user interface.
Public property ShouldDeferUpgradeActions (Inherited from SPPersistedUpgradableObject.)
Public property SmtpInstanceId Gets or sets the ID of the Internet Information Services (IIS) Simple Mail Transfer Protocol (SMTP) instance to configure with IP security settings.
Public property Status Gets or sets the status of the object that the class represents. (Inherited from SPPersistedObject.)
Public property SystemService (Inherited from SPService.)
Public property TypeName Gets the display name that is used to describe the object type within the administrative user interface. (Overrides SPPersistedObject.TypeName.)
Public property UpgradeContext Gets the SPUpgradeContext for the current upgrade operation. (Inherited from SPPersistedUpgradableObject.)
Public property UpgradedPersistedProperties Gets the collection of field names and values for fields that were deleted or changed. (Inherited from SPAutoSerializingObject.)
Public property UseAutomaticSettings Gets or sets a Boolean value that specifies whether incoming e-mail settings are automatically gathered from the default Internet Information Services (IIS) Simple Mail Transfer Protocol (SMTP) instance.
Public property UseDirectoryManagementService Gets or sets a Boolean value that specifies whether the incoming e-mail service uses a SharePoint Directory Management SOAP Web service.
Public property Version Gets a value that is incremented each time the object is updated. (Inherited from SPPersistedObject.)
Protected property WasCreated Gets a Boolean value that indicates whether the object is initialized and can be found in the database. (Inherited from SPPersistedObject.)

Top

Methods

  Name Description
Public method ChangeIPRestrictionList Specifies the servers from which the incoming e-mail service accepts e-mail messages.
Public method Clone Returns a clone of the object that does not come from the in-memory cache, which enables calling code to help ensure thread safety. (Inherited from SPPersistedObject.)
Public method Delete Removes the service and associated resources. (Inherited from SPService.)
Public method Equals Determines whether the current persisted object equals the specified object. (Inherited from SPPersistedObject.)
Protected method Finalize (Inherited from Object.)
Public method GetChild<T>() Returns the child of the persisted object based on the specified type. (Inherited from SPPersistedObject.)
Public method GetChild<T>(String) Returns the child object of the persisted object based on the specified name. (Inherited from SPPersistedObject.)
Public method GetCreateApplicationLink Gets the administration user interface link that is used to create a new service application. (Inherited from SPService.)
Public method GetCreateApplicationOptions Gets the options for creating a new service application. (Inherited from SPService.)
Protected method GetFirstPreconfiguredDatabase (Inherited from SPService.)
Public method GetHashCode Serves as a hash function for the persisted object. (Inherited from SPPersistedObject.)
Public method GetIPRestrictionList Gets the list of servers from which the incoming e-mail service accepts e-mail messages.
Public method GetObjectData Gets the serialized state of the object. (Inherited from SPAutoSerializingObject.)
Protected method GetPreconfiguredDatabaseInfo (Inherited from SPService.)
Public method GetType (Inherited from Object.)
Protected method HasAdditionalUpdateAccess Override this method to allow more users to update the object. (Inherited from SPPersistedObject.)
Public method Invalidate Invalidates computed property values. (Inherited from SPPersistedUpgradableObject.)
Public method IsUserLicensedForEntity Checks if the current user has the proper license to access the specified entity. (Inherited from SPService.)
Public method LegacyUpdate (Inherited from SPPersistedObject.)
Protected method MemberwiseClone (Inherited from Object.)
Protected method OnDeserialization Called immediately after the base class deserializes itself to do additional work. (Inherited from SPPersistedObject.)
Protected method OnPostCreate (Inherited from SPPersistedObject.)
Protected method OnPreCreate (Inherited from SPPersistedObject.)
Public method Provision Makes the changes to the local server that are needed before the object can be used. (Inherited from SPPersistedObject.)
Public method RunWithConcurrencyRetries (Inherited from SPPersistedObject.)
Public method ScheduleAutomaticSettingsUpdate Resets the timer job that is implemented in the incoming e-mail service to use settings of the default Internet Information Services (IIS) Simple Mail Transfer Protocol (SMTP) instance.
Public method ToString Returns the type and name of an object and of all its ancestors (parent, grandparent, and so on). (Inherited from SPPersistedObject.)
Public method Uncache Frees the memory cache that is used by the object. (Inherited from SPPersistedObject.)
Public method Unprovision Makes the changes to the local server that are needed to clean up after deleting the object. (Inherited from SPPersistedObject.)
Public method Update() Commits changes to the incoming e-mail service and starts or stops the timer job if necessary. (Overrides SPPersistedObject.Update().)
Public method Update(Boolean) Causes the object to save its state and propagate changes to all the computers in the server farm, optionally throwing an exception if the object already exists in the configuration store. (Inherited from SPPersistedObject.)
Protected method UpdateParent Causes the containing SPPersistedObject, if one exists, to update its state. (Inherited from SPAutoSerializingObject.)
Public method UpdateWithNoObjectCallbackCheck (Inherited from SPPersistedObject.)
Public method Upgrade() Upgrades the object. (Inherited from SPPersistedUpgradableObject.)
Public method Upgrade(Boolean) Upgrades the object, and if a Boolean parameter equals true, recursively upgrades all descendants of the current object. (Inherited from SPPersistedUpgradableObject.)
Protected method Validate Validates the state of all fields before persisting the object. (Inherited from SPPersistedObject.)
Public method ValidateBackwardsCompatibility Validates the backward compatibility of the content database schema for the DLLs on the Web front end. This method is called each time a connection is made to the content database to verify that the database schema is compatible. (Inherited from SPPersistedUpgradableObject.)

Top

See also

Reference

SPIncomingEmailService class

Microsoft.SharePoint.Administration namespace