This documentation is archived and is not being maintained.

TeamFoundationMailService Class

A service for sending emails through SMTP.

System::Object
  Microsoft.TeamFoundation.Framework.Server::TeamFoundationMailService

Namespace:  Microsoft.TeamFoundation.Framework.Server
Assembly:  Microsoft.TeamFoundation.Framework.Server (in Microsoft.TeamFoundation.Framework.Server.dll)

[TeamFoundationServiceDependency(typeof(TeamFoundationSqlNotificationService))]
[TeamFoundationServiceDependency(typeof(TeamFoundationRegistryService))]
[TeamFoundationServiceDependency(typeof(IdentityService))]
[TeamFoundationServiceDependency(typeof(TeamFoundationJobService))]
public ref class TeamFoundationMailService : ITeamFoundationService

The TeamFoundationMailService type exposes the following members.

  NameDescription
Public propertyAnonymousAuthIt true then mail is sent to the server anonymously.
Public propertyCertThumbprintThe thumbprint of the certificate used to authenticate against the SMTP server.
Public propertyEnabledA flag indicating if the mail service is enabled or not. If it is enabled, all other fields are guaranteed to have been loaded from the registry.
Public propertyEnableSslUse Ssl when communicating to the SMTP server.
Public propertyFromAddressThe default mail address that will show up in the "From" field of sent emails (e.g. a service account).
Public propertyLastRetryThe last retry of sending failed mail requests.
Public propertyLogAllExceptionsIndicator of whether all send mail exceptions should be logged.
Public propertyLogLevelThe log level.
Public propertyMaxEmailBodySizeThe maximum email body size (in bytes).
Public propertyMaxRetryAttemptsMaximum retries of sending failed mail requests.
Public propertyRetryIntervalInterval (in seconds) between retry.
Public propertySendMailJobDelayDelay duration (in seconds) of the send mail job.
Public propertySmtpPasswordPassword portion of the credential used to connect to the SMTP server.
Public propertySmtpPortThe SMTP port.
Public propertySmtpServerThe SMTP host server network address.
Public propertySmtpUserUser credential for connecting to the SMTP server. When empty or null, integrated authorization is used.
Public propertyUseReplyToA flag that controls whether the "From" field is populated with the originator's email address, or the default email address (and the originator's email address is put in the reply to list).
Top

  NameDescription
Public methodEqualsDetermines whether the specified object is equal to the current object. (Inherited from Object.)
Protected methodFinalizeAllows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
Public methodGetHashCodeServes as the default hash function. (Inherited from Object.)
Public methodGetTypeGets the Type of the current instance. (Inherited from Object.)
Public methodLoadSettingsLoad the TeamFoundationMailSevice settings from the registry.
Protected methodMemberwiseCloneCreates a shallow copy of the current Object. (Inherited from Object.)
Public methodQueueMailJob(TeamFoundationRequestContext, IEnumerable<MailMessage>)Queue messages to be sent by the SendMailJob.
Public methodQueueMailJob(TeamFoundationRequestContext, MailMessage)Queue a new message to be sent by the SendMailJob.
Public methodSend(TeamFoundationRequestContext, IEnumerable<MailMessage>)Send multiple mail messages. If an exception is encountered, this method will not continue with sending.
Public methodSend(TeamFoundationRequestContext, MailMessage)Send a mail message.
Public methodServiceEndInvoked on service stop.
Public methodServiceStartInvoked on service start.
Public methodToStringReturns a string that represents the current object. (Inherited from Object.)
Public methodValidateMessageValidate the message to be sent or queued for sending.
Public methodValidateMessagesValidate the messages to be sent or queued for sending.
Top

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.
Show: