> For the complete documentation index, see [llms.txt](https://docs.realmjoin.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.realmjoin.com/automation/runbooks/runbook-references/org/mail/add-mail-contact.md).

# Add Mail Contact

Create a mail contact for an external address

### Description

Creates a mail contact in Exchange Online for an external email address, so the person can be found in the address book and added to groups. First name, last name, contact name and alias are optional; the contact can be hidden from the address lists.

### Location

Organization → Mail → Add Mail Contact

**Full Runbook name**

rjgit-org\_mail\_add-mail-contact

### Details

| Property         | Value                                                                             |
| ---------------- | --------------------------------------------------------------------------------- |
| Version          | 1.0.1                                                                             |
| Required modules | <p>RealmJoin.RunbookHelper (>= 0.8.10)<br>ExchangeOnlineManagement (>= 3.9.2)</p> |
| Schedulable      | no                                                                                |

### Permissions

#### Application permissions

* **Type**: Office 365 Exchange Online
  * Exchange.ManageAsApp
    * *Runs New-/Set-MailContact and Get-MailContact/Get-Recipient preflight checks in the app-only Exchange Online session*

#### RBAC roles

* Exchange Administrator
  * *Required for the managed identity's app-only Exchange Online session to create mail contacts*

### Parameters

#### ExternalEmailAddress

External address of the person. Mail to the contact is delivered there.

| Property            | Value                  |
| ------------------- | ---------------------- |
| Required            | true                   |
| Default Value       |                        |
| Type                | String                 |
| Portal display name | External email address |

#### DisplayName

Name shown in the address book.

| Property            | Value        |
| ------------------- | ------------ |
| Required            | true         |
| Default Value       |              |
| Type                | String       |
| Portal display name | Display name |

#### Name

Unique name used to manage the contact in Exchange Online. Leave empty to use the display name.

| Property            | Value        |
| ------------------- | ------------ |
| Required            | false        |
| Default Value       |              |
| Type                | String       |
| Portal display name | Contact name |

#### FirstName

First name of the person. Can stay empty.

| Property            | Value      |
| ------------------- | ---------- |
| Required            | false      |
| Default Value       |            |
| Type                | String     |
| Portal display name | First name |

#### LastName

Last name of the person. Can stay empty.

| Property            | Value     |
| ------------------- | --------- |
| Required            | false     |
| Default Value       |           |
| Type                | String    |
| Portal display name | Last name |

#### Alias

Mail alias of the contact. Leave empty to have Exchange derive one from the contact name.

| Property            | Value  |
| ------------------- | ------ |
| Required            | false  |
| Default Value       |        |
| Type                | String |
| Portal display name | Alias  |

#### HideFromAddressLists

Hides the contact from the global address list and the other address lists.

| Property            | Value                    |
| ------------------- | ------------------------ |
| Required            | false                    |
| Default Value       | False                    |
| Type                | Boolean                  |
| Portal display name | Hide from address lists? |

[Back to Runbook Reference overview](/automation/runbooks/runbook-references.md)


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docs.realmjoin.com/automation/runbooks/runbook-references/org/mail/add-mail-contact.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.