git2/sys/email.h

0001 /*
0002  * Copyright (C) the libgit2 contributors. All rights reserved.
0003  *
0004  * This file is part of libgit2, distributed under the GNU GPL v2 with
0005  * a Linking Exception. For full terms see the included COPYING file.
0006  */
0007 #ifndef INCLUDE_sys_git_email_h__
0008 #define INCLUDE_sys_git_email_h__
0009
0010 /**
0011  * @file git2/sys/email.h
0012  * @brief Advanced git email creation routines
0013  * @defgroup git_email Advanced git email creation routines
0014  * @ingroup Git
0015  * @{
0016  */
0017 GIT_BEGIN_DECL
0018
0019 /**
0020  * Create a diff for a commit in mbox format for sending via email.
0021  *
0022  * @param out buffer to store the e-mail patch in
0023  * @param diff the changes to include in the email
0024  * @param patch_idx the patch index
0025  * @param patch_count the total number of patches that will be included
0026  * @param commit_id the commit id for this change
0027  * @param summary the commit message for this change
0028  * @param body optional text to include above the diffstat
0029  * @param author the person who authored this commit
0030  * @param opts email creation options
0031  */
0032 GIT_EXTERN(int) git_email_create_from_diff(
0033     git_buf *out,
0034     git_diff *diff,
0035     size_t patch_idx,
0036     size_t patch_count,
0037     const git_oid *commit_id,
0038     const char *summary,
0039     const char *body,
0040     const git_signature *author,
0041     const git_email_create_options *opts);
0042
0043 /** @} */
0044 GIT_END_DECL
0045 #endif