Set-MailContact cmdlet is used for updating contact information - sets the mail contact properties.

Note: Some properties can be disabled for editing if special plan's features like ADSync are enabled. For example, the property is unavailable for editing, if it is synchronized by ADSync.

This cmdlet supports risk-mitigation parameters.

Input parameters

PropertyTypeMandatoryDescriptionRestrictions/Valid Values
1 Authentication Information (all parameters)  
2

Identity

(aliases: GUID, DistinguishedName )

ADObjectIDParameter

R

A property, that is used for managing the mail contact

Value of one of these parameters can be used as Identity:

#ParameterDescription
1 GUID Globally Unique Identifier (ObjectGuid)
2 DistinguishedName Unique name of the object in Active Directory
3

Address

(alias: StreetAddress)

string O Company information (CI): Address (street)

Max length is 1024 symbols

Cannot be set if property is synced with ADSync service   

4 City string O CI: City

Max length is 128 symbols

Cannot be set if property is synced with ADSync service   

5 Company string O CI: Name

Max length is 64 symbols

Cannot be set if property is synced with ADSync service

6 Country string O CI: Country

A full name or a code according to ISO 3166; valid country

Cannot be set if property is synced with ADSync service  

7 Department string O CI: Department of the company, where the contact works

Max length is 64 symbols

Cannot be set if property is synced with ADSync service   

8 DisplayName string O Name of the mail contact in the list of HostPilot

Max length is 256 symbols

Cannot be set if property is synced with ADSync service 

9

EmailAddress

(alias: ExternalEmailAddress)

string O

Contact's external Email address (e.g. aaa@gmail.com )

Valid address
10

FaxPhoneNumber

(alias: Fax)

string O CI: Fax number

Max length is 64 symbols

Cannot be set if property is synced with ADSync service   

11 FirstName string  O First name of the contact

Max length is 64 symbols

Cannot be set if property is synced with ADSync service   

12 HideFromAddressBook bool? O The property specifies whether this contact is visible in the address book.
  • True the contact is excluded from the address book, when the search is performed.
  • False - the contact is visible in the address book.

13

HomePhoneNumber

(alias: HomePhone)

string O Contact's home phone number

Max length is 64 symbols

Cannot be set if property is synced with ADSync service   

14 Initials string  O Initials  of the contact

Max length is 6 symbols

Cannot be set if property is synced with ADSync service    

15 LastName  string  O

Last name of the contact

Max length is 64 symbols

Cannot be set if property is synced with ADSync service

16

MobilePhoneNumber

(alias: MobilePhone)

string  O Contact's mobile phone number

Max length is 64 symbols

Cannot be set if property is synced with ADSync service   

17 Notes string  O Additional information, comments

Max length is 1024 symbols

Cannot be set if property is synced with ADSync service

18 Office string  O

CI: Special attribute of the office (e.g. location)

Max length is 128 symbols

Cannot be set if property is synced with ADSync service   

19 Pager string  O Contact's pager number Max length is 64 symbols
20

PhoneNumber

(alias: BusinessPhone)

string  O CI: Contact's business phone

Max length is 64 symbols

Cannot be set if property is synced with ADSync service   

21

PostalCode

(alias: ZIP)

string  O CI: PostalCode (ZIP)

Max length is 40 symbols

Cannot be set if property is synced with ADSync service  

22 State string  O CI: Name of the state

Max length is 128 symbols

ISO 3166 codes required for input; these codes should be mapped to HostPilot states' names

Cannot be set if property is synced with ADSync service  

23

Title

(alias: JobTitle)

string  O CI: Contact's job title

Max length is 64 symbols

Cannot be set if property is synced with ADSync service   

24

WWWHomePage

(alias: WebPage)

string  O CI: Web page of the contact's company

Max length is 2048 symbols

Output parameters

No parameters

Example of using Set-MailContact cmdlet

Set-MailContact -Identity "6BC6F189-0D73-4950-BD11-6955C8C444AB" -EmailAddress "Sal@accountname.hostpilot.com" -DisplayName "Sal"