src/site/apt/examples/specifying-mail-sender.apt.vm

 ------
 Specifying the Mail Sender
 ------
 Stephane Nicoll
 ------
 2011-03-30
 ------

 ~~ Licensed to the Apache Software Foundation (ASF) under one
 ~~ or more contributor license agreements.  See the NOTICE file
 ~~ distributed with this work for additional information
 ~~ regarding copyright ownership.  The ASF licenses this file
 ~~ to you under the Apache License, Version 2.0 (the
 ~~ "License"); you may not use this file except in compliance
 ~~ with the License.  You may obtain a copy of the License at
 ~~
 ~~   http://www.apache.org/licenses/LICENSE-2.0
 ~~
 ~~ Unless required by applicable law or agreed to in writing,
 ~~ software distributed under the License is distributed on an
 ~~ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 ~~ KIND, either express or implied.  See the License for the
 ~~ specific language governing permissions and limitations
 ~~ under the License.

 ~~ NOTE: For help with the syntax of this file, see:
 ~~ http://maven.apache.org/doxia/references/apt-format.html


Specifying the Mail Sender

 The identity used to send the announcement mail can be customized. It can be
 either a member of the <<<\<developers\>>>> section of the POM or it can be
 specified explicitly with the <<<\<mailSender\>>>> parameter of the plugin.

* Specifying the developer to use

 To specify which developer is used to send the announcement, simply specify the <<<id>>> of
 the developer as in the example below:

+-----------------+
<project>
  <developers>
    ...
    <developer>
      <id>jsmith</id>
      <name>John Smith</name>
      <email>jsmith@foo.bar</email>
    </developer>
    ...
  </developers>
  ...
  <build>
    <plugins>
      <plugin>
        <groupId>org.apache.maven.plugins</groupId>
        <artifactId>maven-changes-plugin</artifactId>
        <version>${project.version}</version>
        <configuration>
          <fromDeveloperId>jsmith</fromDeveloperId>
        </configuration>
      </plugin>
    </plugins>
  </build>
  ...
</project>
+-----------------+

 If no developer <<<id>>> is specified, the first <<<\<developer\>>>> in the list will be used.

 You can also do this from the command line, if the person doing the release
 changes between releases.

+-----------------+
mvn -Dchanges.fromDeveloperId=jsmith changes:announcement-mail
+-----------------+


* Specifying the sender explicitly

 If you want to specify the sender explicitly and not rely on the <<<developers>>> section of your POM,
 define the <<<mailSender>>> parameter of the plugin.

+-----------------+
<project>
  ...
  <build>
    <plugins>
      <plugin>
        <groupId>org.apache.maven.plugins</groupId>
        <artifactId>maven-changes-plugin</artifactId>
        <version>${project.version}</version>
        <configuration>
          <mailSender>
            <name>Release Notification</name>
            <email>noreply@foo.bar</email>
          </mailSender>
        </configuration>
      </plugin>
    </plugins>
  </build>
  ...
</project>
+-----------------+