SPIncomingEmailService Members

Include Protected Members
Include Inherited Members

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
	SPIncomingEmailService()	Reserved for internal use.
	SPIncomingEmailService(String, SPFarm)	Initializes a new instance of the SPIncomingEmailService class based on the specified service name and server farm.

Top

Properties

	Name	Description
	Applications	Gets the collection of service applications associated with the service. (Inherited from SPService.)
	CanUpgrade	Gets a value that indicates whether the object can be upgraded. (Inherited from SPPersistedUpgradableObject.)
	DirectoryManagementServiceUrl	Gets or sets the URL of the SharePoint Directory Management SOAP Web service.
	DirectoryManagementServiceVersion
	DisplayName	Gets the display name that describes the persisted object instance within the administrative user interface. (Inherited from SPPersistedObject.)
	DistributionGroupsEnabled	Gets or sets a Boolean value that specifies whether to allow creation of distribution groups from SharePoint sites.
	DLsRequireAuthenticatedSenders	Gets or sets a Boolean value that specifies whether to require authenticated senders for e-mail messages that are sent to distribution groups.
	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.
	Enabled	Gets or sets a Boolean value that specifies whether to enable delivery of incoming e-mail.
	Farm	Gets the server farm where the object resides. (Inherited from SPPersistedObject.)
	Id	Gets or sets the GUID that is associated with the object. (Inherited from SPPersistedObject.)
	Instances	Gets a collection of all instances of the service in the server farm. (Inherited from SPService.)
	IsBackwardsCompatible	Gets or sets a value that indicates whether the current object is backward compatible. (Inherited from SPPersistedUpgradableObject.)
	JobDefinitions	Gets a collection of job definitions for this service. (Inherited from SPService.)
	JobHistoryEntries	(Inherited from SPService.)
	MaxServerRelativeFileUrlLength
	Name	Gets or sets a name that is used to uniquely identify two objects that have the same parent and class. (Inherited from SPPersistedObject.)
	NeedsUpgrade	Gets or sets a Boolean value that specifies whether the object needs to be upgraded. (Inherited from SPPersistedUpgradableObject.)
	NeedsUpgradeIncludeChildren	Gets a Boolean value that indicates whether the object should be upgraded, considering the children of the object. (Inherited from SPPersistedUpgradableObject.)
	Parent	Gets the parent in the logical hierarchy of the configuration object tree. (Inherited from SPPersistedObject.)
	Properties	Gets metadata for the persisted object. (Inherited from SPPersistedObject.)
	RemoteDirectoryManagementService	Gets or sets a Boolean value that specifies whether to use a remote directory management service to create distribution groups and contacts.
	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.)
	RetryDeliveryInterval	Gets or sets the maximum duration, in hours, that undelivered messages remain in the drop folder before being deleted.
	RunningJobs	Gets a collection of running jobs for this service. (Inherited from SPService.)
	ServerAddress	Gets or sets the name of the server where incoming e-mail messages are received.
	ServerDisplayAddress	Gets or sets the suffix of the e-mail server address that is displayed in the administrative user interface.
	SmtpInstanceId	Gets or sets the ID of the Internet Information Services (IIS) Simple Mail Transfer Protocol (SMTP) instance to configure with IP security settings.
	Status	Gets or sets the status of the object that the class represents. (Inherited from SPPersistedObject.)
	TypeName	Gets the display name that is used to describe the object type within the administrative user interface. (Overrides SPPersistedObject.TypeName.)
	UpgradeContext	Gets the SPUpgradeContext for the current upgrade operation. (Inherited from SPPersistedUpgradableObject.)
	UpgradedPersistedProperties	Gets the collection of field names and values for fields that were deleted or changed. (Inherited from SPAutoSerializingObject.)
	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.
	UseDirectoryManagementService	Gets or sets a Boolean value that specifies whether the incoming e-mail service uses a SharePoint Directory Management SOAP Web service.
	Version	Gets a value that is incremented each time the object is updated. (Inherited from SPPersistedObject.)
	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
	ChangeIPRestrictionList	Specifies the servers from which the incoming e-mail service accepts e-mail messages.
	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.)
	Delete	Removes the service and associated resources. (Inherited from SPService.)
	Equals	Determines whether the current persisted object equals the specified object. (Inherited from SPPersistedObject.)
	Finalize	(Inherited from Object.)
	GetChild<T>()	Returns the child of the persisted object based on the specified type. (Inherited from SPPersistedObject.)
	GetChild<T>(String)	Returns the child object of the persisted object based on the specified name. (Inherited from SPPersistedObject.)
	GetCreateApplicationLink	(Inherited from SPService.)
	GetCreateApplicationOptions	(Inherited from SPService.)
	GetHashCode	Serves as a hash function for the persisted object. (Inherited from SPPersistedObject.)
	GetIPRestrictionList	Gets the list of servers from which the incoming e-mail service accepts e-mail messages.
	GetObjectData	Gets the serialized state of the object. (Inherited from SPAutoSerializingObject.)
	GetType	(Inherited from Object.)
	HasAdditionalUpdateAccess	Override this method to allow more users to update the object. (Inherited from SPPersistedObject.)
	Invalidate	Invalidates computed property values. (Inherited from SPPersistedUpgradableObject.)
	MemberwiseClone	(Inherited from Object.)
	OnDeserialization	Called immediately after the base class deserializes itself to do additional work. (Inherited from SPPersistedObject.)
	Provision	Makes the changes to the local server that are needed before the object can be used. (Inherited from SPPersistedObject.)
	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.
	ToString	Returns the type and name of an object and of all its ancestors (parent, grandparent, and so on). (Inherited from SPPersistedObject.)
	Uncache	Frees the memory cache that is used by the object. (Inherited from SPPersistedObject.)
	Unprovision	Makes the changes to the local server that are needed to clean up after deleting the object. (Inherited from SPPersistedObject.)
	Update()	Commits changes to the incoming e-mail service and starts or stops the timer job if necessary. (Overrides SPPersistedObject.Update().)
	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.)
	UpdateParent	Causes the containing SPPersistedObject, if one exists, to update its state. (Inherited from SPAutoSerializingObject.)
	Upgrade()	Upgrades the object. (Inherited from SPPersistedUpgradableObject.)
	Upgrade(Boolean)	Upgrades the object, and if a Boolean parameter equals true, recursively upgrades all descendants of the current object. (Inherited from SPPersistedUpgradableObject.)
	Validate	Validates the state of all fields before persisting the object. (Inherited from SPPersistedObject.)
	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